1 Extra JavaScript-objecten

Overzicht

Deze sectie beschrijft Zabbix-toevoegingen aan de JavaScript-taal die zijn geïmplementeerd met Duktape en ondersteunde globale JavaScript-functies.

Ingebouwde objecten

Zabbix

Het Zabbix-object biedt interactie met de interne Zabbix-functionaliteit.

Voorbeeld:

Zabbix.log(3, "dit is een logboekvermelding geschreven met het logniveau 'Waarschuwing'")

Je kunt de volgende aliassen gebruiken:

Voorbeeld (vertraagt de uitvoering 15 seconden):

Zabbix.sleep(15000)

HttpRequest

Dit object omvat een cURL-handle waarmee eenvoudige HTTP-verzoeken kunnen worden gedaan. Fouten worden als uitzonderingen gegooid.

Voorbeeld:

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://tsupport.zabbix.lan/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

Het XML-object maakt de verwerking van XML-gegevens mogelijk in item- en laagdrempelige detectie-preprocessing en webhooks.

Voorbeeld:

Invoer:

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

Uitvoer:

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

Serialisatieregels

Bij de conversie van XML naar JSON worden de volgende regels toegepast (voor conversies van JSON naar XML worden omgekeerde regels toegepast):

1. XML-attributen worden geconverteerd naar sleutels waarvan de namen worden voorafgegaan door '@'.

Voorbeeld:

Invoer:

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

Uitvoer:

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

2. Zelfsluitende elementen (<foo/>) worden geconverteerd als zijnde 'null' waarde.

Voorbeeld:

Invoer:

<xml>
         <foo/>
       </xml>

Uitvoer:

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

3. Lege attributen (met "" waarde) worden geconverteerd als zijnde een lege tekenreeks ('') waarde.

Voorbeeld:

Invoer:

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

Uitvoer:

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

4. Meerdere kindknooppunten met dezelfde elementnaam worden geconverteerd naar één sleutel met een array van waarden als zijn waarde.

Voorbeeld:

Invoer:

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

Uitvoer:

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

5. Als een tekstelement geen attributen en geen kinderen heeft, wordt het geconverteerd als een tekenreeks.

Voorbeeld:

Invoer:

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

Uitvoer:

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

6. Als een tekstelement geen kinderen heeft, maar wel attributen heeft: wordt de tekstinhoud geconverteerd naar een element met de sleutel '#text' en de inhoud als waarde; attributen worden geconverteerd zoals beschreven in regel 1 van de serialisatie.

Voorbeeld:

Invoer:

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

Uitvoer:

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

Globale JavaScript-functies

Aanvullende globale JavaScript-functies zijn geïmplementeerd met Duktape:

• btoa(data) - codeert de data naar een base64-string
• atob(base64_string) - decodeert een base64-string

try {
           b64 = btoa("utf8 string");
           utf8 = atob(b64);
       } 
       catch (error) {
           return {'error.name' : error.name, 'error.message' : error.message}
       }

• md5(data) - berekent de MD5-hash van de data

• sha256(data) - berekent de SHA256-hash van de data

• hmac('<hash type>',key,data) - geeft de HMAC-hash als een hex-geformatteerde string terug; MD5- en SHA256-hash types worden ondersteund; sleutel- en dataparameters ondersteunen binair. Voorbeelden:

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

• sign(hash,key,data) - geeft de berekende handtekening (RSA-handtekening met SHA-256) terug als een string, waarbij:
  hash - alleen 'sha256' is toegestaan, anders wordt er een foutmelding weergegeven;
  key - de privésleutel. Deze moet overeenkomen met de PKCS#1- of PKCS#8-standaard. De sleutel kan op verschillende manieren worden opgegeven:
  

  • met spaties in plaats van nieuwe regels;
  • met geëscapete of niet-geëscapete ''s in plaats van nieuwe regels;
  • zonder enige nieuwe regels als een eenregelige string;
  • als een JSON-geformatteerde string.

  De sleutel kan ook worden geladen uit een gebruikersmacro/geheime macro/kluis.

  data - de data die zal worden ondertekend. Het kan een tekenreeks zijn (ook binair ondersteund) of buffer (Uint8Array/ArrayBuffer).
  OpenSSL of GnuTLS wordt gebruikt om de handtekeningen te berekenen. Als Zabbix is gebouwd zonder een van deze versleutelingsbibliotheken, wordt er een foutmelding weergegeven ('missing OpenSSL or GnuTLS library').
  Deze functie wordt ondersteund sinds Zabbix 6.4.1.