同期モードでは、Pythonスクリプトがデータを要求し、続行する前にデータを待機します。これは、単純で順次的かつ予測可能な操作に適しています。
非同期モードでは、スクリプトは各応答を待たずにデータを要求し、他の操作を並行して実行できます。これは、遅いリクエストや大量のデータバッチに対してより効率的です。

このページの例は同期モードに焦点を当てていますが、非同期モードも同様のパターンに従います。追加の例は、zabbix_utils GitHubリポジトリで利用できます。

インポート

zabbix_utilsを使用してアイテム値を収集するには、PythonスクリプトでGetterクラスをインポートします。

from zabbix_utils import Getter

アイテム値のリクエスト

アイテム値をリクエストするには:

ZabbixエージェントのIPアドレスとポートを指定して、Getterインスタンスを作成します。
取得したいアイテムのキーを指定して、Getterインスタンスでget()メソッドを呼び出します。

例えば、system.unameアイテムのデータをリクエストするには:

agent = Getter(host='192.0.2.0', port=10050)
response = agent.get('system.uname')

デフォルト以外のIPの使用

スクリプトを実行しているサーバーに複数のIPアドレスがある場合、Zabbixエージェントに接続する際にGetterが使用するsource_ipを指定できます。

agent = Getter(
    host='192.0.2.0',
    port=10050,
    source_ip='10.10.7.1'
)

タイムアウトの使用

Zabbixエージェントからの応答を待つ時間を制御するために、Getterに応答timeoutを設定できます。

agent = Getter(
    host='192.0.2.0',
    port=10050,
    timeout=30
)

暗号化の使用

Getterには組み込みの暗号化サポートはありませんが、サードパーティのライブラリを使用してラッパーを作成することで暗号化を提供できます。

def psk_wrapper(sock, tls):
    # ...
    # ソケット用のTLS PSKラッパーの実装
    # ...

agent = Getter(
    host='192.0.2.0',
    port=10050,
    socket_wrapper=psk_wrapper
)

レスポンス

Zabbixエージェントからのレスポンスはライブラリによって処理され、AgentResponseオブジェクトとして返されます。

print(response)
# {
#     "error": null,
#     "raw": "Linux zabbix_server 5.15.0-3.60.5.1.el9uek.x86_64",
#     "value": "Linux zabbix_server 5.15.0-3.60.5.1.el9uek.x86_64"
# }

print(response.value)
# Linux zabbix_server 5.15.0-3.60.5.1.el9uek.x86_64

print(response.error)
# None

非同期モード

非同期モードでは、スクリプトが各値の到着を待たずに値を収集できます。多くの値を収集する必要がある場合や、一部の値の収集に時間がかかる場合に、スクリプトをより効率的にすることができます。

非同期モードを使用する場合、同期モードと比較して重要な違いがあります。

Pythonのasyncioモジュールをインポートします（事前に必要な依存関係をインストールする必要があります）。
Getterの代わりにAsyncGetterをインポートします。
コードをasync関数内に記述します。
get()メソッドを呼び出す際にawaitを使用します。

例えば、非同期モードで単一の値を収集するには:

# 1. 非同期モード用にasyncio、zabbix_utilsからAsyncGetterをインポート:
import asyncio
from zabbix_utils import AsyncGetter

# 2. すべてのデータリクエストを実行するメインのasync関数を定義:
async def main():
    agent = AsyncGetter(host='192.0.2.0', port=10050)

    # 3. Zabbixエージェントからsystem.unameの値を取得（awaitが必要）:
    response = await agent.get('system.uname')

    # 4. Zabbixエージェントから返された値を表示:
    print(response.value)

# 5. asyncioのイベントループを使ってasync main()関数を実行:
asyncio.run(main())

What’s next?

Zabbixサーバーまたはプロキシへのデータ送信

Docs

Zabbixエージェントからデータを収集する

概要