3 Скрипты

Обзор

В разделе Оповещения > Скрипты можно настраивать и обслуживать пользовательские глобальные скрипты.

Это меню доступно только пользователям типа SuperAdmin.

Глобальные скрипты, в зависимости от настроенной области действия и разрешений пользователя, доступны для выполнения:

• Из меню узла сети в различных разделах веб-интерфейса (Панель мониторинга, Проблемы, Последние данные, Карты и т. д.).
• Из меню события.
• В качестве операции действия.

Скрипты выполняются только агентом Zabbix, сервером Zabbix (прокси) или сервером Zabbix. См. также раздел Выполнение команд.

Удаленные команды по умолчанию отключены и на агенте Zabbix, и на прокси Zabbix. Их можно включить следующим образом:

• Для удаленных команд, выполняемых агентом Zabbix, добавьте параметр AllowKey=system.run[<command>,*] для каждой разрешенной команды в конфигурации агента, где * соответствует любому режиму выполнения (wait или nowait).
• Для удаленных команд, выполняемых прокси Zabbix, установите параметр EnableRemoteCommands в значение 1 в конфигурации прокси. Обратите внимание, что включать удаленные команды на прокси Zabbix не требуется, если они выполняются агентом Zabbix на узле сети, который отслеживается прокси.

Выполнение глобальных скриптов на сервере Zabbix можно отключить, установив EnableGlobalScripts=0 в конфигурации сервера. В новых установках, начиная с Zabbix 7.0, выполнение глобальных скриптов на сервере Zabbix по умолчанию отключено.

Отображается список существующих скриптов с подробной информацией о них.

Отображаемые данные:

Чтобы настроить новый скрипт, нажмите кнопку Создать скрипт в правом верхнем углу.

Параметры массового редактирования

Кнопка под списком предлагает один вариант массового редактирования:

• Delete - удалить скрипты

Чтобы использовать этот вариант, отметьте флажки перед соответствующими скриптами и нажмите Delete.

Использование фильтра

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

Ссылка Filter доступна над списком скриптов. Если вы нажмете ее, станет доступен фильтр, с помощью которого можно фильтровать скрипты по имени и области применения.

Настройка глобального скрипта

Атрибуты скрипта:

Расширенная настройка

Дополнительные параметры настройки доступны в сворачиваемом разделе Расширенная настройка:

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

Ручной ввод пользователем

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

Например, при выполнении скрипта может потребоваться указать другое целое число или другой URL-адрес.

Чтобы включить ручной ввод пользователем:

• используйте макрос {MANUALINPUT} в скрипте (командах, скрипте, параметре скрипта), где это необходимо; или в поле URL для скриптов URL;
• в разделе расширенной настройки скрипта включите ручной ввод пользователем и настройте параметры ввода.

Если ручной ввод включен, перед выполнением скрипта пользователю будет показано всплывающее окно Ручной ввод с предложением указать пользовательское значение. Указанное значение заменит {MANUALINPUT} в скрипте.

В зависимости от конфигурации пользователю будет предложено ввести строковое значение:

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

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

Выполнение скрипта и результат

Скрипты, запускаемые сервером Zabbix, выполняются в порядке, описанном на странице выполнения команд.

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

• Если скрипт завершается успешно (код выхода 0), возвращаемое значение ограничено 16 МБ (включая конечные пробельные символы, которые усекаются).
• Если скрипт завершается с ошибкой (ненулевой код выхода), возвращаемое значение представляет собой стандартный поток ошибок, ограниченный 2 КБ.

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

Обратите внимание, что для скриптов, выполняемых сервером Zabbix или прокси Zabbix, также применяются ограничения базы данных.

Ниже приведен пример скрипта и окна с результатом:

uname -v
/tmp/non_existing_script.sh
echo "This script was started by {USER.USERNAME}"

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

Тайм-аут скрипта в агенте Zabbix

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

Ниже приведен пример выполнения скрипта на агенте Zabbix и окно с результатом:

sleep 5
df -h

В этом случае сообщение об ошибке будет следующим:

Timeout while executing a shell script.

Чтобы избежать таких ситуаций, рекомендуется оптимизировать сам скрипт (в приведенном выше примере — "5"), а не изменять параметр Timeout в конфигурации агента Zabbix и конфигурации сервера Zabbix.

Если параметр Timeout был изменен в конфигурации агента Zabbix, появится следующее сообщение об ошибке:

Get value from agent failed: ZBX_TCP_READ() timed out.

Это означает, что изменение было внесено в конфигурацию агента Zabbix, но также требуется изменить параметр Timeout в конфигурации сервера Zabbix.

Тайм-аут выполнения скрипта на активных агентах

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

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

Тайм-аут скрипта на сервере/прокси Zabbix

Ниже приведен пример выполнения скрипта на сервере Zabbix и окно с результатом:

sleep 11
df -h

Также рекомендуется оптимизировать сам скрипт (вместо настройки параметра TrapperTimeout на соответствующее значение (в нашем случае, > 11) путем изменения конфигурации сервера Zabbix).