.. _annex_a: Приложение A "Описание меток и доступных метрик Агента СМЭВ4" =================================================================== Ниже приведены доступные метрики Агента СМЭВ4. Не описанные в данном разделе метрики не рекомендуются к использованию. .. table:: Описание меток, приведенных в :numref:`metrics_table`. +---+------------+----------------------------------------------------------------+ | № | Метка | Описание | +===+============+================================================================+ | 1 | status | Успешность выполнения запросов. | | | | | | | | Возможные значения: | | | | | | | | - ``success``; | | | | | | | | - ``error``. | +---+------------+----------------------------------------------------------------+ | 2 | quantile | Возможные значения: 0.75, 0.9, 0.95, 0.99 | +---+------------+----------------------------------------------------------------+ | 3 | address | Адрес брокера | +---+------------+----------------------------------------------------------------+ | 4 | nodeId | Идентификатор ноды | +---+------------+----------------------------------------------------------------+ | 5 | type | Тип соединения: | | | | | | | | - ``DIRECT_PRIMARY`` | | | | | | | | - ``DIRECT_RESERVED`` | | | | | | | | - ``CROSS_PRIMARY`` | | | | | | | | - ``CROSS_RESERVED`` | +---+------------+----------------------------------------------------------------+ .. _metrics_table: .. table:: Список метрик Агента +---------------------+---------------------------------------------------------+-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | **Группа** | **Метрика** | **Название в Prometheus** | **Метка** | **Описание** | +=====================+=========================================================+=======================================================================+==============+==================================================+ | ApiGatway | **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`` | status | Количество выполненных запросов | | | +-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | | ApiGateway-запроса на стороне поставщика. | ``apigw_provider_request_execution_time_seconds`` | quantile | Время выполнения запроса | | | +-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | | Замер происходит от получения запроса по RSocket от | ``apigw_provider_request_execution_time_seconds_max`` | | Максимальное время выполнения запроса | | | | | | | | | ядра до отправки всех данных ответа по 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`` | status | Количество выполненных запросов | | | +-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | | SQL-запроса, полученного через JDBC-интерфейс, на | ``jdbc_sql_request_execution_time_seconds`` | quantile | Время выполнения запроса | | | +-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | | стороне потребителя. | ``jdbc_sql_request_execution_time_seconds_max`` | | Максимальное время выполнения запроса | | | | | | | | | Замер происходит между получением запроса по JDBC от ИС | | | | | | | | | | | | и отправкой всех данных ответа по JDBC ИС. | | | | | +---------------------------------------------------------+-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | | **rest_regulated_query** - метрики выполнения SQL-РЗ, | ``rest_regulated_query_completed_total`` | status | Количество выполненных запросов | | | +-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | | полученного через REST-интерфейс, на стороне | ``rest_regulated_query_execution_time_seconds`` | quantile | Время выполнения запроса | | | +-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | | потребителя. | ``rest_regulated_query_execution_time_seconds_max`` | | Максимальное время выполнения запроса | | | | | | | | | Замер происходит между получением запроса по HTTP от ИС | | | | | | | | | | | | и отправкой всех данных ответа по HTTP ИС. | | | | | +---------------------------------------------------------+-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | | **jdbc_regulated_query** - метрики выполнения SQL-РЗ | ``jdbc_regulated_query_completed_total`` | status | Количество выполненных запросов | | | +-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | | (call-запрос), полученного через JDBC-интерфейс, на | ``jdbc_regulated_query_execution_time_seconds`` | quantile | Время выполнения запроса | | | +-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | | стороне потребителя. | ``jdbc_regulated_query_execution_time_seconds_max`` | | Максимальное время выполнения запроса | | | | | | | | | Замер происходит между получением запроса по JDBC от ИС | | | | | | | | | | | | и отправкой всех данных ответа по JDBC ИС. | | | | | +---------------------------------------------------------+-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | | **subquery_provider_request** - метрики выполнения | ``subquery_provider_request_completed_total`` | status | Количество выполненных запросов | | | +-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | | SQL-подзапроса любого типа, полученного от ядра, на | ``subquery_provider_request_execution_time_seconds`` | quantile | Время выполнения запроса | | | +-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | | стороне поставщика. | ``subquery_provider_request_execution_time_seconds_max`` | | Максимальное время выполнения запроса | | | | | | | | | При использовании HTTP2-протокола для доступа к | | | | | | | | | | | | Prostore замер происходит от получения запроса по | | | | | | | | | | | | RSocket от ядра до отправки всех данных ответа по | | | | | | | | | | | | RSocket в ядро. | | | | | | | | | | | | При использовании Kafka для доступа к Prostore замер | | | | | | | | | | | | происходит от получения запроса по RSocket до отправки | | | | | | | | | | | | запроса в Kafka витрины. | | | | +---------------------+---------------------------------------------------------+-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | BLOB | **rest_blob_request** - метрики выполнения BLOB-запроса,| ``rest_blob_request_completed_total`` | status | Количество выполненных запросов | | | +-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | | потребителя. | ``rest_blob_request_execution_time_seconds`` | quantile | Время выполнения запроса | | | +-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | | Замер происходит между получением запроса по HTTP от ИС | ``rest_blob_request_execution_time_seconds_max`` | | Максимальное время выполнения запроса | | | | | | | | | и отправкой всех данных ответа по HTTP ИС. | | | | | +---------------------------------------------------------+-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | | **jdbc_blob_request** - метрики выполнения BLOB-запроса,| ``jdbc_blob_request_completed_total`` | status | Количество выполненных запросов | | | +-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | | полученного через JDBC-интерфейс, на стороне | ``jdbc_blob_request_execution_time_seconds`` | quantile | Время выполнения запроса | | | +-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | | потребителя. | ``jdbc_blob_request_execution_time_seconds_max`` | | Максимальное время выполнения запроса | | | | | | | | | Замер происходит между получением запроса по JDBC от ИС | | | | | | | | | | | | и отправкой всех данных ответа по JDBC ИС. | | | | | +---------------------------------------------------------+-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | | **blob_provider_request** - метрики выполнения | ``blob_provider_request_completed_total`` | status | Количество выполненных запросов | | | +-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | | BLOB-запроса, полученного от ядра, на стороне | ``blob_provider_request_execution_time_seconds`` | quantile | Время выполнения запроса | | | +-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | | поставщика. | ``blob_provider_request_execution_time_seconds_max`` | | Максимальное время выполнения запроса | | | | | | | | | При использовании HTTP2-протокола для доступа к | | | | | | | | | | | | Prostore замер происходит от получения запроса по | | | | | | | | | | | | RSocket от ядра до отправки всех данных ответа по | | | | | | | | | | | | RSocket в ядро. | | | | | | | | | | | | При использовании Kafka для доступа к Prostore замер | | | | | | | | | | | | происходит от получения запроса по RSocket до отправки | | | | | | | | | | | | запроса в Kafka витрины. | | | | +---------------------+---------------------------------------------------------+-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | Управление Витриной | **datamart_management_provider_request** - метрики | ``datamart_management_provider_request_completed_total`` | status | Количество выполненных запросов | | | +-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | | выполнения запроса управления витриной, полученного от | ``datamart_management_provider_request_execution_time_seconds`` | quantile | Время выполнения запроса | | | +-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | | ядра, на стороне поставщика. | ``datamart_management_provider_request_execution_time_seconds_max`` | | Максимальное время выполнения запроса | | | | | | | | | Замер происходит между получением запроса по RSocket от | | | | | | | | | | | | ядра и отправкой всех данных ответа по RSocket в ядро. | | | | +---------------------+---------------------------------------------------------+-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | Подписки | **rest_get_offset_request** - метрики подписок на | ``rest_get_offset_request_completed_total`` | status | Количество выполненных запросов | | | +-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | | витрины 2.х: запрос чтения примененных CN на стороне | ``rest_get_offset_request_execution_time_seconds`` | quantile | Время выполнения запроса | | | +-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | | потребителя. Замер происходит между получением запроса | ``rest_get_offset_request_execution_time_seconds_max`` | | Максимальное время выполнения запроса | | | | | | | | | по HTTP от ИС и отправкой всех данных ответа по HTTP ИС.| | | | | +---------------------------------------------------------+-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | | **rest_commit_offset_request** - метрики подписок | ``rest_commit_offset_request_completed_total`` | status | Количество выполненных запросов | | | +-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | | на витрины 2.х: запрос фиксации примененных CN на | ``rest_commit_offset_request_execution_time_seconds`` | quantile | Время выполнения запроса | | | +-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | | стороне потребителя. Замер происходит между получением | ``rest_commit_offset_request_execution_time_seconds_max`` | | Максимальное время выполнения запроса | | | | | | | | | запроса по HTTP от ИС и отправкой всех данных ответа по | | | | | | HTTP ИС. | | | | +---------------------+---------------------------------------------------------+-----------------------------------------------------------------------+--------------+--------------------------------------------------+ | Прочие | Статус соединения Агента СМЭВ4 с Ядром СМЭВ4 | ``agent2broker_connection`` | nodeId | Статус соединения с брокером | | | | | | | | | | | type | - 1 - cсоединение установлено; | | | | | | | | | | | address | - 0 - соединение разорвано. | +---------------------+---------------------------------------------------------+-----------------------------------------------------------------------+--------------+--------------------------------------------------+ Типовой дашборд Grafana приложен в файле ниже: :download:`Типовой дашборд Агента СМЭВ4 `