Это перевод страницы документации с английского языка. Помогите нам сделать его лучше.

1. Zabbix агент 2

Zabbix агент 2 поддерживает все ключи элементов данных, которые поддерживаются Zabbix агентом в Unix и Windows. На этой странице представлена подробная информация о дополнительных ключах элементов данных, которые вы можете использовать только с Zabbix агентом 2; эти ключи сгруппированы по плагинам, к которым они относятся.

Ключи элементов данных приведены без параметров и дополнительной информации. Нажмите на ключ элемента данных, чтобы увидеть все подробности.

Ключ элемента данных Описание Плагин
ceph.df.details Использование данных кластера и распределение между пулами. Ceph
ceph.osd.stats Агрегированная статистика и статистика по каждому OSD.
ceph.osd.discovery Список обнаруженных OSD.
ceph.osd.dump Пороги использования и состояния OSD.
ceph.ping Проверка, можно ли установить подключение к Ceph.
ceph.pool.discovery Список обнаруженных пулов.
ceph.status Общее состояние кластера.
docker.container_info Низкоуровневая информация о контейнере. Docker
docker.container_stats Статистика использования ресурсов контейнером.
docker.containers Получение списка контейнеров.
docker.containers.discovery Получение списка контейнеров. Используется для низкоуровневого обнаружения.
docker.data.usage Информация о текущем использовании данных.
docker.images Получение списка образов.
docker.images.discovery Получение списка образов. Используется для низкоуровневого обнаружения.
docker.info Информация о системе.
docker.ping Проверка, активен или нет Docker демон.
ember.get Возвращает результат требуемого устройства. Ember+
memcached.ping Проверка, можно ли установить подключение. Memcached
memcached.stats Получение вывода команды STATS.
mongodb.collection.stats Получение различной статистики хранилища по заданной коллекции. MongoDB
mongodb.collections.discovery Получение списка обнаруженных коллекций.
mongodb.collections.usage Получение статистики использования по коллекциям.
mongodb.connpool.stats Получение информации касательно открытых исходящих подключений с текущего экземпляра базы данных к другим членам кластера сегментов или набора реплик.
mongodb.db.stats Получение статистики, отражающей состояние системы заданной базы.
mongodb.db.discovery Получение списка обнаруженных баз данных.
mongodb.jumbo_chunks.count Получение количества jumbo chunk.
mongodb.oplog.stats Получение состояния набора реплик, используя данные, полученные от oplog.
mongodb.ping Проверка, можно ли установить подключение.
mongodb.rs.config Получение текущей конфигурации набора реплик.
mongodb.rs.status Получение состояния набора реплик с точки зрения члена, откуда вызывается метод.
mongodb.server.status Получение состояния базы данных.
mongodb.sh.discovery Получение списка обнаруженных сегментов, находящихся в кластере.
mongodb.version Получение версии сервера базы данных.
mqtt.get Подписка на заданную тему или темы (с шаблонами), которые предоставляются брокером, и ожидание публикаций. MQTT
mssql.availability.group.get Получение доступности группы. MSSQL
mssql.custom.query Получение результата пользовательского запроса.
mssql.db.get Получение всех доступных баз данных MSSQL.
mssql.job.status.get Получение состояния джобов.
mssql.last.backup.get Получение для всех баз данных времени последнего резервного копирования.
mssql.local.db.get Получение баз данных, которые участвуют в группе доступности Always On, и реплики (основная или вторичная) расположены на сервере, к которому установлено подключение.
mssql.mirroring.get Получение информации о зеркалировании.
mssql.nonlocal.db.get Получение баз данных, которые участвуют в группе доступности Always On и реплики (основная или вторичная) расположены на других серверах (база данных не является локальной на экземпляре сервера SQL, к которому установлено подключение).
mssql.perfcounter.get Получение счётчиков производительности.
mssql.ping Проверка, доступно подключение или нет.
mssql.quorum.get Получение информации о кворуме.
mssql.quorum.member.get Получение информации о членах кворума.
mssql.replica.get Получение реплик.
mssql.version Получение версии MSSQL.
mysql.custom.query Получение результата пользовательского запроса. MySQL
mysql.db.discovery Получение списка баз данных MySQL.
mysql.db.size Размер базы данных в байтах.
mysql.get_status_variables Значения глобальных переменных состояния.
mysql.ping Проверка, можно ли установить подключение
mysql.replication.discovery Получение списка репликаций MySQL.
mysql.replication.get_slave_status Состояние репликации.
mysql.version Версия MySQL.
net.dns.get Выполнение DNS-запроса и получение подробной информации о DNS-записи. Network
oracle.diskgroups.stats Получение статистики группы дисков ASM (Automatic Storage Management). Oracle
oracle.diskgroups.discovery Получение списка групп дисков ASM.
oracle.archive.info Статистика архивных журналов.
oracle.cdb.info Информация о контейнерных базах данных (CDB).
oracle.custom.query Результат пользовательского запроса.
oracle.datafiles.stats Получение статистики файлов данных.
oracle.db.discovery Получение списка баз данных.
oracle.fra.stats Получение статистики области быстрого восставовления (FRA).
oracle.instance.info Статистика экземпляра.
oracle.pdb.info Информация о PDB (Pluggable Databases).
oracle.pdb.discovery Получение списка PDB.
oracle.pga.stats Получение статистики PGA (Program Global Area).
oracle.ping Проверка, можно ли установить подключение к Oracle.
oracle.proc.stats Получение статистики по процессам.
oracle.redolog.info Информация о файле журнала из контрольного файла.
oracle.sga.stats Получение статистики SGA (System Global Area).
oracle.sessions.stats Получение статистики сессий.
oracle.sys.metrics Получение набора значений системных метрик.
oracle.sys.params Получение набора значений системных параметров.
oracle.ts.stats Получение статистики табличных пространств.
oracle.ts.discovery Получение списка табличных пространств.
oracle.user.info Получение информации о пользователе Oracle.
oracle.version Получение версии сервера баз данных.
pgsql.autovacuum.count Количество autovacuum worker. PostgreSQL
pgsql.archive Информация об архивных файлах.
pgsql.bgwriter Общее количество контрольных точек (checkpoint) по кластеру базы данных, с разбивкой по типу контрольных точек.
pgsql.cache.hit Коэффициент успешности кэша буфера PostgreSQL.
pgsql.connections Получение подключений по типу.
pgsql.custom.query Получение результата пользовательского запроса.
pgsql.db.age Возраст самого старого FrozenXID в базе данных.
pgsql.db.bloating_tables Количество «распухших» (bloating) таблиц по каждой базе данных.
pgsql.db.discovery Список баз данных PostgreSQL.
pgsql.db.size Размер базы данных в байтах.
pgsql.dbstat Сбор статистики по каждой базе данных.
pgsql.dbstat.sum Обобщённые данные по всем базам данных в кластере.
pgsql.locks Информация о предоставленных блокировках по каждой базе данных.
pgsql.oldest.xid Возраст самого старого XID.
pgsql.ping Проверка, можно ли установить подключение.
pgsql.queries Измерение времени выполнения запросов.
pgsql.replication.count Количество серверов в режиме ожидания.
pgsql.replication.process Отставание сброса, отставание записи и отставание replay по каждому процессу sender.
pgsql.replication.process.discovery Обнаружение имени процесса репликации.
pgsql.replication.recovery_role Состояние восстановления.
pgsql.replication.status Состояние репликации.
pgsql.replication_lag.b Отставание репликации в байтах.
pgsql.replication_lag.sec Отставание репликации в секундах.
pgsql.uptime Время работы PostgreSQL в миллисекундах.
pgsql.version Получение версии PostgreSQL.
pgsql.wal.stat Статистика WAL.
redis.config Получение параметров конфигурации экземпляра Redis, которые соответствуют шаблону. Redis
redis.info Получение вывода команды INFO.
redis.ping Проверка, можно ли установить подключение.
redis.slowlog.count Количество медленных записей в журнале с момента запуска Redis.
smart.attribute.discovery Получение списка S.M.A.R.T. атрибутов устройств. S.M.A.R.T.
smart.disk.discovery Получение списка S.M.A.R.T. устройств.
smart.disk.get Получение всех доступных свойств S.M.A.R.T. устройств.
systemd.unit.get Получение всех свойств модуля systemd. Systemd
systemd.unit.info Информация о модуле systemd.
systemd.unit.discovery Список модулей systemd и их подробностей.
web.certificate.get Проверка достоверности сертификатов и получение сведений о сертификатах. Web certificates

Смотрите также: - Поставляемые плагины - Подгружаемые плагины

Подробности ключей элементов данных

Параметры без угловых скобок обязательны. Параметры, обозначенные угловыми скобками < >, опциональны.

ceph.df.details[строка_подкл,<пользователь>,<ключ_api>]


Использование данных кластера и распределение между пулами.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь, пароль — учётные данные для входа в Ceph.
ceph.osd.stats[строка_подкл,<пользователь>,<ключ_api]


Агрегированная статистика и статистика по каждому OSD.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь, пароль — учётные данные для входа в Ceph.
ceph.osd.discovery[строка_подкл,<пользователь>,<ключ_api]


Список обнаруженных OSD. Используется для низкоуровневого обнаружения.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь, пароль — учётные данные для входа в Ceph.
ceph.osd.dump[строка_подкл,<пользователь>,<ключ_api]


Пороги использования и состояния OSD.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь, пароль — учётные данные для входа в Ceph.
ceph.ping[строка_подкл,<пользователь>,<ключ_api>]


Проверка, можно ли установить подключение к Ceph.
Возвращаемое значение: 0 — подключение разорвано (если имеется какая-либо ошибка, включая проблемы с аутентификацией или проблемы с настройками); 1 — подключение успешно.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь, пароль — учётные данные для входа в Ceph.
ceph.pool.discovery[строка_подкл,<пользователь>,<ключ_api>]


Список обнаруженных пулов. Используется для низкоуровневого обнаружения.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь, пароль — учётные данные для входа в Ceph.
ceph.status[строка_подкл,<пользователь>,<ключ_api>]


Общее состояние кластера.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь, пароль — учётные данные для входа в Ceph.
docker.container_info[<ID>,<info>]


Низкоуровневая информация о контейнере.
Возвращаемое значение: Вывод API вызова ContainerInspect [en], преобразованный в JSON.

Параметры:

  • ID — ID или имя контейнера;
  • info — объём возвращаемой информации. Возможные значения: short (по умолчанию) или full.

Пользователь Агента 2 («zabbix») должен быть добавлен в группу [en] «docker» для достаточных привилегий. В противном случае проверка завершится с ошибкой.

docker.container_stats[<ID>]


Статистика использования ресурсов контейнером.
Возвращаемое значение: Вывод API вызова ContainerStats [en] и использование CPU в процентах, преобразованные в JSON.

Параметр:

  • ID — ID или имя контейнера.

Пользователь Агента 2 («zabbix») должен быть добавлен в группу [en] «docker» для достаточных привилегий. В противном случае проверка завершится с ошибкой.

docker.containers


Список контейнеров.
Возвращаемое значение: Вывод API вызова ContainerList [en], преобразованный в JSON.

Пользователь Агента 2 («zabbix») должен быть добавлен в группу [en] «docker» для достаточных привилегий. В противном случае проверка завершится с ошибкой.

docker.containers.discovery[<опции>]


Получение списка контейнеров. Используется для низкоуровневого обнаружения.
Возвращаемое значение: Объект JSON.

Параметр:

  • опции — задаёт, следует ли обнаруживать все или только запущенные контейнеры. Поддерживаемые значения: true — возвращать все контейнеры; false — возвращать только запущенные контейнеры (по умолчанию).

Пользователь Агента 2 («zabbix») должен быть добавлен в группу [en] «docker» для достаточных привилегий. В противном случае проверка завершится с ошибкой.

docker.data.usage


Информация о текущем использовании данных.
Возвращаемое значение: Вывод API вызова SystemDataUsage [en], преобразованный в JSON.

Пользователь Агента 2 («zabbix») должен быть добавлен в группу [en] «docker» для достаточных привилегий. В противном случае проверка завершится с ошибкой.

docker.images


Получение списка образов.
Возвращаемое значение: Вывод API вызова ImageList [en], преобразованный в JSON.

Пользователь Агента 2 («zabbix») должен быть добавлен в группу [en] «docker» для достаточных привилегий. В противном случае проверка завершится с ошибкой.

docker.images.discovery


Получение списка образов. Используется для низкоуровневого обнаружения.
Возвращаемое значение: Объект JSON.

Пользователь Агента 2 («zabbix») должен быть добавлен в группу [en] «docker» для достаточных привилегий. В противном случае проверка завершится с ошибкой.

docker.info


Информация о системе.
Возвращаемое значение: Вывод API вызова SystemInfo [en], преобразованный в JSON.

Пользователь Агента 2 («zabbix») должен быть добавлен в группу [en] «docker» для достаточных привилегий. В противном случае проверка завершится с ошибкой.

docker.ping


Проверка, активен или нет Docker демон.
Возвращаемое значение: 1 — подключение установлено; 0 — подключение разорвано.

Пользователь Агента 2 («zabbix») должен быть добавлен в группу [en] «docker» для достаточных привилегий. В противном случае проверка завершится с ошибкой.

ember.get[<uri>,<путь>]


Возвращает результат требуемого устройства.
Возвращаемое значение: Объект JSON.

Параметры:

  • uri — URI устройства Ember+ . По умолчанию: 127.0.0.1:9998;
  • путь — OID путь к устройству. По умолчанию пусто, возвращает данные корневой коллекции.
memcached.ping[строка_подкл,<пользователь>,<пароль>]


Проверка, можно ли установить подключение.
Возвращаемое значение: 1 — подключение активно; 0 — подключение разорвано (если имеется какая-либо ошибка, включая проблемы с аутентификацией или проблемы с настройками).

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь, пароль — учётные данные для входа в Memchached.
memcached.stats[строка_подкл,<пользователь>,<пароль>,<тип>]


Получение вывода команды STATS.
Возвращаемое значение: JSON — вывод, преобразованный в JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь, пароль — учётные данные для входа в Memchached;
  • тип — тип возвращаемой статистики: items, sizes, slabs или settings (по умолчанию пусто, возвращается общая статистика).
mongodb.collection.stats[строка_подкл,<имя_пользователя>,<пароль>,<база_данных>,коллекция]


Получение различной статистики хранилища по заданной коллекции.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные к MongoDB;
  • база_данных — имя базы данных (по умолчанию: admin);
  • коллекция — имя коллекции.
mongodb.collections.discovery[строка_подкл,<имя_пользователя>,<пароль>]


Получение списка обнаруженных коллекций. Используется для низкоуровневого обнаружения.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные к MongoDB.
mongodb.collections.usage[строка_подкл,<имя_пользователя>,<пароль>]


Получение статистики использования по коллекциям.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные к MongoDB.
mongodb.connpool.stats[строка_подкл,<имя_пользователя>,<пароль>]


Получение информации касательно открытых исходящих подключений с текущего экземпляра базы данных к другим членам кластера сегментов или набора реплик.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные к MongoDB;
  • база_данных — имя базы (по умолчанию: admin);
  • коллекция — имя коллекции.
mongodb.db.stats[строка_подкл,<имя_пользователя>,<пароль>,<база_данных>]


Получение статистики, отражающей состояние системы заданной базы.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные к MongoDB;
  • база_данных — имя базы (по умолчанию: admin).
mongodb.db.discovery[строка_подкл,<имя_пользователя>,<пароль>]


Получение списка обнаруженных баз данных. Используется для низкоуровневого обнаружения.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные к MongoDB.
mongodb.jumbo_chunks.count[строка_подкл,<имя_пользователя>,<пароль>]


Получение количества jumbo chunk.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные к MongoDB.
mongodb.oplog.stats[строка_подкл,<имя_пользователя>,<пароль>]


Получение состояния набора реплик, используя данные полученные от oplog.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные к MongoDB.
mongodb.ping[строка_подкл,<имя_пользователя>,<пароль>]


Проверка, можно ли установить подключение.
Возвращаемое значение: 1 — подключение успешно; 0 — подключение разорвано (если имеется какая-либо ошибка, включая проблемы с аутентификацией или проблемы с настройками).

Параметры:

  • строка_подкл — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные к MongoDB.
mongodb.rs.config[строка_подкл,<имя_пользователя>,<пароль>]


Получение текущей конфигурации набора реплик.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные к MongoDB.
mongodb.rs.status[строка_подкл,<имя_пользователя>,<пароль>]


Получение состояния набора реплик с точки зрения члена, откуда вызывается метод.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные к MongoDB.
mongodb.server.status[строка_подкл,<имя_пользователя>,<пароль>]


Получение состояния базы данных.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные к MongoDB.
mongodb.sh.discovery[строка_подкл,<имя_пользователя>,<пароль>]


Получение списка обнаруженных сегментов, находящихся в кластере.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные к MongoDB.
mongodb.version[строка_подкл,<имя_пользователя>,<пароль>]


Получение версии сервера базы данных.
Возвращаемое значение: Строка.

Параметры:

  • строка_подкл — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные к MongoDB.
mqtt.get[<url_ брокера>,тема,<имя_пользователя>,<пароль>]


Подписка на заданную тему или темы (с шаблонами), которые предоставляются брокером, и ожидание публикаций.
Возвращаемое значение: Зависит от содержимого темы. Если использовался шаблон, возвращает содержимое темы в виде JSON.

Параметры:

  • url_брокера — URL брокера MQTT в формате протокол://хост:порт без параметров запроса (поддерживаемые протоколы: tcp, ssl, ws). Если значение не указано, агент будет использовать tcp://localhost:1883. Если протокол или порт не указаны, будет использоваться протокол по умолчанию (tcp) или порт по умолчанию (1883);
  • тема — тема MQTT (обязательно). Поддерживаются шаблоны (+,#);
  • имя_пользователя,пароль — учётные данные для аутентификации (если требуется).

Комментарии:

  • Элемент данных необходимо настроить как активная проверка (тип элемента данных «Zabbix агент (активный)»);
  • Можно использовать сертификаты TLS шифрования, сохранив их в место по умолчанию (например, в Ubuntu директория /etc/ssl/certs/). Для TLS используйте схему tls://.
mssql.availability.group.get[URI,<имя_пользователя>,<пароль>]


Возвращает доступность группы.
Возвращаемое значение: Объект JSON.

Параметры:

  • URI — URI сервера MSSQL (поддерживается только схема sqlserver://). Встроенные креденшиалы будут проигнорированы. Начиная с версии Zabbix 7.0.6, можно указать имя экземпляра как часть URI, например: sqlserver://localhost/InstanceName (без порта). Если указан порт, имя экземпляра игнорируется;
  • имя_пользователя, пароль — имя пользователя и пароль, пересылаемые на защищённый сервер MSSQL.

Для получения дополнительной информации см. readme плагина MSSQL [en].

mssql.custom.query[URI,<имя_пользователя>,<пароль>,имяЗапроса,<аргументы...>]


Возвращает результат пользовательского запроса.
Возвращаемое значение: Объект JSON.

Параметры:

  • URI — URI сервера MSSQL (поддерживается только схема sqlserver://). Встроенные креденшиалы будут проигнорированы. Начиная с версии Zabbix 7.0.6, можно указать имя экземпляра как часть URI, например: sqlserver://localhost/InstanceName (без порта). Если указан порт, имя экземпляра игнорируется;
  • имя_пользователя, пароль — имя пользователя и пароль, пересылаемые на защищённый сервер MSSQL;
  • имяЗапроса — имя пользовательского запроса, настроенного в Plugins.MSSQL.CustomQueriesDir без расширения .sql;
  • аргументы — один или несколько перечисленных через запятую аргументов, которые будут переданы запросу.

Для получения дополнительной информации см. readme плагина MSSQL [en].

mssql.db.get


Возвращает все доступные базы данных MSSQL.
Возвращаемое значение: Объект JSON.

Для получения дополнительной информации см. readme плагина MSSQL [en].

mssql.job.status.get


Возвращает состояние джобов.
Возвращаемое значение: Объект JSON.

Для получения дополнительной информации см. readme плагина MSSQL [en].

mssql.last.backup.get


Возвращает для всех баз данных время последнего резервного копирования.
Возвращаемое значение: Объект JSON.

Для получения дополнительной информации см. readme плагина MSSQL [en].

mssql.local.db.get


Возвращает базы данных, которые участвуют в группе доступности Always On, и реплики (основная или вторичная) расположены на сервере, к которому установлено подключение.
Возвращаемое значение: Объект JSON.

Для получения дополнительной информации см. readme плагина MSSQL [en].

mssql.mirroring.get


Возвращает информацию о зеркалировании.
Возвращаемое значение: Объект JSON.

Для получения дополнительной информации см. readme плагина MSSQL [en].

mssql.nonlocal.db.get


Возвращает базы данных, которые участвуют в группе доступности Always On и реплики (основная или вторичная) расположены на других серверах (база данных не является локальной на экземпляре сервера SQL, к которому установлено подключение).
Возвращаемое значение: Объект JSON.

Для получения дополнительной информации см. readme плагина MSSQL [en].

mssql.perfcounter.get


Возвращает счётчики производительности.
Возвращаемое значение: Объект JSON.

Для получения дополнительной информации см. readme плагина MSSQL [en].

mssql.ping


Пинг базы данных. Тестирует, верно ли настроено подключение.
Возвращаемое значение: 1 — жив, 0 — не жив.

Для получения дополнительной информации см. readme плагина MSSQL [en].

mssql.quorum.get


Возвращает информацию о кворуме.
Возвращаемое значение: Объект JSON.

Для получения дополнительной информации см. readme плагина MSSQL [en].

mssql.quorum.member.get


Возвращает информацию о членах кворума.
Возвращаемое значение: Объект JSON.

Для получения дополнительной информации см. readme плагина MSSQL [en].

mssql.replica.get


Возвращает реплики.
Возвращаемое значение: Объект JSON.

Для получения дополнительной информации см. readme плагина MSSQL [en].

mssql.version


Возвращает версию MSSQL.
Возвращаемое значение: Строка.

Для получения дополнительной информации см. readme плагина MSSQL [en].

mysql.custom.query[строка_подкл,<имя_пользователя>,<пароль>,имяЗапроса,<аргументы...>]


Возвращает результат пользовательского запроса.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные для входа в MySQL;
  • имяЗапроса — имя пользовательского запроса, должно совпадать с именем SQL файла без расширения;
  • args аргументы — один или несколько перечисленных через запятую аргументов, которые будут переданы запросу.

Для получения дополнительной информации смотрите файл readme плагина MySQL.

mysql.db.discovery[строка_подкл, <имя_пользователя>, <пароль>]


Возвращает список баз данных MySQL. Используется для низкоуровневого обнаружения.
Возвращаемое значение: Результат SQL запроса «show databases» в формате LLD JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные для входа в MySQL.
mysql.db.size[строка_подкл, <имя_пользователя>, <пароль>,<имя_базы>]


Размер базы данных в байтах.
Возвращаемое значение: Результат SQL запроса «select coalesce(sum(data_length + index_length),0) as size from information_schema.tables where table_schema=?» для указанной базы данных в байтах.

Параметры:

  • строка_подкл — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные для входа в MySQL;
  • имя_базы — имя базы данных.
mysql.get_status_variables[строка_подкл, <имя_пользователя>, <пароль>]


Значения глобальных переменных состояния.
Возвращаемое значение: Результат SQL запроса «show global status» в формате JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные для входа в MySQL.
mysql.ping[строка_подкл, <имя_пользователя>, <пароль>]


Проверка, можно ли установить подключение.
Возвращаемое значение: 1 — подключение успешно; 0 — подключение разорвано (если имеется какая-либо ошибка, включая проблемы с аутентификацией или проблемы с настройками).

Параметры:

  • строка_подкл — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные для входа в MySQL.
mysql.replication.discovery[строка_подкл, <имя_пользователя>, <пароль>]


Возвращает список репликаций MySQL. Используется для низкоуровневого обнаружения.
Возвращаемое значение: Результат SQL запроса «show slave status» в формате LLD JSON.

Parameters:

  • строка_подкл — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные для входа в MySQL.
mysql.replication.get_slave_status[строка_подкл, <имя_пользователя>, <пароль>, <хост_мастера>]


Состояние репликации.
Возвращаемое значение: Результат SQL запроса «show slave status» в формате JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные для входа в MySQL;
  • хост_мастера — Имя хоста мастера репликации. Если не найдено, возвращается ошибка. Если данный параметр не указан, возвращаются все хосты.
mysql.version[строка_подкл, <имя_пользователя>, <пароль>]


Версия MySQL.
Возвращаемое значение: Строка (с версией экземпляра MySQL).

Параметры:

  • строка_подкл — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные для входа в MySQL.
net.dns.get[<ip>,имя,<тип>,<время ожидания>,<количество>,<протокол>,"<флаги>"]

Выполнение DNS-запроса и получение подробной информации о DNS-записи.
Этот элемент данных является расширенной версией элемента данных Zabbix агента net.dns.record с поддержкой большего количества типов записей и настраиваемыми флагами.
Возвращаемые значения: Объект JSON

Параметры:

  • ip — IP адрес DNS сервера (оставьте пустым, чтобы использовались DNS сервера по умолчанию);
  • имя — проверяемое имя DNS;
  • тип — запрашиваемый тип записи (по умолчанию SOA);
  • время ожидания — время ожидания ответа в секундах (по умолчанию 1 секунда);
  • количество — количество попыток запросов (по умолчанию 2);
  • протокол — используемый протокол при выполнении DNS запросов: udp (по умолчанию) или tcp;
  • флаги — один или несколько аргументов через запятую для передачи в запрос.

Комментарии:

  • Возможные значения для параметра тип: A, NS, MD, MF, CNAME, SOA, MB, MG, MR, NULL, PTR, HINFO, MINFO, MX, TXT, RP, AFSDB, X25, ISDN, RT, NSAPPTR, SIG, KEY, PX, GPOS, AAAA, LOC, NXT, EID, NIMLOC, SRV, ATMA, NAPTR, KX, CERT, DNAME, OPT, APL, DS, SSHFP, IPSECKEY, RRSIG, NSEC, DNSKEY, DHCID, NSEC3, NSEC3PARAM, TLSA, SMIMEA, HIP, NINFO, RKEY, TALINK, CDS, CDNSKEY, OPENPGPKEY, CSYNC, ZONEMD, SVCB, HTTPS, SPF, UINFO, UID, GID, UNSPEC, NID, L32, L64, LP, EUI48, EUI64, URI, CAA, AVC, AMTRELAY. Обратите внимание, что значения должны быть только в верхнем регистре; значения в нижнем регистре или смешанном регистре не поддерживаются.
  • Для обратных DNS-поисков (когда тип задан значением PTR) можно указать DNS-имя как в обратном, так и в необратном формате (см. примеры ниже). Обратите внимание, что при запросе записи PTR имя DNS на самом деле является IP-адресом.
  • Возможные значения для параметра флаги: cdflag или nocdflag (по умолчанию), rdflag (по умолчанию) или nordflag, dnssec или nodnssec (по умолчанию), nsid или nonsid (по умолчанию), edns0 (по умолчанию) или noedns0, aaflag или noaaflag (по умолчанию), adflag или noadflag (по умолчанию). Значения параметра флаги dnssec и nsid нельзя использовать вместе с noedns0, так как для обоих требуется edns0. Обратите внимание, что значения должны быть только в нижнем регистре; значения в верхнем регистре или смешанные значения не поддерживаются.
  • Интерационализированные доменные имена не поддерживаются; вместо них, пожалуйста, используйте имена в IDNA кодировке.
  • Выходные данные представляют собой объект, содержащий информацию о записи DNS на основе предоставленных параметров (см. подробнее).

Примеры:

net.dns.get[192.0.2.0,zabbix.com,DNSKEY,3,3,tcp,"cdflag,rdflag,nsid"]
       
       net.dns.get[,198.51.100.1,PTR,,,,"cdflag,rdflag,nsid"]
       net.dns.get[,1.100.51.198.in-addr.arpa,PTR,,,,"cdflag,rdflag,nsid"]
       
       net.dns.get[,2a00:1450:400f:800::200e,PTR,,,,"cdflag,rdflag,nsid"]
       net.dns.get[,e.0.0.2.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.0.f.0.0.4.0.5.4.1.0.0.a.2.ip6.arpa,PTR,,,,"cdflag,rdflag,nsid"]
oracle.diskgroups.stats[строка_подкл,<пользователь>,<пароль>,<сервис>,<диск_группа>]


Возвращает статистику группы дисков ASM (Automatic Storage Management).
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь — имя пользователя Oracle, поддерживает добавление одной из опций подключения as sysdba, as sysoper или as sysasm в формате пользователь as sysdba (опция подключения чувствительна к регистру; не должна заканчиваться пробелом);
  • пароль — пароль Oracle;
  • сервис — имя сервиса Oracle;
  • диск_группа — имя опрашиваемой группы дисков ASM.
oracle.diskgroups.discovery[строка_подкл,<пользователь>,<пароль>,<сервис>]


Возвращает список групп дисков ASM. Используется для низкоуровневого обнаружения.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь — имя пользователя Oracle, поддерживает добавление одной из опций подключения as sysdba, as sysoper или as sysasm в формате пользователь as sysdba (опция подключения чувствительна к регистру; не должна заканчиваться пробелом);
  • пароль — пароль Oracle;
  • сервис — имя сервиса Oracle.
oracle.archive.info[строка_подкл,<пользователь>,<пароль>,<сервис>,<адресат>]


Статистика архивных журналов.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь — имя пользователя Oracle, поддерживает добавление одной из опций подключения as sysdba, as sysoper или as sysasm в формате пользователь as sysdba (опция подключения чувствительна к регистру; не должна заканчиваться пробелом);
  • пароль — пароль Oracle;
  • сервис — имя сервиса Oracle;
  • адресат — имя опрашиваемого адресата.
oracle.cdb.info[строка_подкл,<пользователь>,<пароль>,<сервис>,<база_данных>]


Информация о контейнерных базах данных (CDB).
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь — имя пользователя Oracle, поддерживает добавление одной из опций подключения as sysdba, as sysoper или as sysasm в формате пользователь as sysdba (опция подключения чувствительна к регистру; не должна заканчиваться пробелом);
  • пароль — пароль Oracle;
  • сервис — имя сервиса Oracle;
  • база_данных — имя опрашиваемой базы данных.
oracle.custom.query[строка_подкл,<пользователь>,<пароль>,<сервис>, имя_запроса, <аргументы...>]


Результат пользовательского запроса.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь — имя пользователя Oracle, поддерживает добавление одной из опций подключения as sysdba, as sysoper или as sysasm в формате пользователь as sysdba (опция подключения чувствительна к регистру; не должна заканчиваться пробелом);
  • пароль — пароль Oracle;
  • сервис — имя сервиса Oracle;
  • имя_запроса — имя пользовательского запроса, должно совпадать с именем sql файла без расширения;
  • аргументы... — один или несколько аргументов, разделённых запятой, которые будут переданы запросу.
oracle.datafiles.stats[строка_подкл,<пользователь>,<пароль>,<сервис>]


Возвращает статистику файлов данных.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь — имя пользователя Oracle, поддерживает добавление одной из опций подключения as sysdba, as sysoper или as sysasm в формате пользователь as sysdba (опция подключения чувствительна к регистру; не должна заканчиваться пробелом);
  • пароль — пароль Oracle;
  • сервис — имя сервиса Oracle.
oracle.db.discovery[строка_подкл,<пользователь>,<пароль>,<сервис>]


Возвращает список баз данных. Используется для низкоуровневого обнаружения.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь — имя пользователя Oracle, поддерживает добавление одной из опций подключения as sysdba, as sysoper или as sysasm в формате пользователь as sysdba (опция подключения чувствительна к регистру; не должна заканчиваться пробелом);
  • пароль — пароль Oracle;
  • сервис — имя сервиса Oracle.
oracle.fra.stats[строка_подкл,<пользователь>,<пароль>,<сервис>]


Возвращает статистику области быстрого восстановления (Fast Recovery Area, FRA).
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь — имя пользователя Oracle, поддерживает добавление одной из опций подключения as sysdba, as sysoper или as sysasm в формате пользователь as sysdba (опция подключения чувствительна к регистру; не должна заканчиваться пробелом);
  • пароль — пароль Oracle;
  • сервис — имя сервиса Oracle.
oracle.instance.info[строка_подкл,<пользователь>,<пароль>,<сервис>]


Статистика экземпляра.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь — имя пользователя Oracle, поддерживает добавление одной из опций подключения as sysdba, as sysoper или as sysasm в формате пользователь as sysdba (опция подключения чувствительна к регистру; не должна заканчиваться пробелом);
  • пароль — пароль Oracle;
  • сервис — имя сервиса Oracle.
oracle.pdb.info[строка_подкл,<пользователь>,<пароль>,<сервис>,<база_данных>]


Информация о PDB (Pluggable Databases).
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь — имя пользователя Oracle, поддерживает добавление одной из опций подключения as sysdba, as sysoper или as sysasm в формате пользователь as sysdba (опция подключения чувствительна к регистру; не должна заканчиваться пробелом);
  • пароль — пароль Oracle;
  • сервис — имя сервиса Oracle;
  • база_данных — имя опрашиваемой базы данных.
oracle.pdb.discovery[строка_подкл,<пользователь>,<пароль>,<сервис>]


Возвращаеь список PDB. Используется для низкоуровневого обнаружения.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь — имя пользователя Oracle, поддерживает добавление одной из опций подключения as sysdba, as sysoper или as sysasm в формате пользователь as sysdba (опция подключения чувствительна к регистру; не должна заканчиваться пробелом);
  • пароль — пароль Oracle;
  • сервис — имя сервиса Oracle.
oracle.pga.stats[строка_подкл,<пользователь>,<пароль>,<сервис>]


Возвращает статистику PGA (Program Global Area).
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь — имя пользователя Oracle, поддерживает добавление одной из опций подключения as sysdba, as sysoper или as sysasm в формате пользователь as sysdba (опция подключения чувствительна к регистру; не должна заканчиваться пробелом);
  • пароль — пароль Oracle;
  • сервис — имя сервиса Oracle.
oracle.ping[строка_подкл,<пользователь>,<пароль>,<сервис>]


Проверка, можно ли установить подключение к Oracle.
Возвращаемое значение: 1 — подключение успешно; 0 — подключение разорвано (если имеется какая-либо ошибка, включая проблемы с аутентификацией или проблемы с настройками).

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь — имя пользователя Oracle, поддерживает добавление одной из опций подключения as sysdba, as sysoper или as sysasm в формате пользователь as sysdba (опция подключения чувствительна к регистру; не должна заканчиваться пробелом);
  • пароль — пароль Oracle;
  • сервис — имя сервиса Oracle.
oracle.proc.stats[строка_подкл,<пользователь>,<пароль>,<сервис>]


Возвращает статистику по процессам.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь — имя пользователя Oracle, поддерживает добавление одной из опций подключения as sysdba, as sysoper или as sysasm в формате пользователь as sysdba (опция подключения чувствительна к регистру; не должна заканчиваться пробелом);
  • пароль — пароль Oracle;
  • сервис — имя сервиса Oracle.
oracle.redolog.info[строка_подкл,<пользователь>,<пароль>,<сервис>]


Информация о файле журнала из контрольного файла.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь — имя пользователя Oracle, поддерживает добавление одной из опций подключения as sysdba, as sysoper или as sysasm в формате пользователь as sysdba (опция подключения чувствительна к регистру; не должна заканчиваться пробелом);
  • пароль — пароль Oracle;
  • сервис — имя сервиса Oracle.
oracle.sga.stats[строка_подкл,<пользователь>,<пароль>,<сервис>]


Возвращает статистику SGA (System Global Area).
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь — имя пользователя Oracle, поддерживает добавление одной из опций подключения as sysdba, as sysoper или as sysasm в формате пользователь as sysdba (опция подключения чувствительна к регистру; не должна заканчиваться пробелом);
  • пароль — пароль Oracle;
  • сервис — имя сервиса Oracle.
oracle.sessions.stats[строка_подкл,<пользователь>,<пароль>,<сервис>,<макс_время_блок>]


Возвращает статистику сессий.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь — имя пользователя Oracle, поддерживает добавление одной из опций подключения as sysdba, as sysoper или as sysasm в формате пользователь as sysdba (опция подключения чувствительна к регистру; не должна заканчиваться пробелом);
  • пароль — пароль Oracle;
  • сервис — имя сервиса Oracle;
  • макс_время_блок — максимальная длительность блокировки сессии в секундах, чтобы он считался заблокированным на долгий срок. По умолчанию: 600 секунд.
oracle.sys.metrics[строка_подкл,<пользователь>,<пароль>,<сервис>,<длительность>]


Возвращает набор значений системных метрик.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь — имя пользователя Oracle, поддерживает добавление одной из опций подключения as sysdba, as sysoper или as sysasm в формате пользователь as sysdba (опция подключения чувствительна к регистру; не должна заканчиваться пробелом);
  • пароль — пароль Oracle;
  • сервис — имя сервиса Oracle;
  • длительность — интервал захвата (в секундах) значений системных метрик. Возможные значения: 60 — долгая длительность (по умолчанию), 15 — короткая длительность.
oracle.sys.params[строка_подкл,<пользователь>,<пароль>,<сервис>]


Возвращает набор значений системных параметров.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь — имя пользователя Oracle, поддерживает добавление одной из опций подключения as sysdba, as sysoper или as sysasm в формате пользователь as sysdba (опция подключения чувствительна к регистру; не должна заканчиваться пробелом);
  • пароль — пароль Oracle;
  • сервис — имя сервиса Oracle.
oracle.ts.stats[строка_подкл,<пользователь>,<пароль>,<сервис>,<tablespace>,<тип>,<имя_контейнера>]


Возвращает статистикау табличных пространств.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь — имя пользователя Oracle, поддерживает добавление одной из опций подключения as sysdba, as sysoper или as sysasm в формате пользователь as sysdba (опция подключения чувствительна к регистру; не должна заканчиваться пробелом);
  • пароль — пароль Oracle;
  • сервис — имя сервиса Oracle;
  • tablespace — имя опрашиваемого табличного пространства. По умолчанию (если оставлено пустым и тип задан):
    - "TEMP" (если тип выставлен в "TEMPORARY");
    - "USERS" (если тип выставлен в "PERMANENT").
  • тип — тип опрашиваемого табличного пространства. По умолчанию (если tablespace задано): "PERMANENT".
  • имя_контейнера — имя контейнера, для которого требуется информация.

Если tablespace, тип или имя_контейнера пропущены, элемент данных вернёт статистику табличных пространств для всех соответствующих контейнеров (включая PDB и CDB).

oracle.ts.discovery[строка_подкл,<пользователь>,<пароль>,<сервис>]


Возвращает список табличных пространств. Используется для низкоуровневого обнаружения.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь — имя пользователя Oracle, поддерживает добавление одной из опций подключения as sysdba, as sysoper или as sysasm в формате пользователь as sysdba (опция подключения чувствительна к регистру; не должна заканчиваться пробелом);
  • пароль — пароль Oracle;
  • сервис — имя сервиса Oracle.
oracle.user.info[строка_подкл,<пользователь>,<пароль>,<сервис>,<имя_пользователя>]


Возвращает информацию о пользователе Oracle.
Возвращаемое значение: Объект JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь — имя пользователя Oracle, поддерживает добавление одной из опций подключения as sysdba, as sysoper или as sysasm в формате пользователь as sysdba (опция подключения чувствительна к регистру; не должна заканчиваться пробелом);
  • пароль — пароль Oracle;
  • сервис — имя сервиса Oracle;
  • имя_пользователя — имя пользователя, по которому необходима информация. Имена пользователей в нижнем регистре не поддерживаются. По умолчанию: текущее имя пользователя.
oracle.version[строка_подкл,<пользователь>,<пароль>,<сервис>]


Возвращает версию сервера баз данных.
Возвращаемое значение: Строка.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пользователь — имя пользователя Oracle, поддерживает добавление одной из опций подключения as sysdba, as sysoper или as sysasm в формате пользователь as sysdba (опция подключения чувствительна к регистру; не должна заканчиваться пробелом);
  • пароль — пароль Oracle;
  • сервис — имя сервиса Oracle.
pgsql.autovacuum.count[uri,<имя_пользователя>,<пароль>,<имя_бд>]


Количество autovacuum worker.
Возвращаемое значение: Целое число.

Параметры:

  • uri — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные PostgreSQL;
  • имя_бд — имя базы данных.
pgsql.archive[uri,<имя_пользователя>,<пароль>,<имя_бд>]


Информация об архивных файлах.
Возвращаемое значение: Объект JSON.

Параметры:

  • uri — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные PostgreSQL;
  • имя_бд — имя базы данных.
pgsql.bgwriter[uri,<имя_пользователя>,<пароль>,<имя_бд>]


Общее количество контрольных точек (checkpoint) по кластеру базы данных, с разбивкой по типу контрольных точек.
Возвращаемое значение: Объект JSON.

Параметры:

  • uri — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные PostgreSQL;
  • имя_бд — имя базы данных.
pgsql.cache.hit[uri,<имя_пользователя>,<пароль>,<имя_бд>]


Коэффициент успешности кэша буфера PostgreSQL.
Возвращаемое значение: Число с плавающей точкой.

Параметры:

  • uri — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные PostgreSQL;
  • имя_бд — имя базы данных.
pgsql.connections[uri,<имя_пользователя>,<пароль>,<имя_бд>]


Возвращает подключения по типу.
Возвращаемое значение: Объект JSON.

Параметры:

  • uri — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные PostgreSQL;
  • имя_бд — имя базы данных.
pgsql.custom.query[uri,<имя_пользователя>,<пароль>,имя_запроса,<аргументы...>]


Возвращает результат пользовательского запроса.
Возвращаемое значение: Объект JSON.

Параметры:

  • uri — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные PostgreSQL;
  • имя_запроса — имя пользовательского запроса, должно совпадать с именем sql файла без расширения;
  • аргументы — один или несколько аргументов (через запятую), которые будут переданы запросу.
pgsql.db.age[uri,<имя_пользователя>,<пароль>,<имя_бд>]


Возраст самого старого FrozenXID в базе данных.
Возвращаемое значение: Целое число.

Параметры:

  • uri — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные PostgreSQL;
  • имя_бд — имя базы данных.
pgsql.db.bloating_tables[uri,<имя_пользователя>,<пароль>,<имя_бд>]


Количество «распухших» (bloating) таблиц по каждой базе данных.
Возвращаемое значение: Целое число.

Параметры:

  • uri — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные PostgreSQL;
  • имя_бд — имя базы данных.
pgsql.db.discovery[uri,<имя_пользователя>,<пароль>,<имя_бд>]


Список баз данных PostgreSQL. Используется для низкоуровневого обнаружения.
Возвращаемое значение: Объект JSON.

Параметры:

  • uri — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные PostgreSQL;
  • имя_бд — имя базы данных.
pgsql.db.size[uri,<имя_пользователя>,<пароль>,<имя_бд>]


Размер базы данных в байтах.
Возвращаемое значение: Целое число.

Параметры:

  • uri — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные PostgreSQL;
  • имя_бд — имя базы данных.
pgsql.dbstat[uri,<имя_пользователя>,<пароль>,<имя_бд>]


Сбор статистики по каждой базе данных. Используется для низкоуровневого обнаружения.
Возвращаемое значение: Объект JSON.

Параметры:

  • uri — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные PostgreSQL;
  • имя_бд — имя базы данных.
pgsql.dbstat.sum[uri,<имя_пользователя>,<пароль>,<имя_бд>]


Обобщённые данные по всем базам данных в кластере.
Возвращаемое значение: Объект JSON.

Параметры:

  • uri — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные PostgreSQL;
  • имя_бд — имя базы данных.
pgsql.locks[uri,<имя_пользователя>,<пароль>,<имя_бд>]


Информация о предоставленных блокировках по каждой базе данных. Используется для низкоуровневого обнаружения.
Возвращаемое значение: Объект JSON.

Параметры:

  • uri — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные PostgreSQL;
  • имя_бд — имя базы данных.
pgsql.oldest.xid[uri,<имя_пользователя>,<пароль>,<имя_бд>]


Возраст самого старого XID.
Возвращаемое значение: Целое число.

Параметры:

  • uri — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные PostgreSQL;
  • имя_бд — имя базы данных.
pgsql.ping[uri,<имя_пользователя>,<пароль>,<имя_бд>]


Проверка, можно ли установить подключение.
Возвращаемое значение: 1 — подключение успешно; 0 — подключение разорвано (если имеется какая-либо ошибка, включая проблемы с аутентификацией или проблемы с настройками).

Параметры:

  • uri — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные PostgreSQL;
  • имя_бд — имя базы данных.
pgsql.queries[uri,<имя_пользователя>,<пароль>,<имя_бд>,<период_времени>]


Измерение времени выполнения запросов.
Возвращаемое значение: Объект JSON.

Параметры:

  • uri — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные PostgreSQL;
  • имя_бд — имя базы данных.
  • период_времени — ограничение времени выполнения для подсчёта медленных запросов (должно быть целым положительным числом).
pgsql.replication.count[uri,<имя_пользователя>,<пароль>]


Количество серверов в режиме ожидания.
Возвращаемое значение: Целое число.

Параметры:

  • uri — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные PostgreSQL.
pgsql.replication.process[uri,<имя_пользователя>,<пароль>]


Отставание сброса, отставание записи и отставание replay по каждому процессу sender.
Возвращаемое значение: Объект JSON.

Параметры:

  • uri — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные PostgreSQL.
pgsql.replication.process.discovery[uri,<имя_пользователя>,<пароль>]


Обнаружение имени процесса репликации.
Возвращаемое значение: Объект JSON.

Параметры:

  • uri — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные PostgreSQL.
pgsql.replication.recovery_role[uri,<имя_пользователя>,<пароль>]


Состояние восстановления.
Возвращаемое значение: 0 — режим ведущего; 1 — восстановление ещё в процессе (режим ведомого).

Параметры:

  • uri — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные PostgreSQL.
pgsql.replication.status[uri,<имя_пользователя>,<пароль>]


Состояние репликации.
Возвращаемое значение: 0 — передача потока не работает; 1 — передача потока работает; 2 — режим ведущего.

Параметры:

  • uri — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные PostgreSQL.
pgsql.replication_lag.b[uri,<имя_пользователя>,<пароль>]


Отставание репликации в байтах.
Возвращаемое значение: Целое число.

Параметры:

  • uri — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные PostgreSQL.
pgsql.replication_lag.sec[uri,<имя_пользователя>,<пароль>]


Отставание репликации в секундах.
Возвращаемое значение: Целое число.

Параметры:

  • uri — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные PostgreSQL.
pgsql.uptime[uri,<имя_пользователя>,<пароль>,<имя_бд>]


Время работы PostgreSQL в миллисекундах.
Возвращаемое значение: Число с плавающей точкой.

Параметры:

  • uri — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные PostgreSQL;
  • имя_бд — имя базы данных.
pgsql.version[uri,<имя_пользователя>,<пароль>,<имя_бд>]


Возвращает версию PostgreSQL.
Возвращаемое значение: Строка.

Параметры:

  • uri — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные PostgreSQL;
  • имя_бд — имя базы данных.
pgsql.wal.stat[uri,<имя_пользователя>,<пароль>,<имя_бд]


Статистика WAL.
Возвращаемое значение: Объект JSON.

Параметры:

  • uri — URI или имя сессии;
  • имя_пользователя, пароль — учётные данные PostgreSQL;
  • имя_бд — имя базы данных.
redis.config[строка_подкл,<пароль>,<шаблон>]


Получение параметров конфигурации экземпляра Redis, которые соответствуют шаблону.
Возвращаемое значение: JSON — если использовался шаблон в стиле glob; одно значение — если шаблон не содержит какого-либо символа подстановки.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пароль — пароль к Redis;
  • шаблон — шаблон в стиле glob (по умолчанию *).
redis.info[строка_подкл,<пароль>,<раздел>]


Получение вывода команды INFO.
Возвращаемое значение: JSON — вывод преобразован в JSON.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пароль — пароль к Redis;
  • разделраздел [en] информации (по умолчанию default).
redis.ping[строка_подкл,<пароль>]


Проверка, можно ли установить подключение.
Возвращаемое значение: 1 — подключение успешно; 0 — подключение разорвано (если имеется какая-либо ошибка, включая проблемы с аутентификацией или проблемы с настройками).

Параметры:

  • строка_подкл — URI или имя сессии;
  • пароль — пароль к Redis.
redis.slowlog.count[строка_подкл,<пароль>]


Количество медленных записей в журнале с момента запуска Redis.
Возвращаемое значение: Целое число.

Параметры:

  • строка_подкл — URI или имя сессии;
  • пароль — пароль к Redis.
smart.attribute.discovery


Возвращает список S.M.A.R.T. атрибутов устройств.
Возвращаемое значение: Объект JSON.

Комментарии:

  • Возвращаются следующие макросы и их значения: {#NAME}, {#DISKTYPE}, {#ID}, {#ATTRNAME}, {#THRESH};
  • Поддерживаются типы дисков HDD, SSD и NVME. Диски могут быть одиночными или объединёнными в RAID. {#NAME} будет иметь дополнение в случае RAID, например: {"{#NAME}": "/dev/sda cciss,2"}.
smart.disk.discovery


Возвращает список S.M.A.R.T. устройств.
Возвращаемое значение: Объект JSON.

Комментарии:

  • Возвращаются следующие макросы и их значения: {#NAME}, {#DISKTYPE}, {#MODEL}, {#SN}, {#PATH}, {#ATTRIBUTES}, {#RAIDTYPE};
  • Поддерживаются типы дисков HDD, SSD и NVME. Если диск не объединён в RAID, {#RAIDTYPE} будет пустым. {#NAME} будет иметь дополнение в случае RAID, например: {"{#NAME}": "/dev/sda cciss,2"}.
smart.disk.get[<путь>,<тип_raid>]


Возвращает все доступные свойства S.M.A.R.T. устройств.
Возвращаемое значение: Объект JSON.

Параметры:

  • путь — путь к диску, в качестве значения можно использовать макрос {#PATH};
  • тип_raid — тип RAID, в качестве значения можно использовать макрос {#RAID}

Комментарии:

  • Поддерживаются типы дисков HDD, SSD и NVME. Диски могут быть одиночными или объединёнными в RAID;
  • Данные включают версию smartctl и аргументы вызова, а также дополнительные поля:
    disk_name — содержит имя с требуемым дополнением для обнаружения RAID, например: {"disk_name": "/dev/sda cciss,2"}
    disk_type — содержит тип диска HDD, SSD или NVME, например: {"disk_type": "ssd"};
  • Если параметры не указаны, элемент данных вернёт информацию обо всех дисках.
systemd.unit.get[имя модуля,<интерфейс>]


Возвращает все свойства модуля systemd.
Возвращаемое значение: Объект JSON.

Параметры:

  • имя модуля — имя модуля (вы, возможно, захотите использовать макрос {#UNIT.NAME} в прототипе элементов данных для обнаружения имени);
  • интерфейс — тип интерфейса модуля, возможные значения: Unit (по умолчанию), Service, Socket, Device, Mount, Automount, Swap, Target, Path.

Комментарии:

  • Этот элемент данных поддерживается только на платформе Linux;
  • LoadState, ActiveState и UnitFileState для интерфейса модуля возвращаются в виде текста и целого числа: "ActiveState":{"state":1,"text":"active"}.
systemd.unit.info[имя модуля,<свойство>,<интерфейс>]


Информация о модуле systemd.
Возвращаемое значение: Строка.

Параметры:

  • имя модуля — имя модуля (вы, возможно, захотите использовать макрос {#UNIT.NAME} в прототипе элементов данных для обнаружения имени);
  • свойство — имя свойства (например, ActiveState (по умолчанию), LoadState, Description);
  • интерфейс — тип интерфейса (например, Unit (по умолчанию), Socket, Service).

Комментарии:

  • Этот элемент данных поддерживается только на платформе Linux;
  • Этот элемент данных позволяет получать определённые свойства с заданного типа интерфейса, которые описаны в dbus API [en].

Примеры:

systemd.unit.info["{#UNIT.NAME}"] #получение информации активного состояния (активный, перезагрузка, неактивный, ошибочный, активация, деактивация) с обнаруженных модулей systemd
       systemd.unit.info["{#UNIT.NAME}",LoadState] #получение информации состояния загрузки с обнаруженных модулей systemd
       systemd.unit.info[mysqld.service,Id] #получение технического имени службы (mysqld.service)
       systemd.unit.info[mysqld.service,Description] #получение описания службы (MySQL Server)
       systemd.unit.info[mysqld.service,ActiveEnterTimestamp] #получение последнего времени, когда служба перешла в активное состояние (1562565036283903)
       systemd.unit.info[dbus.socket,NConnections,Socket] #получение количества соединений с этого модуля сокета
systemd.unit.discovery[<тип>]


Список модулей systemd и их подробностей. Используется для низкоуровневого обнаружения.
Возвращаемое значение: Объект JSON.

Параметр:

  • тип — возможные значения: all, automount, device, mount, path, service (по умолчанию), socket, swap, target.

Этот элемент данных поддерживается только на платформе Linux.

web.certificate.get[имя_хоста,<порт>,<адрес>]


Проверяет достоверность сертификатов и возвращает сведения о сертификатах.
Возвращаемое значение: Объект JSON.

Параметры:

  • имя_хоста — может быть как IP, так и DNS.
    Может содержать схему URL (только https), путь (будет проигнорирован) и порт.
    Если порт указывается в первом и втором параметрах, значения портов должны совпадать.
    Если указан адрес ( третий параметр), имя хоста используется только для удостоверения SNI и имени хоста;
  • порт — номер порта (по умолчанию 443 для HTTPS);
  • адрес — может быть как IP, так и DNS. Если указан, будет использоваться для подключения, и имя хоста (первый параметр) будет использоваться для удостоверения SNI и хоста. В случае, если первый параметр IP адрес, а третий параметр — DNS, то первый параметр будет использоваться для подключения, а третий параметр будет использоваться для удостоверения SNI и хоста.

Комментарии:

  • Этот элемент данных становится неподдерживаемым, если ресурс, указанный в имя_хоста, не существует, или если TLS квитирование завершится с любой ошибкой, за исключением ошибочного сертификата;
  • В настоящее время расширение AIA (Authority Information Access) X.509, CRL и OCSP (включая OCSP сшивание), Certificate Transparency и пользовательские хранилища CA не поддерживаются.