1. Дополнительные объекты Javascript

Обзор

Этот раздел описывает дополнения Zabbix к языку JavaScript, который реализован при помощи Duktape, и поддерживаемые глобальные функции JavaScript.

Встроенные объекты

Zabbix

Объект Zabbix даёт возможность взаимодействия с внутренним функционалом Zabbix.

Пример:

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

Вы можете использовать следующие псевдонимы:

Пример (задержка выполнения на 15 секунд):

Zabbix.sleep(15000)

HttpRequest

Этот объект инкапсулирует обработчик 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 позволяет обрабатывать 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. Пустые атрибуты (со значением "") будут преобразованы как имеющие значение пустой строки ('').

Пример:

Входящие данные:

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

Вывод:

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

4. Несколько дочерних узлов с идентичными именами элементов будут преобразованы в один ключ, который имеет массив значений в качестве своего значения.

Пример:

Входящие данные:

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

Вывод:

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

5. Если текстовый элемент не имеет атрибутов и дочерних элементов, он будет преобразован в строку.

Пример:

Входящие данные:

<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

Дополнительные глобальные функции JavaScript реализованы при помощи Duktape:

• btoa(данные) — кодирует данные в строку Base64;
• atob(строка_base64) — начиная с версии 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(данные) — вычисление MD5 хеш-суммы строки

• sha256(данные) — вычисление SHA256 хеш-суммы строки

• hmac('<тип_хеша>',ключ,данные) — возврат HMAC хеш-суммы в виде шестнадцатеричной строки; поддерживаются типы хеша MD5 и SHA256; параметры ключ и данные поддерживают бинарные данные. Примеры:

• hmac('md5',key,data)

• hmac('sha256',key,data)

• sign(хеш,ключ,данные) — возврат вычисленной подписи (RSA-подпись с SHA-256) в виде строки, где:
  хеш — разрешено только 'sha256', иначе выбрасывается ошибка;
  ключ — закрытый ключ (private key). Он должен соответствовать стандарту PKCS#1 или PKCS#8. Ключ может быть представлен в различных формах:
  

  • с пробелами вместо переводов строк;
  • с экранированными или неэкранированными «» вместо переводов строк;
  • вообще без переводов строк, как одна строка;
  • в виде строки в формате JSON.

  Ключ также может быть загружен из пользовательского макроса / скрытого макроса / хранилища).

  данные — данные, которые будут подписаны. Это может быть строка (поддерживаются бинарные данные) или буфер (Uint8Array/ArrayBuffer).
  Для вычисления подписей используются OpenSSL или GnuTLS. Если Zabbix был скомпилирован без какой-либо из этих библиотек шифрования, будет выброшена ошибка («missing OpenSSL or GnuTLS library»).