1 附加 JavaScript objects

概述

本节介绍Zabbix通过Duktape实现的JavaScript语言扩展功能，以及支持的全局JavaScript函数。

内置对象

Zabbix

Zabbix object 提供与Zabbix内部功能的交互接口。

示例：

Zabbix.log(3, "this is a log entry written with 'Warning' log level")

可使用以下别名：

示例（延迟执行15秒）：

Zabbix.sleep(15000)

HttpRequest

这个 object 封装了 cURL 句柄，允许发起简单的 HTTP 请求。 错误将作为异常抛出。

示例：

try {
    Zabbix.log(4, 'jira webhook script value='+value);

    var result = {
        'tags': {
            'endpoint': 'jira'
        }
    },
    params = JSON.parse(value),
    req = new HttpRequest(),
    fields = {},
    resp;

    req.addHeader('Content-Type: application/json');
    req.addHeader('Authorization: Basic '+params.authentication);

    fields.summary = params.summary;
    fields.description = params.description;
    fields.project = {"key": params.project_key};
    fields.issuetype = {"id": params.issue_id};
    resp = req.post('https://jira.example.com/rest/api/2/issue/',
        JSON.stringify({"fields": fields})
    );

    if (req.getStatus() != 201) {
        throw 'Response code: '+req.getStatus();
    }

    resp = JSON.parse(resp);
    result.tags.issue_id = resp.id;
    result.tags.issue_key = resp.key;
} catch (error) {
    Zabbix.log(4, 'jira issue creation failed json : '+JSON.stringify({"fields": fields}));
    Zabbix.log(4, 'jira issue creation failed : '+error);

    result = {};
}

return JSON.stringify(result);

XML

XML object 允许在 监控项 以及低级发现预处理和webhooks中处理XML数据。

示例：

输入：

<menu>
    <food type = "breakfast">
        <name>Chocolate</name>
        <price>$5.95</price>
        <description></description>
        <calories>650</calories>
    </food>
</menu>

输出：

{
    "menu": {
        "food": {
            "@type": "breakfast",
            "name": "Chocolate",
            "price": "$5.95",
            "description": null,
            "calories": "650"
        }
    }
}

序列化规则

XML到JSON的转换将按照以下规则处理（JSON到XML的转换则应用相反的规则）：

1. XML属性将被转换为键，其名称前添加'@'。

示例：

输入：

<xml foo="FOO">
  <bar>
    <baz>BAZ</baz>
  </bar>
</xml>

输出：

{
  "xml": {
    "@foo": "FOO",
    "bar": {
      "baz": "BAZ"
    }
  }
}

2. 自闭合元素（<foo/>）将被转换为具有'null'值。

示例：

输入：

<xml>
  <foo/>
</xml>

输出：

{
  "xml": {
    "foo": null
  }
}

3. 空属性（值为""）将被转换为具有空string（''）值。

示例：

输入：

<xml>
  <foo bar="" />
</xml>

输出：

{
  "xml": {
    "foo": {
      "@bar": ""
    }
  }
}

4. 具有相同元素名称的多个子节点将被转换为一个键，其值为值的array。

示例：

输入：

<xml>
  <foo>BAR</foo>
  <foo>BAZ</foo>
  <foo>QUX</foo>
</xml>

输出：

{
  "xml": {
    "foo": ["BAR", "BAZ", "QUX"]
  }
}

5. 如果文本元素没有属性且没有子元素，它将被转换为一个string。

示例：

输入：

<xml>
    <foo>BAZ</foo>
</xml>

输出：

{
  "xml": {
    "foo": "BAZ"
   }
}

6. 如果文本元素没有子元素但有属性，文本内容将被转换为一个键为'#text'的元素，其值为内容；属性将按照序列化规则1中描述的方式进行转换。

示例：

输入：

<xml>
  <foo bar="BAR">
    BAZ
  </foo>
</xml>

输出：

{
  "xml": {
    "foo": {
      "@bar": "BAR",
      "#text": "BAZ"
    }
  }
}

全局 JavaScript 函数

已通过 Duktape 实现了额外的全局 JavaScript 函数：

• btoa(data) - 将数据编码为 Base64 字符串。
• atob(base64_string) - 自 7.0.1 版本起，将 Base64 字符串解码为 Uint8Array 缓冲区（在 Zabbix 7.0.0 中，此函数返回解码后的字符串）。

try {
    b64 = btoa("test string");
    buffer = atob(b64);

    // 请注意，解码逻辑取决于缓冲区的数据格式。
    decoded = String.fromCharCode.apply(this, [].slice.call(buffer));
} 
catch (error) {
    return {'error.name' : error.name, 'error.message' : error.message};
}

• md5(data) - 计算数据的 MD5 哈希值。
• sha256(data) - 计算数据的 SHA256 哈希值。

• hmac('<hash type>',key,data) - 返回 HMAC 哈希值，格式为十六进制字符串；支持的 hash type 为 md5 和 sha256；key 和 data 参数支持二进制数据。

  示例：

  • hmac('md5',key,data)
  • hmac('sha256',key,data)

• sign(hash,key,data) - 返回计算出的签名（使用 SHA-256 的 RSA 签名）作为字符串，其中：
  hash - 仅允许 sha256，否则会抛出错误。
  key - 私钥。 它应符合 PKCS#1 或 PKCS#8 标准。 密钥可以采用不同形式提供：
  

  • 使用空格代替换行
  • 使用转义或未转义的 \n 代替换行
  • 不包含任何换行，作为单行字符串
  • 作为 JSON 格式字符串

  密钥也可以从用户宏/秘密宏/vault 中加载。

  data - 要签名的数据。 它可以是字符串（也支持二进制数据）或缓冲区（Uint8Array/ArrayBuffer）。

  示例：

  • sign('sha256',key,data)

  签名使用 OpenSSL 或 GnuTLS 计算。 如果 Zabbix 在编译时未包含这些加密库中的任何一个，将抛出错误（'missing OpenSSL or GnuTLS library'）。