3 脚本

概览

在 Alerts → Scripts 部分，可以配置和维护用户定义的全局脚本。

根据配置的范围和用户权限，全局脚本可用于执行：

• 从 host menu 在各种前端位置 (Dashboard, Problems, Latest data, Maps, 等等)
• 从 event menu
• 可以作为操作执行

脚本在 Zabbix agent, Zabbix server (proxy) 或仅在 Zabbix server 上执行。 请参阅 Command execution。

在 Zabbix agent 和 Zabbix proxy 上，默认禁用远程脚本。 它们可以通过以下方式启用：

• 对于在 Zabbix agent 上执行的远程命令：
  • 在 agent 配置中为每个允许的命令添加 AllowKey=system.run[<command>,*] 参数， * 代表等待和非等待模式；
• 对于在 Zabbix proxy 上执行的远程命令：
  • 警告：如果远程命令在由 Zabbix proxy 监控的 Zabbix agent 上执行，则无需在 Zabbix proxy 上启用远程命令。 然而，如果需要在 Zabbix proxy 上执行远程命令，则在 proxy 配置中将 EnableRemoteCommands 参数设置为 '1'。

在 Zabbix server 上禁用全局脚本执行，可以通过在服务器配置中设置 EnableGlobalScripts=0 来实现。对于新安装，自 Zabbix 7.0 起，默认禁用在 Zabbix server 上的全局脚本执行。

现有脚本及其详细信息的列表被显示。

显示的数据：

要配置新脚本，请点击右上角的 Create script 按钮。

批量编辑选项

列表下方的按钮提供了一个批量编辑选项：

• 删除 - 删除脚本

要使用此选项，请在相应脚本前面勾选复选框，然后单击 删除。

使用过滤器

您可以使用过滤器仅显示您感兴趣的脚本。为了获得更好的搜索性能，搜索数据时未解析宏。

过滤器 链接位于脚本列表上方。 如果您单击它，则会出现一个过滤器，您可以在其中按名称和范围过滤脚本。

配置全局脚本

脚本属性：

高级配置

高级配置选项可在可折叠的 高级配置 部分中找到：

如果同时配置了手动用户输入和确认消息，则它们将依次显示在弹出窗口中。

手动用户输入

手动用户输入允许在每次执行脚本时提供自定义参数。这样可以避免创建多个只有一个参数差异的相似用户脚本。

例如，您可能希望在执行期间向脚本提供不同的整数或不同的URL地址。

要启用手动用户输入：

• 在脚本（命令、脚本、脚本参数）中必要时使用 {MANUALINPUT} 宏；或在URL脚本的URL字段中使用；
• 在高级脚本配置中，启用手动用户输入并配置输入选项。

启用用户输入后，在执行脚本之前，将弹出一个 手动输入 弹出窗口，要求用户提供自定义值。提供的值将替换脚本中的 {MANUALINPUT}。

根据配置不同，用户将被要求输入字符串值：

或从预定义选项的下拉菜单中选择值：

手动用户输入仅适用于范围为“手动主机操作”或“手动事件操作”的脚本。

脚本执行与结果

由Zabbix server运行的脚本按照command execution page中描述的顺序执行。

脚本结果在脚本运行后出现的弹出窗口中显示。脚本的返回值是标准输出：

• 如果脚本成功完成（exit code 0），返回值限制为16MB（包括被截断的尾随空白）。
• 如果脚本以错误退出（非零退出码），返回值是限制为2KB的标准错误。

Zabbix默认不存储扩展的脚本输出。为了保留完整的输出细节，你可以在脚本本身中实现日志记录（例如，将输出重定向到本地日志文件）。

请注意，对于在Zabbix server或Zabbix proxy上执行的脚本，database limits也适用。

下面是一个脚本及其结果窗口的示例：

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

脚本结果不会显示脚本本身。

脚本超时

Zabbix agent

在执行脚本时，可能会遇到超时的情况。

以下是一个在 Zabbix agent 上运行的脚本示例及其结果窗口：

sleep 5
       df -h

在这种情况下，错误消息如下：

Timeout while executing a shell script.

为了避免这种情况，建议优化脚本本身（在上面的例子中，优化 "sleep 5"），而不是调整Zabbix agent 配置和Zabbix server 配置中的 Timeout 参数。 然而，对于 Zabbix agent 主动模式，Zabbix server 配置中的 Timeout 参数应该至少比Zabbix agent 配置中的 RefreshActiveChecks 参数长几秒钟。 这确保服务器有足够的时间从agent接收到主动检查的结果。请注意，从 Zabbix agent 7.0 开始，支持在主动agent上执行脚本。

如果在Zabbix agent 配置中更改了 Timeout 参数，则会出现以下错误消息：

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

这意味着在Zabbix agent 配置中已经进行了修改，但还需要修改Zabbix server 配置中的 Timeout 参数。

Zabbix server/proxy

以下是在 Zabbix server 上运行的脚本示例及其结果窗口：

sleep 11
       df -h

建议优化脚本本身，而不是通过调整Zabbix server配置中的 TrapperTimeout 参数来使其值大于 11。