Метрики событий мониторинга в окружении Platform V Frontend High Load#

Для окружения Platform V Frontend High Load сбор метрик реализован через программный компонент Мониторинг клиентский модуль (MONM) продукта Platform V Monitor (OPM).

Каждая метрика сервиса DCGN публикуется в следующих разрезах:

  • _count — счетчик значений метрики;

  • _sum — сумма значений по метрике;

  • _min — минимальное значение метрики;

  • _max — максимальное значение метрики.

Описание значений меток метрик см. в разделе Метки метрик.

Важно

Метрики, которые считают неуспешные запросы — завершившиеся с системной ошибкой, — не учитывают запросы с бизнес-ошибками. Все бизнес-ошибки отправляются клиенту в ответе на запрос. Клиенту следует самостоятельно учитывать бизнес-ошибки в своих метриках мониторинга.

Общие метрики запросов включают в себя неуспешные запросы — завершившиеся с системной ошибкой.

Метрики Docgen Service#

Код метрики

Описание метрики

Метки метрики с примерами

dcgn_docgen_service_app_stability

Метрика стабильности приложения, с учетом состояния Template Provider.
При стабильности dcgn_docgen_service_app_stability_count должна совпадать с dcgn_docgen_service_app_stability_sum.
Значения метрики:
1 — Приложение стабильно, Template Provider доступен;
0 — приложение было не стабильно, Template Provider недоступен

rn="company:project:dcgn"

dcgn_docgen_service_create_to_date_seconds

Время выполнения запросов на генерацию документа по дате

billedResourceName="DEFAULT",rn="company:project:dcgn",templateCode="TEST-TEMPLATE",unit_type="api_calls"

dcgn_docgen_service_create_to_date

Общее количество вызовов запросов на генерацию документа по дате

billedResourceName="DEFAULT",rn="company:project:dcgn",templateCode="TEST-TEMPLATE",unit_type="api_calls"

dcgn_docgen_service_create_to_date_sys_error

Количество неуспешных запросов на генерацию документа по дате

billedResourceName="DEFAULT",rn="company:project:dcgn",templateCode="TEST-TEMPLATE"

dcgn_docgen_service_create_by_version_uid_seconds

Время выполнения запросов на генерацию документа по идентификатору версии

billedResourceName="DEFAULT",rn="company:project:dcgn",versionUid="{UID}",unit_type="api_calls"

dcgn_docgen_service_create_by_version_uid

Общее количество вызовов запросов на генерацию документа по идентификатору версии

billedResourceName="DEFAULT",rn="company:project:dcgn",versionUid="{UID}",unit_type="api_calls"

dcgn_docgen_service_create_by_version_uid_sys_error

Количество неуспешных запросов на генерацию документа по идентификатору версии

billedResourceName="DEFAULT",rn="company:project:dcgn",versionUid="{UID}"

dcgn_docgen_service_create_by_version_code_seconds

Время выполнения запросов на генерацию документа по коду версии

billedResourceName="DEFAULT",rn="company:project:dcgn",templateCode="TEST-TEMPLATE",versionCode="VERSION_2019",unit_type="api_calls"

dcgn_docgen_service_create_by_version_code

Общее количество вызовов запросов на генерацию документа по коду версии

billedResourceName="DEFAULT",rn="company:project:dcgn",templateCode="TEST-TEMPLATE",versionCode="VERSION_2019",unit_type="api_calls"

dcgn_docgen_service_create_by_version_code_sys_error

Количество неуспешных запросов на генерацию документа по коду версии

billedResourceName="DEFAULT",rn="company:project:dcgn",templateCode="TEST-TEMPLATE",versionCode="VERSION_2019"

dcgn_docgen_service_render_seconds

Время выполнения запроса на генерацию документа по обратносовместимому API. Метки templateCode, versionCode, versionUid заполняются, если переданы в запросе

billedResourceName="DEFAULT",rn="company:project:dcgn",templateCode="TEST-TEMPLATE",versionUid="",versionCode="VERSION_2019",unit_type="api_calls"

dcgn_docgen_service_render

Общее количество запросов на генерацию документа по обратносовместимому API. Метки templateCode, versionCode, versionUid заполняются, если переданы в запросе

billedResourceName="DEFAULT",rn="company:project:dcgn",templateCode="TEST-TEMPLATE",versionUid="",versionCode="VERSION_2019",unit_type="api_calls"

dcgn_docgen_service_render_sys_error

Количество неуспешных запросов на генерацию документа по обратносовместимому API. Метки templateCode, versionCode, versionUid заполняются, если переданы в запросе

billedResourceName="DEFAULT",rn="company:project:dcgn",templateCode="",versionUid="{UID}",versionCode=""

dcgn_docgen_service_fonts_loaded_count

Количество загруженных семейств шрифтов с помощью механизма загрузки дополнительных шрифтов

rn="company:project:dcgn"

dcgn_docgen_service_subfonts_loaded

Количество успешно загруженных шрифтов c помощью механизма загрузки дополнительных шрифтов

rn="company:project:dcgn"

dcgn_docgen_service_subfonts_loaded_error

Количество неуспешных загрузок шрифтов c помощью механизма загрузки дополнительных шрифтов

rn="company:project:dcgn"

Примечание

При недоступности Template Provider и настроенном кешировании шаблонов, можно продолжать генерировать документы через Docgen Service до времени вытеснения шаблона из кеша. При попытке генерации документа по незакешированному шаблону Docgen Service вернет ошибку о невозможности получить шаблон. По метрике стабильности приложения можно определить, что приложение работает не стабильно из-за недоступности Template Provider.

Метрики Template Registry#

Код метрики

Описание метрики

Метки метрики с примерами

dcgn_template_registry_app_status

Метрика доступности приложения, с учетом состояния БД.
При доступности dcgn_template_registry_app_status_sum должна совпадать с dcgn_template_registry_app_status_count.
Значения метрики:
1 — приложение доступно, БД доступна;
0 — приложение недоступно, БД недоступна

rn="company:project:dcgn"

dcgn_template_registry_import_template_seconds

Время выполнения запроса на импорт архива шаблона

billedResourceName="DEFAULT",rn="company:project:dcgn",unit_type="api_calls"

dcgn_template_registry_import_template

Общее количество вызовов запросов на импорт архива шаблона. Метка unit_type принимает значения:
- api_calls — при импорте через API;
- ui_calls — при импорте через UI

billedResourceName="DEFAULT",rn="company:project:dcgn",unit_type="api_calls"

dcgn_template_registry_import_template_sys_error

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

billedResourceName="DEFAULT",rn="company:project:dcgn"

dcgn_template_registry_templates_size_bytes

Общий объем сохраненных шаблонов в разрезе потребителя

billedResourceName="DEFAULT",rn="company:project:dcgn",unit_type="bytes"

dcgn_template_registry_kvr_seconds

Общее количество запросов на создание задачи подтверждения операции

rn="company:project:dcgn"

dcgn_template_registry_kvr_sys_error

Количество неуспешных запросов на создание задачи подтверждения операции

rn="company:project:dcgn"

dcgn_template_registry_kvr_seconds

Время выполнения запроса на создание задач подтверждения операции

rn="company:project:dcgn"

dcgn_template_registry_db_credentials_secret_change

Количество зарегистрированных изменений в файле секрета (УЗ БД)

rn="company:project:dcgn",file_path="/etc/db/secrets/jdbc.DOCGEN.user"

dcgn_template_registry_db_credentials_secret_apply

Количество успешных применений секрета

rn="company:project:dcgn"

dcgn_template_registry_db_credentials_secret_apply_error

Количество неуспешных применений секрета

rn="company:project:dcgn"

dcgn_template_registry_template_version_archivate_apply

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

rn="company:project:dcgn"

dcgn_template_registry_template_version_unarchivate_apply

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

rn="company:project:dcgn"

dcgn_template_registry_template_version_archivate_apply_count

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

rn="company:project:dcgn"

dcgn_template_registry_template_version_unarchivate_apply_count

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

rn="company:project:dcgn"

dcgn_template_registry_(pem | keystore)_secret_change

Количество зарегистрированных изменений в файле секрета (сертификаты в PEM формате или JKS/PKCS#12)

rn="company:project:dcgn",file_path="/etc/config/ssl/certs/tls.crt"

dcgn_template_registry_(pem | keystore)_secret_apply

Количество успешных применений секрета

rn="company:project:dcgn"

dcgn_template_registry_(pem | keystore)_secret_apply_error

Количество неуспешных применений секрета

rn="company:project:dcgn"

Важно!

Для продукта Platform V Frontend High Load для метрики dcgn_template_registry_app_status реализована функциональность критичности аудита. Если инструментом обработки событий аудита недоступен и параметр конфигурации audit.failure.enabled установлен в true, метрика возвращает 0. Подробнее о параметре конфигурации см. в разделе Изменение конфигураций.

Примечание

Метрика доступности приложения позволяет локализовать проблему, когда пользователь обращается с ошибкой «Произошла внутренняя ошибка на стороне сервера».

Метрики Template Provider#

Код метрики

Описание метрики

Метки метрики с примерами

dcgn_template_provider_app_status

Метрика доступности приложения, основывается на состоянии БД.
При доступности dcgn_template_provider_app_status_sum должна совпадать с dcgn_template_provider_app_status_count.
Значения метрики:
1 — приложение доступно, БД доступна;
0 — приложение недоступно, БД недоступна

rn="company:project:dcgn"

dcgn_template_provider_get_template_info

Общее количество запросов на получение шаблона

billedResourceName="DEFAULT",rn="company:project:dcgn",templateCode="TEST-TEMPLATE"

dcgn_template_provider_get_template_info_seconds

Время выполнения запроса на получение шаблона

billedResourceName="DEFAULT",rn="company:project:dcgn",templateCode="TEST-TEMPLATE"

dcgn_template_provider_get_template_info_sys_error

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

billedResourceName="DEFAULT",rn="company:project:dcgn",templateCode="TEST-TEMPLATE"

dcgn_template_provider_get_version

Общее количество запросов на получение версии шаблона

billedResourceName="DEFAULT",rn="company:project:dcgn",versionUid="{UID}",unit_type="api_calls"

dcgn_template_provider_get_version_seconds

Время выполнения запроса на получение версии шаблона

billedResourceName="DEFAULT",rn="company:project:dcgn",versionUid="{UID}",unit_type="api_calls"

dcgn_template_provider_get_version_sys_error

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

billedResourceName="DEFAULT",rn="company:project:dcgn",versionUid="{UID}"

dcgn_template_provider_invocation_db_seconds

Общее количество успешных обращений к БД

repositoryName="ConfigurationRepository.findBy",rn="company:project:dcgn"

dcgn_template_provider_invocation_db_sys_error

Общее количество неуспешных обращений к БД

repositoryName="ConfigurationRepository.findBy",rn="company:project:dcgn"

dcgn_template_provider_invocation_db_seconds

Время выполнения обращения к БД

repositoryName="ConfigurationRepository.findBy",rn="company:project:dcgn"

dcgn_template_provider_db_credentials_secret_change

Количество зарегистрированныхизменений в файле секрета (УЗ БД)

rn="company:project:dcgn",file_path="/etc/db/secrets/jdbc.DOCGEN.user"

dcgn_template_provider_db_credentials_secret_apply

Количество успешных применений секрета

rn="company:project:dcgn"

dcgn_template_provider_db_credentials_secret_apply_error

Количество неуспешных применений секрета

rn="company:project:dcgn"

dcgn_template_provider_(pem | keystore)_secret_change

Количество зарегистрированныхизменений в файле секрета (сертификаты в PEM формате или JKS/PKCS#12)

rn="company:project:dcgn",file_path="/etc/config/ssl/certs/tls.crt"

dcgn_template_provider_(pem | keystore)_secret_applyt

Количество успешных применений секрета

rn="company:project:dcgn"

dcgn_template_provider_(pem | keystore)_secret_apply_error

Количество неуспешных применений секрета

rn="company:project:dcgn"

Примечания

Метрика доступности приложения позволяет отслеживать состояние Template Provider, так как пользователи напрямую не обращаются к Template Provider и не могут контролировать его состояние.

Метрики производительности по БД необходимы для локализации проблемы долгого времени обработки запроса при сборе статистики использования Template Provider.

Метрики hikaricp_connection#

Метрики hikaricp_connection публикуются для Template Provider и Template Registry.

Код метрики

Описание метрики

Метки метрики с примерами

hikaricp_connection

Всего подключений

pool="HikariPool-1"

hikaricp_connection_acquire_seconds_count

Время получения соединения (число)

pool="HikariPool-1"

hikaricp_connection_acquire_seconds_max

Время получения соединения (максимальная длительность)

pool="HikariPool-1"

hikaricp_connection_acquire_seconds_sum

Время получения соединения (общая длительность)

pool="HikariPool-1"

hikaricp_connection_active

Количество активных подключений

pool="HikariPool-1"

hikaricp_connection_creation_seconds_count

Общее время создания подключения

pool="HikariPool-1"

hikaricp_connection_creation_seconds_max

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

pool="HikariPool-1"

hikaricp_connection_creation_seconds_sum

Среднее время создания подключения

pool="HikariPool-1"

hikaricp_connection_idle

Количество простаивающих подключений

pool="HikariPool-1"

hikaricp_connection_max

Максимальное количество подключений

pool="HikariPool-1"

hikaricp_connection_min

Минимальное количество подключений

pool="HikariPool-1"

hikaricp_connection_pending

Ожидающие соединения

pool="HikariPool-1"

hikaricp_connection_timeout_total

Общее время тайм-аута подключения

pool="HikariPool-1"

hikaricp_connection_usage_seconds_count

Время обработки исходящего сообщения в БД (число)

pool="HikariPool-1"

hikaricp_connection_usage_seconds_max

Время обработки исходящего сообщения в БД (максимальная длительность)

pool="HikariPool-1"

hikaricp_connection_usage_seconds_sum

Время обработки исходящего сообщения в БД (общая длительность)

pool="HikariPool-1"