10 環境変数

概要

環境変数を使用すると、設定ファイルに値をハードコーディングすることなく、Zabbix コンポーネントを設定できます。 これにより、Docker などの動的な環境で設定を簡単に管理でき、Docker では、実行時に変数を渡すことでさまざまな設定に適応させることができます。

最も単純なケースでは、Zabbix サーバーの DebugLevel 設定パラメータ値を環境変数に設定することで、起動時にサーバーの設定に使用できます。

# Zabbix サーバー設定ファイル:
       DebugLevel=${NewDebugLevel}
       
       # Zabbix サーバーの起動:
       NewDebugLevel=5 /usr/sbin/zabbix_server

環境変数は、以下の Zabbix コンポーネントでサポートされています。

• Server
• Proxy
• エージェント (UNIX または Windows)
• エージェント 2 (UNIX または Windows)、プラグインを含む
• Webサービス
• Zabbix Sender (-c, --config オプション 使用時)

重要事項

• 設定パラメータが環境変数に設定されており、コンポーネント実行時にその環境変数が指定されていない場合、パラメータのデフォルト値が使用されます。
• ランタイムコマンドを使用する場合（例：エージェントのログレベルを上げる場合）、以前に使用した環境変数を指定する必要があります。これは、Zabbixコンポーネントが設定ファイルを使用してランタイムコマンドを実行するためです。環境変数が省略されている場合、設定パラメータのデフォルト値が使用されます。例を参照してください。
• userparameter_reload ランタイムコマンドは、環境変数の再読み込みをサポートしていません。再読み込み中は変数は無視され、通常の値を持つパラメータのみが再読み込みされます。
• 設定ファイルで使用されていたプロセスの現在の環境変数は、Zabbixコンポーネントの起動後にクリアされます。これにより、子プロセス（例：Zabbixによって実行されるリモートスクリプト）はこれらの変数にアクセスできなくなります。ただし、プロセス初期変数は引き続き取得できることに注意してください。 (たとえば、/proc/<PID>/environ ファイル経由)

構文

環境変数は、${英数字/アンダースコア} という構文を使用する必要があります。

変数名には、英字 (a-z、A-Z)、アンダースコア (_)、数字 (0-9) のみを使用できます。また、数字で始まってはなりません。

必須の構文に一致しない変数、または通常の値と組み合わせられた変数は通常の値として扱われ、エラーが発生する可能性があります。

正しい変数構文:

DebugLevel=${NewDebugLevel}
       Hostname=${ZBX_HOSTNAME}
       LogFile=${LogFile_001}

誤った変数構文:

DebugLevel=${5_DebugLevel}
       Hostname=${ZBX.HOSTNAME 1}
       LogFile=/${HOME}/zabbix/zabbix_server.log

例

以下の例では、Zabbix コンポーネントでの環境変数の設定および使用方法を示しています。

例 1: Zabbix エージェントの設定とテスト

1. エージェント設定ファイルで環境変数を設定します。

Hostname=${ZBX_HOSTNAME}
       ServerActive=${ServerActive}

2. 設定ファイルをテストします。

ZBX_HOSTNAME="New Zabbix agent" ServerActive=127.0.0.1 /usr/sbin/zabbix_agentd -c /etc/zabbix/zabbix_agentd.conf --test-config

3.環境変数を有効にしてエージェントを起動します。

ZBX_HOSTNAME="New Zabbix agent" ServerActive=127.0.0.1 /usr/sbin/zabbix_agentd -c /etc/zabbix/zabbix_agentd.conf

ランタイムコマンドを使用する場合（例：エージェントのログレベルを上げる場合）、以前に使用した環境変数を再度指定する必要があります。

ZBX_HOSTNAME="New Zabbix agent" ServerActive=127.0.0.1 /usr/sbin/zabbix_agentd -c /etc/zabbix/zabbix_agentd.conf -R log_level_increase

これは、エージェントがランタイムコマンドを実行するために設定ファイルを使用するためです。環境変数が省略されている場合、設定パラメータのデフォルト値が使用されます。

あるいは、エージェント設定ファイルで環境変数を設定した後、プロセスでそれらを有効に出来るようにすることもできます。（例：export コマンドを使用） これにより、変数の欠落や誤った設定による予期しない動作のリスクを軽減できます。

export ZBX_HOSTNAME="新しい Zabbix エージェント"
       export ServerActive=127.0.0.1
       /usr/sbin/zabbix_agentd -c /etc/zabbix/zabbix_agentd.conf --test-config
       /usr/sbin/zabbix_agentd -c /etc/zabbix/zabbix_agentd.conf
       /usr/sbin/zabbix_agentd -c /etc/zabbix/zabbix_agentd.conf -R log_level_increase

例 2: コンテナ用の Zabbix エージェントの設定

Zabbix コンポーネント（例: Zabbix エージェント）用のカスタムイメージを独自に作成・設定する場合には、環境変数を使用して設定パラメータを定義し、その変数を有効にしてコンテナを起動できます。

1. イメージを準備する際に、エージェント設定ファイルで環境変数を設定します。

Hostname=${ZBX_HOSTNAME}
       BufferSize=${BUFSZ}
       ListenPort=${LISTENPORT}
       UserParameter=${_UsrPar01}
       UserParameter=${_UsrPar02}

2.コンテナイメージをビルドしたら、環境変数を指定してエージェントコンテナ（例：Docker）を起動します。

docker run --name my-zabbix-agent -e ZBX_HOSTNAME="new-hostname" -e BUFSZ=1000 -e LISTENPORT=20050 -e _UsrPar01="key1,ls" -e _UsrPar02="key2,pwd" --init -d my-zabbix-agent:latest

3. ランタイムコマンドを使用する場合（例：エージェントのログレベルを上げる場合）、コンテナシェルにアクセスし、以下のランタイムコマンドを実行します。

docker exec -it <containerid> sh
       /usr/sbin/zabbix_agentd -R log_level_increase