Метрики

Введение

Метрики предоставляются по HTTP сервису, в формате для БД Prometheus.

Доступны по адресу http(s)://Имя сервера/Имя публикации/hs/info/metrics.

Например: https://su-web/k1c_prod/hs/info/metrics

В запросе можно передавать параметры для частичного получения метрик.

Данный функционал необходимо использовать, в случаях:

Необходимо получать ограниченный набор метрик.
Наблюдаемых данных очень много и требуется реализовать получение в несколько потоков.

Ожидаемый параметр:

selection - Ключ набора метрик, по которому надо отфильтровать вывод метрик.

Значение параметра может быть представлено списком, разделенным запятой.

Например:

https://su-web/k1cprod/hs/info/metrics - Все метрики

https://su-web/k1cprod/hs/info/metrics?selection=license - Информация, только о лицензиях

https://su-web/k1cprod/hs/info/metrics?selection=clusters,bases - Информация отфильтровананя по набору метрик с ключами “clusters” и “bases”.

Ответ метода содержит текст по принципу одна строка = одно значение, и имеют структуру:

ras1c_cluster_avaible{cluster1c="sw-1c-dev",environment1c="Dev",landscape="Базы 1С"} 3

,где:

ras1c_cluster_avaible - имя метрики (нитки)

{cluster1c="sw-1c-dev",environment1c="Dev",landscape="Базы 1С"} - перечень агрегатов

3 - Числовое значение метрики

Строки, начинающиеся с символа “#” - являются комментариями и игнорируются.

Наборы метрик

Если Оркестратор наблюдает за большим количеством объектов, то получение всех метрик одним запросом может занимать значительное время (2-3 секунды и более). Для оптимизации сбора метрик рекомендуется настроить несколько блоков сбора метрик, разделенных по наборам метрик (параметр selection). Посмотреть статистику получения метрик можно в панели визуализации Grafana “Оркестратор 1С (Статистика)”:

Для создания и настройки произвольных наборов метрик, перейдите в разделе “Настройки” в пункт Наборы метрик.

В левой таблице представлены все созданные элементы набора метрик, в правой - объекты, по которым будут отражены метрики в запросе с переданным параметром текущего (выделенного) набора.

Для создания нового набора метрик необходимо нажать кнопку Создать.

Состав объекта в наборе метрик может быть задано с помощью правил, по принципу: чем меньше номер правила, тем оно приоритетнее, если наблюдаемый объект не соответствует ни одному установленному правилу, то решение о включении объекта в набор принимается на основании общего правила группы метрик.

Ключ - значение ключа, которое будет использоваться в параметре “selection”, произвольный текст в нижнем регистре, только латинские буквы, цифры и знак “_”.

Наименование - произвольное наименование, характеризующее данный набор метрик.

Группы метрик (если “выкл” - метрики группы не будут включены в запрос, если “вкл” - метрики включаются, состав метрик определяется правилами, если их использование предусмотрено в данной группе):

Click house - группа метрик, значения, относящиеся к ClickHouse (не имеет правил)
Парсеры - группа метрик, значения, относящиеся к работе парсеров (ЖР и ТЖ)
Кластеры 1С - группа метрик, отвечающая за включение в запрос метрик кластера, правила настраиваются на вкладке “Кластера”
Базы - группа метрик, отвечающая за включение в запрос метрик информационных баз, правила настраиваются на вкладке “Базы”
Сеансы - группа метрик, отвечающая за включение в запрос метрик пользовательских сеансов, правила настраиваются на вкладке “Сеансы”
Лицензии - группа метрик, отвечающая за включение в запрос метрик использования лицензий, правила настраиваются на вкладке “Лицензии”

Результирующий набор - Динамически формируемая таблица, отражающая объекты текущей группы метрик, разрешение или запрет включения их метрик в данный набор и отражение номера правила, на основе которого было принято решение.

Перечень метрик

Общие

Имя метрики	Описание	Тип	Интерпретация
ras1c_cluster_avaible¹	Состояние кластера 1С	фикс.	0 - не мониторится 1 - не доступен 2 - ожидает получения метрик 3 - Доступен
ras1c_cluster_lag_ms¹	Задержка сбора метрик (как давно получены значения с приложения RAS)	мил.сек.
ras1c_cluster_get_duration_ms¹	Время, затраченное на получение метрик	мил.сек.
app1c_metric_time_execution_ms¹⁴	Время, затраченное на формирование метрик	мил.сек.
app1c_metric_count¹⁴	Количество метрик в запросе получения	шт.

Рабочие процессы

Значение "-1" устанавливается тем метрикам, которые считаются просроченными (неактуальными).

Имя метрики	Описание	Тип	Интерпретация
ras1c_rphost_count²	Перечень всех рабочих процессов 1С	фикс.	1 - Значение получено
ras1c_rphost_ram_use²	Объем занимаемой оперативной памяти	байты
ras1c_rphost_available_performance²	Доступная производительность рабочего процесса	целое
ras1c_rphost_stream_avg_count²	Среднее количество потоков	целое
ras1c_rphost_call_avg_duration_ms²	Средняя длительность вызова	мил.сек.
ras1c_rphost_call_service_avg_duration_ms²	Средняя длительность вызова сервисов	мил.сек.
ras1c_rphost_call_subd_avg_duration_ms²	Средняя длительность вызова СУБД	мил.сек.
ras1c_rphost_proccessing_call_avg_duration_ms²	Средняя длительность обработки вызова рабочим процессом 1С	мил.сек.
ras1c_rphost_uptime_sec²	Количество секунд, прошедшее со времени запуска рабочего процесса 1С	секунды
ras1c_rphost_restart_after_sec²	Через какое время будет автоматически перезапущен рабочий процесс 1С	секунды	0 - автоматический перезапуск не настроен
ras1c_server1c_ram_all³	Общее потребление оперативной памяти рабочими процессами	байты

Лицензии

Имя метрики	Описание	Тип	Интерпретация
ras1c_server1c_lic_use⁴	Использование серверных лицензий 1С	фикс.	0 - не используется 1 - используется
ras1c_workplace_lic_use⁵	Использование лицензий на рабочие места 1С	фикс.	0 - не используется 1 - используется
ras1c_lic_use_all⁶	Количество использованных пользовательских лицензий в разрезе ключей лицензий	шт.
ras1c_lic_info⁶	Информация о емкости (максимальном количестве рабочих мест) текущих лицензий	шт.	емкость лицензии
ras1c_server1c_lic_registred⁶	Информация обо всех известных (зарегистрировано использование) серверных лицензиях 1С	шт.	емкость лицензии

Базы 1С

Имя метрики	Описание	Тип	Интерпретация
ras1c_infobase_registered⁷	Все зарегистрированные базы 1С в мониторинге	фикс.	0 - Отсутствует в кластере 1С 1 - Есть в кластере 1С
ras1c_infobase_succes_auth⁷	Успешность авторизации оркестратора 1С в базе 1С	фикс.	0 - авторизация не пройдена 1- успешная авторизация 2 - авторизация для оркестратора выключена
ras1c_infobase_status⁷	Статус базы 1С	фикс.	0 - данные не получены 1- блокировка начала сеансов 2 - блокировка запуска регламентных заданий 3 - незащищенное соединение 4 - защищенное соединение 5 - неизвестно, авторизация для оркестратора выключена
ras1c_infobase_session_start_allowed⁸	Состояние разрешения запуска сеансов	фикс.	0 - заблокирован 1 - разрешен 2- не получено (ошибка авторизации) 3- получение выключено (авторизация выключена)
ras1c_infobase_background_job_start_allowed⁸	Состояние разрешения запуска регламентных заданий	фикс.	0 - заблокирован 1 - разрешен 2- не получено (ошибка авторизации) 3- получение выключено (авторизация выключена)
ras1c_infobase_get_lic_allowed⁸	Состояние разрешения получения лицензий сервером 1С	фикс.	0 - не разрешен 1 - разрешен 2- не получено (ошибка авторизации) 3- получение выключено (авторизация выключена)
ras1c_infobase_rphost_reserved⁸	Состояние флага “Резервировать рабочие процессы”	фикс.	0 - не резервировать 1 - резервировать 2- не получено (ошибка авторизации) 3- получение выключено (авторизация выключена)
ras1c_infobase_security_connection⁸	Уровень безопасности подключения клиентов к базе 1С	фикс.	0 - незащищенное 1 - защищено, при установке соединения 2 - защищено 3 - неизвестно

Сеансы

Имя метрики	Описание	Тип
ras1c_session_count⁹	Текущий сеанс	шт.
ras1c_session_uptime_sec⁹	Время работы сеанса	сек.
ras1c_session_last_active_ago_sec⁹	Время последнего бездействия сеанса	сек.
ras1c_session_active_call_count⁹	Сеанс имеет активный вызов сервера 1С	шт.
ras1c_session_connect_subd_count⁹	Сеанс имеет активный вызов СУБД	шт.
ras1c_session_block_subd_count⁹	Сеанс ожидает освобождения ресурса на уровне СУБД (ожидание на блокировке)	шт.
ras1c_session_block_1c_count⁹	Сеанс ожидает освобождения ресурса на уровне сервера 1С (ожидание на управляемой блокировке)	шт.
ras1c_session_call_duration_total_ms⁹	Длительность вызовов сервера 1С всего	мил.сек.
ras1c_session_call_duration_last_5min_ms⁹	Длительность вызовов сервера 1С за последние 5 минут	мил.сек.
ras1c_session_call_duration_current_ms⁹	Длительность вызовов сервера 1С текущая	мил.сек.
ras1c_session_all_call_duration_total_ms⁹	Длительность всех вызовов всего	мил.сек.
ras1c_session_all_call_duration_last_5min_ms⁹	Длительность всех вызовов за последние 5 минут	мил.сек.
ras1c_session_all_call_duration_current_ms⁹	Длительность всех вызовов текущая	мил.сек.
ras1c_session_service_call_duration_current_ms⁹	Длительность сервисных вызовов текущая	мил.сек.
ras1c_session_service_call_duration_total_ms⁹	Длительность сервисных вызовов всего	мил.сек.
ras1c_session_service_call_duration_last_5min_ms⁹	Длительность сервисных вызовов за последние 5 минут	мил.сек.
ras1c_session_subd_call_duration_total_ms⁹	Длительность вызовов СУБД всего	мил.сек.
ras1c_session_subd_call_duration_last_5min_ms⁹	Длительность вызовов СУБД за последние 5 минут	мил.сек.
ras1c_session_subd_call_duration_current_ms⁹	Длительность вызовов СУБД текущая	мил.сек.
ras1c_session_cpu_call_duration_total_ms⁹	Использование процессорного времени всего	мил.сек.
ras1c_session_cpu_call_duration_last_5min_ms⁹	Использование процессорного времени за последние 5 минут	мил.сек.
ras1c_session_cpu_call_duration_current_ms⁹	Использование процессорного времени текущее	мил.сек.
ras1c_session_ram_used_current_byte⁹	Текущее потребление оперативной памяти	байты
ras1c_session_traffic_cli_srv_total_byte⁹	Объем данных, переданных между клиентом и сервером 1С всего	байты
ras1c_session_traffic_cli_srv_last_5min_byte⁹	Объем данных, переданных между клиентом и сервером 1С за последние 5 минут	байты
ras1c_session_traffic_server1c_subd_total_byte⁹	Объем данных, переданных между сервером 1С и СУБД всего	байты
ras1c_session_traffic_server1c_subd_last_5min_byte⁹	Объем данных, переданных между сервером 1С и СУБД за последние 5 минут	байты
ras1c_session_disk_read_total_byte⁹	Объем данных прочитанных с диска всего	байты
ras1c_session_disk_read_current_byte⁹	Объем данных прочитанных с диска текщий	байты
ras1c_session_disk_write_total_byte⁹	Объем данных записанных на диск всего	байты
ras1c_session_disk_write_current_byte⁹	Объем данных записанных на диск текущий	байты
ras1c_session_uptime_ms⁹	Время работы сеанса	мил.сек.
ras1c_not_use_call_duration_last_5min_ms⁹	Длительность бездействия сеанса (отсутствие серверных вызовов) за последние 5 минут	мил.сек.
ras1c_duration_last_5min_ms⁹	Время существования сеанса за последние 5 минут	мил.сек.

Остальные

Имя метрики	Описание	Тип	Интерпретация
k1c_clickhouse_stat_count¹⁰	Количество записей в журнале регистрации	шт.
k1c_clickhouse_value_deep_sec¹⁰	Время прошедшее с даты первой записи в журнале	сек.
k1c_clickhouse_value_last_sec¹⁰	Время прошедшее с последней записи в журнале	сек.
k1c_clickhouse_table_active¹¹	Наличие таблиц в clickhouse	фикс.	0 - таблица не обнаружена 1 - таблица найдена
k1c_clickhouse_table_size_byte¹¹	Занимаемый объем данных в таблицах clickhouse	байты
k1c_clickhouse_table_row_count¹¹	Количество записей в таблицах clickhouse	шт.
k1c_tj_files_size_byte¹²	Размер файлов технолгических журналов, наблюдаемые парсером ТЖ	байты
k1c_tj_files_processed_size_byte¹²	Размер данных в файлах технологических журналов, которые были разобраны парсером ТЖ	байты
k1c_tj_files_parsing_status¹²	Значение настройки парсера “Разбирать технологический журнал”	фикс.	0 - не разбирать 1 - есть разные значения (разбирать и не разбирать) 2 - разбирать
k1c_tj_files_launched_status¹²	Наличие файлов logcfg.xml, в конфигурационных каталогах, наблюдаемых парсером ТЖ (ведение технологического журнала)	фикс.	0 - не вести ТЖ 1 - есть разные значения (вести и не вести) 2 - вести ТЖ
k1c_tj_files_count¹²	Количество файлов технологического журнала в каталогах, наблюдаемых парсером ТЖ	шт.
k1c_log_1c_cache_count¹³	Количество записей ЖР в кеше оркестратора	шт.
k1c_log_tj_cache_count¹³	Количество записей ТЖ в кеше оркестратора	шт.
k1c_log_1c_cache_bulk_count¹³	Количество пакетов записей ЖР в кеше оркестратора	шт.
k1c_log_tj_cache_bulk_count¹³	Количество пакетов записей ТЖ в кеше оркестратора	шт.
k1c_log_1c_cache_byte¹³	Размер записей ЖР в кеше оркестратора	байты
k1c_log_tj_cache_count¹³	Размер записей ТЖ в кеше оркестратора	байты
k1c_log_1c_ch_count¹³	Количество записей ЖР к сбросу в ClickHouse в оркестраторе	шт.
k1c_log_1c_ch_bulk_count¹³	Количество пакетов записей ЖР к сбросу в ClickHouse в оркестраторе	шт.
k1c_log_1c_ch_byte¹³	Размер записей ЖР к сбросу в ClickHouse в оркестраторе	байты
k1c_log_1c_to_1c_5min_count¹³	Количество записей ЖР полученных оркестратором за последние 5 минут	шт.
k1c_log_1c_to_1c_5min_bulk_count¹³	Количество пакетов записей ЖР полученных оркестратором за последние 5 минут	шт.
k1c_log_1c_to_1c_5min_count_in_bulk¹³	Среднее количество записей ЖР в одном пакете полученных оркестратором за последние 5 минут	шт.
k1c_log_1c_to_1c_5min_byte¹³	Размер записей ЖР полученных оркестратором за последние 5 минут	байты
k1c_log_1c_to_1c_5min_speed_count¹³	Средняя скорость получения записей ЖР оркестратором за последние 5 минут	шт./мил.сек.
k1c_log_1c_to_1c_5min_speed_bulk_count¹³	Средняя скорость получения пакетов записей ЖР оркестратором за последние 5 минут	шт./мил.сек.
k1c_log_1c_to_1c_5min_speed_byte¹³	Средняя скорость получения записей ЖР оркестратором в байтах за последние 5 минут	байт./мил.сек.
k1c_log_1c_etl_5min_count¹³	Количество записей ЖР подготовленных оркестратором за последние 5 минут	шт.
k1c_log_1c_etl_5min_bulk_count¹³	Количество пакетов записей ЖР подготовленных оркестратором за последние 5 минут	шт.
k1c_log_1c_etl_5min_count_in_bulk¹³	Среднее количество записей ЖР в одном пакете подготовленных оркестратором за последние 5 минут	шт.
k1c_log_1c_etl_5min_byte¹³	Размер записей ЖР подготовленных оркестратором за последние 5 минут	байты
k1c_log_1c_etl_5min_speed_count¹³	Средняя скорость подготовки записей ЖР оркестратором за последние 5 минут	шт./мил.сек.
k1c_log_1c_etl_5min_speed_bulk_count¹³	Средняя скорость подготовки пакетов записей ЖР оркестратором за последние 5 минут	шт./мил.сек.
k1c_log_1c_etl_5min_speed_byte¹³	Средняя скорость подготовки записей ЖР в байтах за последние 5 минут	байт./мил.сек.
log_1c_1c_to_ch_5min_count¹³	Количество записей ЖР отправленных оркестратором в clickHouse за последние 5 минут	шт.
log_1c_1c_to_ch_5min_bulk_count¹³	Количество пакетов записей ЖР отправленных оркестратором в clickHouse за последние 5 минут	шт.
log_1c_1c_to_ch_5min_count_in_bulk¹³	Среднее количество записей ЖР в одном пакете отправленных оркестратором в clickHouse за последние 5 минут	шт.
log_1c_1c_to_ch_5min_byte¹³	Размер записей ЖР отправленных оркестратором в clickHouse за последние 5 минут	байты
log_1c_1c_to_ch_5min_speed_count¹³	Средняя скорость загрузки записей ЖР оркестратором в ClickHouse за последние 5 минут	шт./мил.сек.
log_1c_1c_to_ch_5min_speed_bulk_count¹³	Средняя скорость загрузки пакетов записей ЖР оркестратором в ClickHouse за последние 5 минут	шт./мил.сек.
log_1c_1c_to_ch_5min_speed_byte¹³	Средняя скорость загрузки записей ЖР оркестратором в ClickHouse в байтах за последние 5 минут	байт./мил.сек.

Наборы агрегатов

cluster1c - имя кластера 1С
environment1c - инфраструктурный слой (Production, Test, Dev, unknown)
landscape - ландшафт 1С (объекты: Базы 1С, Сервера, Сеансы…) ↩↩↩
cluster1c - имя кластера 1С
environment1c - инфраструктурный слой (Production, Test, Dev, unknown)
server1c - имя сервера 1С
host - имя сервера
port - порт, на котором запущен рабочий процесс 1С
included - рабочий процесс 1C включен (true/false)
active - рабочий процесс 1С активен (true/false)
reserv - это резервный рабочий процесс 1С (true/false)
onlylic - рабочий процесс 1С, выделен только под сервис лицензирования (true/false)
central - это центральный рабочий процесс 1С (true/false)
alias - представление рабочего процесса 1С
↩↩↩↩↩↩↩↩↩↩
cluster1c - имя кластера 1С
environment1c - инфраструктурный слой (Production, Test, Dev, unknown)
server1c - имя сервера 1С
host - имя сервера
port - порт, на котором запущен рабочий процесс 1С
↩
cluster1c - имя кластера 1С
environment1c - инфраструктурный слой (Production, Test, Dev, unknown)
server1c - имя сервера 1С, использующий лицензию
host - имя сервера, где использована лицензия
host_lic - имя сервера лицензирования
lic_name - пользовательское наименование ключа
lic_series - серия лицензионного ключа
lic_code - код элемента справочника в оркестраторе
lic_net - сетевой ключ (true/false)
lic_get_server - лицензия, получена сервером 1С (true/false)
use_rm - является лицензией на рабочие места (true/false)
use_server - является лицензией на сервер 1С (true/false)
software - программная лицензия (true/false)
↩
cluster1c - имя кластера 1С environment1c - инфраструктурный слой (Production, Test, Dev, unknown)
server1c - имя сервера 1С, использующий лицензию
host - имя компьютера, где использована лицензия
host_lic - имя сервера лицензирования
lic_name - пользовательское наименование ключа
lic_series - серия лицензионного ключа
lic_code - код элемента справочника в оркестраторе
lic_net - сетевой ключ (true/false)
lic_get_server - лицензия, получена сервером 1С (true/false)
use_rm - является лицензией на рабочие места (true/false)
use_serverv - является лицензией на сервер 1С (true/false)
software - программная лицензия (true/false)
infobase_code - код справочника базы 1С в оркестраторе
infobase_id - ключ базы 1С, заданный пользователем в орекстраторе
infobase_name - имя базы 1С в кластере
infobase_aliasv - имя базы 1С в оркестраторе
username - имя пользователя, используещего лицензию
app - имя приложения 1С
app_alias - представление приложения 1С
session - номер сеанса, использующего лицензию
↩
lic_name - пользовательское наименование ключа
lic_series - серия лицензионного ключа
lic_code - код элемента справочника в оркестраторе
use_rm - является лицензией на рабочие места (true/false)
use_server - является лицензией на сервер 1С (true/false)
software - программная лицензия (true/false)
↩↩↩
cluster1c - имя кластера 1С
environment1c - инфраструктурный слой (Production, Test, Dev, unknown)
infobase_code - код справочника базы 1С в оркестраторе
infobase_id - ключ базы 1С, заданный пользователем в орекстраторе
infobase_name - имя базы 1С в кластере
infobase_alias - имя базы 1С в оркестраторе
connection_string - строка подключения базы 1С
registered - база зарегистрирована в кластере 1С (true/false)
↩↩↩
cluster1c - имя кластера 1С
environment1c - инфраструктурный слой (Production, Test, Dev, unknown)
infobase_code - код справочника базы 1С в оркестраторе
infobase_id - ключ базы 1С, заданный пользователем в орекстраторе
infobase_name - имя базы 1С в кластере
infobase_alias - имя базы 1С в оркестраторе
connection_string - строка подключения базы 1С
registered - база зарегистрирована в кластере 1С (true/false)
auth - успешность авторизации (получения данных) (true/false)
↩↩↩↩↩
cluster1c - имя кластера 1С
environment1c - инфраструктурный слой (Production, Test, Dev, unknown)
infobase_id - ключ базы 1С, заданный пользователем в орекстраторе
infobase_name - имя базы 1С в кластере
infobase_alias - имя базы 1С в оркестраторе
connection_string - строка подключения базы 1С
lic_series - серия, используемой лицензии
lic_use - сеанс использует лицензию (true/false)
server1c - сервер 1С, если не использует то “not use”
host - сервер, на котором расположен сервер 1С, если нет, то “not use”
port - порт
sleeping - спящий сеанс (true/false)
included - сеанс включен (true/false)
active - сеанс активен (true/false)
reserv - резервный сеанс (true/false)
session - номер сеанса
computer - имя компьютера, на котором запущен сеанс
username - имя пользователя
app - имя приложения
app_alias - представление приложения
is_active_session_last5min - сеанс был активен за последние 5 минут (true/false)
session_uid - уникальный идентификатор сеанса
↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩
cluster1c - имя кластера 1С
environment1c - инфраструктурный слой (Production, Test, Dev, unknown)
infobase_code - код справочника базы 1С в оркестраторе
infobase_id - ключ базы 1С, заданный пользователем в орекстраторе
infobase_name - имя базы 1С в кластере
infobase_alias - имя базы 1С в оркестраторе
connection_string - строка подключения базы 1С
↩↩↩
table - назначение таблиц (ЖР, ТЖ)
alias - представление таблиц (Журнал регистрации, Технологический журнал)
↩↩↩
parser - имя парсера технологического журнала в оркестраторе ↩↩↩↩↩
alias - представление метрики
agg_group - общая группа метрик
↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩↩
selection - ключ набора метрик, если в запросе нет параметра, то “All”
alias - наименование набора метрик, если в запросе нет параметра, то “Все”
↩↩