4 Zabbix agent 2 plugin protocol

Zabbix agent 2 protocol is based on code, size and data model.

Code

Size

Payload data

Payload data definition

Common data

These parameters are present in all requests/responses:

Log request

A request sent by a plugin to write a log message into the agent log file.

Parameters specific to log requests:

Example:

{"id":0,"type":1,"severity":3,"message":"message"}

Register request

A request sent by the agent during the agent startup phase to obtain provided metrics to register a plugin.

Parameters specific to register requests:

Example:

{"id":1,"type":2,"version":"1.0"}

Register response

Plugin’s response to the register request.

Parameters specific to register responses:

Examples:

{"id":2,"type":3,"metrics":["external.test", "External exporter Test."], "interfaces": 4}

or

{"id":2,"type":3,"error":"error message"}

Start request

A request to execute the Start function of the Runner interface.

The request doesn’t have specific parameters, it only contains common data parameters.

Example:

{"id":3,"type":4}

Terminate request

A request sent by the agent to shutdown a plugin.

The request doesn’t have specific parameters, it only contains common data parameters.

Example:

{"id":3,"type":5}

Export request

A request to execute the Export function of the Exporter interface.

Parameters specific to export requests:

Example:

{"id":4,"type":6,"key":"test.key","parameters":["foo","bar"]}

Export response

Response from the Export function of the Exporter interface.

Parameters specific to export responses:

Examples:

{"id":5,"type":7,"value":"response"}

or

{"id":5,"type":7,"error":"error message"}

Configure request

A request to execute the Configure function of the Configurator interface.

Parameters specific to Configure requests:

Example:

{"id":6,"type":8,"global_options":{...},"private_options":{...}}

Validate request

A request to execute Validate function of the Configurator interface.

Parameters specific to Validate requests:

Example:

{"id":7,"type":9,"private_options":{...}}

Validate response

Response from Validate function of Configurator interface.

Parameters specific to Validate responses:

Example:

{"id":8,"type":10}

or

{"id":8,"type":10,"error":"error message"}