3 Zabbix エージェント (UNIX)

概要

このセクションでは、Zabbix エージェントの設定ファイル(zabbix_agentd.conf)で設定できるパラメータを説明します。

パラメータのリストには詳細は含まれません。 パラメータをクリックすると、詳細が表示されます。

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

注意点:

• デフォルト値はプログラム中にハードコーディングされた値となり、出荷時の設定ファイルの値ではありません。
• ZabbixはBOMなしのUTF-8エンコードの設定ファイルのみをサポートします。
• 行の先頭が"#"で開始された場合のみコメントとして認識されます。

パラメータの詳細

Alias

アイテムキーのエイリアスを設定します。 長くて複雑なアイテムキーを、より短くてシンプルなものに置き換えるために使用できます。
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: 同じディスカバリ・アイテムを利用し、複数の ローレベルディスカバリルールを実行

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-65535BufferSize

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 名として無効な値も拒否され、無効として報告されます。

Hostname

カンマ区切りの、大文字と小文字を区別する一意のホスト名のリストです。アクティブチェックに必須で、サーバーに設定されているホスト名と一致する必要があります。値が未定義の場合は、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' アクティブチェックの処理時に、エージェントが Zabbix サーバーまたはプロキシへ 1 秒あたりに送信する新しい行の最大数です。
指定した値は、'log' または 'logrt' のアイテムキーで指定された 'maxlines' パラメータによって上書きされます。
注: Zabbix は、ログアイテム内で必要な文字列を検索するために、MaxLinesPerSecond で設定された値の 10 倍の新しい行を処理します。

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

PidFile

PIDファイルの名前

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

RefreshActiveChecks

アクティブチェックのリストを更新する間隔（秒単位）です。
アクティブチェックの更新に失敗した場合、次回の更新は60秒後に試行されることに注意してください。

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

Server

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互換IPv6アドレス'(プレフィックス0000::/96）はサポートされていますが、RFC4291では非推奨となっています。 スペースは使用できます。

例:

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

必須: StartAgentsが明示的に設定されていない場合は必須

ServerActive

アクティブチェックの取得元となるZabbixサーバー/プロキシのアドレス、またはクラスタ設定です。
サーバー/プロキシのアドレスは、IPアドレスまたはDNS名と、必要に応じてコロンで区切ったポート番号です。
クラスタ設定は、セミコロンで区切られた1つ以上のサーバーまたはプロキシグループメンバーのアドレスです。
複数のZabbixサーバー/クラスタおよびZabbixプロキシを、カンマで区切って指定できます。
プロキシグループを使用しない限り、各Zabbixサーバー/クラスタごとに複数の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サーバーへのリクエストの送信。（アクティブチェック、設定リクエスト、アイテムデータなど）
• ログファイルまたはWindowsイベントログ監視によるログデータの取得
• ハートビートメッセージの送信
• 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の優先順位文字列、または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 - 許可する

User

システム上の特定の既存ユーザーの権限を削除します。
'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エージェント設定の違い