Приложение № 7. Требования, предъявляемые к запросам мониторинга и формату их передачи по интерфейсу взаимодействия между пунктами управления уполномоченных государственных органов, осуществляющих оперативно-разыскную деятельность или обеспечение безопасности Российской Федерации, и программными и техническими средствами, используемыми собственниками или иными владельцами технологических сетей связи, имеющими уникальный идентификатор совокупности средств связи и иных технических средств в информационно-телекоммуникационной сети "Интернет"
1. Посредством использования ПТС должна поддерживаться возможность отправления на ПУ следующей информации о структуре и функционировании ПТС по запросу ПУ:
1) о структуре и составе ПТС, составе и состоянии интерфейса взаимодействия ПТС с ПУ;
2) об установленном в ПТС общесистемном программном обеспечении, перечне и состоянии программных модулей в составе ПО ПТС;
3) о точках подключения ПТС к ИС и интерфейсах ввода информации в ПТС.
2. ПТС по запросу ПУ должны предоставлять следующую информацию в части структуры и состава ПТС, состава и состояния интерфейса взаимодействия ПТС с ПУ:
1) перечень коммутационного и серверного оборудования, средств хранения данных с его идентификацией;
2) идентификацию интерфейсов подключения оборудования ПТС друг к другу;
3) параметры для серверного оборудования:
общий и занятый объем оперативной памяти;
количество сетевых интерфейсов с их идентификацией и нагрузкой;
общее количество и загрузку процессоров;
общий объем дискового пространства, объем свободного пространства;
4) параметры технических средств хранения данных:
перечень модулей, составляющих средства хранения данных с их идентификацией;
для каждого входящего в состав средств хранения данных модуля: общий объем дискового пространства, объем свободного дискового пространства и состояние модуля ("штатное функционирование", "сбой", "не функционирует"), текстовую расшифровку сбоя.
3. Посредством использования ПТС по запросу ПУ должна быть предоставлена информация в части точек подключения ПТС к ИС, интерфейсов ввода информации в ПТС, содержащая:
1) перечень точек подключения к технологической сети связи и точек ввода информации в ПТС с их идентификацией;
2) для каждой точки подключения посредством ПТС предоставляется информация о (об):
состоянии точки подключения (ввода информации) ("штатное функционирование", "сбой", "не функционирует"), текстовую расшифровку сбоя;
объеме информации, поступающей в секунду;
периоде времени, в течение которого на точку подключения и (или) ввода информации в ПТС не поступала информация.
4. ПТС по запросу ПУ должны предоставлять следующую информацию в части состава программного обеспечения ПТС и его состояния:
1) перечень установленного общесистемного программного обеспечения с его идентификацией;
2) информацию для общесистемного программного обеспечения:
идентификатор ПТС, на котором установлено программное обеспечение;
наименование программного обеспечения;
состояние программного обеспечения ("штатное функционирование", "сбой", "не функционирует"), текстовую расшифровку сбоя;
3) перечень установленного ПО ПТС с его идентификацией;
4) информацию для программного обеспечения ПТС:
идентификатор ПТС, на котором установлено программное обеспечение;
назначение (определяется разработчиком ПТС);
состояние ("штатное функционирование", "сбой", "не функционирует"), текстовую расшифровку сбоя;
список контролируемых параметров (определяется разработчиком ПТС).
5. Информация о функционировании и состоянии ПТС, указанная в пунктах 1 - 4 настоящего приложения к Требованиям к ПТС, должна быть представлена в виде временных рядов.
6. Временные ряды должны иметь следующий обязательный набор меток:
systemtype - относится ли метрика к оборудованию или программному обеспечению. Данный временной ряд должен принимать одно из значений: "hardware" или "software";
moduleid - идентификатор модуля;
modulename - наименование модуля;
moduletype - тип модуля;
blocknumber - номер блока оборудования;
groupname - наименование группы метрик;
softwareparentmoduleid - идентификатор модуля ПО, в состав которого входит модуль с данной метрикой;
hardwareparentmoduleid - идентификатор модуля оборудования, в состав которого входит модуль с данной метрикой.
7. Для метрик должны быть заданы единицы измерения и описания их назначения на русском языке.
8. Для получения на ПУ значений метрик посредством ПТС обеспечивается возможность отправки на ПУ запросов мониторинга на конечную точку "/metric".
9. Для кодирования содержимого запросов мониторинга и ответов должен применяться формат JSON.
10. ПТС при успешном выполнении запросов мониторинга должны возвращать HTTP код 2хх.
11. ПТС при возникновении ошибки во время выполнения запросов мониторинга должны в ответе возвращать поле "error" с информацией об ошибке и следующие HTTP коды:
400 Bad Request - в запросе отсутствуют или некорректно заданы параметры;
422 Unprocessable Entity - неправильный формат запроса на языке PromQL в соответствии с пунктом 13 настоящего приложения к Требованиям к ПТС;
503 Service Unavailable - выполнение запроса прервано на стороне ПТС.
12. Ответы на запросы мониторинга должны иметь следующий формат:
{
"status": "success" | "error",
"data": <data>,
"errorType": "<string>",
"error": "<string>",
"warnings": ["<string>"]
},
в котором:
поле "status" - статус выполнения запроса, может принимать одно из двух значений: "success" или "error";
поле "data" - результат выполнения запроса, структура поля зависит от конечной точки, на которую был отправлен запрос (в соответствии с пунктом 13 настоящего приложения к Требованиям к ПТС);
поля "errorТуре" и "error" - соответственно тип и описание ошибки, возникшей при выполнении запроса (поле "status" имеет значение "error");
поле "warnings" - незначительные ошибки (предупреждения), возникшие во время выполнения запроса, но существенно не повлиявшие на его выполнение. При этом поле "data" может содержать частичные результаты выполнения запроса.
13. ПТС должны реализовывать внутри конечной точки "/metric" следующие дополнительные конечные точки:
1) "/api/v1/query" - предназначена для приема запросов мониторинга от ПУ в целях получения метрик для конкретного значения времени, а также передачи на ПУ результатов выполнения данных запросов. Данная конечная точка должна поддерживать HTTP методы GET и POST с параметрами:
"query" - запрос на языке PromQL;
"time" (опционально) - дата и время в формате согласно RFC3339 или Unix-время;
"duration" (опционально) - период времени в формате согласно Time Durations языка PromQL.
Программный код для поля "data" для ответа на запросы мониторинга для данной конечной точки должен иметь следующую структуру:
{
"resultType": "matrix" | "vector" | "scalar" | "string",
"result": <value>
}.
Формат поля "result" должен зависеть от значения поля "resultType" согласно пункту 14 настоящего приложения к Требованиям к ПТС;
2) "/api/v1/query_range" - предназначена для приема запросов мониторинга от ПУ в целях получения метрик для диапазона времени, а также передачи на ПУ результатов выполнения данных запросов. Данная конечная точка должна поддерживать HTTP методы GET и POST с параметрами:
"query" - запрос на языке PromQL;
"start" - дата и время начала диапазона в формате согласно RFC3339 или Unix-время;
"end" - дата и время конца диапазона в формате согласно RFC3339 или Unix-время;
"step" - временной шаг запроса в формате согласно Time Durations языка PromQL или число с плавающей точкой;
"duration" (опционально) - период времени в формате согласно Time Durations языка PromQL.
Программный код для поля "data" для ответа на запросы мониторинга для данной конечной точки должен иметь следующую структуру:
{
"resultType": "matrix",
"result": <value>
}.
Формат поля "result" должен соответствовать подпункту 1 пункта 14 настоящего приложения к Требованиям к ПТС;
3) "/api/v1/series" - предназначена для приема запросов мониторинга от ПУ в целях получения списка метрик, которые имеют заданный набор меток, а также передачи на ПУ результатов выполнения данных запросов. Данная конечная точка должна поддерживать HTTP методы GET и POST с параметрами:
"match[]" - перечень запрашиваемых меток в формате Time series Selectors языка PromQL;
"start" - дата и время начала диапазона в формате согласно RFC3339 или Unix-время;
"end" - дата и время конца диапазона в формате согласно RFC3339 или Unix-время.
Поле "data" для ответа на запросы мониторинга для данной конечной точки должно содержать перечень метрик (представляются перечнем их меток (пара ключ-значение), удовлетворяющих критериям запроса;
4) "/api/v1/labels" - предназначена для приема запросов мониторинга от ПУ в целях получения списка меток, которые имеют заданный набор метрик, а также передачи на ПУ результатов выполнения данных запросов. Данная конечная точка должна поддерживать HTTP методы GET и POST с параметрами:
"match[]" (опционально) - перечень запрашиваемых метрик в формате Time series Selectors языка PromQL;
"start" (опционально) - дата и время начала диапазона в формате согласно RFC3339 или Unix-время;
"end" (опционально) - дата и время конца диапазона в формате согласно RFC3339 или Unix-время.
Поле "data" для ответа на запросы мониторинга для данной конечной точки должно содержать перечень названий меток, удовлетворяющих критериям запроса;
5) "/api/v1/label/<label_name>/values" - предназначена для приема запросов мониторинга от ПУ в целях получения значений заданных меток, а также передачи на ПУ результатов выполнения данных запросов. Данная конечная точка должна поддерживать HTTP метод GET с параметрами:
"match []" (опционально) - перечень запрашиваемых метрик в формате Time series Selectors языка PromQL;
"start" (опционально) - дата и время начала диапазона в формате согласно RFC3339 или Unix-время;
"end" (опционально) - дата и время конца диапазона в формате согласно RFC3339 или Unix-время.
Поле "data" для ответа на запросы мониторинга для данной конечной точки должно содержать перечень значений меток, удовлетворяющих критериям запроса.
14. Поле "result" в ответах на запросы мониторинга может иметь один из следующих форматов:
1) если поле "resultType" имеет значение "matrix", то поле "result" должно иметь следующий формат:
[
{
"metric": {"<label_name>": "<label_value>", ... },
"values": [[<unix_time>, "<sample_value>"], ... ],
"histograms": [[<unix_time>, <histogram>], ... ]
},
...
];
2) если поле "resultType" имеет значение "vector", то поле "result" должно иметь следующий формат:
[
{
"metric": {"<label_name>": "<label_value>", ... },
"value": [<unix_time>, "<sample_value>"],
"histogram": [<unix_time>, <histogram>],
},
...
];
3) если поле "resultType" имеет значение "scalar", то поле "result" должно иметь следующий формат:
[<unix_time>, "<scalar_value>"];
4) если поле "resultType" имеет значение "string", то поле "result" должно иметь следующий формат:
[<unix_time>, "<string_value>"].