Zabbix aģents 2 spraudņa protokols
Zabbix aģents 2 protokols ir balstīts uz kodu, izmēru un datu modeli.
Kods
| Type | Size | Comments |
|---|---|---|
| Byte | 4 | Ielādes tips, pašlaik tiek atbalstīts tikai JSON. |
Izmērs
| Type | Size | Comments |
|---|---|---|
| Byte | 4 | Pašreizējā datu apjoma izmērs baitos. |
Ielādes dati
| Type | Size | Comments |
|---|---|---|
| Byte | Definēts ar lauku Size | JSON formāta dati. |
Datu kopas definīcija
Kopējie dati
Šie parametri ir pieejami visos pieprasījumos/atbildēs:
| Name | Type | Comments |
|---|---|---|
| id | uint32 | Pieprasījumiem - pieaugošs identifikators, ko izmanto pieprasījumu sasaistīšanai ar atbildēm. Unikāls vienā pieprasījuma virzienā (t. i., no aģents uz spraudni vai no spraudņa uz aģents). Atbildēm - atbilstošā pieprasījuma ID. |
| type | uint32 | Pieprasījuma tips. |
Žurnāla pieprasījums
Pieprasījums, ko spraudnis nosūta, lai ierakstītu žurnāla ziņojumu aģenta žurnāla failā.
| direction | spraudnis → aģents |
| response | nē |
Žurnāla pieprasījumiem specifiskie parametri:
| Name | Type | Comments |
|---|---|---|
| severity | uint32 | Ziņojuma svarīgums (žurnāla līmenis). |
| message | string | Ziņojums, ko ierakstīt žurnālā. |
Piemērs:
{"id":0,"type":1,"severity":3,"message":"message"}Reģistrācijas pieprasījums
Pieprasījums, ko aģents nosūta aģenta startēšanas fāzē, lai iegūtu sniegtos metriskos datus un reģistrētu spraudni.
| direction | aģents → spraudnis |
| response | yes |
Reģistrācijas pieprasījumiem specifiskie parametri:
| Name | Type | Comments |
|---|---|---|
| version | string | Protokola versija <major>.<minor> |
Piemērs:
{"id":1,"type":2,"version":"1.0"}Reģistrācijas atbilde
Spraudņa atbilde uz reģistrācijas pieprasījumu.
| direction | spraudnis → aģents |
| response | n/a |
Reģistrācijas atbildēm specifiskie parametri:
| Name | Type | Comments |
|---|---|---|
| name | string | Spraudņa nosaukums. |
| metrics | array of strings (optional) | Metrikas ar aprakstiem, kā tās tiek izmantotas spraudnī. Atgriež RegisterMetrics(). Nav, ja tiek atgriezta kļūda. |
| interfaces | uint32 (optional) | Spraudņa atbalstīto saskarņu bitu maska. Nav, ja tiek atgriezta kļūda. |
| error | string (optional) | Kļūdas ziņojums, kas tiek atgriezts, ja spraudni nevar palaist. Nav, ja tiek atgrieztas metrikas. |
Piemēri:
{"id":2,"type":3,"metrics":["external.test", "External exporter Test."], "interfaces": 4}vai
{"id":2,"type":3,"error":"error message"}Sākuma pieprasījums
Pieprasījums izpildīt Runner saskarnes funkciju Start.
| direction | aģents → plugin |
| response | no |
Pieprasījumam nav specifisku parametru, tas satur tikai kopīgo datu parametrus.
Piemērs:
{"id":3,"type":4}Pieprasījuma pārtraukšana
Pieprasījums, ko aģents nosūta, lai apturētu spraudni.
| direction | aģents → spraudnis |
| response | no |
Šim pieprasījumam nav specifisku parametru, tas satur tikai kopīgo datu parametrus.
Piemērs:
{"id":3,"type":5}Eksporta pieprasījums
Pieprasījums izpildīt Export funkciju Exporter interfeisā.
| direction | aģents → plugin |
| response | no |
Eksporta pieprasījumiem specifiskie parametri:
| Name | Type | Comments |
|---|---|---|
| key | string | Spraudņa atslēga. |
| parameters | array of strings (optional) | Export funkcijas parametri. |
Piemērs:
{"id":4,"type":6,"key":"test.key","parameters":["foo","bar"]}Eksporta atbilde
Atbilde no Export funkcijas Exporter saskarnē.
| direction | spraudnis → aģents |
| response | n/a |
Eksporta atbildēm specifiskie parametri:
| Name | Type | Comments |
|---|---|---|
| value | string (optional) | Atbildes vērtība no Export funkcijas. Nav norādīts, ja tiek atgriezta kļūda. |
| error | string (optional) | Kļūdas ziņojums, ja Export funkcija nav izpildīta veiksmīgi. Nav norādīts, ja tiek atgriezta vērtība. |
Piemēri:
{"id":5,"type":7,"value":"response"}vai
{"id":5,"type":7,"error":"error message"}Konfigurēt pieprasījumu
Pieprasījums izpildīt Configurator saskarnes funkciju Configure.
| direction | aģents → spraudnis |
| response | n/a |
Parametri, kas raksturīgi Configure pieprasījumiem:
| Name | Type | Comments |
|---|---|---|
| global_options | JSON object | JSON objekts, kas satur globālās aģenta konfigurācijas opcijas. |
| private_options | JSON object (optional) | JSON objekts, kas satur privātās spraudņa konfigurācijas opcijas, ja tās ir norādītas. |
Piemērs:
{"id":6,"type":8,"global_options":{...},"private_options":{...}}Validēt pieprasījumu
Pieprasījums izpildīt Validate funkciju no Configurator saskarnes.
| direction | aģents → plugin |
| response | yes |
Parametri, kas raksturīgi Validate pieprasījumiem:
| Name | Type | Comments |
|---|---|---|
| private_options | JSON object (optional) | JSON object, kas satur privātās spraudņa konfigurācijas opcijas, ja tās ir norādītas. |
Piemērs:
{"id":7,"type":9,"private_options":{...}}Validēt atbildi
Atbilde no Validate funkcijas Configurator interfeisā.
| direction | spraudnis → aģents |
| response | n/a |
Parametri, kas raksturīgi Validate atbildēm:
| Name | Type | Comments |
|---|---|---|
| error | string (optional) | Kļūdas ziņojums, kas tiek atgriezts, ja funkcija Validate netiek izpildīta veiksmīgi. Nav pieejams, ja izpilde ir veiksmīga. |
Piemērs:
{"id":8,"type":10}vai
{"id":8,"type":10,"error":"error message"}