6. Приложение А «Описание доступных метрик Агента СМЭВ4»

Ниже приведены доступные метрики Агента СМЭВ4. Не описанные в данном разделе метрики не рекомендуются к использованию.

Таблица 6.1 Список метрик Агента

Группа

Метрика

Название в Prometheus

Описание

Метка

ApiGateway

apigw_consumer_request - метрики выполнения

ApiGateway-запроса на стороне потребителя.

Замер происходит между получением Агента СМЭВ4 запроса

по HTTP от ИС Потребителя и отправкой всех данных ответа по HTTP в ИС Потребителя.

apigw_consumer_request_completed_total

Количество выполненных запросов

status

apigw_consumer_request_execution_time_seconds

Время выполнения запроса

quantile

apigw_consumer_request_execution_time_seconds_max

Максимальное время выполнения запроса

apigw_provider_request - метрики выполнения

ApiGateway-запроса на стороне поставщика.

Замер происходит от получения запроса по RSocket от

ядра до отправки всех данных ответа по RSocket в ядро.

apigw_provider_request_completed_total

Количество выполненных запросов

nodeId

status

apigw_provider_request_execution_time_seconds

Время выполнения запроса

nodeId

quantile

apigw_provider_request_execution_time_seconds_max

Максимальное время выполнения запроса

nodeId

SQL

rest_sql_request - метрики выполнения произвольного

SQL-запроса, полученного через REST-интерфейс, на

стороне потребителя.

Замер происходит между получением запроса по HTTP от ИС

и отправкой всех данных ответа по HTTP ИС.

rest_sql_request_completed_total

Количество выполненных запросов

status

rest_sql_request_execution_time_seconds

Время выполнения запроса

quantile

rest_sql_request_execution_time_seconds_max

Максимальное время выполнения запроса

jdbc_sql_request - метрики выполнения произвольного

SQL-запроса, полученного через JDBC-интерфейс, на

стороне потребителя.

Замер происходит между получением запроса по JDBC от ИС

и отправкой всех данных ответа по JDBC ИС.

jdbc_sql_request_completed_total

Количество выполненных запросов

nodeId

status

jdbc_sql_request_execution_time_seconds

Время выполнения запроса

nodeId

quantile

jdbc_sql_request_execution_time_seconds_max

Максимальное время выполнения запроса

nodeId

rest_regulated_query - метрики выполнения SQL-РЗ,

полученного через REST-интерфейс, на стороне

потребителя.

Замер происходит между получением запроса по HTTP от ИС

и отправкой всех данных ответа по HTTP ИС.

rest_regulated_query_completed_total

Количество выполненных запросов

nodeId

status

rest_regulated_query_execution_time_seconds

Время выполнения запроса

nodeId

quantile

rest_regulated_query_execution_time_seconds_max

Максимальное время выполнения запроса

nodeId

jdbc_regulated_query - метрики выполнения SQL-РЗ

(call-запрос), полученного через JDBC-интерфейс, на

стороне потребителя.

Замер происходит между получением запроса по JDBC от ИС

и отправкой всех данных ответа по JDBC ИС.

jdbc_regulated_query_completed_total

Количество выполненных запросов

nodeId

status

jdbc_regulated_query_execution_time_seconds

Время выполнения запроса

nodeId

quantile

jdbc_regulated_query_execution_time_seconds_max

Максимальное время выполнения запроса

nodeId

subquery_provider_request - метрики выполнения

SQL-подзапроса любого типа, полученного от ядра, на

стороне поставщика.

При использовании HTTP2-протокола для доступа к

Prostore замер происходит от получения запроса по

RSocket от ядра до отправки всех данных ответа по

RSocket в ядро.

При использовании Kafka для доступа к Prostore замер

происходит от получения запроса по RSocket до отправки

запроса в Kafka витрины.

subquery_provider_request_completed_total

Количество выполненных запросов

nodeId

status

subquery_provider_request_execution_time_seconds

Время выполнения запроса

nodeId

quantile

subquery_provider_request_execution_time_seconds_max

Максимальное время выполнения запроса

nodeId

BLOB

rest_blob_request - метрики выполнения BLOB-запроса,

на стороне потребителя.

Замер происходит между получением запроса по HTTP от ИС

и отправкой всех данных ответа по HTTP ИС.

rest_blob_request_completed_total

Количество выполненных запросов

nodeId

status

rest_blob_request_execution_time_seconds

Время выполнения запроса

nodeId

quantile

rest_blob_request_execution_time_seconds_max

Максимальное время выполнения запроса

nodeId

jdbc_blob_request - метрики выполнения BLOB-запроса,

полученного через JDBC-интерфейс, на стороне

потребителя.

Замер происходит между получением запроса по JDBC от ИС

и отправкой всех данных ответа по JDBC ИС.

jdbc_blob_request_completed_total

Количество выполненных запросов

nodeId

status

jdbc_blob_request_execution_time_seconds

Время выполнения запроса

nodeId

quantile

jdbc_blob_request_execution_time_seconds_max

Максимальное время выполнения запроса

nodeId

blob_provider_request - метрики выполнения

BLOB-запроса, полученного от ядра, на стороне

поставщика.

При использовании HTTP2-протокола для доступа к

Prostore замер происходит от получения запроса по

RSocket от ядра до отправки всех данных ответа по

RSocket в ядро.

При использовании Kafka для доступа к Prostore замер

происходит от получения запроса по RSocket до отправки

запроса в Kafka витрины.

blob_provider_request_completed_total

Количество выполненных запросов

nodeId

status

blob_provider_request_execution_time_seconds

Время выполнения запроса

nodeId

quantile

blob_provider_request_execution_time_seconds_max

Максимальное время выполнения запроса

nodeId

Управление Витриной

datamart_management_provider_request - метрики

выполнения запроса управления витриной, полученного от

ядра, на стороне поставщика.

Замер происходит между получением запроса по RSocket от

ядра и отправкой всех данных ответа по RSocket в ядро.

datamart_management_provider_request_completed_total

Количество выполненных запросов

nodeId

status

datamart_management_provider_request_execution_time_seconds

Время выполнения запроса

nodeId

quantile

datamart_management_provider_request_execution_time_seconds_max

Максимальное время выполнения запроса

nodeId

Подписки

rest_get_offset_request - метрики подписок на

витрины 2.х: запрос чтения примененных CN на стороне

потребителя.

Замер происходит между получением запроса по HTTP от ИС

и отправкой всех данных ответа по HTTP ИС.

rest_get_offset_request_completed_total

Количество выполненных запросов

nodeId

status

rest_get_offset_request_execution_time_seconds

Время выполнения запроса

nodeId

quantile

rest_get_offset_request_execution_time_seconds_max

Максимальное время выполнения запроса

nodeId

rest_commit_offset_request - метрики подписок

на витрины 2.х: запрос фиксации примененных CN на

стороне потребителя.

Замер происходит между получением запроса по HTTP от ИС

и отправкой всех данных ответа по HTTP ИС.

rest_commit_offset_request_completed_total

Количество выполненных запросов

nodeId

status

rest_commit_offset_request_execution_time_seconds

Время выполнения запроса

nodeId

quantile

rest_commit_offset_request_execution_time_seconds_max

Максимальное время выполнения запроса

nodeId

Прочие

Статус соединения Агента СМЭВ4 с Ядром СМЭВ4

agent2broker_connection

Статус соединения с брокером

  • 1 - cсоединение установлено;

  • 0 - соединение разорвано.

nodeId

type

address

Метрика состояния лицензии CryptoPro

cryptopro_csp_license_expiration_ts

Дата окончания действия лицензии в формате Unix Timestamp в секундах.

Если установлена бессрочная лицензия, передаётся константа 2.533707648E11 (соответствует дате 9999-01-01T00:00:00Z).

Если лицензия отсутствует (или возникла ошибка получения данных лицензии) передается значение 0

infSystemMnemonic

instanceId

ogrn

source

host

licenseNum

Метрика состояния сертификата

cryptopro_certificate_expiration_ts

Дата окончания действия сертификата в формате Unix Timestamp в секундах.

Если сертификат отсутствует (или возникла ошибка получения данных сертификата) передается значение 0.

infSystemMnemonic

instanceId

ogrn

source

host

certificateNum
Таблица 6.2 Описание меток, приведенных в Таблица 6.1.

№

Метка

Описание

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 приложен в файле ниже:

Типовой дашборд Агента СМЭВ4