設定パラメーター: Zabbix エージェント

概要

設定パラメータを使用すると、Zabbix エージェントの動作をカスタマイズできます。

パラメータの値は、設定ファイル (zabbix_agentd.conf) に指定します。すべてのパラメータは、明示的に必須と記載されていない限り、任意です。

このページの構成は次のとおりです。

• パラメータ概要（パラメータの詳細を表示するには、名前をクリックします）
• パラメータ詳細

注意:

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

パラメーターの詳細

エイリアス

アイテムキーにエイリアスを設定します。 長く複雑なアイテムキーを、より短く簡単なものに置き換えるために使用できます。
複数の 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

バッファーから Zabbix サーバー/プロキシへ値を送信する頻度を設定します（秒単位）。

デフォルト: 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

ホスト 自動登録（アクティブ エージェント）時にホストを識別または区別するための metadata を指定します。
HostMetadata を使用すると、hostname 以外の基準でもホストを区別できます。

未定義の場合、値は HostMetadataItem から取得されます。

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

複数行の metadata はサポートされていません。出力は最初の改行で切り詰められます。

範囲: 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 が定義されていない場合にのみ使用されます。
UserParameter やエイリアスはサポートされていませんが、system.run[] アイテムは AllowKey/DenyKey の値に関係なくサポートされます。

デフォルト: system.hostname

含める

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

例:

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

ListenBacklog

TCPキュー内で保留中の接続の最大数を設定します。
デフォルト値はハードコードされた定数で、システムに依存します。
サポートされる最大値もシステムに依存し、値が高すぎる場合は「implementation-specified maximum」に静かに切り詰められることがあります。

デフォルト: 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 のアクティブチェックを処理する際に、Zabbix サーバー/プロキシへ送信する 1 秒あたりの新しい行数の最大値を設定します。
指定した値は、log または logrt のアイテムキーで指定された 'maxlines' パラメータによって上書きされます。
Note: Zabbix は、ログアイテム内で必要な文字列を検索するために、MaxLinesPerSecond で設定された値の 10 倍の新しい行を処理します。

Default: 20
Range: 1-1000

PidFile

PIDファイルを指定します。

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

RefreshActiveChecks

アクティブチェックの一覧を更新する頻度を秒単位で指定します。
アクティブチェックの更新に失敗した場合、次回の更新は60秒後に試行されることに注意してください。

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

サーバー

Zabbix サーバー/プロキシの IP アドレス、または必要に応じて CIDR 表記の IP アドレス、あるいは 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 サーバー/クラスタから 1 つを超える 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

タイムアウト

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

このパラメーターは、次のようなさまざまな通信操作の継続時間を定義します。

• Zabbix サーバーからの応答を待機する;
• アイテム設定要求や active checks におけるアイテムデータを含む、Zabbix サーバーへの要求送信;
• logfile を通じたログデータの取得;
• ハートビートメッセージの送信;
• vfs.* チェックの最大継続時間;
• Zabbix エージェントモジュールによる使用;
• バージョン 7.0 より古いサーバーまたはプロキシがタイムアウトなしでチェックを送信するシナリオにおけるフォールバックとしての使用。

このタイムアウトは、Webインターフェースでタイムアウト設定を構成できるエージェントチェック（グローバル、プロキシ、またはアイテムごとのレベル）には 使用されません。

デフォルト: 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 の priority string または OpenSSL (TLS 1.2) の cipher string を指定します。 PSK ベースの暗号化に対するデフォルトの ciphersuite 選択基準を上書きします。

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

サーバーとの暗号化通信に使用される、エージェントの事前共有鍵を含むファイルのフルパスを指定します。

TLSPSKIdentity

Zabbixサーバーとの暗号化通信に使用する事前共有鍵の識別文字列を指定します。

TLSServerCertIssuer

許可するサーバー（プロキシ）証明書の発行者を指定します。

TLSServerCertSubject

許可するサーバー（プロキシ）証明書のサブジェクトを指定します。

UnsafeUserParameters

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

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

ユーザー

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

デフォルト: zabbix

UserParameter

監視するためのユーザー定義パラメータを指定します。 ユーザー定義パラメータは複数指定できます。
形式: UserParameter=<key>,<shell command>
なお、シェルコマンドは空文字列または 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 エージェント設定の違い