.. _annex_a: Приложение А "Описание доступных метрик Агента СМЭВ4" =================================================================== Ниже приведены доступные метрики Агента СМЭВ4. Не описанные в данном разделе метрики не рекомендуются к использованию. .. _metrics_table: .. table:: Список метрик Агента +---------------------+---------------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | **Группа** | **Метрика** | **Название в Prometheus** | **Описание** | **Метка** | +=====================+=========================================================+=======================================================================+==================================================+====================+ | ApiGateway | **apigw_consumer_request** - метрики выполнения | ``apigw_consumer_request_completed_total`` | Количество выполненных запросов | status | | | +-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | ApiGateway-запроса на стороне потребителя. | ``apigw_consumer_request_execution_time_seconds`` | Время выполнения запроса | quantile | | | +-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | Замер происходит между получением Агента СМЭВ4 запроса | ``apigw_consumer_request_execution_time_seconds_max`` | Максимальное время выполнения запроса | | | | | | | | | | по HTTP от ИС Потребителя и отправкой всех данных | | | | | | ответа по HTTP в ИС Потребителя. | | | | | +---------------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | **apigw_provider_request** - метрики выполнения | ``apigw_provider_request_completed_total`` | Количество выполненных запросов | nodeId | | | | | | | | | | | | status | | | +-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | ApiGateway-запроса на стороне поставщика. | ``apigw_provider_request_execution_time_seconds`` | Время выполнения запроса | nodeId | | | | | | | | | | | | quantile | | | +-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | Замер происходит от получения запроса по RSocket от | ``apigw_provider_request_execution_time_seconds_max`` | Максимальное время выполнения запроса | nodeId | | | | | | | | | ядра до отправки всех данных ответа по RSocket в ядро. | | | | +---------------------+---------------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | SQL | **rest_sql_request** - метрики выполнения произвольного | ``rest_sql_request_completed_total`` | Количество выполненных запросов | status | | | +-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | SQL-запроса, полученного через REST-интерфейс, на | ``rest_sql_request_execution_time_seconds`` | Время выполнения запроса | quantile | | | +-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | стороне потребителя. | ``rest_sql_request_execution_time_seconds_max`` | Максимальное время выполнения запроса | | | | | | | | | | Замер происходит между получением запроса по HTTP от ИС | | | | | | | | | | | | и отправкой всех данных ответа по HTTP ИС. | | | | | +---------------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | **jdbc_sql_request** - метрики выполнения произвольного | ``jdbc_sql_request_completed_total`` | Количество выполненных запросов | nodeId | | | | | | | | | SQL-запроса, полученного через JDBC-интерфейс, на | | | status | | | +-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | стороне потребителя. | ``jdbc_sql_request_execution_time_seconds`` | Время выполнения запроса | nodeId | | | | | | | | | Замер происходит между получением запроса по JDBC от ИС | | | quantile | | | +-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | и отправкой всех данных ответа по JDBC ИС. | ``jdbc_sql_request_execution_time_seconds_max`` | Максимальное время выполнения запроса | nodeId | | +---------------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | **rest_regulated_query** - метрики выполнения SQL-РЗ, | ``rest_regulated_query_completed_total`` | Количество выполненных запросов | nodeId | | | | | | | | | полученного через REST-интерфейс, на стороне | | | status | | | +-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | потребителя. | ``rest_regulated_query_execution_time_seconds`` | Время выполнения запроса | nodeId | | | | | | | | | Замер происходит между получением запроса по HTTP от ИС | | | quantile | | | +-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | и отправкой всех данных ответа по HTTP ИС. | ``rest_regulated_query_execution_time_seconds_max`` | Максимальное время выполнения запроса | nodeId | | +---------------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | **jdbc_regulated_query** - метрики выполнения SQL-РЗ | ``jdbc_regulated_query_completed_total`` | Количество выполненных запросов | nodeId | | | | | | | | | (call-запрос), полученного через JDBC-интерфейс, на | | | status | | | +-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | стороне потребителя. | ``jdbc_regulated_query_execution_time_seconds`` | Время выполнения запроса | nodeId | | | | | | | | | Замер происходит между получением запроса по JDBC от ИС | | | quantile | | | +-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | и отправкой всех данных ответа по JDBC ИС. | ``jdbc_regulated_query_execution_time_seconds_max`` | Максимальное время выполнения запроса | nodeId | | +---------------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | **subquery_provider_request** - метрики выполнения | ``subquery_provider_request_completed_total`` | Количество выполненных запросов | nodeId | | | | | | | | | SQL-подзапроса любого типа, полученного от ядра, на | | | status | | | +-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | стороне поставщика. | ``subquery_provider_request_execution_time_seconds`` | Время выполнения запроса | nodeId | | | | | | | | | При использовании HTTP2-протокола для доступа к | | | quantile | | | +-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | Prostore замер происходит от получения запроса по | ``subquery_provider_request_execution_time_seconds_max`` | Максимальное время выполнения запроса | nodeId | | | | | | | | | RSocket от ядра до отправки всех данных ответа по | | | | | | | | | | | | RSocket в ядро. | | | | | | | | | | | | При использовании Kafka для доступа к Prostore замер | | | | | | | | | | | | происходит от получения запроса по RSocket до отправки | | | | | | | | | | | | запроса в Kafka витрины. | | | | +---------------------+---------------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | BLOB | **rest_blob_request** - метрики выполнения BLOB-запроса,| ``rest_blob_request_completed_total`` | Количество выполненных запросов | nodeId | | | | | | | | | на стороне потребителя. | | | status | | | +-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | Замер происходит между получением запроса по HTTP от ИС | ``rest_blob_request_execution_time_seconds`` | Время выполнения запроса | nodeId | | | | | | | | | и отправкой всех данных ответа по HTTP ИС. | | | quantile | | | +-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | | ``rest_blob_request_execution_time_seconds_max`` | Максимальное время выполнения запроса | nodeId | | +---------------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | **jdbc_blob_request** - метрики выполнения BLOB-запроса,| ``jdbc_blob_request_completed_total`` | Количество выполненных запросов | nodeId | | | | | | | | | полученного через JDBC-интерфейс, на стороне | | | status | | | +-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | потребителя. | ``jdbc_blob_request_execution_time_seconds`` | Время выполнения запроса | nodeId | | | | | | | | | Замер происходит между получением запроса по JDBC от ИС | | | quantile | | | +-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | и отправкой всех данных ответа по JDBC ИС. | ``jdbc_blob_request_execution_time_seconds_max`` | Максимальное время выполнения запроса | nodeId | | +---------------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | **blob_provider_request** - метрики выполнения | ``blob_provider_request_completed_total`` | Количество выполненных запросов | nodeId | | | | | | | | | BLOB-запроса, полученного от ядра, на стороне | | | status | | | +-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | поставщика. | ``blob_provider_request_execution_time_seconds`` | Время выполнения запроса | nodeId | | | | | | | | | При использовании HTTP2-протокола для доступа к | | | quantile | | | +-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | Prostore замер происходит от получения запроса по | ``blob_provider_request_execution_time_seconds_max`` | Максимальное время выполнения запроса | nodeId | | | | | | | | | RSocket от ядра до отправки всех данных ответа по | | | | | | | | | | | | RSocket в ядро. | | | | | | | | | | | | При использовании Kafka для доступа к Prostore замер | | | | | | | | | | | | происходит от получения запроса по RSocket до отправки | | | | | | | | | | | | запроса в Kafka витрины. | | | | +---------------------+---------------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | Управление Витриной | **datamart_management_provider_request** - метрики | ``datamart_management_provider_request_completed_total`` | Количество выполненных запросов | nodeId | | | | | | | | | выполнения запроса управления витриной, полученного от | | | status | | | +-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | ядра, на стороне поставщика. | ``datamart_management_provider_request_execution_time_seconds`` | Время выполнения запроса | nodeId | | | | | | | | | Замер происходит между получением запроса по RSocket от | | | quantile | | | +-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | ядра и отправкой всех данных ответа по RSocket в ядро. | ``datamart_management_provider_request_execution_time_seconds_max`` | Максимальное время выполнения запроса | nodeId | +---------------------+---------------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | Подписки | **rest_get_offset_request** - метрики подписок на | ``rest_get_offset_request_completed_total`` | Количество выполненных запросов | nodeId | | | | | | | | | витрины 2.х: запрос чтения примененных CN на стороне | | | status | | | +-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | потребителя. | ``rest_get_offset_request_execution_time_seconds`` | Время выполнения запроса | nodeId | | | | | | | | | Замер происходит между получением запроса по HTTP от ИС | | | quantile | | | +-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | и отправкой всех данных ответа по HTTP ИС. | ``rest_get_offset_request_execution_time_seconds_max`` | Максимальное время выполнения запроса | nodeId | | +---------------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | **rest_commit_offset_request** - метрики подписок | ``rest_commit_offset_request_completed_total`` | Количество выполненных запросов | nodeId | | | | | | | | | на витрины 2.х: запрос фиксации примененных CN на | | | status | | | +-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | стороне потребителя. | ``rest_commit_offset_request_execution_time_seconds`` | Время выполнения запроса | nodeId | | | | | | | | | Замер происходит между получением запроса по HTTP от ИС | | | quantile | | | +-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | и отправкой всех данных ответа по HTTP ИС. | ``rest_commit_offset_request_execution_time_seconds_max`` | Максимальное время выполнения запроса | nodeId | +---------------------+---------------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | Прочие | Статус соединения Агента СМЭВ4 с Ядром СМЭВ4 | ``agent2broker_connection`` | Статус соединения с брокером | nodeId | | | | | | | | | | | - 1 - cсоединение установлено; | type | | | | | | | | | | | - 0 - соединение разорвано. | address | | +---------------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | Метрика состояния лицензии CryptoPro | ``cryptopro_csp_license_expiration_ts`` | Дата окончания действия лицензии в формате Unix | infSystemMnemonic | | | | | Timestamp в секундах. | | | | | | | instanceId | | | | | Если установлена бессрочная лицензия, передаётся | | | | | | константа 2.533707648E11 (соответствует дате | ogrn | | | | | 9999-01-01T00:00:00Z). | | | | | | | source | | | | | Если лицензия отсутствует (или возникла ошибка | | | | | | получения данных лицензии) передается значение 0 | host | | | | | | | | | | | | licenseNum | | +---------------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ | | Метрика состояния сертификата | ``cryptopro_certificate_expiration_ts`` | Дата окончания действия сертификата в формате | infSystemMnemonic | | | | | Unix Timestamp в секундах. | | | | | | | instanceId | | | | | Если сертификат отсутствует (или возникла ошибка | | | | | | получения данных сертификата) передается | ogrn | | | | | значение 0. | | | | | | | source | | | | | | | | | | | | host | | | | | | | | | | | | certificateNum | +---------------------+---------------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+--------------------+ .. table:: Описание меток, приведенных в :numref:`metrics_table`. +----+-------------------+-----------------------------------------------------------------+ | № | Метка | Описание | +====+===================+=================================================================+ | 1 | status | Успешность выполнения запросов. | | | | | | | | Возможные значения: | | | | | | | | - ``success``; | | | | | | | | - ``error``. | +----+-------------------+-----------------------------------------------------------------+ | 2 | quantile | Возможные значения: 0.95, 0.99 | +----+-------------------+-----------------------------------------------------------------+ | 3 | address | Адрес брокера | +----+-------------------+-----------------------------------------------------------------+ | 4 | nodeId | Идентификатор ЦОД Ядра СМЭВ4 | +----+-------------------+-----------------------------------------------------------------+ | 5 | type | Тип соединения: | | | | | | | | - ``DIRECT_PRIMARY``; | | | | | | | | - ``DIRECT_RESERVED``; | | | | | | | | - ``CROSS_PRIMARY``; | | | | | | | | - ``CROSS_RESERVED``. | +----+-------------------+-----------------------------------------------------------------+ | 6 | infSystemMnemonic | Мнемоника ИС. | | | | | | | | При формировании метрики сервисом Notarius, в качестве значения | | | | передается «undefined». | +----+-------------------+-----------------------------------------------------------------+ | 7 | instanceId | Идентификатор экземпляра сервиса. | +----+-------------------+-----------------------------------------------------------------+ | 8 | ogrn | ОГРН владельца. | | | | | | | | При формировании метрики сервисом Notarius, в качестве значения | | | | передается «undefined». | +----+-------------------+-----------------------------------------------------------------+ | 9 | source | Источник метрики (einfahrt/notarius/prohibitor). | +----+-------------------+-----------------------------------------------------------------+ | 10 | host | Хост экземпляра сервиса. | +----+-------------------+-----------------------------------------------------------------+ | 11 | licenseNum | Номер лицензии или «error» в случае отсутствия лицензии или | | | | ошибки получения данных. | +----+-------------------+-----------------------------------------------------------------+ | 12 | certificateNum | Серийный номер сертификата или «error» в случае отсутствия | | | | сертификата или ошибки получения данных. | +----+-------------------+-----------------------------------------------------------------+ Типовой дашборд Grafana приложен в файле ниже: :download:`Типовой дашборд Агента СМЭВ4 `