Zabbixエージェント2プロトコルはコード、サイズ、データ モデルに基づいています。
タイプ | サイズ | コメント |
---|---|---|
バイト | 4 | ペイロードタイプ、現在はJSONのみがサポートされています。 |
タイプ | サイズ | コメント |
---|---|---|
バイト | 4 | 現在のペイロードのサイズ(バイト単位) |
タイプ | サイズ | コメント |
---|---|---|
バイト | サイズフィールドで定義される | JSON形式のデータ |
これらのパラメータはすべてのリクエスト/レスポンスに存在します。
名前 | タイプ | コメント |
---|---|---|
id | uint32 | リクエストの場合 - リクエストとレスポンスを関連付けるために使用される増分識別子。リクエスト方向(エージェントからプラグイン、またはプラグインからエージェント)内で一意です。 レスポンスの場合 - 対応するリクエストのID |
type | uint32 | リクエストタイプ |
プラグインからエージェントのログファイルにログメッセージを書き込むために送信されるリクエスト。
direction | plugin → agent |
response | no |
ログリクエスト固有のパラメータ:
Name | Type | Comments |
---|---|---|
severity | uint32 | メッセージの重要度(ログレベル) |
message | string | ログに記録するメッセージ |
例:
{"id":0,"type":1,"severity":3,"message":"message"}
エージェント起動フェーズ中に、プラグインを登録するためのメトリクスを取得するためにエージェントから送信されるリクエスト
direction | agent → plugin |
response | yes |
登録リクエスト固有のパラメータ:
名前 | タイプ | コメント |
---|---|---|
version | 文字列 | プロトコルバージョン <major>.<minor> |
例:
{"id":1,"type":2,"version":"1.0"}
登録リクエストに対するプラグインのレスポンス
direction | plugin → agent |
response | n/a |
登録レスポンスに固有のパラメータ:
Name | Type | Comments |
---|---|---|
name | string | プラグイン名 |
metrics | 文字列の配列 (オプション) | プラグインで使用される説明付きのメトリクス。RegisterMetrics() を返します。エラーが返された場合は省略されます。 |
interfaces | uint32 (オプション) | プラグインでサポートされているインターフェースのビットマスク。エラーが返された場合は省略されます。 |
error | string (オプション) | プラグインを起動できない場合に返されるエラーメッセージ。メトリクスが返された場合は省略されます。 |
例:
{"id":2,"type":3,"metrics":["external.test", "外部エクスポーター テスト."], "interfaces": 4}
または
{"id":2,"type":3,"error":"エラーメッセージ"}
ランナーインターフェースの Start 関数を実行するためのリクエスト
direction | agent → plugin |
response | no |
このリクエストには特定のパラメーターはなく、共通データパラメーターのみが含まれます。
例:
{"id":3,"type":4}
プラグインをシャットダウンするためにエージェントから送信されるリクエスト
direction | agent → plugin |
response | no |
このリクエストには特定のパラメータはなく、共通データパラメータのみが含まれます。
例:
{"id":3,"type":5}
エクスポーターインターフェースのエクスポート機能を実行するためのリクエスト
direction | agent → plugin |
response | no |
エクスポートリクエスト固有のパラメーター:
Name | Type | Comments |
---|---|---|
key | string | プラグインキー |
parameters | 文字列の配列(オプション) | エクスポート機能のパラメーター |
例:
{"id":4,"type":6,"key":"test.key","parameters":["foo","bar"]}
エクスポーターインターフェースのエクスポート機能からのレスポンス
direction | plugin → agent |
response | n/a |
エクスポートレスポンス固有のパラメーター:
Name | Type | Comments |
---|---|---|
value | 文字列 (オプション) | エクスポート機能からのレスポンス値。エラーが返された場合は省略されます。 |
error | 文字列 (オプション) | エクスポート機能が正常に実行されなかった場合のエラーメッセージ。値が返された場合は省略されます。 |
例:
{"id":5,"type":7,"value":"response"}
または
{"id":5,"type":7,"error":"error message"}
Configurator インターフェースの Configure 機能を実行するためのリクエスト
direction | agent → plugin |
response | n/a |
Configure リクエスト固有のパラメーター:
名前 | タイプ | コメント |
---|---|---|
global_options | JSON オブジェクト | グローバルエージェント構成オプションを含む JSON オブジェクト |
private_options | JSON オブジェクト (オプション) | プライベートプラグイン構成オプション (指定されている場合) を含む JSON オブジェクト |
例:
{"id":6,"type":8,"global_options":{...},"private_options":{...}}
Configurator インターフェースの Validate 関数を実行するためのリクエスト
direction | agent → plugin |
response | yes |
Validate リクエスト固有のパラメーター:
Name | Type | Comments |
---|---|---|
private_options | JSON オブジェクト (オプション) | プライベートプラグイン設定オプション (指定されている場合) を含む JSON オブジェクト |
例:
{"id":7,"type":9,"private_options":{...}}
Configurator インターフェースの Validate 関数からのレスポンス | | | |---|---| |direction|plugin → agent| |response|n/a|
Validate レスポンス固有のパラメーター:
Name | Type | Comments |
---|---|---|
error | 文字列 (オプション) | Validate 関数が正常に実行されなかった場合に返されるエラーメッセージ。正常に実行された場合は存在しません。 |
例:
{"id":8,"type":10}
または
{"id":8,"type":10,"error":"エラーメッセージ"}