3 Zabbix エージェント (UNIX)

概要

このセクションでは、Zabbix エージェントの設定ファイル (zabbix_agentd.conf) でサポートされるパラメーターを一覧表示します。

パラメーターは追加情報なしで一覧表示されています。 パラメーターをクリックすると、詳細を表示できます。

特に明記されていない限り、すべてのパラメーターは必須ではありません。

注意:

• 既定値は、配布される設定ファイル内の値ではなく、デーモンの既定値を反映しています。
• 値は 環境変数 をサポートします。
• Zabbix は、BOM を含まない UTF-8 エンコーディングの設定ファイルのみをサポートします。
• # で始まるコメントは、行頭でのみサポートされます。

パラメータの詳細

エイリアス

アイテムキーにエイリアスを設定します。 長く複雑なアイテムキーを、より短く簡単なものに置き換えるために使用できます。
複数の Alias パラメータを指定できます。 同じ Alias キーを持つ複数のパラメータは許可されません。
異なる Alias キーが同じアイテムキーを参照することはできます。
エイリアスは HostMetadataItem では使用できますが、HostnameItem パラメータでは使用できません。

例 1: ユーザー zabbix の ID を取得する。

Alias=zabbix.userid:vfs.file.regexp[/etc/passwd,"^zabbix:.:([0-9]+)",,,,\1]

これで、zabbix.userid の省略キーを使用してデータを取得できます。

例 2: デフォルトおよびカスタムパラメータで CPU 使用率を取得する。

Alias=cpu.util:system.cpu.util
Alias=cpu.util[*]:system.cpu.util[*]

これにより、cpu.util キーを使用してデフォルトパラメータの CPU 使用率を取得できるほか、cpu.util[all, idle, avg15] を使用して CPU 使用率の特定データを取得できます。

例 3: 同じ検出アイテムを処理する複数の low-level discovery ルールを実行する。

Alias=vfs.fs.discovery[*]:vfs.fs.discovery

これで、各ルールに異なるパラメータを指定して vfs.fs.discovery を使用する複数の検出ルールを設定できます。たとえば、vfs.fs.discovery[foo]、vfs.fs.discovery[bar] などです。

AllowKey

パターンに一致するアイテムキーの実行を許可します。 キーのパターンはワイルドカード式で、任意の数の任意の文字に一致する * 文字をサポートします。
DenyKey と組み合わせて、複数のキー一致ルールを定義できます。 パラメーターは、記載順に1つずつ処理されます。 関連項目: エージェントチェックの制限。

AllowRoot

エージェントを 'root' として実行することを許可します。 無効にした場合、エージェントが 'root' によって開始された場合、代わりに 'zabbix' ユーザーに切り替えようとします。 通常のユーザーで開始した場合は効果がありません。

デフォルト: 0
値: 0 - 許可しない; 1 - 許可する

BufferSend

N秒を超えてバッファ内にデータを保持しません。

デフォルト: 5
範囲: 1-3600

BufferSize

メモリバッファ内の値の最大数。 バッファがいっぱいになると、エージェントは収集したすべてのデータをZabbixサーバーまたはプロキシに送信します。

デフォルト: 100
範囲: 2-65535

DebugLevel

デバッグレベルを指定します:

• 0 - Zabbixプロセスの開始と停止に関する基本情報;
• 1 - 重大な情報;
• 2 - エラー情報;
• 3 - 警告;
• 4 - デバッグ用（大量の情報を出力します）;
• 5 - 拡張デバッグ用（さらに多くの情報を出力します）。

デフォルト: 3
範囲: 0-5

DenyKey

パターンに一致するアイテムキーの実行を拒否します。 キーのパターンはワイルドカード式で、任意の数の任意の文字に一致する * 文字をサポートします。
複数のキー一致ルールを AllowKey と組み合わせて定義できます。 パラメータは、記載順に1つずつ処理されます。 関連項目: エージェントチェックの制限。

EnableRemoteCommands

Zabbixサーバーからのリモートコマンドを許可します。
このパラメーターは非推奨です。代わりに AllowKey=system.run[*] または DenyKey=system.run[*] を使用してください。
これは値に応じて AllowKey/DenyKey パラメーターの内部エイリアスです。

• 0 - DenyKey=system.run[*]
• 1 - AllowKey=system.run[*]

デフォルト: 0
値: 0 - 許可しない、1 - 許可する

HeartbeatFrequency

ハートビートメッセージの頻度（秒単位）。 アクティブチェックの可用性を監視するために使用されます。
0 - ハートビートメッセージを無効にします。

デフォルト: 60
範囲: 0-3600

HostInterface

ホストの自動登録処理中に使用されるホストインターフェース（IPアドレスまたはDNS名）を定義する任意のパラメータです。 この値は、新しく作成されるホストのインターフェースを設定するために使用され、IPアドレスまたはDNSアドレスのいずれかを明示的に設定できます。 詳細については、DNSをデフォルトのインターフェースとして使用するを参照してください。

定義されていない場合、値は HostInterfaceItem から取得されます。

値が255文字を超える場合、エージェントはエラーを出力して起動しません。

範囲: 0-255文字

HostInterfaceItem

ホストの自動登録プロセス中に、ホストインターフェース（IPアドレスまたはDNS名）を判定するために使用するアイテムを定義する任意のパラメーターです。 この値は、HostInterface が定義されていない場合にのみ使用されます。 詳細は、DNSをデフォルトインターフェースとして使用するを参照してください。

自動登録リクエストの処理中、指定したアイテムが返す値が255文字の上限を超えている場合、エージェントは警告メッセージをログに記録します。

system.run[] アイテムは、AllowKey/DenyKey の設定に関係なくサポートされます。

HostMetadata

ホストの自動登録プロセス（アクティブエージェント）中に、ホストを識別または区別するために使用されるメタデータを定義する任意のパラメーターです。
HostMetadata を使用すると、ホスト名以外の情報でもホストを区別できます。

定義されていない場合、値は HostMetadataItem から取得されます。

指定した値が 2034 バイトの上限を超える場合、または UTF-8 文字列でない場合、エージェントはエラーを出力して起動しません。
パラメーターが IP アドレスまたは DNS 名を期待する場合、UTF-8 としては有効でも IP アドレスまたは DNS 名として無効な値は拒否され、無効として報告されます。

複数行のメタデータはサポートされていません。出力は最初の改行で切り捨てられます。

範囲: 0-2034 バイト

HostMetadataItem

ホストメタデータ を取得するために使用される Zabbix エージェントのアイテムを定義する任意のパラメーターです。
このオプションは HostMetadata が定義されていない場合にのみ使用されます。

HostMetadataItem の値は各 自動登録 の試行時に取得され、ホストの自動登録プロセス（アクティブ エージェント）でのみ使用されます。
HostMetadataItem により、ホスト名以外の情報でホストを識別できます。

ユーザーパラメーターとエイリアスがサポートされています。
system.run[] アイテムは、AllowKey/DenyKey の設定に関係なくサポートされます。

自動登録リクエスト中に、指定したアイテムが返す値が 65535 UTF-8 コードポイントの上限を超える場合、エージェントは警告メッセージをログに記録します。
アイテムが返す値は UTF-8 文字列でなければならず、そうでない場合は無視されます。
パラメーターが IP アドレスまたは DNS 名を期待する場合、UTF-8 としては有効でも IP アドレスまたは DNS 名として無効な値は拒否され、無効として報告されます。

複数行のメタデータはサポートされません。出力は最初の改行で切り捨てられます。

ホスト名

カンマ区切りの、一意で大文字小文字を区別するホスト名の一覧です。 アクティブチェックに必要であり、サーバーで設定されたホスト名と一致している必要があります。 未定義の場合、値は HostnameItem から取得されます。
使用可能な文字: 英数字、'.'、' '、'_'、'-'。 最大長: ホスト名ごとに 128 文字、行全体で 2048 文字。

デフォルト: HostnameItem により設定されます

HostnameItem

ホスト名を取得するために使用される Zabbix エージェントのアイテムを定義する任意のパラメーターです。 このオプションは、Hostname が定義されていない場合にのみ使用されます。 User parameters や aliases はサポートされていませんが、system.run[] アイテムは AllowKey/DenyKey の値に関係なくサポートされています。

デフォルト: system.hostname

Include

個々のファイルまたはディレクトリ内のすべてのファイルを設定ファイルに含めることができます。 指定したディレクトリ内の関連ファイルのみを含めるために、パターンマッチング用のアスタリスクワイルドカード文字がサポートされています。
制限事項については特記事項を参照してください。

例:

Include=/absolute/path/to/config/files/*.conf

ListenBacklog

TCP キュー内の保留中の接続の最大数。
デフォルト値はシステムに依存するハードコードされた定数です。
サポートされる最大値はシステムに依存し、値が大きすぎる場合は'実装で指定された最大値' で自動的に切り捨てられる場合があります。

デフォルト: SOMAXCONN
範囲: 0 - INT_MAX

ListenIP

エージェントが待受するIPアドレスのカンマ区切りリスト

デフォルト: 0.0.0.0

ListenPort

エージェントは、サーバーからの接続をこのポートで待受します。

デフォルト: 10050
範囲: 1024-32767

LoadModule

エージェントの起動時に読み込むモジュールです。 モジュールはエージェントの機能を拡張するために使用されます。 モジュールは LoadModulePath で指定されたディレクトリに配置されている必要があります。そうでない場合は、モジュール名の前にパスを指定する必要があります。 先頭のパスが絶対パス（/ で始まる）である場合、LoadModulePath は無視されます。
形式:

• LoadModule=<module.so>
• LoadModule=<path/module.so>
• LoadModule=</abs_path/module.so>

複数の LoadModule パラメータを指定できます。

LoadModulePath

エージェントモジュールの場所へのフルパス。 デフォルトはコンパイルオプションによって異なります。

LogFile

ログファイルの名前。

必須: はい。LogType が file に設定されている場合は必須です。それ以外の場合は不要です。

LogFileSize

ログファイルの最大サイズ（MB）
0 - 自動ログローテーションを無効にします。
注: ログファイルのサイズ制限に達し、何らかの理由でファイルローテーションが失敗した場合、既存のログファイルは切り捨てられ、新たに開始されます。

デフォルト: 1
範囲: 0-1024

LogRemoteCommands

実行されたシェルコマンドを警告としてログに記録します。
コマンドは、リモートで実行された場合にのみログに記録されます。
system.run[] が HostMetadataItem、HostInterfaceItem、または HostnameItem パラメータによってローカルで起動された場合、ログエントリは作成されません。

デフォルト: 0
値: 0 - 無効、1 - 有効

LogType

ログ出力の種類:

• file - LogFile パラメータで指定されたファイルにログを書き込みます。
• system - syslog にログを書き込みます。
• console - 標準出力にログを書き込みます。

デフォルト: file

MaxLinesPerSecond

エージェントが log および logrt のアクティブチェックを処理する際に、サーバーまたはプロキシへ 1 秒あたりに送信する新しい行の最大数です。 指定した値は、log または logrt アイテムキーで指定された maxlines パラメータによって上書きされます。
注: Zabbix は、ログアイテム内で必要な文字列を検索するために、MaxLinesPerSecond に設定された値の 10 倍の新しい行を処理します。

デフォルト: 20
範囲: 1-1000

PidFile

PIDファイルの名前

デフォルト: /tmp/zabbix_agentd.pid

RefreshActiveChecks

アクティブチェックのリストをリフレッシュする間隔(秒)。 アクティブチェックのリフレッシュに失敗した場合、次のリフレッシュは60秒後に試行されます。

デフォルト: 5
範囲: 1-86400

サーバー

ZabbixサーバーおよびZabbixプロキシの、カンマ区切りのIPアドレス（必要に応じてCIDR表記）またはDNS名の一覧です。
受信接続は、ここに列挙されたホストからのみ受け入れられます。
IPv6サポートが有効な場合、127.0.0.1、::127.0.0.1、::ffff:127.0.0.1 は同等に扱われ、::/0 により任意のIPv4またはIPv6アドレスが許可されます。
0.0.0.0/0 は任意のIPv4アドレスを許可するために使用できます。
"IPv4-compatible IPv6 addresses"（0000::/96 プレフィックス）はサポートされていますが、RFC4291 により非推奨であることに注意してください。
スペースは使用できます。

例:

Server=127.0.0.1,192.168.1.0/24,::1,2001:db8::/32,zabbix.example.com

必須: はい。ただし、StartAgents が明示的に 0 に設定されていない場合

ServerActive

アクティブチェックを取得するための Zabbix サーバー/プロキシのアドレス、またはクラスタ構成です。 サーバー/プロキシのアドレスは IP アドレスまたは DNS 名で、必要に応じてコロンで区切ったポートを指定できます。
クラスタ構成は、セミコロンで区切られた 1 つ以上のサーバーまたはプロキシグループのメンバーアドレスです。 複数の Zabbix サーバー/クラスタおよび Zabbix プロキシを、カンマ区切りで指定できます。 プロキシグループを使用しない場合、各 Zabbix サーバー/クラスタに対して 2 つ以上の Zabbix プロキシを指定しないでください。 Zabbix プロキシを指定した場合、そのプロキシに対応する Zabbix サーバー/クラスタは指定しないでください。
複数のカンマ区切りアドレスを指定して、複数の独立した Zabbix サーバーを並列に使用できます。 スペースは使用できます。
ポートを指定しない場合は、デフォルトのポートが使用されます。
IPv6 アドレスでは、そのホストのポートを指定する場合、角括弧で囲む必要があります。 ポートを指定しない場合、IPv6 アドレスの角括弧は省略可能です。
このパラメーターが指定されていない場合、アクティブチェックは無効になります。

Zabbix プロキシの例:

ServerActive=127.0.0.1:10051

Zabbix プロキシグループの例:

ServerActive=proxy1.example.com;proxy2.example.com;proxy3.example.com;proxy4.example.com;proxy5.example.com

複数サーバーの例:

ServerActive=127.0.0.1:20051,zabbix.domain,[::1]:30051,::1,[12fc::1]

高可用性の例:

ServerActive=zabbix.cluster.node1;zabbix.cluster.node2:20051;zabbix.cluster.node3

2 つのクラスタと 1 つのサーバーを使用した高可用性の例:

ServerActive=zabbix.cluster.node1;zabbix.cluster.node2:20051,zabbix.cluster2.node1;zabbix.cluster2.node2,zabbix.domain

SourceIP

以下の接続に使用する送信元IPアドレスです。

• ZabbixサーバーまたはZabbixプロキシへの送信接続
• 一部のアイテム（web.page.get、net.tcp.port など）を実行する際の接続

StartAgents

受動チェックを処理する、事前に fork された zabbix_agentd のインスタンス数です。 0 に設定すると、受動チェックは無効になり、エージェントは TCP ポートで待ち受けしなくなります。

デフォルト: 10
範囲: 0-100

Timeout

Zabbixプロキシまたはサーバーとの接続確立およびデータ交換を待機する時間（秒単位）を指定します。

このパラメータは、以下を含むさまざまな通信操作の期間を定義します。

• Zabbixサーバーからの応答を待つ
• アイテム設定リクエストやアクティブチェックのアイテムデータなど、Zabbixサーバーへのリクエスト送信
• logfileを介したログデータの取得
• ハートビートメッセージの送信
• vfs.*チェックの最大継続時間
• Zabbixエージェントモジュールによる使用
• タイムアウトなしでチェックを送信するバージョン7.0より前のサーバーまたはプロキシからのフォールバックとして機能

このタイムアウトは、フロントエンドでタイムアウト設定が可能なエージェントチェック（グローバル、プロキシ、またはアイテム単位）には使用されません。

デフォルト: 3
範囲: 1-30

TLSAccept

受信接続に必要な暗号化レベル。
パッシブチェックで使用されます。
複数の値を指定でき、カンマで区切ります:

• unencrypted - 暗号化なしの接続を受け入れる（デフォルト）;
• psk - TLS と事前共有鍵（PSK）を使用した接続を受け入れる;
• cert - TLS と証明書を使用した接続を受け入れる。

必須: はい。TLS証明書またはPSKパラメータが定義されている場合（unencrypted 接続でも）; それ以外はいいえ

TLSCAFile

Zabbix コンポーネント間の暗号化通信に使用される、ピア証明書検証用の最上位 CA 証明書を含むファイルのフルパス名

TLSCertFile

Zabbix コンポーネントとの暗号化通信に使用されるエージェント証明書または証明書チェーンを含むファイルのフルパス名

TLSCipherAll

GnuTLSの優先順位文字列またはOpenSSL（TLS 1.2）の暗号文字列。 証明書およびPSKベースの暗号化のためのデフォルトの暗号スイート選択基準を上書きします。

例:

TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256

TLSCipherAll13

TLS 1.3でのOpenSSL 1.1.1以降の暗号文字列。 証明書ベースおよびPSKベースの暗号化のデフォルトの暗号スイート選択基準を上書きします。

GnuTLSの例:

NONE:+VERS-TLS1.2:+ECDHE-RSA:+RSA:+ECDHE-PSK:+PSK:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+SHA1:+CURVE-ALL:+COMP-NULL::+SIGN-ALL:+CTYPE-X.509

OpenSSLの例:

EECDH+aRSA+AES128:RSA+aRSA+AES128:kECDHEPSK+AES128:kPSK+AES128

TLSCipherCert

GnuTLSの優先度文字列またはOpenSSL（TLS 1.2）の暗号文字列。 証明書ベースの暗号化のためのデフォルトの暗号スイート選択基準を上書きします。

GnuTLSの例:

NONE:+VERS-TLS1.2:+ECDHE-RSA:+RSA:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+SHA1:+CURVE-ALL:+COMP-NULL:+SIGN-ALL:+CTYPE-X.509

OpenSSLの例:

EECDH+aRSA+AES128:RSA+aRSA+AES128

TLSCipherCert13

TLS 1.3でOpenSSL 1.1.1以降の暗号文字列。 証明書ベースの暗号化のためのデフォルトの暗号スイート選択基準を上書きします。

TLSCipherPSK

GnuTLSの優先順位文字列またはOpenSSL（TLS 1.2）の暗号文字列。 PSKベースの暗号化のためのデフォルトの暗号スイート選択基準を上書きします。

GnuTLSの例:

NONE:+VERS-TLS1.2:+ECDHE-PSK:+PSK:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+SHA1:+CURVE-ALL:+COMP-NULL:+SIGN-ALL

OpenSSLの例:

kECDHEPSK+AES128:kPSK+AES128

TLSCipherPSK13

TLS 1.3でOpenSSL 1.1.1以降の暗号文字列。 PSKベースの暗号化のためのデフォルトの暗号スイート選択基準を上書きします。

例:

TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256

TLSConnect

Zabbixサーバーまたはプロキシへのエージェント接続に必要な暗号化レベル。
アクティブチェックで使用されます。
指定できる値は1つだけです:

• unencrypted - 暗号化なしで接続します（デフォルト）。
• psk - TLSと事前共有キー（PSK）を使用して接続します。
• cert - TLSと証明書を使用して接続します。

必須: はい。TLS証明書またはPSKパラメータが定義されている場合（unencrypted 接続でも）; それ以外の場合はいいえ

TLSCRLFile

失効した証明書を含むファイルのフルパス名です。 このパラメータは、Zabbixコンポーネント間の暗号化通信に使用されます。

TLSKeyFile

Zabbix コンポーネント間の暗号化通信に使用されるエージェント秘密鍵を含むファイルのフルパス名

TLSPSKFile

Zabbix サーバーとの暗号化通信に使用されるエージェントの事前共有キーを含むファイルのフルパス名

TLSPSKIdentity

Zabbixサーバーとの暗号化通信に使用される、事前共有キーのID文字列

TLSServerCertIssuer

許可されたサーバー（プロキシ）証明書の発行者

TLSServerCertSubject

許可されたサーバー（プロキシ）証明書のサブジェクト

UnsafeUserParameters

ユーザー定義パラメータの引数に、すべての文字を渡せるようにします。 次の文字は使用できません: \ ' " ` * ? [ ] { } \~ $ ! & ; ( ) < > | # @
さらに、改行文字も使用できません。

デフォルト: 0
値: 0 - 許可しない、1 - 許可する

ユーザー

システム上に存在する特定のユーザーに権限を下げます。
root として実行され、AllowRoot が無効な場合にのみ有効です。

デフォルト: zabbix

UserParameter

監視するユーザー定義パラメータ。 ユーザー定義パラメータは複数指定できます。
フォーマット: UserParameter=<キー>,<シェルコマンド>
シェルコマンドは空文字列やEOLのみを返してはいけません。 UserParameterDirパラメータが指定されている場合、シェルコマンドは相対パスを使用できます。

例:

UserParameter=system.test,who|wc -l
UserParameter=check_cpu,./custom_script.sh

UserParameterDir

UserParameter コマンドのデフォルト検索パスです。 使用すると、エージェントはコマンドを実行する前に、作業ディレクトリをここで指定したディレクトリに変更します。 これにより、UserParameter コマンドでは完全なパスの代わりに、相対的な ./ プレフィックスを使用できます。
指定できるエントリは 1 つだけです。

例:

UserParameterDir=/opt/myscripts

参考

1. バージョン2.0.0以降のアクティブチェックとパッシブチェックのZabbixエージェント設定の違い