2 Controlli degli agenti passivi e attivi
Panoramica
Questa sezione fornisce dettagli sui controlli passivi e attivi eseguiti da Zabbix agent e Zabbix agent 2.
Zabbix utilizza un protocollo di comunicazione basato su JSON per comunicare con gli agent.
I protocolli di Zabbix agent e Zabbix agent 2 sono stati unificati a partire da Zabbix 7.0. La differenza tra le richieste/risposte di Zabbix agent e Zabbix agent 2 è espressa dal valore del tag "variant".
Controlli passivi
Un controllo passivo è una semplice richiesta di dati. Zabbix server o proxy richiede alcuni dati (ad esempio, il carico della CPU) e Zabbix agent invia il risultato al server.
I controlli passivi vengono eseguiti in modo asincrono: non è necessario ricevere la risposta a una richiesta prima che vengano avviati altri controlli. Anche la risoluzione DNS è asincrona.
Il poller dell'agent tenterà di connettersi a tutti gli indirizzi restituiti dalla ricerca DNS. Questo garantisce che, se un indirizzo IP non è raggiungibile, il poller proverà il successivo indirizzo disponibile, aumentando la probabilità di una connessione riuscita. Questo miglioramento si applica sia a Zabbix server sia a proxy.
La concorrenza massima dei controlli asincroni è 1000 (definita da MaxConcurrentChecksPerPoller).
Il numero di poller asincroni dell'agent è definito dal parametro StartAgentPollers.
Richiesta del server
Per la definizione dell'intestazione e della lunghezza dei dati, fare riferimento ai dettagli del protocollo.
{
"request": "passive checks",
"data": [
{
"key": "agent.version",
"timeout": 3
}
]
}
| Campo | Tipo | Obbligatorio | Valore | |
|---|---|---|---|---|
| request | string | yes | "passive checks" |
|
| data | array of object | yes | Elemento di controllo passivo. | |
| key | string | yes | Chiave dell'item con macro espanse. | |
| timeout | number | yes | Timeout di comunicazione. | |
Risposta dell'agent
{
"version": "8.0.0",
"variant": 2,
"data": [
{
"value": "8.0.0"
}
]
}
| Campo | < | Tipo | Obbligatorio | Valore | |
|---|---|---|---|---|---|
| version | < | string | yes | Numero di versione dell'agent. | |
| variant | < | number | yes | Variante dell'agent (1 - Zabbix agent, 2 - Zabbix agent 2). | |
| data | < | array of object | yes | Contiene il risultato del controllo. | |
| value | < | string | no | Il valore dell'item se il controllo è riuscito. | |
| error | < | string | no | Il messaggio di errore se il controllo non è riuscito. | |
Ad esempio, per item supportati:
- Il server apre una connessione TCP
- Il server invia <HEADER><DATALEN>{"request":"passive checks","data":[{"key":"agent.ping","timeout":3}]}
- L'agent legge la richiesta e risponde con <HEADER><DATALEN>{"version":"8.0.0","variant":2,"data":[{"value":1}]}
- Il server elabora i dati per ottenere il valore, '1' nel nostro caso
- La connessione TCP viene chiusa
Per item non supportati:
- Il server apre una connessione TCP
- Il server invia <HEADER><DATALEN>{"request":"passive checks","data":[{"key":"vfs.fs.size[/nono]","timeout":3}]}
- L'agent legge la richiesta e risponde con <HEADER><DATALEN>{"version":"8.0.0","variant":2,"data":[{"error":"Unsupported item key."}]}
- Il server elabora i dati, cambia lo stato dell'item in non supportato con il messaggio di errore specificato
- La connessione TCP viene chiusa
Fallback al vecchio protocollo
Per garantire che Zabbix server o proxy possano funzionare con agent delle versioni precedenti alla 7.2, che utilizzano il protocollo in testo semplice, è stato implementato un fallback al vecchio protocollo.
I controlli passivi vengono eseguiti utilizzando il protocollo JSON (7.0 e successive) dopo un riavvio o quando viene modificata la configurazione dell'interfaccia.
Se in risposta non viene ricevuto alcun JSON valido (l'agent ha inviato "ZBX_NOTSUPPORTED"), Zabbix memorizzerà l'interfaccia come vecchio protocollo e ritenterà il controllo inviando solo la chiave dell'item.
Si noti che ogni ora Zabbix server/proxy proverà nuovamente a utilizzare il nuovo protocollo con tutte le interfacce, tornando al vecchio protocollo se necessario.
Controlli attivi
I controlli attivi richiedono un'elaborazione più complessa. L'agent deve prima recuperare dal server/proxy un elenco di item e/o comandi remoti per l'elaborazione indipendente.
I server/proxy da cui ottenere i controlli attivi sono elencati nel parametro 'ServerActive' del file di configurazione dell'agent. La frequenza con cui vengono richiesti questi controlli è impostata dal parametro 'RefreshActiveChecks' nello stesso file di configurazione. Tuttavia, se l'aggiornamento dei controlli attivi non riesce, il tentativo viene ripetuto dopo 60 secondi predefiniti.
A partire da Zabbix 6.4, l'agent (in modalità attiva) non riceve più dal server/proxy una copia completa della configurazione una volta ogni due minuti (impostazione predefinita). Invece, per ridurre il traffico di rete e l'utilizzo delle risorse, viene eseguita una sincronizzazione incrementale della configurazione ogni 5 secondi (impostazione predefinita), durante la quale il server/proxy fornisce una copia completa della configurazione solo se l'agent non l'ha ancora ricevuta oppure se è cambiato qualcosa nella configurazione dell'host, nelle macro globali o nelle espressioni regolari globali.
L'agent invia quindi periodicamente i nuovi valori al server o ai server. Se l'agent ha ricevuto dei comandi remoti da eseguire, verrà inviato anche il risultato dell'esecuzione. Si noti che l'esecuzione di comandi remoti su un agent attivo è supportata a partire da Zabbix agent 7.0.
Se un agent si trova dietro il firewall, si può prendere in considerazione l'uso dei soli controlli attivi, perché in questo caso non sarebbe necessario modificare il firewall per consentire le connessioni iniziali in ingresso.
Ottenere l'elenco degli item
Richiesta dell'agent
La richiesta di active checks viene usata per ottenere gli active checks da elaborare da parte dell'agent.
Questa richiesta viene inviata dall'agent all'avvio e poi a intervalli di RefreshActiveChecks.
{
"request": "active checks",
"host": "Zabbix server",
"host_metadata": "mysql,nginx",
"interface": "zabbix.server.lan",
"ip": "159.168.1.1",
"port": 12050,
"version": "8.0.0",
"variant": 2,
"config_revision": 1,
"session": "e3dcbd9ace2c9694e1d7bbd030eeef6e"
}
| Field | Type | Mandatory | Value |
|---|---|---|---|
| request | string | yes | active checks |
| host | string | yes | Nome host. |
| host_metadata | string | no | Il parametro di configurazione HostMetadata o il valore della metrica HostMetadataItem. |
| interface | string | no | Il parametro di configurazione HostInterface o il valore della metrica HostInterfaceItem. |
| ip | string | no | Il primo IP del parametro di configurazione ListenIP, se impostato. |
| port | number | no | Il valore del parametro di configurazione ListenPort, se impostato e diverso dalla porta di ascolto predefinita dell'agent. |
| version | string | yes | Il numero di versione dell'agent. |
| variant | number | yes | La variante dell'agent (1 - Zabbix agent, 2 - Zabbix agent 2). |
| config_revision | number | no | Identificatore di configurazione per sincronizzazione incrementale della configurazione. |
| session | string | no | Identificatore di sessione per sincronizzazione incrementale della configurazione. |
Risposta del server
La risposta degli active checks viene inviata dal server all'agent dopo l'elaborazione della richiesta di active checks.
{
"response": "success",
"config_revision": 2,
"data": [
{
"key": "system.uptime",
"itemid": 1234,
"delay": "10s",
"lastlogsize": 0,
"mtime": 0
},
{
"key": "agent.version",
"itemid": 5678,
"delay": "10m",
"lastlogsize": 0,
"mtime": 0,
"timeout": "30s"
}
],
"commands": [
{
"command": "df -h --output=source,size / | awk 'NR>1 {print $2}'",
"id": 1324,
"wait": 1
}
]
}
| Field | Type | Mandatory | Value | |
|---|---|---|---|---|
| response | string | yes | success | failed |
|
| info | string | no | Informazioni sull'errore in caso di fallimento. | |
| data | array of objects | no | Item di active check. Omitted if host configuration is unchanged. | |
| key | string | no | Chiave dell'item con macro espanse. | |
| itemid | number | no | Identificatore dell'item. | |
| delay | string | no | Intervallo di aggiornamento dell'item. Gli intervalli flessibili/di pianificazione sono supportati sia da Zabbix agent sia da Zabbix agent 2 a partire da Zabbix 7.0. |
|
| lastlogsize | number | no | lastlogsize dell'item. | |
| mtime | number | no | mtime dell'item. | |
| timeout | string | no | timeout dell'item. | |
| refresh_unsupported | number | no | Intervallo di aggiornamento degli item non supportati. | |
| regexp | array of objects | no | Espressioni regolari globali. | |
| name | string | no | Nome dell'espressione regolare globale. | |
| expression | string | no | Espressione regolare globale. | |
| expression_type | number | no | Tipo di espressione regolare globale. | |
| exp_delimiter | string | no | Delimitatore dell'espressione regolare globale. | |
| case_sensitive | number | no | Impostazione di sensibilità alle maiuscole/minuscole dell'espressione regolare globale. | |
| commands | array of objects | no | Comandi remoti da eseguire. Inclusi se l'esecuzione di un comando remoto è stata attivata da un'azione operation o dall'esecuzione manuale di uno script. Nota che l'esecuzione di comandi remoti su un active agent è supportata a partire da Zabbix agent 7.0. Gli active agent più vecchi ignoreranno eventuali comandi remoti inclusi nella risposta del server agli active checks. | |
| command | string | no | Comando remoto. | |
| id | number | no | Identificatore del comando remoto. | |
| wait | number | no | Modalità di esecuzione del comando remoto ("0" (nowait) per i comandi provenienti da operations di un'azione; "1" (wait) per i comandi provenienti dall'esecuzione manuale di uno script). | |
| timeout | number | no | Timeout di esecuzione del comando remoto nella configurazione di server/proxy. | |
| config_revision | number | no | Identificatore di configurazione per sincronizzazione incrementale della configurazione. Omitted if host configuration is unchanged. Incremented if host configuration is changed. | |
Il server deve rispondere con success.
Per esempio:
- L'agent apre una connessione TCP
- L'agent richiede l'elenco dei check
- Il server risponde con un elenco di item e di comandi remoti da eseguire
- L'agent analizza la risposta
- La connessione TCP viene chiusa
- L'agent avvia la raccolta periodica dei dati ed esegue i comandi remoti (supportato da Zabbix agent 7.0)
Nota che i dati di configurazione (sensibili) possono diventare disponibili a soggetti che hanno accesso alla porta trapper del server Zabbix quando si usa un active check. Questo è possibile perché chiunque può fingersi un active agent e richiedere i dati di configurazione degli item; l'autenticazione non avviene a meno che non si usino opzioni di crittografia.
Invio dei dati raccolti
Invio dell'agent
La richiesta dati dell'agent contiene i valori degli item raccolti e i valori dei comandi remoti eseguiti (se presenti).
{
"request": "agent data",
"data": [
{
"id": 1,
"itemid": 5678,
"value": "7.0.0",
"clock": 1712830783,
"ns": 76808644
},
{
"id": 2,
"itemid": 1234,
"value": "69672",
"clock": 1712830783,
"ns": 77053975
}
],
"commands": [
{
"id": 1324,
"value": "16G"
}
],
"session": "8495cd52070e6ca52b371f29c8574165",
"host": "Zabbix server",
"version": "8.0.0",
"variant": 2
}
| Campo | Tipo | Obbligatorio | Valore | |
|---|---|---|---|---|
| request | string | sì | agent data |
|
| data | array of objects | sì | Valori degli item. | |
| id | number | sì | Identificatore del valore (contatore incrementale usato per verificare i valori duplicati in caso di problemi di rete). | |
| itemid | number | sì | Identificatore dell'item. | |
| value | string | no | Valore dell'item. | |
| lastlogsize | number | no | lastlogsize dell'item. | |
| mtime | number | no | mtime dell'item. | |
| state | number | no | Stato dell'item. | |
| source | string | no | Sorgente del log eventi del valore. | |
| eventid | number | no | eventid del log eventi del valore. | |
| severity | number | no | Severità del log eventi del valore. | |
| timestamp | number | no | Timestamp del log eventi del valore. | |
| clock | number | sì | Timestamp del valore (secondi dall'Epoch). | |
| ns | number | sì | Nanosecondi del timestamp del valore. | |
| commands | array of objects | no | Risultato dell'esecuzione dei comandi remoti. Si noti che l'esecuzione di comandi remoti su un agent attivo è supportata a partire da Zabbix agent 7.0. Gli agent attivi meno recenti ignoreranno eventuali comandi remoti inclusi nella risposta del server ai controlli attivi. | |
| id | number | no | Identificatore del comando remoto. | |
| value | string | no | Risultato dell'esecuzione del comando remoto se l'esecuzione è riuscita. | |
| error | string | no | Messaggio di errore dell'esecuzione del comando remoto se l'esecuzione non è riuscita. | |
| session | string | sì | Identificatore univoco della sessione generato ogni volta che l'agent viene avviato. | |
| host | string | sì | Nome del host. | |
| version | string | sì | Numero di versione dell'agent. | |
| variant | number | sì | Variante dell'agent (1 - Zabbix agent, 2 - Zabbix agent 2). | |
A ogni valore viene assegnato un ID virtuale. L'ID del valore è un semplice contatore crescente, univoco all'interno di una sessione dati (identificata dal token di sessione). Questo ID viene usato per scartare i valori duplicati che potrebbero essere inviati in ambienti con connettività scarsa.
Risposta del server
La risposta ai dati dell'agent viene inviata dal server all'agent dopo l'elaborazione della richiesta dati dell'agent.
{
"response": "success",
"info": "processed: 2; failed: 0; total: 2; seconds spent: 0.003534"
}
| Campo | Tipo | Obbligatorio | Valore |
|---|---|---|---|
| response | string | sì | success | failed |
| info | string | sì | Risultati dell'elaborazione degli item. |
Se l'invio di alcuni valori non riesce sul server (per esempio, perché il host o l'item è stato disabilitato o eliminato), l'agent non ritenterà l'invio di tali valori.
Per esempio:
- L'agent apre una connessione TCP
- L'agent invia un elenco di valori
- Il server elabora i dati e restituisce lo stato
- La connessione TCP viene chiusa
Il messaggio di errore verrà troncato a 2048 simboli sul lato server.
Messaggio heartbeat
Agent invia
Il messaggio heartbeat viene inviato da un agent attivo a Zabbix server/proxy ogni HeartbeatFrequency secondi (configurato nel file di configurazione di Zabbix agent/agent 2).
Viene utilizzato per monitorare la disponibilità dei controlli attivi.
{
"request": "active check heartbeat",
"host": "Zabbix server",
"heartbeat_freq": 60,
"version": "8.0.0",
"variant": 2
}
| Campo | Tipo | Obbligatorio | Valore |
|---|---|---|---|
| request | string | sì | active check heartbeat |
| host | string | sì | Il nome dell'host. |
| heartbeat_freq | number | sì | La frequenza heartbeat dell'agent (parametro di configurazione HeartbeatFrequency). |
| version | string | sì | Il numero di versione dell'agent. |
| variant | number | sì | La variante dell'agent (1 - Zabbix agent, 2 - Zabbix agent 2). |
Risposta di reindirizzamento
Quando un host è stato riassegnato, il server può indicare all'agent di reindirizzare il proprio heartbeat (e i successivi controlli attivi) a un'altra istanza di proxy o server.
{
"response": "failed",
"redirect": {
"revision": 2,
"address": "192.0.2.1:10055"
}
}
| Campo | Tipo | Obbligatorio | Valore | |
|---|---|---|---|---|
| response | string | sì | success | failed |
|
| redirect | object | sì | Istruzioni di reindirizzamento. | |
| revision | number | sì | Identificatore della revisione della configurazione. | |
| address | string | sì | Indirizzo di destinazione di server/proxy. | |
Protocollo XML precedente
Zabbix accetterà fino a 16 MB di dati XML codificati in Base64, ma un singolo valore decodificato non deve superare 64 KB, altrimenti verrà troncato a 64 KB durante la decodifica.