.. _annex_b:

Приложение B Список метрик Агента СМЭВ4
==========================================

.. _metrics_table: 

.. table:: Список метрик Агента

    +---+---------------+-----------------------------------------+-------------+--------------+---------------------------------+
    |   | Тема          | Метрика Prometheus                      | Тип         | Доп. метрики | Описание                        |
    +===+===============+=========================================+=============+==============+=================================+
    | 1 | Api Gateway   | api_gateway_execution_time_seconds      | Histogram   | -            | Время выполнения запроса API    |
    |   |               |                                         |             |              | Gateway на стороне Агента       |
    |   |               |                                         |             |              | Инициатора                      |
    +---+---------------+-----------------------------------------+-------------+--------------+---------------------------------+
    | 2 | Api Gateway   | api_gateway_request_handle_time_seconds | Histogram   | -            | Время выполнения запроса API    |
    |   |               |                                         |             |              | Gateway на стороне Агента       |
    |   |               |                                         |             |              | Ответчика                       |
    +---+---------------+-----------------------------------------+-------------+--------------+---------------------------------+
    | 3 | SQL-подзапрос | subquery_request_handle_time_seconds    | Histogram   | quantile     | Время выполнения SQL подзапроса |
    |   |               |                                         |             |              | Поставщиком (Агент Поставщика - |
    |   |               |                                         |             |              | Витрина - Агент Поставщика)     |
    +---+---------------+-----------------------------------------+-------------+--------------+---------------------------------+
    | 4 | Трафик агента | req_time                                | Histogram   | quantile     | Время обработки входящего       |
    |   |               |                                         |             |              | запроса с указанием типа в kind |
    |   |               |                                         |             | kind         |                                 |
    +---+---------------+-----------------------------------------+-------------+--------------+---------------------------------+
    | 5 | Трафик агента | req_count                               | Counter     | result       | Количество обработанных         |
    |   |               |                                         |             |              | запросов с указанием типа       |
    |   |               |                                         |             | kind         | запроса в kind                  |
    +---+---------------+-----------------------------------------+-------------+--------------+---------------------------------+
    | 6 | Трафик агента | agent2broker_connection                 | Gauge       | nodeId       | Соединение с брокером           |
    |   |               |                                         |             |              |                                 |
    |   |               |                                         |             | type         | метрика показывает              |
    |   |               |                                         |             |              | кол-во соединений:              |
    |   |               |                                         |             | address      |                                 |
    |   |               |                                         |             |              | - 1 - cсоединение установлено;  |
    |   |               |                                         |             |              |                                 |
    |   |               |                                         |             |              | - 0 - соединение разорвано.     |
    +---+---------------+-----------------------------------------+-------------+--------------+---------------------------------+


.. table:: Описание меток

    +---+------------+----------------------------------------------------------------+
    | № | Метка      | Описание                                                       |
    +===+============+================================================================+
    | 1 | address    | Адрес брокера                                                  |
    +---+------------+----------------------------------------------------------------+
    | 2 | kind       | Для рассылок:                                                  |
    |   |            |                                                                |
    |   |            | - запрос на получение дельты - ``subscription_delta_request``; |
    |   |            |                                                                |
    |   |            | - уведомление Ядро -> Витрина Потребителя о новых данных       |
    |   |            |   в подписке - ``subscrip-tion_delta_notification_in_event``;  |
    |   |            |                                                                |
    |   |            | - уведомление о новых данных от Витрины Поставщика -           |
    |   |            |   ``subscrip-tion_delta_notification_event``;                  |
    |   |            |                                                                |
    |   |            | - запрос на передачу дельты: ответ с ошибкой -                 |
    |   |            |   ``subscription_delta_error``;                                |
    |   |            |                                                                |
    |   |            | - запрос на передачу дельты: ключ чанка с данными              |
    |   |            |   дельты - ``subscription_delta_result_chunk``;                |
    |   |            |                                                                |
    |   |            | - статус применения дельты: подтверждение применения           |
    |   |            |   дельты - ``subscription_delta_apply_result``;                |
    |   |            |                                                                |
    |   |            | - статус применения дельты: ошибка применения                  |
    |   |            |   дельты - ``subscription_delta_apply_error``;                 |
    |   |            |                                                                |
    |   |            | - запрос дельты от ИС Потребителя подписки -                   |
    |   |            |   ``subscription_request_delta``;                              |
    |   |            |                                                                |
    |   |            | Для РЗ-SQL:                                                    |
    |   |            |                                                                |
    |   |            | - РЗ-SQL, произвольные запросы и подзапросы -                  |
    |   |            |   ``query_request``;                                           |
    |   |            |                                                                |
    |   |            | - ответ на РЗ-SQL, произвольный запрос - ``query_result``;     |
    |   |            |                                                                |
    |   |            | - ошибочный ответ на РЗ-SQL от Витрины - ``query_error``;      |
    |   |            |                                                                |
    |   |            | - SQL-подзапросы: ``sub_query_request``, ``sub_query_result``, | 
    |   |            |   ``sub_query_error``;                                         |
    |   |            |                                                                |
    |   |            | - запрос на загрузку ТП - ``table_param``;                     |
    |   |            |                                                                |
    |   |            | - запрос BLOB по ссылке - ``blob_request``;                    |
    |   |            |                                                                |
    |   |            | - успешный ответ на запрос BLOB по ссылке - ``blob_result``;   |
    |   |            |                                                                |
    |   |            | - ошибочный ответ на запрос BLOB по ссылке - ``blob_error``;   |
    |   |            |                                                                |
    |   |            | Для РЗ-REST:                                                   |
    |   |            |                                                                |
    |   |            | - чанк мета запроса РЗ-REST - ``api_gw_meta_request``;         |
    |   |            |                                                                |
    |   |            | - чанк тела запроса РЗ-REST - ``api_gw_payload_request``;      |
    |   |            |                                                                |
    |   |            | - ответ на РЗ-REST - ``api_gw_response``.                      |
    +---+------------+----------------------------------------------------------------+
    | 3 | nodeId     | Идентификатор ноды                                             |
    +---+------------+----------------------------------------------------------------+
    | 4 | quantile   | Возможные значения: 0.75, 0.9, 0.95, 0.99                      |
    +---+------------+----------------------------------------------------------------+
    | 5 | result     | Успешность результата обработки запроса                        |
    |   |            |                                                                |
    |   |            | - "success";                                                   |
    |   |            |                                                                |
    |   |            | - "cancel" (отмена по дедлайну);                               |
    |   |            |                                                                |
    |   |            | - "limit_error" (блокировка по лимитам);                       |
    |   |            |                                                                |
    |   |            | - "error"                                                      |
    +---+------------+----------------------------------------------------------------+
    | 6 | type       |  Тип соединения                                                |
    +---+------------+----------------------------------------------------------------+