4 Zabbixエージェント2プラグインプロトコル

Zabbixエージェント2プロトコルはコード、サイズ、データ モデルに基づいています。

コード

サイズ

ペイロードデータ

ペイロードデータの定義

共通データ

これらのパラメータは、すべてのリクエスト/レスポンスに含まれます。

ログリクエスト

プラグインがログメッセージをエージェントのログファイルに書き込むために送信するリクエストです。

ログリクエスト固有のパラメータ:

例:

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

登録リクエスト

プラグインを登録するために、提供されるメトリクスを取得する目的で、エージェントの起動フェーズ中にエージェントから送信されるリクエストです。

登録リクエスト固有のパラメータ:

例:

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

Register応答

registerリクエストに対するプラグインの応答です。

register応答固有のパラメータ:

例:

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

または

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

Startリクエスト

RunnerインターフェースのStart関数を実行するためのリクエストです。

このリクエストには固有のパラメータはなく、共通データのパラメータのみが含まれます。

例:

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

終了リクエスト

プラグインをシャットダウンするためにエージェントから送信されるリクエストです。

このリクエストには固有のパラメータはなく、共通データ パラメータのみが含まれます。

例:

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

エクスポートリクエスト

ExporterインターフェースのExport関数を実行するためのリクエスト。

エクスポートリクエスト固有のパラメータ:

例:

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

エクスポート応答

ExporterインターフェースのExport関数からの応答。

エクスポート応答固有のパラメータ:

例:

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

または

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

リクエストの設定

Configurator インターフェースの Configure 機能を実行するためのリクエストです。

Configure リクエスト固有のパラメータ:

例:

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

リクエストの検証

Configurator インターフェースの Validate 関数を実行するためのリクエスト。

Validate リクエスト固有のパラメータ:

例:

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

レスポンスの検証

Configurator インターフェースの Validate 関数からのレスポンス。

Validate レスポンス固有のパラメータ:

例:

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

または

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