9 HTTP aģents

Pārskats

Šis vienuma tips ļauj veikt datu aptauju, izmantojot HTTP/HTTPS protokolu. Ir iespējama arī datu iesūtīšana, izmantojot Zabbix sender utilītu vai Zabbix sender protokolu (datu nosūtīšanai uz Zabbix serveri vai starpniekserveri), vai izmantojot history.push API metodi (datu nosūtīšanai uz Zabbix serveri).

HTTP vienumu pārbaudes izpilda Zabbix serveris. Tomēr, ja hosts tiek uzraudzīti ar Zabbix starpniekserveri, HTTP vienumu pārbaudes izpilda starpniekserveris.

HTTP vienumu pārbaudēm nav nepieciešams, lai uz uzraudzītā hosta darbotos kāds aģents.

HTTP aģents atbalsta gan HTTP, gan HTTPS. Zabbix pēc izvēles sekos pāradresācijām (skatiet tālāk esošo opciju Sekot pāradresācijām). Maksimālais pāradresāciju skaits ir stingri noteikts uz 10 (izmantojot cURL opciju CURLOPT_MAXREDIRS).

Zabbix serverim/starpniekserverim sākotnēji jābūt konfigurētam ar cURL (libcurl) atbalstu.

HTTP pārbaudes tiek izpildītas asinhroni - nav nepieciešams saņemt viena pieprasījuma atbildi, pirms tiek sāktas citas pārbaudes. DNS atrisināšana arī ir asinhrona.

Asinhrono pārbaužu maksimālais paralēlais skaits ir 1000 (definēts ar MaxConcurrentChecksPerPoller).

Asinhrono HTTP aģenta aptaujātāju skaitu nosaka parametrs StartHTTPAgentPollers.

Pastāvīgo savienojumu cURL funkcionalitāte HTTP aģenta pārbaudēm ir pievienota kopš Zabbix 7.0.

Konfigurēšana

Lai konfigurētu HTTP vienumu:

  1. Dodieties uz Data collection > Hosts.
  2. Hosts rindā noklikšķiniet uz Items.
  3. Noklikšķiniet uz Create item.
  4. Veidlapā ievadiet vienuma parametrus.

Visi obligātie ievades lauki ir atzīmēti ar sarkanu zvaigznīti.

Lauki, kuriem HTTP vienumiem nepieciešama specifiska informācija, ir šādi:

Parametrs Apraksts
Type Šeit atlasiet HTTP agent.
Key Ievadiet unikālu vienuma atslēgu.
URL URL, ar kuru izveidot savienojumu un izgūt datus. Piemēram:
https://www.example.com
http://www.example.com/download
Domēna nosaukumus var norādīt Unicode rakstzīmēs. Izpildot HTTP pārbaudi, tie tiek automātiski pārveidoti par ASCII, izmantojot punycode.
Pogu Parse var izmantot, lai no URL atdalītu neobligātos vaicājuma laukus (piemēram, ?name=Admin&password=mypassword), pārvietojot atribūtus un vērtības uz Query fields, lai veiktu automātisku URL kodēšanu.
Ierobežots līdz 2048 rakstzīmēm.
Atbalstītie makrosi: {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {HOST.PORT}, {ITEM.ID}, {ITEM.KEY}, {ITEM.KEY.ORIG}, lietotāja makrosi, zema līmeņa atklāšanas makrosi.
Tiek iestatīta cURL opcija CURLOPT_URL.
Query fields URL mainīgie (skatiet iepriekš).
Norādīti kā atribūtu un vērtību pāri.
Vērtības tiek automātiski kodētas URL formātā. Makrosu vērtības tiek atrisinātas un pēc tam automātiski kodētas URL formātā.
Atbalstītie makrosi: {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {HOST.PORT}, {ITEM.ID}, {ITEM.KEY}, {ITEM.KEY.ORIG}, lietotāja makrosi, zema līmeņa atklāšanas makrosi.
Tiek iestatīta cURL opcija CURLOPT_URL.
Request type Atlasiet pieprasījuma metodes tipu: GET, POST, PUT vai HEAD.
Request body type Atlasiet pieprasījuma pamatteksta tipu:
Raw data - pielāgots HTTP pieprasījuma pamatteksts; makrosi tiek aizstāti, bet kodēšana netiek veikta
JSON data - HTTP pieprasījuma pamatteksts JSON formātā. Makrosus var izmantot kā virkni, skaitli, true un false; makrosi, kas tiek izmantoti kā virknes, jāiekļauj dubultpēdiņās. Makrosu vērtības tiek atrisinātas un pēc tam automātiski aizbēgtas. Ja galvenēs nav norādīts "Content-Type", pēc noklusējuma tiks izmantots "Content-Type: application/json"
XML data - HTTP pieprasījuma pamatteksts XML formātā. Makrosus var izmantot kā teksta mezglu, atribūtu vai CDATA sadaļu. Makrosu vērtības tiek atrisinātas un pēc tam automātiski aizbēgtas teksta mezglā un atribūtā. Ja galvenēs nav norādīts "Content-Type", pēc noklusējuma tiks izmantots "Content-Type: application/xml"
Piezīme: atlasot XML data, nepieciešama libxml2.
Request body Ievadiet pieprasījuma pamattekstu.
Atbalstītie makrosi: {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {HOST.PORT}, {ITEM.ID}, {ITEM.KEY}, {ITEM.KEY.ORIG}, lietotāja makrosi, zema līmeņa atklāšanas makrosi.
Headers Pielāgotas HTTP galvenes, kas tiks nosūtītas, izpildot pieprasījumu.
Norādītas kā atribūtu un vērtību pāri.
Atbalstītie makrosi: {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {HOST.PORT}, {ITEM.ID}, {ITEM.KEY}, {ITEM.KEY.ORIG}, lietotāja makrosi, zema līmeņa atklāšanas makrosi.
Tiek iestatīta cURL opcija CURLOPT_HTTPHEADER.
Required status codes Sagaidāmo HTTP statusa kodu saraksts. Ja Zabbix saņem kodu, kas nav iekļauts sarakstā, vienums kļūs neatbalstīts. Ja saraksts ir tukšs, pārbaude netiek veikta.
Piemēram: 200,201,210-299
Sarakstā atbalstītie makrosi: lietotāja makrosi, zema līmeņa atklāšanas makrosi.
Tiek izmantota cURL opcija CURLINFO_RESPONSE_CODE.
Follow redirects Atzīmējiet izvēles rūtiņu, lai sekotu HTTP novirzēm.
Tiek iestatīta cURL opcija CURLOPT_FOLLOWLOCATION.
Retrieve mode Atlasiet izgūstamo atbildes daļu:
Body - tikai pamatteksts
Headers - tikai galvenes
Body and headers - pamatteksts un galvenes
Convert to JSON Ja Retrieve mode nav iestatīts uz Body, galvenes tiek saglabātas kā atribūtu un vērtību pāri zem atslēgas "header".
Ja tiek atrasts 'Content-Type: application/json', pamatteksts tiek saglabāts kā objekts; pretējā gadījumā tas tiek saglabāts kā virkne, piemēram:
HTTP proxy Varat norādīt izmantojamo HTTP starpniekserveri, izmantojot formātu [protocol://][username[:password]@]proxy.example.com[:port].
Neobligāto prefiksu protocol:// var izmantot, lai norādītu alternatīvus starpniekservera protokolus (piemēram, https, socks4, socks5; skatiet dokumentāciju; protokola prefiksa atbalsts tika pievienots cURL 7.21.7). Ja protokols nav norādīts, starpniekserveris tiks uzskatīts par HTTP starpniekserveri. Ja norādīts nepareizs protokols, savienojums neizdosies un vienums kļūs neatbalstīts.
Pēc noklusējuma tiks izmantots ports 1080.
Ja starpniekserveris ir norādīts, tas aizstās ar starpniekserveri saistītos vides mainīgos, piemēram, http_proxy, HTTPS_PROXY. Ja starpniekserveris nav norādīts, tas ar starpniekserveri saistītos vides mainīgos neaizstās. Ievadītā vērtība tiek nodota "kā ir", un tās pareizība netiek pārbaudīta.
Piezīme: ar HTTP starpniekserveri tiek atbalstīta tikai vienkārša autentifikācija.
Atbalstītie makrosi: {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {HOST.PORT}, {ITEM.ID}, {ITEM.KEY}, {ITEM.KEY.ORIG}, lietotāja makrosi, zema līmeņa atklāšanas makrosi.
Tiek iestatīta cURL opcija CURLOPT_PROXY.
HTTP authentication Atlasiet autentifikācijas opciju:
None - autentifikācija netiek izmantota;
Basic - tiek izmantota pamata autentifikācija;
NTLM - tiek izmantota NTLM (Windows NT LAN Manager) autentifikācija;
Kerberos - tiek izmantota Kerberos autentifikācija (skatiet arī: Kerberos konfigurēšana ar Zabbix);
Digest - tiek izmantota Digest autentifikācija.
Tiek iestatīta cURL opcija CURLOPT_HTTPAUTH.
User name Ievadiet lietotājvārdu (līdz 255 rakstzīmēm).
Šis lauks ir pieejams, ja HTTP authentication ir iestatīts uz Basic, NTLM, Kerberos vai Digest. Tiek atbalstīti lietotāja makrosi un zema līmeņa atklāšanas makrosi.
Password Ievadiet lietotāja paroli (līdz 255 rakstzīmēm).
Šis lauks ir pieejams, ja HTTP authentication ir iestatīts uz Basic, NTLM, Kerberos vai Digest. Tiek atbalstīti lietotāja makrosi un zema līmeņa atklāšanas makrosi.
SSL verify peer Atzīmējiet izvēles rūtiņu, lai pārbaudītu tīmekļa servera SSL sertifikātu. Servera sertifikāts tiek pārbaudīts, izmantojot uzticamas sertificēšanas iestādes (CA) sertifikātus no visas sistēmas CA atrašanās vietas. CA failu atrašanās vietu varat mainīt, izmantojot Zabbix servera vai starpniekservera konfigurācijas parametru SSLCALocation.
Tiek iestatīta cURL opcija CURLOPT_SSL_VERIFYPEER.
SSL verify host Atzīmējiet izvēles rūtiņu, lai pārbaudītu, vai tīmekļa servera sertifikāta lauks Common Name vai Subject Alternate Name atbilst.
Tiek iestatīta cURL opcija CURLOPT_SSL_VERIFYHOST.
SSL certificate file Klienta autentifikācijai izmantotā SSL sertifikāta faila nosaukums. Sertifikāta failam jābūt PEM1 formātā. Ja sertifikāta failā ir arī privātā atslēga, atstājiet SSL atslēgas faila lauku tukšu. Ja atslēga ir šifrēta, norādiet paroli SSL atslēgas paroles laukā. Direktoriju, kurā atrodas šis fails, norāda Zabbix servera vai starpniekservera konfigurācijas parametrs SSLCertLocation.
Atbalstītie makrosi: {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {HOST.PORT}, {ITEM.ID}, {ITEM.KEY}, {ITEM.KEY.ORIG}, lietotāja makrosi, zema līmeņa atklāšanas makrosi.
Tiek iestatīta cURL opcija CURLOPT_SSLCERT.
SSL key file Klienta autentifikācijai izmantotā SSL privātās atslēgas faila nosaukums. Privātās atslēgas failam jābūt PEM1 formātā. Direktoriju, kurā atrodas šis fails, norāda Zabbix servera vai starpniekservera konfigurācijas parametrs SSLKeyLocation.
Atbalstītie makrosi: {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {HOST.PORT}, {ITEM.ID}, {ITEM.KEY}, {ITEM.KEY.ORIG}, lietotāja makrosi, zema līmeņa atklāšanas makrosi.
Tiek iestatīta cURL opcija CURLOPT_SSLKEY.
SSL key password SSL privātās atslēgas faila parole.
Atbalstītie makrosi: lietotāja makrosi, zema līmeņa atklāšanas makrosi.
Tiek iestatīta cURL opcija CURLOPT_KEYPASSWD.
Timeout Zabbix URL apstrādei nepatērēs vairāk par iestatīto laiku (1-600 sekundes). Faktiski šis parametrs nosaka maksimālo laiku savienojuma izveidei ar URL un maksimālo laiku HTTP pieprasījuma izpildei. Tāpēc Zabbix vienai pārbaudei nepatērēs vairāk par 2 x Timeout sekundēm.
Tiek iestatīta cURL opcija CURLOPT_TIMEOUT.
Papildinformāciju par parametru Timeout skatiet vispārīgajos vienuma atribūtos.
Enable trapping Ja šī izvēles rūtiņa ir atzīmēta, vienums darbosies arī kā trapper vienums un pieņems datus, kas nosūtīti Zabbix serverim vai starpniekserverim, izmantojot utilītu Zabbix sender vai Zabbix sender protokolu, vai pieņems datus, kas nosūtīti Zabbix serverim, izmantojot history.push API metodi. Papildinformāciju par datu nosūtīšanu skatiet: Trapper vienumi.
Allowed hosts Redzams tikai tad, ja ir atzīmēta izvēles rūtiņa Enable trapping.
Ar komatiem atdalīts IP adrešu saraksts, pēc izvēles CIDR apzīmējumā, vai DNS nosaukumi.
Ja norādīts, ienākošie savienojumi tiks pieņemti tikai no šeit uzskaitītajiem hostiem.
Ja IPv6 atbalsts ir iespējots, '127.0.0.1', '::127.0.0.1', '::ffff:127.0.0.1' tiek uzskatīti par līdzvērtīgiem, un '::/0' ļaus izmantot jebkuru IPv4 vai IPv6 adresi.
'0.0.0.0/0' var izmantot, lai atļautu jebkuru IPv4 adresi.
Ņemiet vērā, ka "IPv4-compatible IPv6 addresses" (0000::/96 prefikss) tiek atbalstītas, taču RFC4291 tās vairs neiesaka.
Piemērs: 127.0.0.1, 192.168.1.0/24, 192.168.3.1-255, 192.168.1-10.1-255, ::1,2001:db8::/32, mysqlserver1, zabbix.example.com, {HOST.HOST}
Šajā laukā ir atļautas atstarpes un lietotāja makrosi.
Šajā laukā ir atļauti hosta makrosi: {HOST.HOST}, {HOST.NAME}, {HOST.IP}, {HOST.DNS}, {HOST.CONN}.

Ja lauks HTTP proxy ir atstāts tukšs, cits veids, kā izmantot HTTP starpniekserveri, ir iestatīt ar starpniekserveri saistītos vides mainīgos.

HTTP gadījumā iestatiet http_proxy vides mainīgo Zabbix servera lietotājam. Piemēram:
http_proxy=http://proxy_ip:proxy_port.

HTTPS gadījumā iestatiet HTTPS_PROXY vides mainīgo. Piemēram:
HTTPS_PROXY=http://proxy_ip:proxy_port. Papildinformāciju varat iegūt, izpildot čaulas komandu: # man curl.

[1] Zabbix atbalsta tikai sertifikātu un privāto atslēgu failus PEM formātā. Ja sertifikāta un privātās atslēgas dati atrodas PKCS #12 formāta failā (parasti ar paplašinājumu *.p12 vai *.pfx), PEM failu no tā varat ģenerēt, izmantojot šādas komandas:

openssl pkcs12 -in ssl-cert.p12 -clcerts -nokeys -out ssl-cert.pem
openssl pkcs12 -in ssl-cert.p12 -nocerts -nodes  -out ssl-cert.key

Piemēri

Piemērs 1

Nosūtiet vienkāršus GET pieprasījumus, lai izgūtu datus no tādiem pakalpojumiem kā Elasticsearch:

  • Izveidojiet GET vienumu ar URL: localhost:9200/?pretty
  • Pievērsiet uzmanību atbildei:
    {
      "name" : "YQ2VAY-",
      "cluster_name" : "elasticsearch",
      "cluster_uuid" : "kH4CYqh5QfqgeTsjh2F9zg",
      "version" : {
        "number" : "6.1.3",
        "build_hash" : "af51318",
        "build_date" : "2018-01-26T18:22:55.523Z",
        "build_snapshot" : false,
        "lucene_version" : "7.1.0",
        "minimum_wire_compatibility_version" : "5.6.0",
        "minimum_index_compatibility_version" : "5.0.0"
      },
      "tagline" : "You know, for search"
    }
  • Tagad izvelciet versijas numuru, izmantojot JSONPath pirmapstrādes soli: $.version.number
Piemērs 2

Nosūtiet vienkāršus POST pieprasījumus, lai izgūtu datus no tādiem pakalpojumiem kā Elasticsearch:

  • Izveidojiet POST vienumu ar URL: http://localhost:9200/str/values/_search?scroll=10s
  • Konfigurējiet šādu POST ķermeni, lai iegūtu procesora noslodzi (1 minūtes vidējais rādītājs uz kodolu)
    {
        "query": {
            "bool": {
                "must": [{
                    "match": {
                        "itemid": 28275
                    }
                }],
                "filter": [{
                    "range": {
                        "clock": {
                            "gt": 1517565836,
                            "lte": 1517566137
                        }
                    }
                }]
            }
        }
    }
  • Saņemts:
    {
        "_scroll_id": "DnF1ZXJ5VGhlbkZldGNoBQAAAAAAAAAkFllRMlZBWS1UU1pxTmdEeGVwQjRBTFEAAAAAAAAAJRZZUTJWQVktVFNacU5nRHhlcEI0QUxRAAAAAAAAACYWWVEyVkFZLVRTWnFOZ0R4ZXBCNEFMUQAAAAAAAAAnFllRMlZBWS1UU1pxTmdEeGVwQjRBTFEAAAAAAAAAKBZZUTJWQVktVFNacU5nRHhlcEI0QUxR",
        "took": 18,
        "timed_out": false,
        "_shards": {
            "total": 5,
            "successful": 5,
            "skipped": 0,
            "failed": 0
        },
        "hits": {
            "total": 1,
            "max_score": 1.0,
            "hits": [{
                "_index": "dbl",
                "_type": "values",
                "_id": "dqX9VWEBV6sEKSMyk6sw",
                "_score": 1.0,
                "_source": {
                    "itemid": 28275,
                    "value": "0.138750",
                    "clock": 1517566136,
                    "ns": 25388713,
                    "ttl": 604800
                }
            }]
        }
    }
  • Tagad izmantojiet JSONPath pirmapstrādes soli, lai iegūtu vienuma vērtību: $.hits.hits[0]._source.value
Piemērs 3

Pārbauda, vai Zabbix API ir aktīva, izmantojot apiinfo.version.

  • Vienuma konfigurācija:

Ņemiet vērā POST metodes izmantošanu ar JSON datiem, pieprasījuma galvenes iestatīšanu un pieprasījumu atgriezt tikai galvenes:

  • Vienuma vērtības pirmapstrāde ar regulāro izteiksmi, lai iegūtu HTTP kodu:

  • Rezultāta pārbaude sadaļā Latest data:

Piemērs 4

Laikapstākļu informācijas iegūšana, pieslēdzoties Openweathermap publiskajam servisam.

  • Konfigurējiet galveno vienumu lielapjoma datu apkopošanai vienā JSON:

Ņemiet vērā makro izmantošanu vaicājuma laukos. Skatiet Openweathermap API, lai uzzinātu, kā tos aizpildīt.

Parauga JSON, kas atgriezts HTTP aģenta atbildē:

{
    "body": {
        "coord": {
            "lon": 40.01,
            "lat": 56.11
        },
        "weather": [{
            "id": 801,
            "main": "Clouds",
            "description": "few clouds",
            "icon": "02n"
        }],
        "base": "stations",
        "main": {
            "temp": 15.14,
            "pressure": 1012.6,
            "humidity": 66,
            "temp_min": 15.14,
            "temp_max": 15.14,
            "sea_level": 1030.91,
            "grnd_level": 1012.6
        },
        "wind": {
            "speed": 1.86,
            "deg": 246.001
        },
        "clouds": {
            "all": 20
        },
        "dt": 1526509427,
        "sys": {
            "message": 0.0035,
            "country": "RU",
            "sunrise": 1526432608,
            "sunset": 1526491828
        },
        "id": 487837,
        "name": "Stavrovo",
        "cod": 200
    }
}

Nākamais uzdevums ir konfigurēt atkarīgos vienumus, kas no JSON izgūst datus.

  • Konfigurējiet parauga atkarīgo vienumu mitrumam:

Citi laikapstākļu rādītāji, piemēram, "Temperature", tiek pievienoti tādā pašā veidā.

  • Parauga atkarīgā vienuma vērtības pirmapstrāde ar JSONPath:

  • Pārbaudiet laikapstākļu datu rezultātu sadaļā Latest data:

Piemērs 5

Savienošana ar Nginx statusa lapu un tās metrikas iegūšana masveidā.

  • Konfigurējiet Nginx, ievērojot oficiālo rokasgrāmatu.
  • Konfigurējiet galveno vienumu masveida datu vākšanai:

Nginx stub statusa izvades paraugs:

Active connections: 1 Active connections:
server accepts handled requests
 52 52 52 
Reading: 0 Writing: 1 Waiting: 0

Nākamais uzdevums ir konfigurēt atkarīgos vienumus, kas iegūst datus.

  • Konfigurējiet atkarīgā vienuma paraugu pieprasījumiem sekundē:

  • Atkarīgā vienuma vērtības priekšapstrādes paraugs ar regulāro izteiksmi server accepts handled requests\s+([0-9]+) ([0-9]+) ([0-9]+):

  • Pārbaudiet pilno rezultātu no stub moduļa sadaļā Latest data: