Документация Ключ-АСТРОМ - Вклад [ru]

MongoDB

2026-09-15T19:35:28Z

Aleksandr.Zubarev:

= Мониторинг MongoDB в Ключ-АСТРОМ =
Инструкция по настройке расширения для мониторинга '''MongoDB'''.

Расширение подключается к экземпляру '''MongoDB''' через сетевой порт (по умолчанию 27017) и собирает метрики сервера, баз данных, операций, памяти и подключений.

== Возможности расширения ==

=== Что делает ===

* Подключается к экземпляру '''MongoDB''' через сетевой порт.
* Собирает метрики сервера (<code>serverStatus</code>), включая статистику операций, подключений, памяти, блокировок и транзакций.
* Создает сущности '''MongoDB Instance''' и '''Database''' со связями между ними.
* Предоставляет данные для анализа производительности и работоспособности СУБД.

=== Что не делает ===

* Не устанавливает и не настраивает '''MongoDB'''.
* Не использует '''Management API''' или веб-интерфейс — только прямое сетевое подключение к СУБД.
* Не выполняет трассировку запросов между приложениями.
* Не создает и не изменяет объекты баз данных, кроме создания учетной записи для мониторинга.

Метрики начинают поступать после завершения настройки и первого цикла сбора (в течение 2–3 минут).

== Предварительные условия ==

* Версия '''MongoDB''': 4.0 или выше (рекомендуется 5.0+).
* Версия Ключ-АСТРОМ: 1.308 или выше.
* На хосте с '''MongoDB''' установлен ЕдиныйАгент Ключ-АСТРОМ, контроллер выполнения расширений ('''EEC''') включен.
* Подготовлен пакет расширения (<code>.zip</code>) для загрузки в Расширения — либо расширение уже доступно в каталоге Расширений.
* Сетевая доступность: порт '''MongoDB''' (по умолчанию 27017) должен быть открыт для подключений со стороны ЕдиногоАгента.
* Учетная запись с правами мониторинга (рекомендуется пользователь с ролью <code>clusterMonitor</code>).

== Рекомендация по подключению ==
При локальном мониторинге (ЕдиныйАгент на том же хосте, что и '''MongoDB''') в конфигурации установите флажок '''Connect via 'localhost'?'''. Это позволит использовать loopback-адрес для подключения.

Для защищенного соединения можно настроить '''TLS''' (флажок '''Enable insecure TLS''' устанавливать не рекомендуется — используйте правильно настроенные сертификаты).

== Шаг 0. Подготовка MongoDB к мониторингу ==
Данный этап выполняется непосредственно на сервере с '''MongoDB''' от имени администратора базы данных.

=== 0.1 Подключение к MongoDB ===
Подключитесь к экземпляру '''MongoDB''' с помощью <code>mongosh</code>.

'''Без аутентификации:'''<pre>
mongosh
</pre>'''С аутентификацией (рекомендуется):'''<pre>
mongosh --username admin --password <пароль_admin> --authenticationDatabase admin
</pre>Переключитесь на административную базу данных:<pre>
use admin
</pre>Проверьте существующих пользователей (опционально):<pre>
db.getUsers()
</pre>Создайте пользователя для мониторинга с ролью <code>clusterMonitor</code>:<pre>
db.createUser({user: "dt_user", pwd: "<пароль>", roles: ["clusterMonitor"]})
</pre>Примечание: Роль <code>clusterMonitor</code> предоставляет необходимые права для сбора метрик производительности и состояния кластера, включая доступ к командам <code>serverStatus()</code>, <code>dbStats()</code> и другим диагностическим данным.

=== 0.3 Проверка доступности баз данных ===
Убедитесь, что '''MongoDB''' работает корректно и базы данных доступны для мониторинга:<pre>
show dbs
</pre>Ожидаемый результат: список существующих баз данных.

== Шаг 1. Загрузка расширения в Расширения ==
Если расширение еще не установлено в окружении:

# Откройте '''Расширения''' → раздел '''Extensions'''.
# Нажмите '''Загрузить Расширение 2.0''' и выберите загрузку пользовательского / custom-расширения.
# Укажите файл <code>.zip</code>-пакета расширения '''MongoDB''' (доступен в каталоге Расширений или загружен из внешнего источника).
# Дождитесь успешной проверки подписи и загрузки.
# Активируйте нужную версию расширения для окружения.

Если расширение уже присутствует в Расширениях окружения, откройте его карточку и убедитесь, что требуемая версия активна. После активации перейдите на вкладку '''Конфигурация''' — можно добавлять конфигурацию мониторинга.

== Шаг 2. Добавление конфигурации мониторинга ==

# Откройте '''Расширения''' → расширение '''MongoDB''' → вкладка '''Конфигурация'''.
# Нажмите '''Добавить конфигурацию мониторинга'''.

== Шаг 3. Выбор источника мониторинга ==
Для типичного сценария «ЕдиныйАгент на хосте с MongoDB» выберите '''Мониторить локально''' и нужный хост. Убедитесь, что у хоста '''EEC''' отображается как «Включено».

Нажмите '''Следующий шаг'''.

== Шаг 4. Параметры подключения к MongoDB ==
{| class="wikitable"
!Поле
!Описание
!Пример
|-
|Port
|Порт '''MongoDB''' (по умолчанию 27017)
|27017
|-
|User
|Пользователь с правами мониторинга (создан на шаге 0)
|dt_user
|-
|Password
|Пароль пользователя
|–
|-
|Auth Mechanism
|Механизм аутентификации (оставьте пустым для использования стандартного)
|–
|-
|Authentication Database
|База данных аутентификации (обычно admin)
|admin
|}
Рекомендации по настройке:

* '''Порт''': Оставьте значение по умолчанию (27017), если только '''MongoDB''' не использует нестандартный порт.
* '''Пользователь''': Используйте учетную запись, созданную на шаге 0 с ролью <code>clusterMonitor</code>.
* '''Authentication Database''': Укажите <code>admin</code> (база данных, где создан пользователь).
* '''Enable insecure TLS''': Не устанавливайте данный флажок в production-средах. Используйте корректно настроенные сертификаты для '''TLS'''-соединений.
* '''Connect via 'localhost'?''': Установите флажок при локальном мониторинге (ЕдиныйАгент на том же хосте, что и '''MongoDB'''). Это гарантирует подключение через loopback-адрес.

== Шаг 5. Ярлык конфигурации и наборы метрик ==

* Оставьте конфигурацию включенной ('''Enabled''').
* Укажите понятный ярлык ('''Description'''), например имя кластера или окружения.
* Рекомендуется включить все наборы функций:
** '''Instance''' (метрики сервера)
** '''Database''' (метрики баз данных)
* Сохраните конфигурацию.

== Шаг 6. Проверка статуса ==
В разделе '''Конфигурация''' расширения убедитесь, что:

* Конфигурация включена.
* Состояние отображается как '''Ok'''.
* Указан корректный хост выполнения.

При статусе '''Ok''' можно перейти к дашборду кнопкой '''Перейти на дашборд'''.

Через 1–3 минуты в Ключ-АСТРОМ появляются сущности '''MongoDB Instance''' (а также '''Database''' — если они есть в '''MongoDB''').

== Контрольный список ==
{| class="wikitable"
!№
!Пункт
|-
|1
|На сервере '''MongoDB''' создана учетная запись <code>dt_user</code> с ролью <code>clusterMonitor</code>.
|-
|2
|Пакет расширения загружен в Расширения и активирован.
|-
|3
|Конфигурация мониторинга добавлена и включена, состояние '''Ok'''.
|-
|4
|Выбран корректный режим (локально / удаленно).
|-
|5
|Указаны корректные параметры подключения (порт, пользователь, пароль, Authentication Database).
|-
|6
|При локальном мониторинге установлен флажок '''Connect via 'localhost'?'''.
|-
|7
|На дашбордах и в сущностях отображаются метрики '''MongoDB'''.
|}

== Возможные проблемы ==
{| class="wikitable"
!Симптом
!Что проверить
|-
|Состояние конфигурации не '''Ok'''
|Сетевая доступность порта '''MongoDB''' (27017) с хоста ЕдиногоАгента / АктивногоШлюза, корректность учетных данных, статус '''EEC'''.
|-
|Ошибка авторизации
|Проверьте логин и пароль пользователя, а также Authentication Database (обычно <code>admin</code>). Убедитесь в наличии роли <code>clusterMonitor</code>.
|-
|Нет сущностей Database
|В '''MongoDB''' нет баз данных, либо еще не завершился первый цикл сбора.
|-
|Нулевые значения метрик
|Ожидаемо при отсутствии нагрузки; расширение отражает фактическое состояние СУБД.
|-
|Требуется удаленный сбор
|Группа АктивныхШлюзов с сетевым доступом к <code>host:27017</code> и отдельная учетная запись с ролью <code>clusterMonitor</code>.
|-
|Ошибка подключения при '''TLS'''
|Проверьте сертификаты. Временно для тестирования можно установить флажок '''Enable insecure TLS''' (не рекомендуется для production).
|-
|Расширение не видит базы данных
|Проверьте права пользователя <code>dt_user</code> — необходима роль <code>clusterMonitor</code>. Также убедитесь, что базы данных существуют и доступны (<code>show dbs</code>).
|}

== История версий ==

{| class="wikitable"
! Версия
! Изменения
|-
|2.2.2
|Начало поддержки расширения для Ключ-АСТРОМ <code>1.318.0+</code>. Поддерживается локальный и удалённый мониторинг MongoDB, включая метрики подключений, операций, памяти, блокировок, WiredTiger и репликации.
|}

Linux command extension

2026-09-15T19:32:30Z

Aleksandr.Zubarev:

= Расширение linux_command для Ключ-АСТРОМ =
Расширение '''linux_command''' предназначено для выполнения произвольных '''bash'''-команд на удалённых хостах по '''SSH''' и преобразования вывода в метрики Ключ-АСТРОМ. Метрики имеют префикс <code>custom.linux_command</code>.

== Возможности расширения ==

* Выполнение произвольной '''bash'''-команды на удалённом хосте.
* Подключение по '''SSH''' с паролем или по приватному ключу.
* Запуск команды от имени другого пользователя через <code>su <user> -c <command></code>.
* Разбор вывода в двух режимах:
** <code>SINGLE_VALUE</code> — первое числовое значение из вывода.
** <code>MULTI_VALUE</code> — набор пар <code>key=value</code>.
* Отправка метрик с измерением <code>endpoint</code>, соответствующим имени endpoint.

== Требования ==
На хосте, где запускается расширение (АктивныйШлюз или среда выполнения), должны быть установлены:

* <code>ssh</code>
* <code>sshpass</code>

== Конфигурация ==
Конфигурация задаётся через '''activation.json'''.

=== Пример activation.json ===
<pre>
{
"enabled": true,
"description": "linux_command activation",
"version": "0.0.6",
"activationContext": "REMOTE",
"pythonRemote": {
"endpoints": [
{
"endpoint_name": "test-endpoint",
"execution_frequency": 1,
"hostname": "172.18.38.131",
"ssh_port": 22,
"username": "test-user",
"password": "{{sshPassword}}",
"second_username": "",
"second_password": "",
"private_key_file": "",
"private_key_passphrase": "",
"command": "id -u",
"metric_extraction_mode": "SINGLE_VALUE",
"metric_pair_delimiter": "",
"key_value_delimiter": ""
}
]
}
}
</pre>

== Параметры endpoint ==
{| class="wikitable"
!Параметр
!Описание
|-
|<code>endpoint_name</code>
|Имя endpoint (попадает в измерение <code>endpoint</code>).
|-
|<code>execution_frequency</code>
|Частота запуска в минутах (минимум 1).
|-
|<code>hostname</code>
|Хост для '''SSH'''-подключения.
|-
|<code>ssh_port</code>
|'''SSH'''-порт (по умолчанию 22).
|-
|<code>username</code>
|'''SSH'''-пользователь.
|-
|<code>password</code>
|'''SSH'''-пароль.
|-
|<code>second_username</code>
|Второй пользователь для <code>su</code> (опционально).
|-
|<code>second_password</code>
|Пароль второго пользователя (опционально).
|-
|<code>private_key_file</code>
|Путь к приватному ключу на АктивномШлюзе/среде выполнения (опционально).
|-
|<code>private_key_passphrase</code>
|Парольная фраза ключа (опционально).
|-
|<code>command</code>
|Команда для запуска.
|-
|<code>metric_extraction_mode</code>
|Режим извлечения метрик: <code>SINGLE_VALUE</code> или <code>MULTI_VALUE</code>.
|-
|<code>metric_pair_delimiter</code>
|Разделитель пар в <code>MULTI_VALUE</code> (по умолчанию <code>\n</code>).
|-
|<code>key_value_delimiter</code>
|Разделитель ключ/значение в <code>MULTI_VALUE</code> (по умолчанию <code>=</code>).
|}

== Режимы извлечения метрик ==

=== SINGLE_VALUE ===
Берётся первая строка, которую можно преобразовать в число с плавающей точкой.

'''Пример:'''

Команда: <code>id -u</code>

Вывод: <code>1001</code>

Метрика: <code>custom.linux_command.value = 1001</code>

=== MULTI_VALUE ===
Ожидается вывод в формате <code>key=value</code> (или с заданными разделителями).

'''Пример:'''

Команда: <code>printf 'cpu=12\nmem=45.5\nerrors=0\n'</code>

<code>metric_pair_delimiter</code>: <code>\n</code>

<code>key_value_delimiter</code>: <code>=</code>

Метрики:

* <code>custom.linux_command.cpu = 12</code>
* <code>custom.linux_command.mem = 45.5</code>
* <code>custom.linux_command.errors = 0</code>

== Примеры сценариев ==

=== Команда от второго пользователя ===

* <code>username</code>: пользователь для '''SSH'''.
* <code>second_username</code>: пользователь, от которого выполнить команду.
* <code>command</code>: например, <code>id -u</code>.

Фактически выполняется:<pre>
su <second_username> -c '<command>'
</pre>

=== Подключение по приватному ключу ===

* <code>private_key_file</code>: путь к приватному ключу (например, <code>/root/.ssh/id_rsa</code>).
* Если ключ защищён парольной фразой:
** Заполните <code>private_key_passphrase</code>.
** Поле <code>password</code> остаётся обязательным по схеме, но при наличии <code>private_key_file</code> + <code>private_key_passphrase</code> используется парольная фраза ключа.

== История версий ==

{| class="wikitable"
! Версия
! Изменения
|-
|0.1.0
|Начало поддержки расширения в Ключ-АСТРОМ <code>1.285+</code>. Расширение выполняет команды на удалённых Linux-хостах по SSH и преобразует полученные значения в метрики.
|}

Filesystem monitoring

2026-09-15T19:29:55Z

Aleksandr.Zubarev:

'''''[[Расширения]] / [[Расширения#.D0.A0.D0.B0.D1.81.D1.88.D0.B8.D1.80.D0.B5.D0.BD.D0.B8.D1.8F%202.0|Расширения 2.0]] / Filesystem monitoring'''''

Следите за своими файлами и папками. Автоматическое развертывание на сотнях хостов за считанные минуты.

== Обзор ==
С расширением файловой системы V2 отслеживайте свои файлы в установках ЕдиногоАгента для Windows и Linux.

Это расширение предлагает больше функциональных возможностей, чем предыдущая версия, и использует новую структуру расширений (EF2.0).

Файл расширения больше не нужно распаковывать на отслеживаемых хостах. Настройка и развертывание выполняются через пользовательский интерфейс Ключ-АСТРОМ.

Нацеливание может быть выполнено по хосту, группе хостов, зоне управления или среде. Теги можно применять для разделения ваших конфигураций (максимум 100 конфигураций).

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

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

Метрики :

* Количество файлов: количество файлов, соответствующих шаблону.
* Счетчик возраста файла: количество файлов, соответствующих шаблону и возрасту.
* Возраст файла: возраст определенного файла (самый старый или самый новый при возврате более 1 файла).
* Размер файла: Размер файлов в байтах
* Файл смонтирован: файл смонтирован в Unix NFS.

== Случаи Использования ==
Примеры пути:

* Подсчитайте количество файлов журнала внутри /var/log/myapp Выберите тип проверки = count Путь = /var/log/myapp/*.log
* Подсчитайте количество файлов журнала внутри c:\temp Выберите тип проверки = count Путь = c:\temp*.log
* Подсчитайте количество файлов журналов внутри /var/log/myapp и любых подкаталогов Выберите тип проверки = count Путь = /var/log/myapp/**/*.log
* Возвращает общий размер всех файлов файлов внутри /var/log/myapp Выберите тип проверки = размер Путь = /var/log/myapp/*
* Возвращает возраст самого старого файла в /tmp/test/. Выберите тип проверки = возраст модификации. Отмените выбор пользователя. Самый новый файл. Путь = /tmp/test/*.
* Вернуть количество файлов журналов старше 1 часа в /tmp/test Выберите тип проверки = счетчик возраста модификации Установите для оператора сравнения возраста значение Older than Установите пороговое значение 60 Path = /tmp/test/*.log
* Проверьте, смонтирован ли /data/mount-data Выберите тип проверки = точка монтирования Путь = /data/mount-data
* Убедитесь, что создан журнал за сегодня: /var/mylog20222211.log Выберите тип проверки = count Путь = /var/mylogГГГГММДД.log Принимает ДДММГГГГ, ДД-ММ-ГГГГ, ДД_ММ_ГГГГ, ГГГГММДД. ГГГГ-ММ-ДД, ГГГГ_ММ_ДД. Дата будет локальной датой, когда работает OneAgent/расширение.

Расписания: если расписание не выбрано, проверка будет выполняться круглосуточно и без выходных.

Если проверку не следует проводить в воскресенье, выберите расписание и снимите флажок «Воскресенье».

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

Для каждого времени будет добавлено поле длительности расписания, чтобы определить конец. См. пример для работы только с 9:00 в течение 8 часов.

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

Это справедливо для любого файла. Файл должен быть как минимум доступен для чтения пользователю Ключ-АСТРОМ, в противном случае он будет невидим для расширения.

Также поддерживаются файловые ресурсы Azure. При выборе появятся 2 новых поля. Учетная запись Azure и ключ.

Убедитесь, что есть подключение к Azure из ЕдиногоАгента.

== Информация О Совместимости ==
Это расширение ЕдиногоАгента, совместимое с Windows и Linux.

Кластер версии 1.254 и ЕдиныйАгент минимум 1.249.

Хранилище BLOB-объектов Azure поддерживается

== История версий ==

{| class="wikitable"
! Версия
! Изменения
|-
|1.3.3
|
* В параметры запуска проверок от имени другого пользователя на узлах Linux добавлена поддержка <code>sesu</code>.
* Исправлен запуск через <code>sudo</code>: если имя пользователя не указано, команда корректно выполняется от имени пользователя <code>dtuser</code>.
|-
|1.3.0
|Начало поддержки расширения в Ключ-АСТРОМ <code>1.289.0+</code>.
|}

Расширение PostgreSQL

2026-09-15T19:16:45Z

Aleksandr.Zubarev:

{| class="wikitable"
!Версия
!Изменения

|-
|2.9.7
|
* Версия расширения для Ключ-АСТРОМ <code>1.318.0+</code>.
* Добавлены наборы функций <code>SLRU</code>, <code>I/O</code>, <code>User Functions</code> и <code>Subscription</code>.
* Добавлены новые метрики репликации, конфликтов, WAL и активности PostgreSQL.
* Добавлены описания наборов функций.
* Добавлены шаблоны оповещений о недоступности экземпляра и переходе в режим восстановления.
* Добавлены переходы к сущностям PostgreSQL со страницы хоста и из обзорной панели.
* Исправлены запросы обзорной панели для анализа производительности и блокировок.
* Исправлено создание сущностей при отсутствии обязательных измерений.
* Для PostgreSQL 16 и новее добавлен сбор статистики ввода-вывода.
* Сохранено использование функции <code>astromkey.astromkey_execution_plan</code> для получения планов выполнения.
|-
|2.6.6
|
* Версия расширения для Ключ-АСТРОМ <code>1.310.0+</code>.
* Версия основана на 2.6.5 и содержит те же функции мониторинга.
* Схема для получения планов выполнения изменена на <code>astromkey</code>.
* Функция получения планов выполнения переименована в <code>astromkey.astromkey_execution_plan</code>.
|-
|2.6.5
|
* Версия расширения для Ключ-АСТРОМ <code>1.310.0+</code>.
* Добавлен сбор конфигурации PostgreSQL.
* Добавлены наборы функций <code>Replication</code> и <code>Locks</code>.
* Добавлены метрики размера базы данных и возраста идентификатора транзакции.
* Добавлен сбор длительных и наиболее ресурсоёмких запросов из <code>pg_stat_activity</code> и <code>pg_stat_statements</code>.
* Добавлены отдельные интервалы сбора основных и длительных запросов.
* Добавлен параметр <code>Endpoint Metadata</code>.
* Добавлена возможность получения планов выполнения запросов.
* Добавлена готовая обзорная панель.
* Версия PostgreSQL добавлена в атрибуты сущности экземпляра.
* Добавлена связь между экземпляром PostgreSQL и соответствующим процессом при наличии ЕдиногоАгента.
* Команды <code>ALTER</code> исключены из сбора наиболее ресурсоёмких запросов.
* Метрика <code>postgres.blk_hit.count</code> переименована в <code>postgres.blks_hit.count</code>.
* Метрики привязаны к соответствующим типам сущностей.
* Из метрик активности удалено изменчивое измерение <code>client_port</code>.
* Исправлен сбор метрик фоновой записи в PostgreSQL 17.
* Исправлен сбор размера разницы WAL для реплицируемых экземпляров.
* Исправлен расчёт продолжительности запросов внутри транзакций.
* Исправлены графики использования подключений и анализа запросов.
* Исправлено значение по умолчанию для интервала сбора длительных запросов.

|-
|1.2.0
|Улучшения:

* Мониторинг баз данных был улучшен для поддержки всех версий Postgres, начиная с 11. Ранее он работал только для Postgres 14+.
* Все показатели были привязаны к соответствующему типу сущности, чтобы обеспечить корректное отображение показателей при активации менеджмент зон и фильтрации по сущности.

Исправления ошибок:

* <code>client_port</code> измерение было удалено из следующих метрик, поскольку поле не несет ценной информации и является слишком изменчивым, что приводит к созданию слишком большого количества отдельных временных рядов.
** <code>postgres.activity.active</code>
** <code>postgres.activity.fastpath_function_call</code>
** <code>postgres.activity.idle_in_transaction_aborted</code>
** <code>postgres.activity.idle_in_transaction</code>
** <code>postgres.activity.idle</code>
|-
|1.1.0
|Новые функции:

* Новые наборы функций
* Новый тип топологии: табличное пространство
* Метрика разности WAL
* Видимость на уровне запроса для самых длительных запросов
* Новые метрики и диаграммы на экранах сущностей

Исправления ошибок:

* Дублирующиеся топологические сущности
* Неправильные типы метрик
* Неправильная метрика восстановления
* Ссылки на панель инструментов и экраны сущностей
|-
|1.0.3
|
* Исправление изменения схемы
|-
|1.0.2
|
* Исправлена ссылка на конфигурации в обзорной панели.
|-
|1.0.1
|Начало поддержки расширения PostgreSQL
|}

== Обзор ==
Решение для мониторинга '''PostgresSQL''' основано на подходе удалённого мониторинга, реализованном в виде расширения Ключ-АСТРОМ АктивногоШлюза. Расширение запрашивает ключевые показатели производительности и работоспособности баз данных '''Postgres'''. Затем искусственный интеллект от Ключ-АСТРоМ анализирует эти показатели для выявления отклонений и проблем.

== Варианты использования ==

* Контролируйте состояние работоспособности и производительность своей настройки '''PostgreSQL'''.
* Обнаруживайте аномалии и оповещайте о них.
* Примите превентивные меры для предотвращения проблем в обслуживании.

=== Мониторинг популярных запросов ===
Если мониторинг логов Ключ-АСТРОМ включён и <code>pg_stat_statements</code> представление доступно, Ключ-АСТРОМ будет собирать '''100''' самых популярных запросов (отсортированных по общему времени выполнения) каждые 5 минут и сохранять их в виде логов. Эти логи доступны либо на экране экземпляра базы данных, либо в приложении '''Базы данных''' в разделе '''Топ-запросов по общему времени выполнения'''.

Чтобы отфильтровать эти запросы на дашборде или в блокноте, можно использовать фильтры по <code>dt.extension.name = com.astromkey.extension.postgres</code> и <code>event.group = top_queries</code>. Ниже представлен пример '''DQL-запроса''':
fetch logs
| filter dt.extension.name=="com.astromkey.extension.postgres" and event.group=="top_queries"
| sort total_exec_time desc
Независимо от того, <code>pg_stat_statements</code> доступно это или нет, Ключ-АСТРОМ все равно будет собирать запросы <code>pg_stat_activity</code> как часть набора функций <code>Queries</code>, которые аналогичным образом поступают в виде логов с <code>event.group = longest_queries</code>.

=== Получение деталей плана выполнения ===
Для пользователей '''SaaS''', имеющих доступ к приложению '''Базы данных''' и включённых функциях мониторинга самых популярных запросов (см. предыдущий раздел), доступна функция получения планов выполнения для этих запросов. Это можно сделать в приложении '''Базы данных''' в разделе <code>Statement performance</code>, щёлкнув <code>Request</code> по плану выполнения конкретного запроса.

Для этого <code>query</code> расширение попытается выполнить следующее:
SELECT * from astromkey.astromkey_execution_plan({query})
и затем загрузить в Ключ-АСТРОМ первую строку столбца с именем <code>explain</code>. Эти планы выполнения загружаются в виде логов с <code>event.group = execution_plans</code>.

== Начать ==

=== Активация ===
''Действия по активации удаленного мониторинга'' (версия '''1.255+'''):

* Активируйте расширение в Ключ-АСТРОМ, перейдя по ссылке:
* Ключ-АСТРОМ → Расширения → PostgreSQL → Добавить в среду
* Добавить новую конфигурацию мониторинга

=== Требования ===

* Должно быть установлено соединение между АктивнымШлюзом, где развернуто расширение, и базой данных '''Postgres'''.
* Необходимо предоставить пользователю базы данных соответствующие разрешения.

Пример:
CREATE USER astromkey WITH PASSWORD '<PASSWORD>' INHERIT;
GRANT pg_monitor TO astromkey;
Для мониторинга самых популярных запросов:

* <code>pg_stat_statements</code> просмотр (должен быть включен) [ https://www.postgresql.org/docs/current/pgstatstatements.html#PGSTATSTATEMENTS ].
* <code>pg_stat_statements.track_planning</code> должен быть включен, чтобы разрешить выборку планов.

Для мониторинга деталей плана исполнения:

* В базе данных должна быть создана специальная функция <code>astromkey.astromkey_execution_plan</code>, к которой вы будете подключаться и из которой будут извлекаться планы выполнения.

CREATE SCHEMA astromkey;
CREATE OR REPLACE FUNCTION astromkey.astromkey_execution_plan(
<nowiki> </nowiki> query text,
<nowiki> </nowiki> OUT explain JSON
) RETURNS SETOF JSON
<nowiki> </nowiki> LANGUAGE plpgsql
<nowiki> </nowiki> VOLATILE
<nowiki> </nowiki> RETURNS NULL ON NULL INPUT
<nowiki> </nowiki> SECURITY DEFINER
<nowiki> </nowiki> ROWS 1
<nowiki> </nowiki> SET plan_cache_mode = force_generic_plan
AS
$$DECLARE
<nowiki> </nowiki> arg_count integer;
<nowiki> </nowiki> open_paren text;
<nowiki> </nowiki> close_paren text;
<nowiki> </nowiki> explain_cmd text;
<nowiki> </nowiki> json_result json;
BEGIN

<nowiki> </nowiki> /* reject statements containing a semicolon in the middle */
<nowiki> </nowiki> IF pg_catalog.strpos(
<nowiki> </nowiki> pg_catalog.rtrim(astromkey_execution_plan.query, ';'),
<nowiki> </nowiki> ';'
<nowiki> </nowiki> ) OPERATOR(pg_catalog.>) 0 THEN
<nowiki> </nowiki> RAISE EXCEPTION 'query string must not contain a semicolon';
<nowiki> </nowiki> END IF;

<nowiki> </nowiki> /* get the parameter count */
<nowiki> </nowiki> SELECT count(*) INTO arg_count
<nowiki> </nowiki> FROM pg_catalog.regexp_matches( /* extract the "$n" */
<nowiki> </nowiki> pg_catalog.regexp_replace( /* remove single quoted strings */
<nowiki> </nowiki> astromkey_execution_plan.query,
<nowiki> </nowiki> <nowiki>'''</nowiki>[^<nowiki>''</nowiki>]*<nowiki>'''</nowiki>,
<nowiki> </nowiki> <nowiki>''</nowiki>,
<nowiki> </nowiki> 'g'
<nowiki> </nowiki> ),
<nowiki> </nowiki> '\$\d{1,}',
<nowiki> </nowiki> 'g'
<nowiki> </nowiki> );

<nowiki> </nowiki> IF arg_count OPERATOR(pg_catalog.=) 0 THEN
<nowiki> </nowiki> open_paren := <nowiki>''</nowiki>;
<nowiki> </nowiki> close_paren := <nowiki>''</nowiki>;
<nowiki> </nowiki> ELSE
<nowiki> </nowiki> open_paren := '(';
<nowiki> </nowiki> close_paren := ')';
<nowiki> </nowiki> END IF;

<nowiki> </nowiki> /* construct a prepared statement */
<nowiki> </nowiki> EXECUTE
<nowiki> </nowiki> pg_catalog.concat(
<nowiki> </nowiki> 'PREPARE _stmt_',
<nowiki> </nowiki> open_paren,
<nowiki> </nowiki> pg_catalog.rtrim(
<nowiki> </nowiki> pg_catalog.repeat('unknown,', arg_count),
<nowiki> </nowiki> ','
<nowiki> </nowiki> ),
<nowiki> </nowiki> close_paren,
<nowiki> </nowiki> ' AS ',
<nowiki> </nowiki> astromkey_execution_plan.query
<nowiki> </nowiki> );

<nowiki> </nowiki> /* construct an EXPLAIN statement */
<nowiki> </nowiki> explain_cmd :=
<nowiki> </nowiki> pg_catalog.concat(
<nowiki> </nowiki> 'EXPLAIN (FORMAT JSON, ANALYZE FALSE) EXECUTE _stmt_',
<nowiki> </nowiki> open_paren,
<nowiki> </nowiki> pg_catalog.rtrim(
<nowiki> </nowiki> pg_catalog.repeat('NULL,', arg_count),
<nowiki> </nowiki> ','
<nowiki> </nowiki> ),
<nowiki> </nowiki> close_paren
<nowiki> </nowiki> );

<nowiki> </nowiki> /* get and return the plan */
<nowiki> </nowiki> EXECUTE explain_cmd INTO json_result;
<nowiki> </nowiki> RETURN QUERY SELECT json_result;

<nowiki> </nowiki> /* delete the prepared statement */
<nowiki> </nowiki> DEALLOCATE _stmt_;
END;$$;

* Обратите внимание, что функция выше определена с <code>SECURITY DEFINER</code>, то есть она выполняется с привилегиями пользователя, который её определил, а не того, кто её выполняет. Это связано с тем, что для запроса <code>EXPLAIN</code> требуются те же разрешения, что и для его выполнения, то есть пользователь, с которым определена эта функция, должен иметь достаточные привилегии для запуска <code>PREPARE</code> и <code>EXPLAIN</code> для запросов, которые она будет объяснять. Поэтому для полной функциональности убедитесь, что функция определена с соответствующим пользователем.
* Пользователю, осуществляющему мониторинг, необходимо иметь <code>USAGE</code> грант на <code>astromkey</code> схему.

GRANT USAGE ON SCHEMA astromkey to <username>

* В некоторых конфигурациях '''PostgreSQL''' вам также может потребоваться настроить <code>search_path</code> для пользователя мониторинга:

ALTER USER astromkey SET search_path to astromkey, public;

== Подробности ==

=== Ограничения ===
Популярные запросы:

* Из соображений безопасности <code>ALTER</code> утверждения исключены из коллекции самых популярных запросов.

Подробности плана выполнения:

* Доступно только для пользователей '''SaaS''' с установленным приложением '''DB'''. Разрешение <code>extensions:configuration.actions:write</code> требуется для запуска загрузки плана выполнения.
* План выполнения можно получить только из базы данных, в которой была создана функция <code>astromkey.astromkey_execution_plan</code>.

=== Лицензирование ===
Метрики, собираемые с помощью этого расширения, используют единицы данных Ключ-АСТРОМ ИИ (см. [[DDU для пользовательских событий ИИ|DDU для метрик]]).

Грубую оценку количества '''DDU''', потребляемых метрическим методом, можно получить с помощью следующей формулы:
( (11 * number of instances)
+ (29 * number of databases)
+ (1 * number of tablespaces)
) * 525.6 DDUs/year
Для логов действует стандартное потребление '''DDU''' для мониторинга логов. В зависимости от вашей модели лицензирования, см. потребление [[DDU для лога мониторинга|DDU для мониторинга логов]].

Если ваша лицензия включает пользовательские метрики. Каждая пользовательская метрика эквивалентна '''525,6 DDU/год'''. См. документацию [[Распределение затрат|Расчёт стоимости метрики]].

== Информация о совместимости ==
Расширение предназначено для работы с PostgreSQL версии 11 и более поздних версий.

Ceph

2026-09-15T19:15:02Z

Aleksandr.Zubarev:

= Расширение Ceph storage =

Осуществляйте мониторинг использования распределенного хранилища '''Ceph''', состояния '''OSD''' и производительности пулов на уровне клиента и хоста с помощью метрик '''Prometheus''' и информационных панелей.

== Начало работы ==
=== Обзор ===
Отслеживайте использование системы хранения '''Ceph''' как на стороне клиента, так и на уровне хоста. Используйте расширение '''Ceph storage''' для:
* Мониторинга использования и производительности вашей платформы '''Ceph'''.
* Постоянного получения актуальной информации о ресурсах хоста и потоке данных.
* Сокращения до минимума времени анализа, необходимого для выявления первопричины возможных системных сбоев.

=== Варианты использования ===
* Мониторинг использования ресурсов хоста и уровней его емкости.
* Сбор данных об активных и неактивных демонах объектного хранилища '''Ceph'''.
* Наблюдение за потоком данных системы с точки зрения операций записи и чтения, как для кластера в целом, так и для отдельных '''OSD'''.

=== Требования ===
* Хранилище '''Ceph''', работающее в вашей среде.
* Расширение активировано в вашей среде с помощью встроенного раздела '''Расширения'''.

== Подробности ==
=== Лицензирование и стоимость ===
Расширение '''Ceph storage''' собирает пользовательские метрики, которые, в зависимости от вашей лицензионной модели, могут либо потреблять '''DDUs''', либо учитываться как '''метрики в рамках вашей подписки на платформу Ключ-АСТРОМ'''. Ниже приведена формула для оценки потребления лицензии для этого расширения:
* '''DDUs''' для всех включенных метрик: ((3 * кол-во мониторов) + (7 * кол-во кластеров) + (13 * кол-во '''OSD''') + (9 * кол-во групп размещения)) * 60 мин * 24 ч * 365 дней * 0.001
* Точек данных для всех включенных метрик: ((3 * кол-во мониторов) + (7 * кол-во кластеров) + (13 * кол-во '''OSD''') + (9 * кол-во групп размещения)) * 60 мин * 24 ч * 365 дней

== Наборы функций ==
При активации расширения с помощью '''конфигурации мониторинга''' вы можете ограничить мониторинг одним из наборов функций. Для корректной работы расширение должно собирать хотя бы одну метрику после активации. В сильно сегментированных сетях наборы функций могут отражать сегменты вашей среды. Затем, при создании конфигурации мониторинга, вы можете выбрать набор функций и соответствующую группу АктивныхШлюзов, которая может подключаться к этому конкретному сегменту. Все метрики, не отнесенные ни к одному набору функций, считаются заданными по умолчанию и всегда передаются. Метрика наследует набор функций подгруппы, которая, в свою очередь, наследует набор функций группы. Кроме того, набор функций, определенный на уровне метрики, переопределяет набор функций, определенный на уровне подгруппы, который, в свою очередь, переопределяет набор функций, определенный на уровне группы.

== pool ==
{| class="wikitable"
|-
! Название метрики !! Ключ метрики !! Описание
|-
| Objects count || ceph_pool_objects || Количество объектов в пуле
|-
| Recovered objects || ceph_pool_num_objects_recovered || Количество восстановленных объектов в пуле
|-
| Recovered bytes || ceph_pool_num_bytes_recovered || Количество восстановленных байт в пуле
|-
| Pool objects quota || ceph_pool_quota_objects || Квота объектов, установленная для пула
|-
| Pool bytes quota || ceph_pool_quota_bytes || Квота байт, установленная для пула
|}

== health ==
{| class="wikitable"
|-
! Название метрики !! Ключ метрики !! Описание
|-
| Health status || ceph_health_status || Состояние здоровья кластера
|-
| Slow operations || ceph_healthcheck_slow_ops || Запросы '''OSD''' или монитора, обработка которых занимает много времени
|}

== osdLatency ==
{| class="wikitable"
|-
! Название метрики !! Ключ метрики !! Описание
|-
| OSD apply latency || ceph_osd_apply_latency_ms || Задержка операции «применение» на '''OSD'''
|-
| OSD commit latency || ceph_osd_commit_latency_ms || Задержка операции «фиксация» на '''OSD'''
|-
| OSD write latency sum || ceph_osd_op_w_latency_sum || Общая задержка операций «запись» на '''OSD'''
|-
| OSD read latency sum || ceph_osd_op_r_latency_sum || Общая задержка операций «чтение» на '''OSD'''
|}

== osdOperations ==
{| class="wikitable"
|-
! Название метрики !! Ключ метрики !! Описание
|-
| Bytes written || ceph_osd_op_w_in_bytes || Общий объем байт, записанных на '''OSD'''
|-
| Bytes read || ceph_osd_op_r_out_bytes || Общий объем байт, прочитанных с '''OSD'''
|-
| Write operations || ceph_osd_op_w || Общее количество операций записи, выполненных на '''OSD'''
|-
| Read operations || ceph_osd_op_r || Общее количество операций чтения, выполненных на '''OSD'''
|-
| Recovery operations || ceph_osd_recovery_ops || Количество операций восстановления в '''OSD'''
|}

== Placement Groups ==
{| class="wikitable"
|-
! Название метрики !! Ключ метрики !! Описание
|-
| PG active || ceph_pg_active || Группа размещения активна на пул
|-
| PG down || ceph_pg_down || Группа размещения недоступна на пул
|-
| PG clean || ceph_pg_clean || Группа размещения чиста на пул
|-
| PG backfill toofull || ceph_pg_backfill_toofull || Группа размещения переполнена на пул
|-
| PG degraded || ceph_pg_degraded || Группа размещения деградировала на пул
|-
| PG failed repair || ceph_pg_failed_repair || Группа размещения с ошибкой восстановления на пул
|-
| PG incomplete || ceph_pg_incomplete || Группа размещения неполная на пул
|-
| PG stale || ceph_pg_stale || Группа размещения устарела на пул
|-
| PG inconsistent || ceph_pg_inconsistent || Группа размещения несогласованна на пул
|}

== default ==
{| class="wikitable"
|-
! Название метрики !! Ключ метрики !! Описание
|-
| Total capacity || ceph_cluster_total_bytes || Общая емкость кластера в байтах
|-
| Used capacity || ceph_cluster_total_used_bytes || Использованная емкость кластера в байтах
|-
| Monitor metadata || ceph_mon_metadata || Метрика-заполнитель для получения измерений метаданных монитора от экспортера
|-
| OSD metadata || ceph_osd_metadata || Метрика-заполнитель для получения измерений метаданных '''OSD''' от экспортера
|}

== osdState ==
{| class="wikitable"
|-
! Название метрики !! Ключ метрики !! Описание
|-
| OSD in || ceph_osd_in || Demons хранения в кластере
|-
| OSD up || ceph_osd_up || Demons хранения запущены
|-
| Placement groups || ceph_osd_numpg || Группы размещения
|}

== monState ==
{| class="wikitable"
|-
! Название метрики !! Ключ метрики !! Описание
|-
| Open sessions || ceph_mon_num_sessions || Количество открытых сессий монитора
|-
| Quorum status || ceph_mon_quorum_status || Demons монитора в кворуме
|}

== История изменений ==

{| class="wikitable"
!Версия
!Изменения
|-
|1.1.3
|
* Версия расширения для Ключ-АСТРОМ <code>1.296.0+</code>.
* Мониторинг Ceph через источник данных Prometheus.
* Начало поддержки расширения.
|}

ClickHouse

2026-09-15T19:14:21Z

Aleksandr.Zubarev:

= Расширение Ключ-АСТРОМ для мониторинга ClickHouse =
Python-расширение '''Extensions 2.0''' для мониторинга серверов '''ClickHouse''' через '''HTTP'''-интерфейс.

== Требования ==

* АктивныйШлюз с включённым выполнением расширений.
* С АктивногоШлюза должен быть доступен '''HTTP'''- или '''HTTPS'''-интерфейс '''ClickHouse'''.
* Пользователь '''ClickHouse''' с правами чтения системных таблиц мониторинга.

== Какие данные собираются ==
Коллектор получает все числовые значения из следующих таблиц:
{| class="wikitable"
!Таблица ClickHouse
!Префикс метрик Ключ-АСТРОМ
!Назначение
|-
|<code>system.metrics</code>
|<code>clickhouse.metrics.*</code>
|Текущие значения: выполняемые запросы, слияния, память и другие показатели
|-
|<code>system.events</code>
|<code>clickhouse.events.*</code>
|Накопительные счётчики запросов, строк, байтов, '''CPU''' и операций ввода-вывода
|-
|<code>system.asynchronous_metrics</code>
|<code>clickhouse.asynchronous.*</code>
|'''CPU''', память, '''MergeTree''' и другие системные показатели
|}
Дополнительно расширение отправляет:
{| class="wikitable"
!Метрика
!Описание
|-
|<code>clickhouse.topology</code>
|Служебная метрика для создания сущности хоста
|-
|<code>clickhouse.host.availability</code>
|Результат проверки <code>/ping</code>: 1 — доступен, 0 — недоступен
|-
|<code>clickhouse.host.replica_status</code>
|Результат <code>/replicas_status</code>: 1 — реплика исправна, 0 — недоступна или отстаёт
|-
|<code>clickhouse.host.uptime</code>
|Время работы сервера в секундах
|}
Метрика <code>OSIOWaitMicroseconds</code> формируется '''ClickHouse''' только при включённом '''Linux''' <code>task_delayacct</code>.

При необходимости включите его на сервере '''ClickHouse''':<pre>
sudo sysctl -w kernel.task_delayacct=1
</pre>Для постоянного применения добавьте параметр в конфигурацию <code>sysctl</code> согласно правилам вашей '''ОС'''.

== Создание пользователя ClickHouse ==
Пример пользователя с минимальными правами чтения:<pre>
CREATE USER astromkey
IDENTIFIED WITH sha256_password BY 'ЗАМЕНИТЕ_ПАРОЛЬ';

GRANT SELECT ON system.metrics TO astromkey;
GRANT SELECT ON system.events TO astromkey;
GRANT SELECT ON system.asynchronous_metrics TO astromkey;
</pre>

== История изменений ==

{| class="wikitable"
!Версия
!Изменения
|-
|1.0.26
|
* Версия расширения для Ключ-АСТРОМ <code>1.285+</code>.
* Добавлен удалённый мониторинг ClickHouse через HTTP- и HTTPS-интерфейсы.
* Добавлены метрики доступности сервера, состояния реплик и времени работы.
* Добавлен сбор показателей из системных таблиц ClickHouse.
|}

ClickHouse

2026-09-15T19:13:51Z

Aleksandr.Zubarev:

= Расширение Ключ-АСТРОМ для мониторинга ClickHouse =
Python-расширение '''Extensions 2.0''' для мониторинга серверов '''ClickHouse''' через '''HTTP'''-интерфейс.

== Требования ==

* АктивныйШлюз с включённым выполнением расширений.
* С АктивногоШлюза должен быть доступен '''HTTP'''- или '''HTTPS'''-интерфейс '''ClickHouse'''.
* Пользователь '''ClickHouse''' с правами чтения системных таблиц мониторинга.

== Какие данные собираются ==
Коллектор получает все числовые значения из следующих таблиц:
{| class="wikitable"
!Таблица ClickHouse
!Префикс метрик Ключ-АСТРОМ
!Назначение
|-
|<code>system.metrics</code>
|<code>clickhouse.metrics.*</code>
|Текущие значения: выполняемые запросы, слияния, память и другие показатели
|-
|<code>system.events</code>
|<code>clickhouse.events.*</code>
|Накопительные счётчики запросов, строк, байтов, '''CPU''' и операций ввода-вывода
|-
|<code>system.asynchronous_metrics</code>
|<code>clickhouse.asynchronous.*</code>
|'''CPU''', память, '''MergeTree''' и другие системные показатели
|}
Дополнительно расширение отправляет:
{| class="wikitable"
!Метрика
!Описание
|-
|<code>clickhouse.topology</code>
|Служебная метрика для создания сущности хоста
|-
|<code>clickhouse.host.availability</code>
|Результат проверки <code>/ping</code>: 1 — доступен, 0 — недоступен
|-
|<code>clickhouse.host.replica_status</code>
|Результат <code>/replicas_status</code>: 1 — реплика исправна, 0 — недоступна или отстаёт
|-
|<code>clickhouse.host.uptime</code>
|Время работы сервера в секундах
|}
Метрика <code>OSIOWaitMicroseconds</code> формируется '''ClickHouse''' только при включённом '''Linux''' <code>task_delayacct</code>.

При необходимости включите его на сервере '''ClickHouse''':<pre>
sudo sysctl -w kernel.task_delayacct=1
</pre>Для постоянного применения добавьте параметр в конфигурацию <code>sysctl</code> согласно правилам вашей '''ОС'''.

== Создание пользователя ClickHouse ==
Пример пользователя с минимальными правами чтения:<pre>
CREATE USER astromkey
IDENTIFIED WITH sha256_password BY 'ЗАМЕНИТЕ_ПАРОЛЬ';

GRANT SELECT ON system.metrics TO astromkey;
GRANT SELECT ON system.events TO astromkey;
GRANT SELECT ON system.asynchronous_metrics TO astromkey;
</pre>

== История изменений ==

{| class="wikitable"
!Версия
!Изменения
|-
|1.0.26
|
* Версия расширения для Ключ-Астроном <code>1.285+</code>.
* Добавлен удалённый мониторинг ClickHouse через HTTP- и HTTPS-интерфейсы.
* Добавлены метрики доступности сервера, состояния реплик и времени работы.
* Добавлен сбор показателей из системных таблиц ClickHouse.
|}

Ceph

2026-09-15T19:08:50Z

Aleksandr.Zubarev:

= Расширение Ceph storage =

Осуществляйте мониторинг использования распределенного хранилища '''Ceph''', состояния '''OSD''' и производительности пулов на уровне клиента и хоста с помощью метрик '''Prometheus''' и информационных панелей.

== Начало работы ==
=== Обзор ===
Отслеживайте использование системы хранения '''Ceph''' как на стороне клиента, так и на уровне хоста. Используйте расширение '''Ceph storage''' для:
* Мониторинга использования и производительности вашей платформы '''Ceph'''.
* Постоянного получения актуальной информации о ресурсах хоста и потоке данных.
* Сокращения до минимума времени анализа, необходимого для выявления первопричины возможных системных сбоев.

=== Варианты использования ===
* Мониторинг использования ресурсов хоста и уровней его емкости.
* Сбор данных об активных и неактивных демонах объектного хранилища '''Ceph'''.
* Наблюдение за потоком данных системы с точки зрения операций записи и чтения, как для кластера в целом, так и для отдельных '''OSD'''.

=== Требования ===
* Хранилище '''Ceph''', работающее в вашей среде.
* Расширение активировано в вашей среде с помощью встроенного раздела '''Расширения'''.

== Подробности ==
=== Лицензирование и стоимость ===
Расширение '''Ceph storage''' собирает пользовательские метрики, которые, в зависимости от вашей лицензионной модели, могут либо потреблять '''DDUs''', либо учитываться как '''метрики в рамках вашей подписки на платформу Ключ-АСТРОМ'''. Ниже приведена формула для оценки потребления лицензии для этого расширения:
* '''DDUs''' для всех включенных метрик: ((3 * кол-во мониторов) + (7 * кол-во кластеров) + (13 * кол-во '''OSD''') + (9 * кол-во групп размещения)) * 60 мин * 24 ч * 365 дней * 0.001
* Точек данных для всех включенных метрик: ((3 * кол-во мониторов) + (7 * кол-во кластеров) + (13 * кол-во '''OSD''') + (9 * кол-во групп размещения)) * 60 мин * 24 ч * 365 дней

== Наборы функций ==
При активации расширения с помощью '''конфигурации мониторинга''' вы можете ограничить мониторинг одним из наборов функций. Для корректной работы расширение должно собирать хотя бы одну метрику после активации. В сильно сегментированных сетях наборы функций могут отражать сегменты вашей среды. Затем, при создании конфигурации мониторинга, вы можете выбрать набор функций и соответствующую группу АктивныхШлюзов, которая может подключаться к этому конкретному сегменту. Все метрики, не отнесенные ни к одному набору функций, считаются заданными по умолчанию и всегда передаются. Метрика наследует набор функций подгруппы, которая, в свою очередь, наследует набор функций группы. Кроме того, набор функций, определенный на уровне метрики, переопределяет набор функций, определенный на уровне подгруппы, который, в свою очередь, переопределяет набор функций, определенный на уровне группы.

== pool ==
{| class="wikitable"
|-
! Название метрики !! Ключ метрики !! Описание
|-
| Objects count || ceph_pool_objects || Количество объектов в пуле
|-
| Recovered objects || ceph_pool_num_objects_recovered || Количество восстановленных объектов в пуле
|-
| Recovered bytes || ceph_pool_num_bytes_recovered || Количество восстановленных байт в пуле
|-
| Pool objects quota || ceph_pool_quota_objects || Квота объектов, установленная для пула
|-
| Pool bytes quota || ceph_pool_quota_bytes || Квота байт, установленная для пула
|}

== health ==
{| class="wikitable"
|-
! Название метрики !! Ключ метрики !! Описание
|-
| Health status || ceph_health_status || Состояние здоровья кластера
|-
| Slow operations || ceph_healthcheck_slow_ops || Запросы '''OSD''' или монитора, обработка которых занимает много времени
|}

== osdLatency ==
{| class="wikitable"
|-
! Название метрики !! Ключ метрики !! Описание
|-
| OSD apply latency || ceph_osd_apply_latency_ms || Задержка операции «применение» на '''OSD'''
|-
| OSD commit latency || ceph_osd_commit_latency_ms || Задержка операции «фиксация» на '''OSD'''
|-
| OSD write latency sum || ceph_osd_op_w_latency_sum || Общая задержка операций «запись» на '''OSD'''
|-
| OSD read latency sum || ceph_osd_op_r_latency_sum || Общая задержка операций «чтение» на '''OSD'''
|}

== osdOperations ==
{| class="wikitable"
|-
! Название метрики !! Ключ метрики !! Описание
|-
| Bytes written || ceph_osd_op_w_in_bytes || Общий объем байт, записанных на '''OSD'''
|-
| Bytes read || ceph_osd_op_r_out_bytes || Общий объем байт, прочитанных с '''OSD'''
|-
| Write operations || ceph_osd_op_w || Общее количество операций записи, выполненных на '''OSD'''
|-
| Read operations || ceph_osd_op_r || Общее количество операций чтения, выполненных на '''OSD'''
|-
| Recovery operations || ceph_osd_recovery_ops || Количество операций восстановления в '''OSD'''
|}

== Placement Groups ==
{| class="wikitable"
|-
! Название метрики !! Ключ метрики !! Описание
|-
| PG active || ceph_pg_active || Группа размещения активна на пул
|-
| PG down || ceph_pg_down || Группа размещения недоступна на пул
|-
| PG clean || ceph_pg_clean || Группа размещения чиста на пул
|-
| PG backfill toofull || ceph_pg_backfill_toofull || Группа размещения переполнена на пул
|-
| PG degraded || ceph_pg_degraded || Группа размещения деградировала на пул
|-
| PG failed repair || ceph_pg_failed_repair || Группа размещения с ошибкой восстановления на пул
|-
| PG incomplete || ceph_pg_incomplete || Группа размещения неполная на пул
|-
| PG stale || ceph_pg_stale || Группа размещения устарела на пул
|-
| PG inconsistent || ceph_pg_inconsistent || Группа размещения несогласованна на пул
|}

== default ==
{| class="wikitable"
|-
! Название метрики !! Ключ метрики !! Описание
|-
| Total capacity || ceph_cluster_total_bytes || Общая емкость кластера в байтах
|-
| Used capacity || ceph_cluster_total_used_bytes || Использованная емкость кластера в байтах
|-
| Monitor metadata || ceph_mon_metadata || Метрика-заполнитель для получения измерений метаданных монитора от экспортера
|-
| OSD metadata || ceph_osd_metadata || Метрика-заполнитель для получения измерений метаданных '''OSD''' от экспортера
|}

== osdState ==
{| class="wikitable"
|-
! Название метрики !! Ключ метрики !! Описание
|-
| OSD in || ceph_osd_in || Demons хранения в кластере
|-
| OSD up || ceph_osd_up || Demons хранения запущены
|-
| Placement groups || ceph_osd_numpg || Группы размещения
|}

== monState ==
{| class="wikitable"
|-
! Название метрики !! Ключ метрики !! Описание
|-
| Open sessions || ceph_mon_num_sessions || Количество открытых сессий монитора
|-
| Quorum status || ceph_mon_quorum_status || Demons монитора в кворуме
|}

== История изменений ==

{| class="wikitable"
!Версия
!Изменения
|-
|1.1.3
|
* Версия расширения для Ключ-Астроном <code>1.296.0+</code>.
* Мониторинг Ceph через источник данных Prometheus.
* Начало поддержки расширения.
|}

Cassandra

2026-09-15T19:05:01Z

Aleksandr.Zubarev:

= Мониторинг Cassandra в Ключ-АСТРОМ =

Инструкция по настройке расширения '''Apache Cassandra JMX'''.

Расширение подключается к серверу '''Cassandra''' через '''JMX''' ('''Java Management Extension''') и собирает метрики кластера, нодов, кэшей, пулов потоков и исключений. Обеспечивает полную наблюдаемость за производительностью и работоспособностью СУБД '''Cassandra'''.

== Возможности расширения ==

=== Что делает ===

* Подключается к серверу '''Cassandra''' через '''JMX'''.
* Собирает метрики кластера и отдельных нодов: исключения, неудачные запросы, задержки операций чтения/записи, загрузка хранилища, состояние пулов потоков и сборка мусора '''JVM'''.
* Создает сущности '''Cluster''' и '''Node''' со связями между ними.
* Предоставляет готовый дашборд «Cassandra JMX Overview» для визуализации ключевых метрик.
* Автоматически обнаруживает хосты с '''Cassandra''' при включении глобального мониторинга.

=== Что не делает ===

* Не устанавливает и не настраивает '''Cassandra'''.
* Не собирает метрики со стороны клиентских приложений (только серверная часть).
* Не выполняет трассировку запросов между приложениями (для этого требуется ЕдиныйАгент на клиентских приложениях).
* Не подключается через '''Management API''' или '''HTTP''' — только через '''JMX'''.

== Предварительные условия ==

# Версия '''Cassandra''': 2.xx или выше.
# Версия Ключ-Астроном: 1.318.0 или выше.
# На хосте с '''Cassandra''' установлен ЕдиныйАгент Ключ-АСТРОМ, контроллер выполнения расширений ('''EEC''') включен.
# Подготовлен пакет расширения (<code>.zip</code>) для загрузки в Расширения — либо расширение уже доступно в каталоге Расширений.
# '''JMX'''-порт '''Cassandra''' (по умолчанию 7199) должен быть доступен для ЕдиногоАгента.
# Для сбора метрик с удаленных нодов требуется настроенный АктивныйШлюз с сетевым доступом к '''JMX'''-портам '''Cassandra'''.

== Рекомендация по подключению ==
При локальном мониторинге (ЕдиныйАгент на том же хосте, что и '''Cassandra''') расширение подключается к '''JMX''' через loopback-адрес. Для удаленного сбора убедитесь, что АктивныйШлюз имеет сетевой доступ к нодам '''Cassandra''' и порт '''JMX''' (7199) открыт.

Важно: Расширение использует '''JMX''' для сбора метрик. Убедитесь, что '''JMX'''-сервер '''Cassandra''' включен и настроен для удаленного доступа при необходимости.

== Шаг 1. Включение глобального мониторинга Cassandra ==
Для автоматического обнаружения хостов с '''Cassandra''':

# Откройте веб-интерфейс Ключ-АСТРОМ.
# Перейдите в '''Настройки''' → '''Мониторинг''' → '''Отслеживаемые технологии'''.
# В списке '''Поддерживаемые технологии''' найдите строку '''Cassandra JMX'''.
# Включите переключатель '''Cassandra JMX'''.

После включения ЕдиныйАгент будет автоматически обнаруживать процессы '''Cassandra''' на всех хостах.

== Шаг 2. Загрузка расширения в Расширения ==
Если расширение еще не установлено в окружении:

# Откройте '''Расширения''' → раздел '''Extensions'''.
# Нажмите '''Загрузить расширение''' и выберите загрузку пользовательского/custom-расширения.
# Укажите файл <code>.zip</code>-пакета расширения '''Apache Cassandra JMX'''.
# Дождитесь успешной проверки подписи и загрузки.
# Активируйте нужную версию расширения для окружения.

Если расширение уже присутствует в Расширениях окружения, откройте его карточку и убедитесь, что требуемая версия активна.

После активации перейдите на вкладку '''Конфигурация''' — можно добавлять конфигурацию мониторинга.

== Шаг 3. Выбор источника мониторинга ==
Для типичного сценария «ЕдиныйАгент на хосте с Cassandra» выберите нужный хост. Убедитесь, что у хоста '''EEC''' отображается как «Включено».

== Контрольный список ==
{| class="wikitable"
!№
!Пункт
|-
|1
|На сервере '''Cassandra''' включен и доступен '''JMX'''-сервер (порт 7199).
|-
|2
|Включен глобальный мониторинг '''Cassandra JMX''' в '''Настройки''' → '''Отслеживаемые технологии'''.
|-
|3
|Пакет расширения загружен в Расширения и активирован.
|-
|4
|Конфигурация мониторинга добавлена и включена, состояние '''Ok'''.
|-
|5
|Выбран корректный режим (локально / удаленно).
|-
|6
|Указаны корректные параметры подключения (порт '''JMX''', при необходимости — учетные данные).
|-
|7
|На дашборде и в сущностях отображаются метрики '''Cassandra'''.
|}

== Возможные проблемы ==
{| class="wikitable"
!Симптом
!Что проверить
|-
|Состояние конфигурации не '''Ok'''
|Сетевая доступность '''JMX'''-порта '''Cassandra''' (7199) с хоста ЕдиногоАгента/АктивногоШлюза, статус '''EEC'''. Убедитесь, что '''JMX'''-сервер запущен.
|-
|Ошибка авторизации
|Проверьте логин и пароль для '''JMX'''-аутентификации. Убедитесь, что пользователь имеет права.
|-
|Нулевые значения метрик
|Ожидаемо при отсутствии нагрузки или если расширение еще не завершило первый цикл сбора.
|-
|Требуется удаленный сбор
|Группа АктивныхШлюзов с сетевым доступом к '''JMX'''-портам '''Cassandra'''. Убедитесь, что '''JMX'''-сервер настроен для удаленного доступа.
|}

== История изменений ==

{| class="wikitable"
!Версия
!Изменения
|-
|1.2.0
|
* Начало поддержки расширения.

|}

Расширение Oracle Database

2026-09-15T18:50:32Z

Aleksandr.Zubarev:

{| class="wikitable"
!Версия
!Изменения

|-
|3.7.6
|Обновление расширения

* Минимальная поддерживаемая версия Ключ-АСТРОМ повышена до <code>1.310.0</code>, минимальная версия EEC — до <code>1.301.0</code>.
* Добавлены метрики времени работы, состояния RAC, заблокированных сеансов, взаимных блокировок и повреждённых блоков данных.
* Добавлены метрики и журналы для анализа наиболее ресурсоёмких SQL-запросов.
* Добавлены сущности топологии для кластера, экземпляра, базы данных, заданий резервного копирования, групп и дисков ASM.
* Добавлены и обновлены оповещения о недоступности экземпляров и PDB, состоянии табличных пространств, файлов данных и Data Guard.
* Добавлен обзорный дашборд <code>documents/overview.dashboard.json</code>.
|-
|2.3.0
|Улучшения в этой версии:

* Удален параметр <code>event</code> из <code>com.astromkey.extension.sql-oracle.wait.count</code> и <code>com.astromkey.extension.sql-oracle.wait.time.count</code> для предотвращения непреднамеренно высокого потребления DDU. Для замены прежней функциональности был добавлен новый набор функций, <code>waitEvents (detailed)</code>, с метриками <code>com.astromkey.extension.sql-oracle.wait.events.count</code> и <code>com.astromkey.extension.sql-oracle.wait.events.time.count</code> который отслеживает общее время ожидания и общее время ожидания для 20 наиболее частых событий ожидания. При обновлении конфигураций мониторинга до новой версии убедитесь, что вы включили новый набор функций, чтобы продолжить получать информацию на уровне событий.
|-
|2.2.3
|Исправлено в этой версии:

* Плитки ASM Disks на дашборде использовали устаревшие названия метрик.
|-
|2.2.2
|Исправлено в этой версии:

* Запросы ASM Disk Groups и ASM Disks не будут выполняться из-за синтаксиса
|-
|2.2.1
|Новое в этой версии:

* Отслеживание зоны быстрого восстановления (FRA)
* Табличные пространства отслеживаются по контейнерам (CDB и PDB)
* Группы дисков ASM отслеживаются как отдельные сущности, связанные с дисками ASM
* Состояние данных и временных файлов отслеживается для каждого контейнера (CDB и PDB).
* Мониторинг защиты данных
** Тяжелые события
** Разрыв между основной и резервной последовательностями применения
** Количество нерегистрируемых действий
** Статус ошибки назначения архива

Улучшения в этой версии:

* Использование табличного пространства рассчитывается на основе максимально возможного размера, включая автоматические экстенты.
* Использование табличного пространства <code>CDB_TABLESPACE_USAGE_METRICS</code> отражается с учетом базовой файловой системы (такой же, как в Oracle Enterprise Manager)
* Использование сеансов и процессов отображается в процентах от настроенного лимита.
|-
|2.1.5
|Новое в этой версии:

* Данные расширения теперь можно использовать с приложением «Обзор базы данных».
* Задания резервного копирования регистрируют дополнительные сведения на основе своих наборов резервных копий.
* Время с момента последнего резервного копирования данного типа теперь регистрируется как метрика

Улучшения в этой версии:

* Более четко описан параметр конфигурации времени ожидания запроса.

Исправлено в этой версии:

* Диаграмма табличных пространств на странице «Экземпляр» отображала длинное имя выражения метрики.
* Не все резервные копии были обнаружены и перечислены на странице экземпляра.
|-
|2.0.0
|Критические изменения:

Из-за изменений топологии, упомянутых ниже, ваша среда может создавать новые сущности для замены созданных старыми версиями расширения.

Любая пользовательская конфигурация, основанная на следующих типах сущностей, работать не будет:

* <code>sql:com_astromkey_extension_sql-oracle_cdb</code>
* <code>sql:com_astromkey_extension_sql-oracle_pdb</code> (заменить на <code>sql:com_astromkey_extension_sql-oracle_database</code>)
* <code>sql:com_astromkey_extension_sql-oracle_service</code>

Новое в этой версии:

* Дополнительные атрибуты, сообщаемые для экземпляров Oracle
* Когда расширение настроено на подключение к контейнеру (CDB), все базы данных (PDB) автоматически отслеживаются.
* Добавлено новое оповещение о сбоях заданий резервного копирования.

Улучшения в этой версии:

* Топология была упрощена:
** Экземпляр Oracle теперь представляет собой либо автономный экземпляр, либо контейнер.
** Идентификаторы этих сущностей теперь рассчитываются точнее.
** Oracle Database теперь представляет собой либо автономную, либо подключаемую базу данных.
** Удалены сущности Oracle CDB, Oracle PDB и Oracle Service.
* Резервные копии базы данных видны на странице сведений об экземпляре.
* Все списки сущностей поддерживают фильтрацию
* На странице сведений о сервере Oracle отображаются данные о процессах Oracle, если на хосте развернут ЕдиныйАгент.
* Все метрики имеют тег «Oracle», который можно использовать в меню «Метрики».

Исправлено в этой версии:

* Резервные копии не будут обнаружены, если процесс завершится сбоем до завершения первого подзадания.
* Резервные копии будут объединены, если они выполнены в течение одного сеанса.
|}

== Обзор ==
Ключ-АСТРОМ автоматически определяет все приложения и микросервисы, развернутые в вашей системе, а также то, как ваша система использует '''Oracle Database'''.

Ключ-АСТРОМ диагностирует аномалии в режиме реального времени с помощью ИИ и выявляет первопричину медленно работающих или ошибочных '''SQL-запросов'''. Глубокий анализ кода в сочетании с облачным мониторингом серверов баз данных поможет вам обеспечить надежную производственную среду.

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

== Варианты использования ==

* Понять зависимости приложений от баз данных: какие запросы выполняются и какова их производительность.
* Повысить производительность приложений за счёт оптимизации типичных паттернов БД, например проблемы 1+N-запросов.
* Определить, как приложения нагружают базу данных.
* Понять, как нехватка ресурсов или ошибки на стороне БД влияют на приложения.
* Анализировать аудит-логи БД, чтобы выявлять неудачные попытки входа.
* Отслеживать состояние и производительность серверов '''Oracle''' (одиночных или мультиарендных).
* Отслеживать наиболее ресурсоёмкие запросы.
* Ускорить диагностику проблем в приложениях, вызванных базой данных.

== Начать ==
Это удалённое расширение, работающее через АктивныйШлюз в вашей среде и подключающееся к каждой базе данных '''Oracle''', которую необходимо отслеживать. Выполняется серия запросов к различным представлениям баз данных, и данные отправляются обратно в Ключ-АСТРОМ.

=== Начало работы для клиентов Oracle Database: ===
Если приложение, подключающееся к серверу '''Oracle Database''', работает на виртуальной машине или на физическом сервере, установите на него ЕдиныйАгент, чтобы начать работу.

Если приложение, подключающееся к серверу '''Oracle Database''', работает как рабочая нагрузка в '''Kubernetes''' или '''OpenShift''', настройте Ключ-АСТРОМ на '''Kubernetes''' или '''OpenShift''' .

Активируйте следующие функции ЕдиногоАгента, чтобы получить полную информацию об отслеживании:

* '''Node.js Oracle DB'''
* '''PHP Oracle'''

=== Начните работу для серверов Oracle Database: ===
Если ваш сервер '''Oracle Database''' работает на виртуальной машине или на аппаратном уровне, установите на нем ЕдиныйАгент, чтобы начать работу с показателями производительности системы.

Активируйте удалённое расширение '''Oracle Database''', чтобы получить полную информацию о состоянии и производительности сервера '''Oracle Database''', включая метрики и события. Расширение собирает данные, напрямую запрашивая представления производительности базы данных, поэтому для его работы требуется подключение к ней.

Для мониторинга рекомендуется создать отдельную учётную запись пользователя. Для удобства скрипты создания пользователей можно найти [https://github.com/dynatrace-extensions/convenience-scripts/tree/main/oracle-db здесь]. Эти скрипты создают пользователя с ролями <code>CREATE_SESSION</code> и разрешениями <code>SELECT</code> для следующих представлений производительности:

* <code>CDB_DATA_FILES</code>
* <code>CDB_TABLESPACE_USAGE_METRICS</code>
* <code>CDB_TABLESPACES</code>
* <code>CDB_TEMP_FILES</code>
* <code>GV_$ARCHIVE_DEST</code>
* <code>GV_$ARCHIVE_DEST_STATUS</code>
* <code>V_$ASM_DISK_STAT</code>
* <code>V_$ASM_DISKGROUP_STAT</code>
* <code>V_$BACKUP_SET_DETAILS</code>
* <code>GV_$CLUSTER_INTERCONNECTS</code>
* <code>GV_$CONTAINERS</code>
* <code>V_$CONTAINERS</code>
* <code>GV_$CON_SYS_TIME_MODEL</code>
* <code>GV_$CON_SYSSTAT</code>
* <code>GV_$DATABASE</code>
* <code>V_$DATABASE</code>
* <code>V_$DATABASE_BLOCK_CORRUPTION</code>
* <code>GV_$DATAFILE</code>
* <code>V_$DATAFILE</code>
* <code>GV_$DATAGUARD_STATUS</code>
* <code>GV_$INSTANCE</code>
* <code>GV_$INSTANCE_PING</code>
* <code>GV_$LIBRARYCACHE</code>
* <code>V_$LOG</code>
* <code>GV_$METRIC</code>
* <code>GV_$METRICGROUP</code>
* <code>GV_$PARAMETER</code>
* <code>GV_$PDBS</code>
* <code>GV_$PGASTAT</code>
* <code>V_$RECOVER_FILE</code>
* <code>V_$RECOVERY_FILE_DEST</code>
* <code>GV_$RESOURCE_LIMIT</code>
* <code>V_$RMAN_BACKUP_JOB_DETAILS</code>
* <code>GV_$SESSION</code>
* <code>V_$SESSION</code>
* <code>GV_$SGASTAT</code>
* <code>GV_$SQL</code>
* <code>V_$SQL</code>
* <code>GV_$SQLAREA</code>
* <code>V_$SQL_PLAN</code>
* <code>GV_$SQL_PLAN</code>
* <code>V_$SQL_PLAN_STATISTICS_ALL</code>
* <code>GV_$SYSSTAT</code>
* <code>GV_$SYSTEM_EVENT</code>
* <code>GV_$SYSTEM_WAIT_CLASS</code>
* <code>V_$TABLESPACE</code>
* <code>V_$TEMPFILE</code>

В качестве альтернативы <code>SELECT_CATALOG_ROLE</code> можно назначить пользователю, осуществляющему мониторинг.

Для мониторинга мультиарендной конфигурации '''Oracle DB''' убедитесь, что расширение указывает на '''CDB'''. Обнаружение и мониторинг '''PDB''' будут выполняться автоматически. В этом случае необходимы явные разрешения на доступ к данным во всех контейнерах:

<code>alter user <your_username> set container_data=all container = current;</code>

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

Пользователям приложения '''Базы данных''', желающим использовать планы выполнения запросов, также необходимо предоставить разрешение для представлений <code>V$SQL_PLAN</code>, <code>V$SESSION</code>, <code>V$SQL_PLAN_STATISTICS_ALL</code> и <code>V$SQL</code>. Эти разрешения включены в скрипты создания пользователей. Подробнее см. в разделе '''Мониторинг планов выполнения''' ниже.

Наконец, активируйте мониторинг логов, чтобы получить полную картину логов.

'''Примечание''':

При использовании набора функций '''TopN''' расширение выводит отчеты о наиболее затратных по времени запросах на странице сущностей экземпляра '''Oracle''' в разделе '''Логи'''. Включение этой функции может привести к раскрытию конфиденциальных данных в отчетах о запросах.

== Подробности ==

==== Этот пакет расширения содержит: ====

* Определения топологии и взаимосвязей для кластеров '''RAC''', заданий резервного копирования, баз данных, экземпляров, дисков '''ASM''' и групп дисков '''ASM'''.
* Классический и новый дашборд, предлагающий обзор мониторинга среды '''Oracle Database'''.
* Оповещения об ошибках резервного копирования, недоступных '''PDB''', недоступных экземплярах, высоком использовании табличного пространства и т.д.
* Страница унифицированного анализа для вышеупомянутой топологии

== Информация о совместимости ==
Поддерживаются следующие версии '''Oracle''':

* '''Oracle DB 12.2+'''

Поддерживаются следующие архитектуры:

* Автономные серверы '''Oracle'''
* '''Oracle Multitenant (CDB/PDB)'''
** Настройка мониторинга '''CDB''' для обнаружения всех '''PDB'''
* '''Oracle AWS RDS'''
* '''Oracle RAC'''
** Настройка мониторинга для '''SCAN''' обнаружения всех экземпляров и баз данных.

== Управление логами и аналитика ==

=== Отслеживание файлов логов аудита ===

==== Проверка местоположения файла логов ====

* <code>SELECT name, value FROM v$parameter WHERE name = 'audit_trail';</code>

<code>OS</code> означает, что логи аудита хранятся локально в файле.

* <code>SELECT value FROM v$parameter WHERE name = 'audit_file_dest';</code>

указывает местоположение файла логов

==== Добавить правила безопасности LogAgent ====
Настройте правила безопасности '''LogAgent''', чтобы разрешить доступ к локальным файлам, добавив файл <code>oracle.json</code> в:

* в Linux/UNIX: <code>/var/lib/astromkey/oneagent/agent/config/logmodule</code>
* в Windows: <code>%PROGRAMDATA%\astromkey\oneagent\agent\config\logmodule</code>

{
"@version": "1.0.0",
"allowed-log-paths-configuration": [
{
"directory-pattern": "/u01/app/oracle/admin/oracle_standalone/adump/",
"file-pattern": "*.aud",
"action": "INCLUDE"
}
]
}
Перезапуск агента не требуется, данная конфигурация будет применена в течение 1 минуты.

==== Настройте собственный источник логов и правила приема логов ====

===== Пользовательский источник логов =====
Используйте местоположение файла логов, полученное с помощью запроса, выполненного на первом этапе, например <code>/u01/app/oracle/admin/oracle_standalone/adump/*</code>.

===== Правила приема логов =====
Пример конфигурации, которая включает только сообщения <code>ORA-01017</code> о попытках входа с недействительным именем пользователя или паролем, можно настроить с помощью: <code>Log content is any of: (.*)RETURNCODE:\[(\d+)\] "1017 AND Log source is any of: /u01/app/oracle/admin/oracle_standalone/adump/*</code>

==== Доступ к логам ====
Доступ к логам, собранным описанным выше способом, можно получить с помощью следующего '''DQL-запроса''': <code>fetch logs | filter matchesValue(log.source, "/u01/app/oracle/admin/oracle_standalone/adump/*")</code>.

==== Извлечение метрик ====

===== Правило обработки логов =====
Настройте правило обработки логов для извлечения атрибутов лога из его содержимого:

* '''Имя правила''': предпочтительное имя
* '''Сопоставитель''': <code>matchesValue(log.source, "/u01/app/oracle/admin/oracle_standalone/adump/*")</code>
* '''Определение процессора''':

PARSE(content, "
DATA ' RETURNCODE:['INT']' SPACE '\"' INT:ora.returncode LD") |
PARSE(content, "
DATA ' USERID:['INT']'SPACE CSVDQS:ora.userid LD") |
PARSE(content, "
DATA ' USERHOST:['INT']'SPACE CSVDQS:ora.userhost LD")

===== Извлечение метрических данных =====
Извлеките показатели из записей логов для включения оповещений:

* '''Метрический ключ''': например <code>log.oracle.invalid_credentials</code>
* '''Сопоставитель''': <code>matchesValue(log.source, "/u01/app/oracle/admin/oracle_standalone/adump/*")</code>
* '''Метрические измерения''': <code>Occurence of logs records</code>
* '''Измерения''': укажите атрибуты журнала, которые будут использоваться в качестве метрических измерений.

== Мониторинг плана выполнения ==
Для клиентов SaaS, имеющих доступ к приложению «Базы данных», функция мониторинга плана выполнения также доступна при анализе эффективности выполнения выписок.

Для работы функции <code>DBMS_XPLAN</code> пакет должен быть доступен, а пользователь, настроенный в расширении Ключ-АСТРОМ, должен иметь разрешения на вызов функции <code>DISPLAY_CURSOR</code>. Согласно официальной документации, это означает, что для следующих представлений <code>SELECT</code>, <code>READ</code> требуются разрешения:

* <code>V$SQL_PLAN</code>
* <code>V$SESSION</code>
* <code>V$SQL_PLAN_STATISTICS_ALL</code>
* <code>V$SQL</code>

В дополнение к этому, разрешение <code>SELECT</code> также требуется для <code>V$SQL_PLAN</code>.

== Маскировка конфиденциальных данных ==
Отслеживание производительности запросов может раскрыть конфиденциальные данные в отчётах. Поэтому Ключ-АСТРОМ предоставляет дополнительный механизм, позволяющий маскировать выбранные атрибуты.

Представленные ниже конфигурации представляют собой пример того, как конфиденциальные данные могут быть замаскированы в отслеживаемых выписках.

* Создать новое правило обработки можно в разделе <code>Настройки -> Мониторинг -> Процессы</code>
** Определение процесса: <code>USING(INOUT content) | FIELDS_ADD(content: REPLACE_PATTERN(content, "(\"'\"):p1 (LD):p2 (\"'\"):p3", "${p1}${p2|sha1}${p3}"))</code>
* Или создайте/измените свое собственное расширение для распространения таких правил в вашей среде:

logProcessingRules:
- ruleName: TopN statements masking
query: event.group="query_performance"
enabled: true
ProcessorDefinition:
rule: |
USING(INOUT content) | FIELDS_ADD(content: REPLACE_PATTERN(content, "(\"'\"):p1 (LD):p2 (\"'\"):p3", "${p1}${p2|sha1}${p3}"))
RuleTesting:
sampleLog: |
{
"event.group": "query_performance",
"content": "/*dt:ownQuery*/SELECT DECODE(name, 'sessions', value) AS sessions_limit, DECODE(name, 'processes', value) AS processes_limit FROM v$parameter WHERE name IN('sessions', 'processes')"
}
Измените это правило в соответствии с вашим вариантом использования.

== Лицензирование ==
Метрики, собираемые с помощью этого расширения, используют единицы данных ИИ Ключ-АСТРОМ (см. [[DDU для пользовательских событий ИИ|DDU для метрик]]).

Грубую оценку количества '''DDU''', потребляемых метрическим методом, можно получить с помощью следующей формулы:
(55 * number of instances * 525.6) + (7 * number of databases * 525.6) + (8 * number of backup jobs per year * 0.005) + (5 * number of ASM disks * 525.6) + (3 * number of ASM disk groups * 525.6)
Для логов действует стандартное потребление '''DDU''' для мониторинга логов. В зависимости от вашей модели лицензирования, см. потребление [[DDU для лога мониторинга|DDU для мониторинга логов]].

Расширение UPS Device

2026-09-15T18:47:55Z

Aleksandr.Zubarev:

{| class="wikitable"
!Версия
!Изменения

|-
|1.0.1
|Обновление расширения

* Минимальная поддерживаемая версия Ключ-АСТРОМ повышена до <code>1.309.0</code>.
* Добавлен обзорный дашборд <code>documents/ups_overview.dashboard.json</code>.

|-
|1.0.0
|
* Сбор показателей батареи UPS и входной/выходной мощности/байпаса
* Обзорный дашборд
* Пользовательские правила топологии
|}

== Обзор ==
Это расширение собирает важные метрики инфраструктуры '''UPS''' для мониторинга состояния и надежности устройств. Метрики собираются с помощью '''SNMP-запросов'''.

== Варианты использования ==

* Проверьте состояние батареи '''UPS''', например уровень заряда или оставшееся время.
* Выявляйте аномалии в работе устройств и предотвращайте сбои в работе центров обработки данных

== Начать ==
Просто активируйте расширение в своей среде с помощью встроенного в продукт Ключ-АСТРОМ в разделе '''Расширения''', выполните необходимые настройки устройства — и все готово.

== Подробности ==
Пакет расширения содержит:

* Конфигурация источника данных '''SNMP'''
* Обзорный дашборд
* Пользовательские типы топологии, извлеченные из метрических измерений
** UPS Device

Файлы '''SNMP''' '''MIB''', используемые для мониторинга:

* UPS-MIB
* RFC1213-MIB

== Информация о совместимости ==

* Большинство производителей и моделей UPS (поддерживается UPS-MIB)

Расширение UPS Device

2026-09-15T18:47:40Z

Aleksandr.Zubarev:

{| class="wikitable"
!Версия
!Изменения

|-
|1.0.1
|Обновление расширения

* Минимальная поддерживаемая версия Ключ-АСТРОМ повышена до <code>1.309.0</code>.
* Добавлен обзорный дашборд <code>documents/ups_overview.dashboard.json</code>.
* Тип топологии UPS Device переведён с <code>snmp:com_dynatrace_extension_ups_device</code> на <code>snmp:ru_ruscomtech_extension_ups_device</code>.

|-
|1.0.0
|
* Сбор показателей батареи UPS и входной/выходной мощности/байпаса
* Обзорный дашборд
* Пользовательские правила топологии
|}

== Обзор ==
Это расширение собирает важные метрики инфраструктуры '''UPS''' для мониторинга состояния и надежности устройств. Метрики собираются с помощью '''SNMP-запросов'''.

== Варианты использования ==

* Проверьте состояние батареи '''UPS''', например уровень заряда или оставшееся время.
* Выявляйте аномалии в работе устройств и предотвращайте сбои в работе центров обработки данных

== Начать ==
Просто активируйте расширение в своей среде с помощью встроенного в продукт Ключ-АСТРОМ в разделе '''Расширения''', выполните необходимые настройки устройства — и все готово.

== Подробности ==
Пакет расширения содержит:

* Конфигурация источника данных '''SNMP'''
* Обзорный дашборд
* Пользовательские типы топологии, извлеченные из метрических измерений
** UPS Device

Файлы '''SNMP''' '''MIB''', используемые для мониторинга:

* UPS-MIB
* RFC1213-MIB

== Информация о совместимости ==

* Большинство производителей и моделей UPS (поддерживается UPS-MIB)

Расширение Redis

2026-09-15T18:47:04Z

Aleksandr.Zubarev:

{| class="wikitable"
!Версия
!Изменения

|-
|2.4.0
|Обновление расширения

* Минимальная поддерживаемая версия Ключ-АСТРОМ повышена до <code>1.318.0</code>.
* Для TLS/SSL добавлены параметры клиентского сертификата и закрытого ключа.
* Добавлены описания наборов функций Clients, Replication, Memory, Slow Log, Database и Statistics.
* Добавлены шаблоны оповещений о синхронизации и рассинхронизации реплик Redis.
* Добавлен обзорный дашборд <code>documents/redis_extension_overview.dashboard.json</code>.
* Обновлены встроенные зависимости расширения.

|-
|2.1.0
|Функции

* Поддержка TLS/SSL
* Анализ файла конфигурации Redis для автоматического получения и использования пароля для пользователя по умолчанию
|-
|2.0.8
|
* Исправлена ошибка, из-за которой не сообщалось о redis.hit_ratio.
|-
|2.0.5
|
* Исправлена ошибка в обработке снапшотов, которая могла помешать сбору данных в некоторых интервалах.
* Правильный тип данных пароля верхнего уровня, чтобы он был зашифрованным секретом
|-
|2.0.3
|
* Исправлена логика анализа файла снапшота, чтобы избежать сбоев в некоторых сценариях.
|-
|2.0.2
|
* Более точное обнаружение и обработка контрольных процессов
* Попытаться подключения без пароля, если обнаружен сценарий, в котором пароль был предоставлен, но не требуется
|-
|2.0.1
|
* Первоначальный выпуск 2.0
|}

== Обзор ==
'''Redis''' — это база данных с открытым исходным кодом, работающая в оперативной памяти, типа «'''ключ-значение'''» (или «сервер структур данных»), с возможностью повышения надежности. '''Redis''' обычно используется в качестве базы данных, кэша, очереди и брокера сообщений (публикация и подписка). Ключ-АСТРОМ без дополнительных настроек отслеживает стандартные метрики уровня процесса '''Redis'''. С помощью этого расширения вы можете собирать дополнительные метрики '''Redis''', включая время отклика, фрагментацию памяти, коэффициент попаданий в кэш, использование кэша, количество подключений, попаданий, промахов и многое другое.

== Варианты использования ==

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

== Начать ==
Начните с активации этого расширения в своей среде с помощью встроенного в продукт Ключ-АСТРОМ или через приложение '''Расширения'''. Затем создайте конфигурацию мониторинга. Чтобы создать конфигурации для группы отслеживаемых ЕдинымАгентов хостов, можно использовать такие элементы, как группы хостов, зоны управления и теги, чтобы создать единую конфигурацию, применимую ко всем хостам.

Поддерживается несколько экземпляров '''Redis''' на одном отслеживаемом хосте ЕдиногоАгента. Вы можете указать пароль и местоположение файла конфигурации (для идентификации переименованных команд) для всей конфигурации мониторинга, а также предоставить переопределения, если отдельным экземплярам требуются особые настройки. Все экземпляры '''Redis''' на хосте будут обнаружены автоматически, поэтому вам нужно предоставить переопределения только в том случае, если они отличаются от значений по умолчанию. Расширение будет использовать порт прослушивания для сопоставления ваших переопределений конфигурации с соответствующим экземпляром '''Redis'''. Для стандартных процессов это будет идентифицированный порт прослушивания. Для экземпляров '''Redis''', использующих '''Docker''', это будет сопоставленный/привязанный порт, предоставленный на хосте, если он доступен. Если порт недоступен, будет использоваться внутренний порт в контейнере '''Docker'''.

Для подключения к '''Docker-экземплярам''' пользователь, запускающий расширения (по умолчанию «'''dtuser'''»), должен иметь права на чтение и доступ к сокету '''Docker''' (<code>/var/run/docker.sock</code>). Скорее всего, вам потребуется добавить этого пользователя в группу (например, группу '''docker''') с такими правами.

== Подробности ==

=== Метрики ===
Собранные метрики будут отображаться в экземпляре группы процессов '''Redis'''. Чтобы просмотреть эти метрики, перейдите на экран экземпляра группы процессов для соответствующего процесса '''Redis''', нажмите кнопку с тремя точками (<code>...</code>) и выберите '''Анализ метрик и логов'''.

Метрики организованы в несколько наборов функций (см. описания в разделе наборов функций ниже) на основе:

* Репликация
* Память
* Статистика
* Клиенты
* Базы данных
* Медленные логи

=== Метрические события для оповещения ===
В расширении определены два события метрики. По умолчанию они отключены, поэтому их необходимо включить, прежде чем они станут активными. Чтобы внести изменения в эти события, необходимо клонировать их и отредактировать копию, так как любые изменения могут быть перезаписаны в будущих обновлениях.

* Синхронизация реплики '''Redis''' в процессе
** Срабатывает, если обнаружено, что реплика находится в состоянии «'''синхронизации'''» в течение 3 минут из любого 5-минутного интервала.
* Реплика '''Redis''' не синхронизирована
** Срабатывает, если обнаружено, что реплика находится в «'''несинхронизированном'''» состоянии в течение 3 минут из любого 5-минутного интервала.

== Информация о совместимости ==

=== Требования и ограничения ===

* '''Redis Server 2.8''' или выше
* '''ОС Linux'''
* '''Redis''' должен прослушивать порт '''localhost'''. Требуется привязка '''localhost''' к порту '''Redis'''.

=== Поддержка Docker ===

* Образ '''Redis Docker''' версии '''5.0.0+'''

== Лицензирование ==
Плата за расширение не взимается, взимается только плата за данные, которые оно обрабатывает. Подробности использования лицензии зависят от используемой модели лицензирования. Это может быть классическая модель лицензирования Ключч-АСТРОМ или модель подписки на платформу Ключ-АСТРОМ ('''DPS''') .

==== Метрики ====
Потребление лицензии рассчитывается на основе количества полученных метрических данных. Следующая формула рассчитает приблизительное количество полученных метрических данных за год при условии, что все наборы функций включены.

<code>(19 + (3 * <number_of_databases)) * 60 minutes * 24 hours * 365 days data points per year</code>

==== Классическое лицензирование ====
В классической модели лицензирования прием метрик будет потреблять единицы данных ИИ ('''DDU''') по ставке '''0,001 DDU''' на точку метрических данных.

Умножьте приведенную выше формулу для годовых точек данных на '''0,001,''' чтобы оценить годовое использование '''DDU'''.

Расширение PostgreSQL

2026-09-15T18:45:03Z

Aleksandr.Zubarev:

{| class="wikitable"
!Версия
!Изменения

|-
|2.9.7
|
* Версия расширения для Ключ-Астроном <code>1.318.0+</code>.
* Добавлены наборы функций <code>SLRU</code>, <code>I/O</code>, <code>User Functions</code> и <code>Subscription</code>.
* Добавлены новые метрики репликации, конфликтов, WAL и активности PostgreSQL.
* Добавлены описания наборов функций.
* Добавлены шаблоны оповещений о недоступности экземпляра и переходе в режим восстановления.
* Добавлены переходы к сущностям PostgreSQL со страницы хоста и из обзорной панели.
* Исправлены запросы обзорной панели для анализа производительности и блокировок.
* Исправлено создание сущностей при отсутствии обязательных измерений.
* Для PostgreSQL 16 и новее добавлен сбор статистики ввода-вывода.
* Сохранено использование функции <code>astromkey.astromkey_execution_plan</code> для получения планов выполнения.
|-
|2.6.6
|
* Версия расширения для Ключ-Астроном <code>1.310.0+</code>.
* Версия основана на 2.6.5 и содержит те же функции мониторинга.
* Схема для получения планов выполнения изменена на <code>astromkey</code>.
* Функция получения планов выполнения переименована в <code>astromkey.astromkey_execution_plan</code>.
|-
|2.6.5
|
* Версия расширения для Ключ-Астроном <code>1.310.0+</code>.
* Добавлен сбор конфигурации PostgreSQL.
* Добавлены наборы функций <code>Replication</code> и <code>Locks</code>.
* Добавлены метрики размера базы данных и возраста идентификатора транзакции.
* Добавлен сбор длительных и наиболее ресурсоёмких запросов из <code>pg_stat_activity</code> и <code>pg_stat_statements</code>.
* Добавлены отдельные интервалы сбора основных и длительных запросов.
* Добавлен параметр <code>Endpoint Metadata</code>.
* Добавлена возможность получения планов выполнения запросов.
* Добавлена готовая обзорная панель.
* Версия PostgreSQL добавлена в атрибуты сущности экземпляра.
* Добавлена связь между экземпляром PostgreSQL и соответствующим процессом при наличии ЕдиногоАгента.
* Команды <code>ALTER</code> исключены из сбора наиболее ресурсоёмких запросов.
* Метрика <code>postgres.blk_hit.count</code> переименована в <code>postgres.blks_hit.count</code>.
* Метрики привязаны к соответствующим типам сущностей.
* Из метрик активности удалено изменчивое измерение <code>client_port</code>.
* Исправлен сбор метрик фоновой записи в PostgreSQL 17.
* Исправлен сбор размера разницы WAL для реплицируемых экземпляров.
* Исправлен расчёт продолжительности запросов внутри транзакций.
* Исправлены графики использования подключений и анализа запросов.
* Исправлено значение по умолчанию для интервала сбора длительных запросов.

|-
|1.2.0
|Улучшения:

* Мониторинг баз данных был улучшен для поддержки всех версий Postgres, начиная с 11. Ранее он работал только для Postgres 14+.
* Все показатели были привязаны к соответствующему типу сущности, чтобы обеспечить корректное отображение показателей при активации менеджмент зон и фильтрации по сущности.

Исправления ошибок:

* <code>client_port</code> измерение было удалено из следующих метрик, поскольку поле не несет ценной информации и является слишком изменчивым, что приводит к созданию слишком большого количества отдельных временных рядов.
** <code>postgres.activity.active</code>
** <code>postgres.activity.fastpath_function_call</code>
** <code>postgres.activity.idle_in_transaction_aborted</code>
** <code>postgres.activity.idle_in_transaction</code>
** <code>postgres.activity.idle</code>
|-
|1.1.0
|Новые функции:

* Новые наборы функций
* Новый тип топологии: табличное пространство
* Метрика разности WAL
* Видимость на уровне запроса для самых длительных запросов
* Новые метрики и диаграммы на экранах сущностей

Исправления ошибок:

* Дублирующиеся топологические сущности
* Неправильные типы метрик
* Неправильная метрика восстановления
* Ссылки на панель инструментов и экраны сущностей
|-
|1.0.3
|
* Исправление изменения схемы
|-
|1.0.2
|
* Исправлена ссылка на конфигурации в обзорной панели.
|-
|1.0.1
|Начало поддержки расширения PostgreSQL
|}

== Обзор ==
Решение для мониторинга '''PostgresSQL''' основано на подходе удалённого мониторинга, реализованном в виде расширения Ключ-АСТРОМ АктивногоШлюза. Расширение запрашивает ключевые показатели производительности и работоспособности баз данных '''Postgres'''. Затем искусственный интеллект от Ключ-АСТРоМ анализирует эти показатели для выявления отклонений и проблем.

== Варианты использования ==

* Контролируйте состояние работоспособности и производительность своей настройки '''PostgreSQL'''.
* Обнаруживайте аномалии и оповещайте о них.
* Примите превентивные меры для предотвращения проблем в обслуживании.

=== Мониторинг популярных запросов ===
Если мониторинг логов Ключ-АСТРОМ включён и <code>pg_stat_statements</code> представление доступно, Ключ-АСТРОМ будет собирать '''100''' самых популярных запросов (отсортированных по общему времени выполнения) каждые 5 минут и сохранять их в виде логов. Эти логи доступны либо на экране экземпляра базы данных, либо в приложении '''Базы данных''' в разделе '''Топ-запросов по общему времени выполнения'''.

Чтобы отфильтровать эти запросы на дашборде или в блокноте, можно использовать фильтры по <code>dt.extension.name = com.astromkey.extension.postgres</code> и <code>event.group = top_queries</code>. Ниже представлен пример '''DQL-запроса''':
fetch logs
| filter dt.extension.name=="com.astromkey.extension.postgres" and event.group=="top_queries"
| sort total_exec_time desc
Независимо от того, <code>pg_stat_statements</code> доступно это или нет, Ключ-АСТРОМ все равно будет собирать запросы <code>pg_stat_activity</code> как часть набора функций <code>Queries</code>, которые аналогичным образом поступают в виде логов с <code>event.group = longest_queries</code>.

=== Получение деталей плана выполнения ===
Для пользователей '''SaaS''', имеющих доступ к приложению '''Базы данных''' и включённых функциях мониторинга самых популярных запросов (см. предыдущий раздел), доступна функция получения планов выполнения для этих запросов. Это можно сделать в приложении '''Базы данных''' в разделе <code>Statement performance</code>, щёлкнув <code>Request</code> по плану выполнения конкретного запроса.

Для этого <code>query</code> расширение попытается выполнить следующее:
SELECT * from astromkey.astromkey_execution_plan({query})
и затем загрузить в Ключ-АСТРОМ первую строку столбца с именем <code>explain</code>. Эти планы выполнения загружаются в виде логов с <code>event.group = execution_plans</code>.

== Начать ==

=== Активация ===
''Действия по активации удаленного мониторинга'' (версия '''1.255+'''):

* Активируйте расширение в Ключ-АСТРОМ, перейдя по ссылке:
* Ключ-АСТРОМ → Расширения → PostgreSQL → Добавить в среду
* Добавить новую конфигурацию мониторинга

=== Требования ===

* Должно быть установлено соединение между АктивнымШлюзом, где развернуто расширение, и базой данных '''Postgres'''.
* Необходимо предоставить пользователю базы данных соответствующие разрешения.

Пример:
CREATE USER astromkey WITH PASSWORD '<PASSWORD>' INHERIT;
GRANT pg_monitor TO astromkey;
Для мониторинга самых популярных запросов:

* <code>pg_stat_statements</code> просмотр (должен быть включен) [ https://www.postgresql.org/docs/current/pgstatstatements.html#PGSTATSTATEMENTS ].
* <code>pg_stat_statements.track_planning</code> должен быть включен, чтобы разрешить выборку планов.

Для мониторинга деталей плана исполнения:

* В базе данных должна быть создана специальная функция <code>astromkey.astromkey_execution_plan</code>, к которой вы будете подключаться и из которой будут извлекаться планы выполнения.

CREATE SCHEMA astromkey;
CREATE OR REPLACE FUNCTION astromkey.astromkey_execution_plan(
<nowiki> </nowiki> query text,
<nowiki> </nowiki> OUT explain JSON
) RETURNS SETOF JSON
<nowiki> </nowiki> LANGUAGE plpgsql
<nowiki> </nowiki> VOLATILE
<nowiki> </nowiki> RETURNS NULL ON NULL INPUT
<nowiki> </nowiki> SECURITY DEFINER
<nowiki> </nowiki> ROWS 1
<nowiki> </nowiki> SET plan_cache_mode = force_generic_plan
AS
$$DECLARE
<nowiki> </nowiki> arg_count integer;
<nowiki> </nowiki> open_paren text;
<nowiki> </nowiki> close_paren text;
<nowiki> </nowiki> explain_cmd text;
<nowiki> </nowiki> json_result json;
BEGIN

<nowiki> </nowiki> /* reject statements containing a semicolon in the middle */
<nowiki> </nowiki> IF pg_catalog.strpos(
<nowiki> </nowiki> pg_catalog.rtrim(astromkey_execution_plan.query, ';'),
<nowiki> </nowiki> ';'
<nowiki> </nowiki> ) OPERATOR(pg_catalog.>) 0 THEN
<nowiki> </nowiki> RAISE EXCEPTION 'query string must not contain a semicolon';
<nowiki> </nowiki> END IF;

<nowiki> </nowiki> /* get the parameter count */
<nowiki> </nowiki> SELECT count(*) INTO arg_count
<nowiki> </nowiki> FROM pg_catalog.regexp_matches( /* extract the "$n" */
<nowiki> </nowiki> pg_catalog.regexp_replace( /* remove single quoted strings */
<nowiki> </nowiki> astromkey_execution_plan.query,
<nowiki> </nowiki> <nowiki>'''</nowiki>[^<nowiki>''</nowiki>]*<nowiki>'''</nowiki>,
<nowiki> </nowiki> <nowiki>''</nowiki>,
<nowiki> </nowiki> 'g'
<nowiki> </nowiki> ),
<nowiki> </nowiki> '\$\d{1,}',
<nowiki> </nowiki> 'g'
<nowiki> </nowiki> );

<nowiki> </nowiki> IF arg_count OPERATOR(pg_catalog.=) 0 THEN
<nowiki> </nowiki> open_paren := <nowiki>''</nowiki>;
<nowiki> </nowiki> close_paren := <nowiki>''</nowiki>;
<nowiki> </nowiki> ELSE
<nowiki> </nowiki> open_paren := '(';
<nowiki> </nowiki> close_paren := ')';
<nowiki> </nowiki> END IF;

<nowiki> </nowiki> /* construct a prepared statement */
<nowiki> </nowiki> EXECUTE
<nowiki> </nowiki> pg_catalog.concat(
<nowiki> </nowiki> 'PREPARE _stmt_',
<nowiki> </nowiki> open_paren,
<nowiki> </nowiki> pg_catalog.rtrim(
<nowiki> </nowiki> pg_catalog.repeat('unknown,', arg_count),
<nowiki> </nowiki> ','
<nowiki> </nowiki> ),
<nowiki> </nowiki> close_paren,
<nowiki> </nowiki> ' AS ',
<nowiki> </nowiki> astromkey_execution_plan.query
<nowiki> </nowiki> );

<nowiki> </nowiki> /* construct an EXPLAIN statement */
<nowiki> </nowiki> explain_cmd :=
<nowiki> </nowiki> pg_catalog.concat(
<nowiki> </nowiki> 'EXPLAIN (FORMAT JSON, ANALYZE FALSE) EXECUTE _stmt_',
<nowiki> </nowiki> open_paren,
<nowiki> </nowiki> pg_catalog.rtrim(
<nowiki> </nowiki> pg_catalog.repeat('NULL,', arg_count),
<nowiki> </nowiki> ','
<nowiki> </nowiki> ),
<nowiki> </nowiki> close_paren
<nowiki> </nowiki> );

<nowiki> </nowiki> /* get and return the plan */
<nowiki> </nowiki> EXECUTE explain_cmd INTO json_result;
<nowiki> </nowiki> RETURN QUERY SELECT json_result;

<nowiki> </nowiki> /* delete the prepared statement */
<nowiki> </nowiki> DEALLOCATE _stmt_;
END;$$;

* Обратите внимание, что функция выше определена с <code>SECURITY DEFINER</code>, то есть она выполняется с привилегиями пользователя, который её определил, а не того, кто её выполняет. Это связано с тем, что для запроса <code>EXPLAIN</code> требуются те же разрешения, что и для его выполнения, то есть пользователь, с которым определена эта функция, должен иметь достаточные привилегии для запуска <code>PREPARE</code> и <code>EXPLAIN</code> для запросов, которые она будет объяснять. Поэтому для полной функциональности убедитесь, что функция определена с соответствующим пользователем.
* Пользователю, осуществляющему мониторинг, необходимо иметь <code>USAGE</code> грант на <code>astromkey</code> схему.

GRANT USAGE ON SCHEMA astromkey to <username>

* В некоторых конфигурациях '''PostgreSQL''' вам также может потребоваться настроить <code>search_path</code> для пользователя мониторинга:

ALTER USER astromkey SET search_path to astromkey, public;

== Подробности ==

=== Ограничения ===
Популярные запросы:

* Из соображений безопасности <code>ALTER</code> утверждения исключены из коллекции самых популярных запросов.

Подробности плана выполнения:

* Доступно только для пользователей '''SaaS''' с установленным приложением '''DB'''. Разрешение <code>extensions:configuration.actions:write</code> требуется для запуска загрузки плана выполнения.
* План выполнения можно получить только из базы данных, в которой была создана функция <code>astromkey.astromkey_execution_plan</code>.

=== Лицензирование ===
Метрики, собираемые с помощью этого расширения, используют единицы данных Ключ-АСТРОМ ИИ (см. [[DDU для пользовательских событий ИИ|DDU для метрик]]).

Грубую оценку количества '''DDU''', потребляемых метрическим методом, можно получить с помощью следующей формулы:
( (11 * number of instances)
+ (29 * number of databases)
+ (1 * number of tablespaces)
) * 525.6 DDUs/year
Для логов действует стандартное потребление '''DDU''' для мониторинга логов. В зависимости от вашей модели лицензирования, см. потребление [[DDU для лога мониторинга|DDU для мониторинга логов]].

Если ваша лицензия включает пользовательские метрики. Каждая пользовательская метрика эквивалентна '''525,6 DDU/год'''. См. документацию [[Распределение затрат|Расчёт стоимости метрики]].

== Информация о совместимости ==
Расширение предназначено для работы с PostgreSQL версии 11 и более поздних версий.

Расширение Oracle Database

2026-09-15T18:18:46Z

Aleksandr.Zubarev:

{| class="wikitable"
!Версия
!Изменения

|-
|3.7.6
|Обновление расширения

* Минимальная поддерживаемая версия Ключ-АСТРОМ повышена до <code>1.310.0</code>, минимальная версия EEC — до <code>1.301.0</code>.
* Добавлены метрики времени работы, состояния RAC, заблокированных сеансов, взаимных блокировок и повреждённых блоков данных.
* Добавлены метрики и журналы для анализа наиболее ресурсоёмких SQL-запросов.
* Добавлены сущности топологии для кластера, экземпляра, базы данных, заданий резервного копирования, групп и дисков ASM.
* Идентификаторы типов топологии переведены в пространство имён <code>sql:ru_ruscomtech_extension_sql-oracle_*</code>. Ссылки на прежние типы <code>sql:com_dynatrace_extension_sql-oracle_*</code> в пользовательских дашбордах и правилах необходимо обновить.
* Добавлены и обновлены оповещения о недоступности экземпляров и PDB, состоянии табличных пространств, файлов данных и Data Guard.
* Добавлен обзорный дашборд <code>documents/overview.dashboard.json</code>.
|-
|2.3.0
|Улучшения в этой версии:

* Удален параметр <code>event</code> из <code>com.astromkey.extension.sql-oracle.wait.count</code> и <code>com.astromkey.extension.sql-oracle.wait.time.count</code> для предотвращения непреднамеренно высокого потребления DDU. Для замены прежней функциональности был добавлен новый набор функций, <code>waitEvents (detailed)</code>, с метриками <code>com.astromkey.extension.sql-oracle.wait.events.count</code> и <code>com.astromkey.extension.sql-oracle.wait.events.time.count</code> который отслеживает общее время ожидания и общее время ожидания для 20 наиболее частых событий ожидания. При обновлении конфигураций мониторинга до новой версии убедитесь, что вы включили новый набор функций, чтобы продолжить получать информацию на уровне событий.
|-
|2.2.3
|Исправлено в этой версии:

* Плитки ASM Disks на дашборде использовали устаревшие названия метрик.
|-
|2.2.2
|Исправлено в этой версии:

* Запросы ASM Disk Groups и ASM Disks не будут выполняться из-за синтаксиса
|-
|2.2.1
|Новое в этой версии:

* Отслеживание зоны быстрого восстановления (FRA)
* Табличные пространства отслеживаются по контейнерам (CDB и PDB)
* Группы дисков ASM отслеживаются как отдельные сущности, связанные с дисками ASM
* Состояние данных и временных файлов отслеживается для каждого контейнера (CDB и PDB).
* Мониторинг защиты данных
** Тяжелые события
** Разрыв между основной и резервной последовательностями применения
** Количество нерегистрируемых действий
** Статус ошибки назначения архива

Улучшения в этой версии:

* Использование табличного пространства рассчитывается на основе максимально возможного размера, включая автоматические экстенты.
* Использование табличного пространства <code>CDB_TABLESPACE_USAGE_METRICS</code> отражается с учетом базовой файловой системы (такой же, как в Oracle Enterprise Manager)
* Использование сеансов и процессов отображается в процентах от настроенного лимита.
|-
|2.1.5
|Новое в этой версии:

* Данные расширения теперь можно использовать с приложением «Обзор базы данных».
* Задания резервного копирования регистрируют дополнительные сведения на основе своих наборов резервных копий.
* Время с момента последнего резервного копирования данного типа теперь регистрируется как метрика

Улучшения в этой версии:

* Более четко описан параметр конфигурации времени ожидания запроса.

Исправлено в этой версии:

* Диаграмма табличных пространств на странице «Экземпляр» отображала длинное имя выражения метрики.
* Не все резервные копии были обнаружены и перечислены на странице экземпляра.
|-
|2.0.0
|Критические изменения:

Из-за изменений топологии, упомянутых ниже, ваша среда может создавать новые сущности для замены созданных старыми версиями расширения.

Любая пользовательская конфигурация, основанная на следующих типах сущностей, работать не будет:

* <code>sql:com_astromkey_extension_sql-oracle_cdb</code>
* <code>sql:com_astromkey_extension_sql-oracle_pdb</code> (заменить на <code>sql:com_astromkey_extension_sql-oracle_database</code>)
* <code>sql:com_astromkey_extension_sql-oracle_service</code>

Новое в этой версии:

* Дополнительные атрибуты, сообщаемые для экземпляров Oracle
* Когда расширение настроено на подключение к контейнеру (CDB), все базы данных (PDB) автоматически отслеживаются.
* Добавлено новое оповещение о сбоях заданий резервного копирования.

Улучшения в этой версии:

* Топология была упрощена:
** Экземпляр Oracle теперь представляет собой либо автономный экземпляр, либо контейнер.
** Идентификаторы этих сущностей теперь рассчитываются точнее.
** Oracle Database теперь представляет собой либо автономную, либо подключаемую базу данных.
** Удалены сущности Oracle CDB, Oracle PDB и Oracle Service.
* Резервные копии базы данных видны на странице сведений об экземпляре.
* Все списки сущностей поддерживают фильтрацию
* На странице сведений о сервере Oracle отображаются данные о процессах Oracle, если на хосте развернут ЕдиныйАгент.
* Все метрики имеют тег «Oracle», который можно использовать в меню «Метрики».

Исправлено в этой версии:

* Резервные копии не будут обнаружены, если процесс завершится сбоем до завершения первого подзадания.
* Резервные копии будут объединены, если они выполнены в течение одного сеанса.
|}

== Обзор ==
Ключ-АСТРОМ автоматически определяет все приложения и микросервисы, развернутые в вашей системе, а также то, как ваша система использует '''Oracle Database'''.

Ключ-АСТРОМ диагностирует аномалии в режиме реального времени с помощью ИИ и выявляет первопричину медленно работающих или ошибочных '''SQL-запросов'''. Глубокий анализ кода в сочетании с облачным мониторингом серверов баз данных поможет вам обеспечить надежную производственную среду.

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

== Варианты использования ==

* Понять зависимости приложений от баз данных: какие запросы выполняются и какова их производительность.
* Повысить производительность приложений за счёт оптимизации типичных паттернов БД, например проблемы 1+N-запросов.
* Определить, как приложения нагружают базу данных.
* Понять, как нехватка ресурсов или ошибки на стороне БД влияют на приложения.
* Анализировать аудит-логи БД, чтобы выявлять неудачные попытки входа.
* Отслеживать состояние и производительность серверов '''Oracle''' (одиночных или мультиарендных).
* Отслеживать наиболее ресурсоёмкие запросы.
* Ускорить диагностику проблем в приложениях, вызванных базой данных.

== Начать ==
Это удалённое расширение, работающее через АктивныйШлюз в вашей среде и подключающееся к каждой базе данных '''Oracle''', которую необходимо отслеживать. Выполняется серия запросов к различным представлениям баз данных, и данные отправляются обратно в Ключ-АСТРОМ.

=== Начало работы для клиентов Oracle Database: ===
Если приложение, подключающееся к серверу '''Oracle Database''', работает на виртуальной машине или на физическом сервере, установите на него ЕдиныйАгент, чтобы начать работу.

Если приложение, подключающееся к серверу '''Oracle Database''', работает как рабочая нагрузка в '''Kubernetes''' или '''OpenShift''', настройте Ключ-АСТРОМ на '''Kubernetes''' или '''OpenShift''' .

Активируйте следующие функции ЕдиногоАгента, чтобы получить полную информацию об отслеживании:

* '''Node.js Oracle DB'''
* '''PHP Oracle'''

=== Начните работу для серверов Oracle Database: ===
Если ваш сервер '''Oracle Database''' работает на виртуальной машине или на аппаратном уровне, установите на нем ЕдиныйАгент, чтобы начать работу с показателями производительности системы.

Активируйте удалённое расширение '''Oracle Database''', чтобы получить полную информацию о состоянии и производительности сервера '''Oracle Database''', включая метрики и события. Расширение собирает данные, напрямую запрашивая представления производительности базы данных, поэтому для его работы требуется подключение к ней.

Для мониторинга рекомендуется создать отдельную учётную запись пользователя. Для удобства скрипты создания пользователей можно найти [https://github.com/dynatrace-extensions/convenience-scripts/tree/main/oracle-db здесь]. Эти скрипты создают пользователя с ролями <code>CREATE_SESSION</code> и разрешениями <code>SELECT</code> для следующих представлений производительности:

* <code>CDB_DATA_FILES</code>
* <code>CDB_TABLESPACE_USAGE_METRICS</code>
* <code>CDB_TABLESPACES</code>
* <code>CDB_TEMP_FILES</code>
* <code>GV_$ARCHIVE_DEST</code>
* <code>GV_$ARCHIVE_DEST_STATUS</code>
* <code>V_$ASM_DISK_STAT</code>
* <code>V_$ASM_DISKGROUP_STAT</code>
* <code>V_$BACKUP_SET_DETAILS</code>
* <code>GV_$CLUSTER_INTERCONNECTS</code>
* <code>GV_$CONTAINERS</code>
* <code>V_$CONTAINERS</code>
* <code>GV_$CON_SYS_TIME_MODEL</code>
* <code>GV_$CON_SYSSTAT</code>
* <code>GV_$DATABASE</code>
* <code>V_$DATABASE</code>
* <code>V_$DATABASE_BLOCK_CORRUPTION</code>
* <code>GV_$DATAFILE</code>
* <code>V_$DATAFILE</code>
* <code>GV_$DATAGUARD_STATUS</code>
* <code>GV_$INSTANCE</code>
* <code>GV_$INSTANCE_PING</code>
* <code>GV_$LIBRARYCACHE</code>
* <code>V_$LOG</code>
* <code>GV_$METRIC</code>
* <code>GV_$METRICGROUP</code>
* <code>GV_$PARAMETER</code>
* <code>GV_$PDBS</code>
* <code>GV_$PGASTAT</code>
* <code>V_$RECOVER_FILE</code>
* <code>V_$RECOVERY_FILE_DEST</code>
* <code>GV_$RESOURCE_LIMIT</code>
* <code>V_$RMAN_BACKUP_JOB_DETAILS</code>
* <code>GV_$SESSION</code>
* <code>V_$SESSION</code>
* <code>GV_$SGASTAT</code>
* <code>GV_$SQL</code>
* <code>V_$SQL</code>
* <code>GV_$SQLAREA</code>
* <code>V_$SQL_PLAN</code>
* <code>GV_$SQL_PLAN</code>
* <code>V_$SQL_PLAN_STATISTICS_ALL</code>
* <code>GV_$SYSSTAT</code>
* <code>GV_$SYSTEM_EVENT</code>
* <code>GV_$SYSTEM_WAIT_CLASS</code>
* <code>V_$TABLESPACE</code>
* <code>V_$TEMPFILE</code>

В качестве альтернативы <code>SELECT_CATALOG_ROLE</code> можно назначить пользователю, осуществляющему мониторинг.

Для мониторинга мультиарендной конфигурации '''Oracle DB''' убедитесь, что расширение указывает на '''CDB'''. Обнаружение и мониторинг '''PDB''' будут выполняться автоматически. В этом случае необходимы явные разрешения на доступ к данным во всех контейнерах:

<code>alter user <your_username> set container_data=all container = current;</code>

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

Пользователям приложения '''Базы данных''', желающим использовать планы выполнения запросов, также необходимо предоставить разрешение для представлений <code>V$SQL_PLAN</code>, <code>V$SESSION</code>, <code>V$SQL_PLAN_STATISTICS_ALL</code> и <code>V$SQL</code>. Эти разрешения включены в скрипты создания пользователей. Подробнее см. в разделе '''Мониторинг планов выполнения''' ниже.

Наконец, активируйте мониторинг логов, чтобы получить полную картину логов.

'''Примечание''':

При использовании набора функций '''TopN''' расширение выводит отчеты о наиболее затратных по времени запросах на странице сущностей экземпляра '''Oracle''' в разделе '''Логи'''. Включение этой функции может привести к раскрытию конфиденциальных данных в отчетах о запросах.

== Подробности ==

==== Этот пакет расширения содержит: ====

* Определения топологии и взаимосвязей для кластеров '''RAC''', заданий резервного копирования, баз данных, экземпляров, дисков '''ASM''' и групп дисков '''ASM'''.
* Классический и новый дашборд, предлагающий обзор мониторинга среды '''Oracle Database'''.
* Оповещения об ошибках резервного копирования, недоступных '''PDB''', недоступных экземплярах, высоком использовании табличного пространства и т.д.
* Страница унифицированного анализа для вышеупомянутой топологии

== Информация о совместимости ==
Поддерживаются следующие версии '''Oracle''':

* '''Oracle DB 12.2+'''

Поддерживаются следующие архитектуры:

* Автономные серверы '''Oracle'''
* '''Oracle Multitenant (CDB/PDB)'''
** Настройка мониторинга '''CDB''' для обнаружения всех '''PDB'''
* '''Oracle AWS RDS'''
* '''Oracle RAC'''
** Настройка мониторинга для '''SCAN''' обнаружения всех экземпляров и баз данных.

== Управление логами и аналитика ==

=== Отслеживание файлов логов аудита ===

==== Проверка местоположения файла логов ====

* <code>SELECT name, value FROM v$parameter WHERE name = 'audit_trail';</code>

<code>OS</code> означает, что логи аудита хранятся локально в файле.

* <code>SELECT value FROM v$parameter WHERE name = 'audit_file_dest';</code>

указывает местоположение файла логов

==== Добавить правила безопасности LogAgent ====
Настройте правила безопасности '''LogAgent''', чтобы разрешить доступ к локальным файлам, добавив файл <code>oracle.json</code> в:

* в Linux/UNIX: <code>/var/lib/astromkey/oneagent/agent/config/logmodule</code>
* в Windows: <code>%PROGRAMDATA%\astromkey\oneagent\agent\config\logmodule</code>

{
"@version": "1.0.0",
"allowed-log-paths-configuration": [
{
"directory-pattern": "/u01/app/oracle/admin/oracle_standalone/adump/",
"file-pattern": "*.aud",
"action": "INCLUDE"
}
]
}
Перезапуск агента не требуется, данная конфигурация будет применена в течение 1 минуты.

==== Настройте собственный источник логов и правила приема логов ====

===== Пользовательский источник логов =====
Используйте местоположение файла логов, полученное с помощью запроса, выполненного на первом этапе, например <code>/u01/app/oracle/admin/oracle_standalone/adump/*</code>.

===== Правила приема логов =====
Пример конфигурации, которая включает только сообщения <code>ORA-01017</code> о попытках входа с недействительным именем пользователя или паролем, можно настроить с помощью: <code>Log content is any of: (.*)RETURNCODE:\[(\d+)\] "1017 AND Log source is any of: /u01/app/oracle/admin/oracle_standalone/adump/*</code>

==== Доступ к логам ====
Доступ к логам, собранным описанным выше способом, можно получить с помощью следующего '''DQL-запроса''': <code>fetch logs | filter matchesValue(log.source, "/u01/app/oracle/admin/oracle_standalone/adump/*")</code>.

==== Извлечение метрик ====

===== Правило обработки логов =====
Настройте правило обработки логов для извлечения атрибутов лога из его содержимого:

* '''Имя правила''': предпочтительное имя
* '''Сопоставитель''': <code>matchesValue(log.source, "/u01/app/oracle/admin/oracle_standalone/adump/*")</code>
* '''Определение процессора''':

PARSE(content, "
DATA ' RETURNCODE:['INT']' SPACE '\"' INT:ora.returncode LD") |
PARSE(content, "
DATA ' USERID:['INT']'SPACE CSVDQS:ora.userid LD") |
PARSE(content, "
DATA ' USERHOST:['INT']'SPACE CSVDQS:ora.userhost LD")

===== Извлечение метрических данных =====
Извлеките показатели из записей логов для включения оповещений:

* '''Метрический ключ''': например <code>log.oracle.invalid_credentials</code>
* '''Сопоставитель''': <code>matchesValue(log.source, "/u01/app/oracle/admin/oracle_standalone/adump/*")</code>
* '''Метрические измерения''': <code>Occurence of logs records</code>
* '''Измерения''': укажите атрибуты журнала, которые будут использоваться в качестве метрических измерений.

== Мониторинг плана выполнения ==
Для клиентов SaaS, имеющих доступ к приложению «Базы данных», функция мониторинга плана выполнения также доступна при анализе эффективности выполнения выписок.

Для работы функции <code>DBMS_XPLAN</code> пакет должен быть доступен, а пользователь, настроенный в расширении Ключ-АСТРОМ, должен иметь разрешения на вызов функции <code>DISPLAY_CURSOR</code>. Согласно официальной документации, это означает, что для следующих представлений <code>SELECT</code>, <code>READ</code> требуются разрешения:

* <code>V$SQL_PLAN</code>
* <code>V$SESSION</code>
* <code>V$SQL_PLAN_STATISTICS_ALL</code>
* <code>V$SQL</code>

В дополнение к этому, разрешение <code>SELECT</code> также требуется для <code>V$SQL_PLAN</code>.

== Маскировка конфиденциальных данных ==
Отслеживание производительности запросов может раскрыть конфиденциальные данные в отчётах. Поэтому Ключ-АСТРОМ предоставляет дополнительный механизм, позволяющий маскировать выбранные атрибуты.

Представленные ниже конфигурации представляют собой пример того, как конфиденциальные данные могут быть замаскированы в отслеживаемых выписках.

* Создать новое правило обработки можно в разделе <code>Настройки -> Мониторинг -> Процессы</code>
** Определение процесса: <code>USING(INOUT content) | FIELDS_ADD(content: REPLACE_PATTERN(content, "(\"'\"):p1 (LD):p2 (\"'\"):p3", "${p1}${p2|sha1}${p3}"))</code>
* Или создайте/измените свое собственное расширение для распространения таких правил в вашей среде:

logProcessingRules:
- ruleName: TopN statements masking
query: event.group="query_performance"
enabled: true
ProcessorDefinition:
rule: |
USING(INOUT content) | FIELDS_ADD(content: REPLACE_PATTERN(content, "(\"'\"):p1 (LD):p2 (\"'\"):p3", "${p1}${p2|sha1}${p3}"))
RuleTesting:
sampleLog: |
{
"event.group": "query_performance",
"content": "/*dt:ownQuery*/SELECT DECODE(name, 'sessions', value) AS sessions_limit, DECODE(name, 'processes', value) AS processes_limit FROM v$parameter WHERE name IN('sessions', 'processes')"
}
Измените это правило в соответствии с вашим вариантом использования.

== Лицензирование ==
Метрики, собираемые с помощью этого расширения, используют единицы данных ИИ Ключ-АСТРОМ (см. [[DDU для пользовательских событий ИИ|DDU для метрик]]).

Грубую оценку количества '''DDU''', потребляемых метрическим методом, можно получить с помощью следующей формулы:
(55 * number of instances * 525.6) + (7 * number of databases * 525.6) + (8 * number of backup jobs per year * 0.005) + (5 * number of ASM disks * 525.6) + (3 * number of ASM disk groups * 525.6)
Для логов действует стандартное потребление '''DDU''' для мониторинга логов. В зависимости от вашей модели лицензирования, см. потребление [[DDU для лога мониторинга|DDU для мониторинга логов]].

Расширение NVIDIA

2026-09-15T18:16:35Z

Aleksandr.Zubarev:

{| class="wikitable"
!Версия
!Изменения

|-
|1.1.0
|Обновление расширения

* Минимальная поддерживаемая версия Ключ-АСТРОМ повышена до <code>1.309.0</code>.
* Минимальная версия EEC — <code>1.280.0</code>.
* Добавлены обзорные дашборды <code>dashboards/overview_dashboard.json</code> и <code>documents/nvidia_overview.dashboard.json</code>.

|-
|1.0.3
|Исправлена ошибка, из-за которой расширение давало сбой, если графический процессор не сообщал определенные показатели.
|-
|1.0.2
|Сообщать 0, когда для определенного графического процессора нет процессов
|-
|1.0.1
|Добавлена метрика энергопотребления
|-
|1.0.0
|Поддержка мониторинга графических процессоров Nvidia на основе новейшей платформы Framework Расширения 2.0. Мониторинг температуры, памяти, количества процессов и загрузки. Создание экранов хоста для этих показателей.
|}

== Обзор ==
Это расширение отслеживает базовые параметры графических процессоров '''NVIDIA''', отслеживая нагрузку, использование памяти и ресурсов. Расширение использует доступ к инструментарию '''NVIDIA''' через '''Python''' для предоставления подробной информации об использовании графических процессоров.

Это предназначено для пользователей, которые:

Хотят расширить мониторинг своих хостов на '''GPU''' и иметь обзор их использования.

== Варианты использования ==
Это расширение позволяет вам:

* Мониторить использование графического процессора в вашей среде
* Находить узкие места в использовании памяти графического процессора

== Начать ==
Это расширение выполняется ЕдинымАгентом (локальный мониторинг). Для начала просто активируйте расширение в своей среде с помощью встроенного в продукт '''Расширения'''.

== Подробности ==

=== Собранные показатели: ===

* Количество процессов, запущенных на '''GPU'''
* Использование в процентах
* Использование памяти
* Общая память
* Температура графического процессора

=== Это расширение создано на основе Framework Расширения 2.0 и обеспечивает: ===

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

== Информация о совместимости ==
Это расширение использует следующие внешние библиотеки, которые должны поддерживаться вашим графическим процессором (картой и драйвером):

* '''gpustat'''
* '''nvidia-ml-py'''

Расширение Hadoop

2026-09-15T18:15:24Z

Aleksandr.Zubarev:

{| class="wikitable"
!Версия
!Изменения

|-
|1.0.4
|Обновление расширения

* Минимальная поддерживаемая версия Ключ-АСТРОМ повышена до <code>1.310.0</code>.
* Добавлен обзорный дашборд <code>documents/hadoop_overview.dashboard.json</code>.

|-
|1.0.1
|Начало поддержки расширения Hadoop
|}

== Обзор ==
Мониторинг '''Hadoop''' в Ключ-АСТРОМ обеспечивает общий обзор основных компонентов '''Hadoop''' в вашем кластере. Эти расширенные данные предоставляют дополнительные метрики непосредственно из сервисов '''HDFS''' и '''YARN'''.

== Варианты использования ==
Расширение позволяет получить представление об общем состоянии сервисов '''Hadoop''' '''HDFS''' и '''YARN'''.

== Начать ==
Активируйте это расширение в среде Ключ-АСТРОМ из встроенного в продукт '''Расщирения''' и просто выберите, для каких ЕдиныхАгентов его следует включить.

== Подробности ==
Это расширение предоставляет дополнительные метрики '''Hadoop''' посредством использования '''JMX-запросов'''.

* '''HDFS''' — распределенная файловая система '''Hadoop'''
** Улучшенная видимость состояния '''HDFS''' '''NameNodes''' и '''DataNodes'''
* '''YARN''' — еще один переговорщик по ресурсам
** Улучшенная видимость состояния ваших служб '''YARN''' '''NodeManagers''', '''ResourceManagers''' и '''MRAppMaster'''.

== Информация о совместимости ==

* '''Hadoop''' версии '''2.4.1+'''
* '''ОС Linux'''
* Для полной видимости '''Hadoop''' необходимо установить ЕдиныйАгент на всех машинах, на которых выполняются следующие процессы '''Hadoop''': '''NameNode''', '''ResourceManager''', '''NodeManager''', '''DataNode''' и '''MRAppMaster'''.

Расширение Hadoop

2026-09-15T18:14:35Z

Aleksandr.Zubarev:

{| class="wikitable"
!Версия
!Изменения

|1.0.4
|Обновление расширения

* Минимальная поддерживаемая версия Ключ-АСТРОМ повышена до <code>1.310.0</code>.
* Добавлен обзорный дашборд <code>documents/hadoop_overview.dashboard.json</code>.

|-
|1.0.1
|Начало поддержки расширения Hadoop
|}

== Обзор ==
Мониторинг '''Hadoop''' в Ключ-АСТРОМ обеспечивает общий обзор основных компонентов '''Hadoop''' в вашем кластере. Эти расширенные данные предоставляют дополнительные метрики непосредственно из сервисов '''HDFS''' и '''YARN'''.

== Варианты использования ==
Расширение позволяет получить представление об общем состоянии сервисов '''Hadoop''' '''HDFS''' и '''YARN'''.

== Начать ==
Активируйте это расширение в среде Ключ-АСТРОМ из встроенного в продукт '''Расщирения''' и просто выберите, для каких ЕдиныхАгентов его следует включить.

== Подробности ==
Это расширение предоставляет дополнительные метрики '''Hadoop''' посредством использования '''JMX-запросов'''.

* '''HDFS''' — распределенная файловая система '''Hadoop'''
** Улучшенная видимость состояния '''HDFS''' '''NameNodes''' и '''DataNodes'''
* '''YARN''' — еще один переговорщик по ресурсам
** Улучшенная видимость состояния ваших служб '''YARN''' '''NodeManagers''', '''ResourceManagers''' и '''MRAppMaster'''.

== Информация о совместимости ==

* '''Hadoop''' версии '''2.4.1+'''
* '''ОС Linux'''
* Для полной видимости '''Hadoop''' необходимо установить ЕдиныйАгент на всех машинах, на которых выполняются следующие процессы '''Hadoop''': '''NameNode''', '''ResourceManager''', '''NodeManager''', '''DataNode''' и '''MRAppMaster'''.

Расширение Elasticsearch

2026-09-15T18:13:33Z

Aleksandr.Zubarev:

{| class="wikitable"
!Версия
!Изменения

|-
|2.0.9
|Обновление расширения

* Минимальная поддерживаемая версия Ключ-АСТРОМ повышена до <code>1.310.0</code>.
* Исправлен ключ метрики количества сборок мусора JVM: <code>elasticsearch_jvm_gc_collection_count.count</code>.
* Добавлен обзорный дашборд <code>documents/overview.dashboard.json</code>.

|-
|2.0.2
|Изменения на уровне патча

* Исправлены проблемы с аутентификацией конечной точки при определенных обстоятельствах.
* Исправлено ''количество'' сообщений о значении метрик узлов, когда узлы используют один и тот же хост.
* Исправлена непоследовательность в предоставлении отчетов о значениях метрики ''времени запроса.''
|-
|2.0.0
|Новые функции

* Добавлена поддержка хранилища учётных данных. Теперь имя пользователя и пароль, необходимые для подключения к ElasticSearch, можно хранить в хранилище учётных данных Ключ-АСТРОМ в соответствии с требованиями.

Критическое изменение: после внедрения этого релиза вам потребуется пересоздать конфигурацию мониторинга. Приносим извинения за неудобства, но изменение поддержки хранилища учётных данных влечет за собой такие последствия.
|-
|1.1.6
|Изменения на уровне патча:

* Поддержка фильтрации показателей по менеджмент зонам.
* Исправлена проблема с fastcheck, использующей неправильную переменную «конечной точки».
* Исправлено неверное условие, препятствовавшее сбору информации.
|-
|1.1.4
|Изменения на уровне патча

* Если API Elasticsearch находится в общем доступе, имя пользователя и пароль не требуются.
* Добавлена проверка для подтверждения того, заданы ли имя пользователя и пароль перед настройкой базового типа аутентификации.
|-
|1.1.1
|Новые функции:

* поддержка аутентификации на основе токенов API для конечной точки Elasticsearch
|-
|1.0.9
|Новые функции

* Добавлена поддержка прокси-сервера в удаленном подключении к кластеру ElasticSearch.

Изменения на уровне патча

* Исправлено отношение SAME_AS между хостом, отслеживаемым ЕдинымАгентом, и серверными сущностями, созданными этим расширением.
|-
|1.0.7
|В этом выпуске изменён способ определения кластеров.

* Теперь для объекта idPattern вместо имени кластера используется UUID кластера. Это изменение необходимо для решения проблем, когда расширение отслеживает два идентичных кластера с одинаковыми именами узлов кластера, развёрнутых в разных средах, например, prod и dev.

Критическое изменение: сущности, созданные в предыдущей версии расширения, не будут сохранены, а после обновления расширения будут созданы новые сущности. Это может повлиять на ваши пользовательские дашборды и оповещения, если вы их создали — их также может потребоваться обновить.

Кроме того, в этом выпуске:

* Исправлена проблема со сбоем fastcheck из-за ошибки анализа схемы активации.
|-
|1.0.5
|Исправлены проблемы с тихим сбоем запросов к конечным точкам. Обновлен шаблон идентификатора узла, чтобы он был уникальным для всех кластеров, поэтому мониторинг производительности в многокластерной и многоузловой среде сохраняет корректную детализацию и топологические взаимосвязи.
|-
|1.0.2
|Первый выпуск расширения для мониторинга Elasticsearch на базе Prometheus. Использует общедоступные API, не требует активации Prometheus для мониторинга Elasticsearch.
|}

== Обзор ==
Это расширение удалённо отслеживает метрики кластеров, узлов и индексов '''Elasticsearch''', собирая их поминутно. Вы можете использовать экраны унифицированного анализа для анализа состояния кластеров '''Elasticsearch''' и детального анализа отдельных метрик для выявления первопричины потенциальных проблем с производительностью.

Это предназначено для пользователей, которые:

* Хотят отслеживать состояние и производительность своих кластеров, узлов и индексов '''Elasticsearch'''.
* Обращаются за аналитической поддержкой для администраторов операционных отделов, ИТ-отделов и сетей.

Это позволит вам:

* Контролировать свою инфраструктуру '''Elasticsearch''' с помощью комплексных унифицированных аналитических экранов и дашбордов.
* Включать оповещения на основе обнаруженных аномалий.

== Варианты использования ==

* Контролируйте состояние и производительность кластера '''ElasticSearch''', используя встроенные экраны анализа и удобные в навигации дашборды.
* Анализ первопричин проблем производительности кластера, узлов и индексов '''Elasticsearch'''.

== Начать ==

* В Ключ-АСТРОМ загрузите расширение '''Elasticsearch''' и нажмите '''Добавить конфигурацию мониторинга''' рядом с версией расширения в списке версий .
* Выберите '''хост''', который вы хотите отслеживать, затем укажите '''URL-адрес''' экземпляра '''elasticsearch''' и учетные данные для подключения к нему.
* Наконец, выберите наборы функций, содержащие метрики, которые вы хотите импортировать.

==== Требуются разрешения на доступ к кластеру Elasticsearch ====
Расширение использует следующие конечные точки '''Elasticsearch''' для сбора метрик:

* /_cluster/health
* /_all/_stats?level=shards
* /_nodes/stats
* /_alias
* /_cat/shards

Согласно [https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html документации '''Elasticsearch'''], по крайней мере

* контролировать привилегии кластера и
* привилегии '''monitor''' и '''view_index_metadata indexs'''

Требуются для пользователя, определенного в конфигурации мониторинга расширения.

== Подробности ==
Расширение '''Elasticsearch''' создано на основе новой платформы '''Расширения 2.0''' с использованием встроенного экспортера метрик '''Elasticsearch'''. Экраны '''Unified Analysis''' предоставляют информацию о состоянии и производительности кластеров '''Elasticsearch'''.

==== Этот пакет расширения содержит ====

* Конфигурацию источника данных для приема метрик.
* Определения топологии и взаимосвязей для кластеров '''Elasticsearch''' и их узлов, индексов, дисков и пулов потоков.
* Единые экраны анализа для каждого объекта (доступны с дашборда)
* Обзорный дашборд
* Оповещения по нескольким ключевым показателям
** Общая загрузка ЦП > 85%
** Использование файловой системы > 80%
** Открытые файловые дескрипторы > 80% от максимального количества файловых дескрипторов
** Использование кеша > 85%
** Отклоненные темы > 300

== Информация о совместимости ==

* Это расширение подключается к кластеру '''Elasticsearch''' через '''API'''. Кластер должен быть доступен из АктивногоШлюза, где было активировано расширение.
* Один хост, управляемый ЕдинымАгентом, также может запустить это расширение, поэтому кластер '''Elasticsearch''' можно контролировать из ЕдиногоАгента, указав на сетевой адрес '''localhost'''.
** Однако, если вы активируете расширение на нескольких хостах в одном кластере, вы будете получать одни и те же данные кластера несколько раз. Поэтому, если вы решите запустить его локально, активируйте его только на одном хосте в кластере.
* Это расширение поддерживает '''Elasticsearch''' версии '''8.0''' или выше.

DB Query

2026-09-15T18:10:27Z

Aleksandr.Zubarev:

= Расширение DB Query для Ключ-АСТРОМ =
Расширение '''DB Query''' предназначено для мониторинга баз данных через выполнение пользовательских запросов и извлечения метрик. Оно поддерживает основные реляционные СУБД и '''MongoDB''', позволяя превращать результаты запросов в метрики и измерения Ключ-АСТРОМ.

== Возможности расширения ==

* Подключение к базам данных '''PostgreSQL''', '''Oracle''', '''MySQL''', '''MariaDB''', '''SQL Server''' и '''MongoDB'''.
* Выполнение произвольных запросов ('''SQL''' или '''MongoDB'''-команд) и преобразование результатов в метрики и размерности.
* Настройка интервала выполнения запросов и расписания запуска по времени.
* Ограничение времени выполнения запроса.
* Проверка доступности подключения лёгким запросом ('''fastcheck''').
* Создание сущностей '''DB Query Host''' и '''DB Query Endpoint''' с топологическими связями.
* Готовый обзорный дашборд.
* Отображение ошибок подключения и выполнения в статусе расширения.

== Поддерживаемые базы данных ==

* '''PostgreSQL'''
* '''Oracle'''
* '''MySQL'''
* '''MariaDB'''
* '''SQL Server'''
* '''MongoDB'''

== Требования ==

* АктивныйШлюз с включённым выполнением расширений (или ЕдиныйАгент с '''EEC''').
* Сетевой доступ к базе данных.
* Учётные данные с правами на выполнение запросов.
* Для '''MongoDB''' — зависимость '''pymongo''' (включена в расширение).

== Конфигурация ==

Расширение выполняется на АктивномШлюзе и подключается к удалённым базам данных. АктивномуШлюзу должны быть доступны адрес и порт базы данных, а используемая учётная запись должна иметь право выполнять настроенные запросы.

Поддерживаемые базы данных:

* PostgreSQL
* Oracle Database
* MySQL
* MariaDB
* Microsoft SQL Server
* MongoDB

=== Настройка подключения ===

Подключение можно настроить с помощью отдельных полей или строки <code>JDBC connection string</code>.

Если строка подключения указана внутри endpoint, она имеет приоритет над общей строкой подключения. Отсутствующие в строке имя пользователя и пароль берутся из общих полей <code>DB user</code> и <code>DB password</code>.

Пароль рекомендуется хранить в секретном поле <code>DB password</code>, а не включать в строку подключения.

Поддерживаются строки подключения PostgreSQL, Oracle, MySQL, MariaDB, SQL Server, MongoDB и MongoDB SRV.

{| class="wikitable"
!Параметр
!Значение по умолчанию
!Описание
|-
|<code>DB name</code>
|—
|Тип базы данных: <code>Postgres</code>, <code>Oracle</code>, <code>MySQL</code>, <code>MariaDB</code>, <code>SQLServer</code> или <code>MongoDB</code>. Можно не заполнять, если тип определяется из строки подключения.
|-
|<code>Host</code>
|—
|IP-адрес или DNS-имя сервера. Можно не заполнять, если адрес указан в строке подключения.
|-
|<code>DB port</code>
|Стандартный порт СУБД
|Порт сервера базы данных.
|-
|<code>DB user</code>
|—
|Имя пользователя базы данных.
|-
|<code>DB password</code>
|—
|Пароль пользователя. Значение хранится как секрет.
|-
|<code>JDBC connection string</code>
|—
|Необязательная строка подключения. Максимальная длина — 2000 символов.
|-
|<code>Query interval (minutes)</code>
|<code>1</code>
|Интервал выполнения запросов без индивидуального расписания.
|-
|<code>Query timeout (seconds)</code>
|<code>600</code>
|Общий таймаут запроса. Допустимый диапазон — от 1 до 86400 секунд.
|-
|<code>Max rows per query</code>
|<code>10000</code>
|Максимальное количество строк или документов, получаемых одним запросом. Значение <code>0</code> отключает ограничение.
|-
|<code>Max parallel queries</code>
|<code>4</code>
|Количество одновременно выполняемых endpoint. Допустимый диапазон — от 1 до 20.
|}

=== Настройка endpoint ===

Конфигурация должна содержать от 1 до 100 endpoint. Каждый endpoint описывает один запрос и правила преобразования его результата в метрики.

{| class="wikitable"
!Параметр
!Обязательный
!Описание
|-
|<code>Endpoint Name</code>
|Да
|Уникальное имя запроса. Используется при формировании ключа метрики. Рекомендуется использовать латинские буквы в нижнем регистре, цифры и символ подчёркивания.
|-
|<code>DBase name</code>
|Условно
|Имя базы данных. Для Oracle указывается service name, PDB service или SID. Можно не заполнять, если имя базы содержится в строке подключения.
|-
|<code>JDBC connection string</code>
|Нет
|Строка подключения только для этого endpoint. Позволяет разным endpoint обращаться к разным серверам и базам данных.
|-
|<code>Query</code>
|Да
|SQL-запрос для реляционной базы данных или JSON-команда для MongoDB. Максимальная длина — 10000 символов.
|-
|<code>Schedule (cron or HH:MM)</code>
|Нет
|Индивидуальное расписание выполнения запроса по локальному времени АктивногоШлюза.
|-
|<code>Query timeout (seconds)</code>
|Нет
|Индивидуальный таймаут endpoint. Имеет приоритет над общим таймаутом.
|-
|<code>Dimension columns</code>
|Нет
|Имена или порядковые номера колонок, которые используются как измерения. Несколько значений разделяются запятыми.
|-
|<code>Metric columns</code>
|Нет
|Имена или порядковые номера числовых колонок, которые отправляются как метрики. Несколько значений разделяются запятыми.
|}

Порядковые номера колонок начинаются с 1. Например, значение <code>1,3</code> выбирает первую и третью колонки результата.

=== Расписание запросов ===

Если поле <code>Schedule (cron or HH:MM)</code> не заполнено, запрос выполняется через интервал, заданный в <code>Query interval (minutes)</code>.

Поддерживаются:

* точное время в формате <code>HH:MM</code>, например <code>09:00</code>;
* несколько значений времени через запятую, например <code>09:00,18:30</code>;
* cron из пяти полей, например <code>*/15 * * * *</code> или <code>0 9 * * 1-5</code>;
* макросы <code>@hourly</code>, <code>@daily</code>, <code>@weekly</code>, <code>@monthly</code> и <code>@yearly</code>;
* несколько расписаний через точку с запятой.

Секунды в cron-выражениях не поддерживаются. Запрос выполняется в течение пяти минут после расчётного времени и не более одного раза для каждого слота расписания.

=== Преобразование результата в метрики ===

Поле <code>Metric columns</code> определяет числовые колонки, которые отправляются как метрики. Если оно не заполнено, числовые колонки определяются автоматически.

Поле <code>Dimension columns</code> определяет колонки, которые добавляются как измерения. Если оно не заполнено, измерениями становятся все колонки, не выбранные как метрики.

При одной метрической колонке ключ формируется следующим образом:

<pre>
ru.ruscomtech.dbquery.<endpoint>
</pre>

При нескольких метрических колонках к ключу добавляется имя колонки:

<pre>
ru.ruscomtech.dbquery.<endpoint>.<column>
</pre>

Во все метрики автоматически добавляются измерения с адресом сервера, портом, типом базы данных, именем базы и именем endpoint.

Для MongoDB поле <code>Query</code> принимает JSON-команду. Поддерживаются операции <code>find</code>, <code>find_one</code>, <code>count_documents</code>, <code>estimated_document_count</code> и <code>aggregate</code>.

=== Проверка конфигурации ===

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

Для реляционных СУБД выполняется короткий запрос <code>SELECT 1</code>. Для Oracle используется <code>SELECT 1 FROM dual</code>, для MongoDB — команда <code>ping</code>.

Ошибки конфигурации, подключения, аутентификации и выполнения запросов отображаются в статусе расширения.

== Метрики ==

* <code>ru.ruscomtech.dbquery.host.status</code> — состояние настроенного хоста DB Query.
* <code>ru.ruscomtech.dbquery.query.duration</code> — продолжительность выполнения запроса в миллисекундах.
* <code>ru.ruscomtech.dbquery.query.timeout</code> — признак превышения таймаута: 1, если запрос завершён по таймауту, иначе 0.

== История версий ==

=== Версия 0.3.1 ===

* Добавлена поддержка строки подключения '''JDBC connection string''' на уровне расширения и отдельного endpoint. Поддерживаются PostgreSQL, Oracle, MySQL, MariaDB, SQL Server и MongoDB.
* Поля подключения можно не заполнять, если необходимые параметры указаны в строке подключения.
* Расписание запуска поддерживает cron из пяти полей, макросы <code>@hourly</code>, <code>@daily</code>, <code>@weekly</code>, <code>@monthly</code>, <code>@yearly</code> и прежний формат <code>HH:MM</code>.
* Таймаут запроса теперь задаётся в секундах. Его можно переопределить для отдельного endpoint.
* Добавлены ограничения <code>Max rows per query</code> и <code>Max parallel queries</code>.
* Добавлено параллельное выполнение endpoint.
* Добавлены метрики <code>ru.ruscomtech.dbquery.query.duration</code> и <code>ru.ruscomtech.dbquery.query.timeout</code>.

=== Версия 0.2.30 ===

* Лимит поля '''Query''' увеличен до 10000 символов.
* Добавлено поле '''Query timeout (minutes)''' для ограничения времени выполнения одного запроса. По умолчанию 10 минут; применяется для '''Postgres''', '''Oracle''', '''MySQL''', '''MariaDB''', '''SQLServer''' и '''MongoDB'''.
* Добавлено поле '''Execution times''' для запуска конкретного endpoint по расписанию. Формат: '''HH:MM''' по локальному времени хоста/АктивногоШлюза; несколько значений через запятую, например <code>09:00,18:30</code>.
* Запуск по '''Execution times''' выполняется в окне от указанного времени до +5 минут. Если поле пустое, endpoint выполняется по старому правилу через '''Query interval (minutes)'''.
* <code>fastcheck()</code> проверяет подключение к БД лёгким запросом: '''MongoDB''' — <code>ping</code>, '''Oracle''' — <code>SELECT 1 FROM dual</code>, '''MySQL/MariaDB/SQLServer''' — <code>SELECT 1</code>, '''Postgres''' — <code>SELECT 1</code>.
* Ошибки выполнения '''query''' больше не отображаются как '''OK''': последняя ошибка endpoint сохраняется и возвращается в '''runtime status'''.
* Ошибки подключения, авторизации и конфигурации мапятся в соответствующие '''StatusValue'''; ошибка '''Oracle''' <code>DPY-6005: cannot connect to database</code> классифицируется как <code>DEVICE_CONNECTION_ERROR</code>.
* Исправлена ошибка '''UnboundLocalError''' после неуспешного подключения к '''MongoDB''' или другой БД.
* Русифицированы описания полей.
* Добавлена служебная метрика <code>ru.ruscomtech.dbquery.host.status</code> для отображения '''DB Query Host''' на '''overview dashboard'''.
* Плитка '''DB Query Host''' теперь содержит '''Data Explorer''' query и показывает хосты по <code>device.address</code>.
* Метрика <code>ru.ruscomtech.dbquery.host.status</code> отправляется в каждом цикле <code>query()</code> для валидной конфигурации, даже если endpoint пропущен по расписанию или интервалу.

=== Версия 0.2.11 ===

* Добавлена поддержка '''MongoDB'''.
* Добавлена зависимость '''pymongo'''.
* Для '''MongoDB''' поле '''query''' принимает '''JSON''':
** raw '''MongoDB''' command для выполнения через <code>db.command(...)</code>;
** wrapper с <code>collection</code> и <code>operation</code>.
* Поддержанные операции '''MongoDB''': <code>find</code>, <code>find_one</code>, <code>count_documents</code>, <code>estimated_document_count</code>, <code>aggregate</code>.
* Поля <code>dimension_columns</code> и <code>metric_columns</code> работают для '''MongoDB''' по возвращаемым полям документов, так же как для '''SQL'''-колонок.

=== Версия 0.2.10 ===

* Добавлены '''topology''' entities для '''DB Query Host''' и '''DB Query Endpoint'''.
* Добавлен '''overview dashboard'''.

=== Версия 0.2.1 ===

* Добавлена поддержка '''Oracle'''.
* Добавлена функция ожидания после каждого выполнения.

== Примеры конфигурации ==

=== Пример MongoDB count ===
<pre>
{
"name": "mongo_orders_open",
"db_name": "mydb",
"query": "{\"collection\":\"orders\",\"operation\":\"count_documents\",\"filter\":{\"status\":\"open\"}}",
"metric_columns": "count"
}
</pre>

=== Пример MongoDB aggregate ===
<pre>
{
"name": "mongo_orders_by_status",
"db_name": "mydb",
"query": "{\"collection\":\"orders\",\"operation\":\"aggregate\",\"pipeline\":[{\"$group\":{\"_id\":\"$status\",\"total\":{\"$sum\":1}}}]}",
"dimension_columns": "_id",
"metric_columns": "total"
}
</pre>

Расширение Elasticsearch

2026-09-15T12:02:35Z

Aleksandr.Zubarev:

{| class="wikitable"
!Версия
!Изменения
|-
|2.0.2
|Изменения на уровне патча

* Исправлены проблемы с аутентификацией конечной точки при определенных обстоятельствах.
* Исправлено ''количество'' сообщений о значении метрик узлов, когда узлы используют один и тот же хост.
* Исправлена непоследовательность в предоставлении отчетов о значениях метрики ''времени запроса.''
|-
|2.0.0
|Новые функции

* Добавлена поддержка хранилища учётных данных. Теперь имя пользователя и пароль, необходимые для подключения к ElasticSearch, можно хранить в хранилище учётных данных Ключ-АСТРОМ в соответствии с требованиями.

Критическое изменение: после внедрения этого релиза вам потребуется пересоздать конфигурацию мониторинга. Приносим извинения за неудобства, но изменение поддержки хранилища учётных данных влечет за собой такие последствия.
|-
|1.1.6
|Изменения на уровне патча:

* Поддержка фильтрации показателей по менеджмент зонам.
* Исправлена проблема с fastcheck, использующей неправильную переменную «конечной точки».
* Исправлено неверное условие, препятствовавшее сбору информации.
|-
|1.1.4
|Изменения на уровне патча

* Если API Elasticsearch находится в общем доступе, имя пользователя и пароль не требуются.
* Добавлена проверка для подтверждения того, заданы ли имя пользователя и пароль перед настройкой базового типа аутентификации.
|-
|1.1.1
|Новые функции:

* поддержка аутентификации на основе токенов API для конечной точки Elasticsearch
|-
|1.0.9
|Новые функции

* Добавлена поддержка прокси-сервера в удаленном подключении к кластеру ElasticSearch.

Изменения на уровне патча

* Исправлено отношение SAME_AS между хостом, отслеживаемым ЕдинымАгентом, и серверными сущностями, созданными этим расширением.
|-
|1.0.7
|В этом выпуске изменён способ определения кластеров.

* Теперь для объекта idPattern вместо имени кластера используется UUID кластера. Это изменение необходимо для решения проблем, когда расширение отслеживает два идентичных кластера с одинаковыми именами узлов кластера, развёрнутых в разных средах, например, prod и dev.

Критическое изменение: сущности, созданные в предыдущей версии расширения, не будут сохранены, а после обновления расширения будут созданы новые сущности. Это может повлиять на ваши пользовательские дашборды и оповещения, если вы их создали — их также может потребоваться обновить.

Кроме того, в этом выпуске:

* Исправлена проблема со сбоем fastcheck из-за ошибки анализа схемы активации.
|-
|1.0.5
|Исправлены проблемы с тихим сбоем запросов к конечным точкам. Обновлен шаблон идентификатора узла, чтобы он был уникальным для всех кластеров, поэтому мониторинг производительности в многокластерной и многоузловой среде сохраняет корректную детализацию и топологические взаимосвязи.
|-
|1.0.2
|Первый выпуск расширения для мониторинга Elasticsearch на базе Prometheus. Использует общедоступные API, не требует активации Prometheus для мониторинга Elasticsearch.
|}

== Обзор ==
Это расширение удалённо отслеживает метрики кластеров, узлов и индексов '''Elasticsearch''', собирая их поминутно. Вы можете использовать экраны унифицированного анализа для анализа состояния кластеров '''Elasticsearch''' и детального анализа отдельных метрик для выявления первопричины потенциальных проблем с производительностью.

Это предназначено для пользователей, которые:

* Хотят отслеживать состояние и производительность своих кластеров, узлов и индексов '''Elasticsearch'''.
* Обращаются за аналитической поддержкой для администраторов операционных отделов, ИТ-отделов и сетей.

Это позволит вам:

* Контролировать свою инфраструктуру '''Elasticsearch''' с помощью комплексных унифицированных аналитических экранов и дашбордов.
* Включать оповещения на основе обнаруженных аномалий.

== Варианты использования ==

* Контролируйте состояние и производительность кластера '''ElasticSearch''', используя встроенные экраны анализа и удобные в навигации дашборды.
* Анализ первопричин проблем производительности кластера, узлов и индексов '''Elasticsearch'''.

== Начать ==

* В Ключ-АСТРОМ загрузите расширение '''Elasticsearch''' и нажмите '''Добавить конфигурацию мониторинга''' рядом с версией расширения в списке версий .
* Выберите '''хост''', который вы хотите отслеживать, затем укажите '''URL-адрес''' экземпляра '''elasticsearch''' и учетные данные для подключения к нему.
* Наконец, выберите наборы функций, содержащие метрики, которые вы хотите импортировать.

==== Требуются разрешения на доступ к кластеру Elasticsearch ====
Расширение использует следующие конечные точки '''Elasticsearch''' для сбора метрик:

* /_cluster/health
* /_all/_stats?level=shards
* /_nodes/stats
* /_alias
* /_cat/shards

Согласно [https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html документации '''Elasticsearch'''], по крайней мере

* контролировать привилегии кластера и
* привилегии '''monitor''' и '''view_index_metadata indexs'''

Требуются для пользователя, определенного в конфигурации мониторинга расширения.

== Подробности ==
Расширение '''Elasticsearch''' создано на основе новой платформы '''Расширения 2.0''' с использованием встроенного экспортера метрик '''Elasticsearch'''. Экраны '''Unified Analysis''' предоставляют информацию о состоянии и производительности кластеров '''Elasticsearch'''.

==== Этот пакет расширения содержит ====

* Конфигурацию источника данных для приема метрик.
* Определения топологии и взаимосвязей для кластеров '''Elasticsearch''' и их узлов, индексов, дисков и пулов потоков.
* Единые экраны анализа для каждого объекта (доступны с дашборда)
* Обзорный дашборд
* Оповещения по нескольким ключевым показателям
** Общая загрузка ЦП > 85%
** Использование файловой системы > 80%
** Открытые файловые дескрипторы > 80% от максимального количества файловых дескрипторов
** Использование кеша > 85%
** Отклоненные темы > 300

== Информация о совместимости ==

* Это расширение подключается к кластеру '''Elasticsearch''' через '''API'''. Кластер должен быть доступен из АктивногоШлюза, где было активировано расширение.
* Один хост, управляемый ЕдинымАгентом, также может запустить это расширение, поэтому кластер '''Elasticsearch''' можно контролировать из ЕдиногоАгента, указав на сетевой адрес '''localhost'''.
** Однако, если вы активируете расширение на нескольких хостах в одном кластере, вы будете получать одни и те же данные кластера несколько раз. Поэтому, если вы решите запустить его локально, активируйте его только на одном хосте в кластере.
* Это расширение поддерживает '''Elasticsearch''' версии '''8.0''' или выше.

Расширение Elasticsearch

2026-09-15T12:01:51Z

Aleksandr.Zubarev:

{| class="wikitable"
!Версия
!Изменения
|-
|2.0.2
|Изменения на уровне патча

* Исправлены проблемы с аутентификацией конечной точки при определенных обстоятельствах.
* Исправлено ''количество'' сообщений о значении метрик узлов, когда узлы используют один и тот же хост.
* Исправлена непоследовательность в предоставлении отчетов о значениях метрики ''времени запроса.''
|-
|2.0.0
|Новые функции

* Добавлена поддержка хранилища учётных данных. Теперь имя пользователя и пароль, необходимые для подключения к ElasticSearch, можно хранить в хранилище учётных данных Ключ-АСТРОМ в соответствии с требованиями.

Критическое изменение: после внедрения этого релиза вам потребуется пересоздать конфигурацию мониторинга. Приносим извинения за неудобства, но изменение поддержки хранилища учётных данных влечет за собой такие последствия.
|-
|1.1.6
|Изменения на уровне патча:

* Поддержка фильтрации показателей по менеджмент зонам.
* Исправлена проблема с fastcheck, использующей неправильную переменную «конечной точки».
* Исправлено неверное условие, препятствовавшее сбору информации.
|-
|1.1.4
|Изменения на уровне патча

* Если API Elasticsearch находится в общем доступе, имя пользователя и пароль не требуются.
* Добавлена проверка для подтверждения того, заданы ли имя пользователя и пароль перед настройкой базового типа аутентификации.
|-
|1.1.1
|Новые функции:

* поддержка аутентификации на основе токенов API для конечной точки Elasticsearch
|-
|1.0.9
|Новые функции

* Добавлена поддержка прокси-сервера в удаленном подключении к кластеру ElasticSearch.

Изменения на уровне патча

* Исправлено отношение SAME_AS между хостом, отслеживаемым ЕдинымАгентом, и серверными сущностями, созданными этим расширением.
|-
|1.0.7
|В этом выпуске изменён способ определения кластеров.

* Теперь для объекта idPattern вместо имени кластера используется UUID кластера. Это изменение необходимо для решения проблем, когда расширение отслеживает два идентичных кластера с одинаковыми именами узлов кластера, развёрнутых в разных средах, например, prod и dev.

Критическое изменение: сущности, созданные в предыдущей версии расширения, не будут сохранены, а после обновления расширения будут созданы новые сущности. Это может повлиять на ваши пользовательские дашборды и оповещения, если вы их создали — их также может потребоваться обновить.

Кроме того, в этом выпуске:

* Исправлена проблема со сбоем fastcheck из-за ошибки анализа схемы активации.
|-
|1.0.5
|Исправлены проблемы с тихим сбоем запросов к конечным точкам. Обновлен шаблон идентификатора узла, чтобы он был уникальным для всех кластеров, поэтому мониторинг производительности в многокластерной и многоузловой среде сохраняет корректную детализацию и топологические взаимосвязи.
|-
|1.0.2
|Первый выпуск расширения для мониторинга Elasticsearch на базе Prometheus. Использует общедоступные API, не требует активации Prometheus для мониторинга Elasticsearch.
|}

== Обзор ==
Это расширение удалённо отслеживает метрики кластеров, узлов и индексов '''Elasticsearch''', собирая их поминутно. Вы можете использовать экраны унифицированного анализа для анализа состояния кластеров '''Elasticsearch''' и детального анализа отдельных метрик для выявления первопричины потенциальных проблем с производительностью.

Это предназначено для пользователей, которые:

* Хотят отслеживать состояние и производительность своих кластеров, узлов и индексов '''Elasticsearch'''.
* Обращаются за аналитической поддержкой для администраторов операционных отделов, ИТ-отделов и сетей.

Это позволит вам:

* Контролировать свою инфраструктуру '''Elasticsearch''' с помощью комплексных унифицированных аналитических экранов и дашбордов.
* Включать оповещения на основе обнаруженных аномалий.

== Варианты использования ==

* Контролируйте состояние и производительность кластера '''ElasticSearch''', используя встроенные экраны анализа и удобные в навигации дашборды.
* Анализ первопричин проблем производительности кластера, узлов и индексов '''Elasticsearch'''.

== Начать ==

* В Ключ-АСТРОМ загрузите расширение '''Elasticsearch''' и нажмите '''Добавить конфигурацию мониторинга''' рядом с версией расширения в списке версий .
* Выберите '''хост''', который вы хотите отслеживать, затем укажите '''URL-адрес''' экземпляра '''elasticsearch''' и учетные данные для подключения к нему.
* Наконец, выберите наборы функций, содержащие метрики, которые вы хотите импортировать.

==== Требуются разрешения на доступ к кластеру Elasticsearch ====
Расширение использует следующие конечные точки '''Elasticsearch''' для сбора метрик:

* /_cluster/health
* /_all/_stats?level=shards
* /_nodes/stats
* /_alias
* /_cat/shards

Согласно [https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html документации '''Elasticsearch'''], по крайней мере

* контролировать привилегии кластера и
* привилегии '''monitor''' и '''view_index_metadata indexs'''

требуются для пользователя, определенного в конфигурации мониторинга расширения.

== Подробности ==
Расширение '''Elasticsearch''' создано на основе новой платформы '''Расширения 2.0''' с использованием встроенного экспортера метрик '''Elasticsearch'''. Экраны '''Unified Analysis''' предоставляют информацию о состоянии и производительности кластеров '''Elasticsearch'''.

==== Этот пакет расширения содержит ====

* Конфигурацию источника данных для приема метрик.
* Определения топологии и взаимосвязей для кластеров '''Elasticsearch''' и их узлов, индексов, дисков и пулов потоков.
* Единые экраны анализа для каждого объекта (доступны с дашборда)
* Обзорный дашборд
* Оповещения по нескольким ключевым показателям
** Общая загрузка ЦП > 85%
** Использование файловой системы > 80%
** Открытые файловые дескрипторы > 80% от максимального количества файловых дескрипторов
** Использование кеша > 85%
** Отклоненные темы > 300

== Информация о совместимости ==

* Это расширение подключается к кластеру '''Elasticsearch''' через '''API'''. Кластер должен быть доступен из АктивногоШлюза, где было активировано расширение.
* Один хост, управляемый ЕдинымАгентом, также может запустить это расширение, поэтому кластер '''Elasticsearch''' можно контролировать из ЕдиногоАгента, указав на сетевой адрес '''localhost'''.
** Однако, если вы активируете расширение на нескольких хостах в одном кластере, вы будете получать одни и те же данные кластера несколько раз. Поэтому, если вы решите запустить его локально, активируйте его только на одном хосте в кластере.
* Это расширение поддерживает '''Elasticsearch''' версии '''8.0''' или выше.