Lösa praktiska problem i Zabbix med hjälp av JavaScript

Tikhon Uskov, ingenjör för integrationsgruppen Zabbix

Zabbix är en anpassningsbar plattform som används för att övervaka alla typer av data. Från de tidigaste versionerna av Zabbix hade övervakningsadministratörer möjlighet att köra olika skript genom Åtgärder för kontroller på nätverkets målknutpunkter. Att köra skript medförde dock en rad svårigheter, inklusive behovet av att stödja skript, leverera dem till anslutningspunkter och proxyer samt stödja olika versioner.

JavaScript för Zabbix

I april 2019 presenterades Zabbix 4.2 med funktionen för förbearbetning i JavaScript. Många blev inspirerade av tanken att överge skrivandet av skript som hämtar data, bearbetar dem och presenterar dem i ett format som Zabbix förstår, och i stället utföra enkla kontroller som får oförberedd data för lagring och bearbetning i Zabbix, för att sedan bearbeta denna datastream med hjälp av Zabbix och JavaScript. Tillsammans med låg-nivå upptäckter och beroende datakomponenter som introducerades i Zabbix 3.4, skapades ett tillräckligt flexibelt koncept för sortering och hantering av erhållen data.

I Zabbix 4.4, som en logisk fortsättning på förbearbetning i JavaScript, introducerades ett nytt varningssätt — Webhook, som kan användas för enkel integration av Zabbix-varningar med tredjepartsapplikationer.

JavaScript och Duktape

Varför valdes just JavaScript och Duktape? Olika alternativ för språk och motorer övervägdes:

• Lua – Lua 5.1
• Lua – LuaJIT
• JavaScript – Duktape
• JavaScript – JerryScript
• Embedded Python
• Embedded Perl

De huvudsakliga urvalskriterierna var spridning, enkelhet av motorens integration i produkten, låg resursförbrukning och den allmänna prestandan hos motorn, samt säkerheten av att integrera kod på detta språk i övervakningen. Baserat på dessa kriterier vann JavaScript med Duktape-motorn.

Urvalskriterier och prestandatestning

Egenskaper hos Duktape:

— Standard ECMAScript E5/E5.1
— Zabbix-moduler för Duktape:

• Zabbix.log() — gör att meddelanden med olika detaljeringsnivåer kan skrivas direkt i Zabbix Server-loggen, vilket möjliggör jämförelse av fel, till exempel i Webhook, med serverstatus.
• CurlHttpRequest() — möjliggör HTTP-begärningar till nätverket, vilket utgör grunden för användning av Webhook.
• atob() och btoa() — möjliggör kodning och avkodning av strängar i Base64-format.

OBS. Duktape uppfyller ACME-standarder. I Zabbix används skriptversionen från 2015. Efterföljande ändringar är obetydliga och kan därför ignoreras..

Magin med JavaScript

All magi i JavaScript ligger i den dynamiska typningen och typkonverteringarna: strängar, nummer och logiska värden.

Detta innebär att man inte behöver deklarera på förhand vilken typ av variabel som ska returnera ett värde.

Vid matematiska operationer konverteras värden som returneras av operator-funktioner till siffror. Undantaget från sådana operationer är addition, eftersom om minst en av summorna är en sträng, tillämpas strängkonvertering på alla summor.

OBS. Metoder som ansvarar för sådana konverteringar implementeras vanligtvis i förälderprototyper av objekt, valueOf och toString. valueOf anropas vid numerisk konvertering och kommer alltid före metoden toString. Metoden valueOf måste returnera primitiva värden, annars ignoreras dess resultat.

För ett objekt anropas metoden valueOF. Om den inte hittas eller inte returnerar ett primitivt värde, anropas metoden toString. Om metoden toString inte hittas, letas det i objektets prototyp, och allt upprepas tills värdet har behandlats och alla värden i uttrycket har konverterats till samma typ. valueOf Om ett objekt har en metod. , som returnerar ett primitivt värde, används den för strängkonvertering. toStringResultatet av att använda denna metod behöver dock inte nödvändigtvis vara en sträng. Till exempel, om ett objekt ‘

‘ definierar metodenobj`var obj = { toString() { return "200" }}` toString,

returnerar just en sträng, och vid addition av strängen med ett nummer får vi en sammansatt sträng: 

metod toString `obj + 1 // '2001'``obj + 'a' // '200a'`

Men om vi skriver om

, så att metoden returnerar ett nummer, kommer additionen av objektet att utföra en matematisk operation med numerisk konvertering och resultatet blir resultatet av matematisk addition. toString`var obj = { toString() { return 200 }}``obj + 1 // '2001'`

Om vi dessutom utför addition med en sträng, görs strängkonvertering, och vi får en sammansatt sträng.

`obj + 'a' // '200a'`

Detta är anledningen till att nybörjare ofta får många fel i JavaScript.

Man kan skriva en funktion som ökar det aktuella värdet i objektet med 1.

I metoden toString Körning av skriptet under förutsättning att variabeln är lika med 3, och den är också lika med 4.

Kör skriptet under förutsättning att variabeln är lika med 3 och den också är lika med 4.

Vid jämförelse med typkonvertering (==) anropas metoden varje gång toString med värdeökande funktion. Därför ökar värdet vid varje efterföljande jämförelse. Detta kan undvikas genom att använda jämförelse utan typkonvertering (===).

Jämförelse utan typkonvertering

OBS. Använd inte typkonvertering vid jämförelse utan behov.

För komplexa skript, till exempel Webhook med komplex logik, där jämförelse med typkonvertering är nödvändig, rekommenderas det att först skriva kontroller för värdena som returneras av variabler och hantera avvikelser och fel.

Webhook Media

I slutet av 2019 och början av 2020 arbetade Zabbix integreringsteam aktivt med utveckling av Webhooks och

• Discord
• Jira
• Jira Service Desk
• Mattermost
• Microsoft Teams
• Opsgenie
• OTRS
• Pagerduty
• Pushover
• Redmine
• ServiceNow
• SINGL4
• Slack
• Telegram
• Zammad
• Zendesk

Länk till dokumentationen

Förbehandling

• Framväxten av förbehandling på JavaScript har möjliggjort avskaffandet av de flesta externa skript, och just nu kan man i Zabbix få vilket värde som helst och omvandla det till ett annat värde.
• Förbehandling i Zabbix implementeras med kod på JavaScript, som vid kompilering till bytekod omvandlas till en funktion som tar ett enda värde som parameter value i form av en sträng (den kan innehålla både siffror och tecken).
• Eftersom utdata är en funktion, är det obligatoriskt i slutet av skriptet återvända.
• Användning av användardefinierade makron i koden är möjlig.
• Resurser kan begränsas inte bara på operativsystemsnivå utan också programmässigt. För steget förbehandling tilldelas maximalt 10 megabyte RAM och en exekveringstid på 10 sekunder.

OBS. Timeout-värdena på 10 sekunder är ganska mycket, eftersom insamling av tusentals datainmatningar per sekund enligt ett ganska "tungt" förbehandlingssätt kan bromsa Zabbix. Därför rekommenderas det inte att använda förbehandling för att köra fullfjädrade skript på JavaScript via så kallade dummy-dataelement, som endast körs för att utföra förbehandling..

Du kan kontrollera din kod genom förbehandlingsrelaterad test eller med hjälp av verktyget zabbix_js:

`zabbix_js -s *script-file -p *input-param* [-l log-level] [-t timeout]` 

`zabbix_js -s script-file -i input-file [-l log-level] [-t timeout]` 

`zabbix_js -h` 

`zabbix_js -V`

Praktiska uppgifter

Uppgift 1

Ersätt den beräknade datan med en förbehandling.

Villkor: vi får temperaturen från sensorn i Fahrenheit för att lagra den i Celsius.

Tidigare skulle vi ha skapat en datakomponent som samlar in temperaturen i Fahrenheit. Efter det — en annan datakomponent (beräknad) som med en formel omvandlar grader Fahrenheit till grader Celsius.

Problem:

• Det är nödvändigt att duplicera datakomponenter och lagra alla värden i databasen.
• Det är nödvändigt att samordna intervallen för den 'parent'-datakomponenten, som beräknas och används i formeln, med den beräknade datakomponenten. Annars kan den beräknade datakomponenten gå in i ett otillåtet tillstånd eller räkna det föregående värdet, vilket påverkar tillförlitligheten i övervakningsresultaten.

En av lösningarna var att överge flexibla kontrollintervall till förmån för fasta intervall, för att säkerställa att den beräknade datakomponenten beräknas efter datakomponenten som får data (i vårt fall — temperaturen i Fahrenheit).

Men om, till exempel, mallen vi använder för att kontrollera ett stort antal enheter, och kontrollen genomförs vart 30:e sekund, så 'slappar' Zabbix i 29 sekunder, och börjar kontroller och beräkningar under den sista sekunden. Detta leder till skapandet av en kö och påverkar prestandan. Därför rekommenderas fasta intervall endast om det verkligen är nödvändigt.

För denna uppgift är den optimala lösningen en förbehandling på en rad i JavaScript som omvandlar grader Fahrenheit till grader Celsius:

`return (value - 32) * 5 / 9;`

Det är snabbt och enkelt, det krävs inte att skapa onödiga datakomponenter och lagra historik för dem, och det kan också användas för flexibla kontrollintervall.

`return (parseInt(value) + parseInt("{$EXAMPLE.MACRO}"));`

Men om, i en hypotetisk situation, det är nödvändigt att summera den erhållna datakomponenten med, till exempel, en konstant definierad i makrot, måste vi ta hänsyn till att parametern value avtäckes i en sträng. Vid addition av strängar sammanfogas de helt enkelt till en sträng.

`return (value + "{$EXAMPLE.MACRO}");`

För att få resultaten av en matematisk operation måste värdenas typer konverteras till numeriskt format. För detta kan du använda funktionen parseInt(), som ger ett heltal, funktionen parseFloat(), som ger ett decimaltal, eller funktionen number, som ger antingen ett heltal eller ett decimaltal.

Uppgift 2

Få tiden i sekunder till certifikatets utgång.

Villkor: en viss tjänst ger certifikatets utgångsdatum i formatet "Feb 12 12:33:56 2022 GMT".

I ECMAScript5 Date.parse() tar emot datum i ISO 8601-format (YYYY-MM-DDTHH:mm:ss.sssZ). Det är nödvändigt att konvertera strängen till formatet MMM DD YYYY HH:mm:ss ZZ

Problemet: månadens värde uttrycks i textform och inte som ett nummer. Data i detta format godtas inte av Duktape.

Exempel på lösning:

• Först deklareras en variabel som får ett värde (hela skriptet består av deklarationer av variabler som anges med kommatecken).

• I den första raden får vi datumet i parametern value och delar den med mellanslag med metoden split. Således får vi en array där varje element, med början från index 0, motsvarar ett datumselement före och efter mellanslaget. split(0) — månad, split(1) — dag, split(2) — tidssträng osv. Efter detta kan varje datumselement nås via index i arrayen.

`var split = value.split(' '),`

• Varje månad (i kronologisk ordning) motsvarar index för dess position i arrayen (från 0 till 11). För att konvertera textvärdet till ett numeriskt läggs ett till månadens index (eftersom månadnumreringen börjar från 1). Detta uttryck med tillägg av ett görs i parentes, eftersom det annars skulle ge en sträng istället för ett nummer. I slutet utför vi slice() — en skärning av arrayen från slutet för att behålla endast två tecken (vilket är viktigt för månader med tvåsiffriga nummer).

`MONTHS_LIST = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'],`

`month_index = ('0' + (MONTHS_LIST.indexOf(split[0]) + 1)).slice(-2),`

• Vi formar en sträng i ISO-format från de erhållna värdena genom att helt enkelt addera strängar i rätt ordning.

`ISOdate = split[3] + '-' + month_index + '-' + split[1] + 'T' + split[2],`

Data i det erhållna formatet representerar antalet sekunder sedan 1970 till en viss tidpunkt i framtiden. Att använda data i det formatet i triggers är praktiskt taget omöjligt, eftersom Zabbix endast tillåter att arbeta med makron {Date} och {Time}, som returnerar datum och tid i ett användarvänligt format.

• Efter detta kan vi få det aktuella datumet i JavaScript i Unix Timestamp-format och subtrahera det från det erhållna certifikatets slutdatum för att få antal millisekunder från nuvarande ögonblick till certifikatets utgångstid.

`now = Date.now();`

• Vi delar det erhållna värdet med tusen för att få sekunder i Zabbix.

`return parseInt((Date.parse(ISOdate) - now) / 1000);`

I triggern kan man ange uttrycket ‘last<‘ och en uppsättning siffror som motsvarar antalet sekunder i den period som ska reageras på, till exempel i veckor. På så sätt kommer triggern att meddela att certifikatets giltighetstid löper ut om en vecka.

OBS. Observera användningen av parseInt() i funktionen återvända, för att konvertera det decimala talet som erhållits som resultat av division med millisekunder till ett heltal. Det går också att använda parseFloat() och lagra decimala data.

Se rapporten

Källa: habr.com