4 Zabbix エージェント 2 (UNIX)

概要

Zabbixエージェント 2 は新世代の Zabbixエージェントであり、 Zabbixエージェントの代わりに使用できます。

このセクションでは、Zabbixエージェント 2 の設定ファイル (zabbix_agent2.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使用率の割合を取得するために cpu.util キーを使用できるほか、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つずつ処理されます。
参照: エージェントチェックの制限。

BufferSend

バッファーからZabbixサーバーへ値を送信する頻度を決定する、秒単位の時間間隔です。
バッファーがいっぱいになった場合、データはより早く送信されることに注意してください。

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

BufferSize

メモリバッファ内の値の最大数です。
バッファがいっぱいになると、エージェントは収集したすべてのデータをZabbixサーバーまたはプロキシに送信します。
このパラメータは、永続バッファが無効になっている場合（EnablePersistentBuffer=0）にのみ使用してください。

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

ControlSocket

制御ソケット。'-R' オプションを指定したランタイムコマンドの送信に使用します。

デフォルト: /tmp/agent.sock

DebugLevel

デバッグレベルを指定します。
0 - Zabbix プロセスの起動と停止に関する基本情報
1 - 重要な情報
2 - エラー情報
3 - 警告
4 - デバッグ用（多くの情報を生成します）
5 - 拡張デバッグ（さらに多くの情報を生成します）

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

DenyKey

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

EnablePersistentBuffer

アクティブアイテムに対するローカル永続ストレージの使用を有効にします。
永続ストレージが無効な場合は、メモリバッファが使用されます。

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

ForceActiveChecksOnStart

再起動後、最初に受信した設定に対して、アクティブチェックを直ちに実行します。
このパラメータはプラグインごとの設定パラメータとしても利用できます。例: Plugins.Uptime.System.ForceActiveChecksOnStart=1

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

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

デフォルト: system.hostname

Include

設定ファイルには、個別のファイル、またはディレクトリ内のすべてのファイルを含めることができます。
インストール時に、コンパイル時に変更されていない限り、Zabbix は /usr/local/etc に include ディレクトリを作成します。
パスは zabbix_agent2.conf ファイルの場所からの相対パスにすることもできます。
指定したディレクトリ内で関連するファイルのみを含めるために、パターンマッチング用のアスタリスクワイルドカード文字がサポートされています。
制限事項については、特記事項を参照してください。

例:

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

ListenIP

エージェントが待ち受ける、カンマ区切りのIPアドレスのリストです。
接続先がZabbixサーバーである場合、アクティブチェックのリストを取得するために、最初のIPアドレスがZabbixサーバーに送信されます。

デフォルト: 0.0.0.0

ListenPort

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

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

LogFile

ログファイル名

デフォルト: /tmp/zabbix_agent2.log
必須: LogType が file に設定されている場合は必須、それ以外の場合は必須ではありません。

LogFileSize

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

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

LogType

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

デフォルト: file

PersistentBufferFile

Zabbixエージェント2がSQLiteデータベースを保持するファイルです。
完全なファイル名を指定する必要があります。
このパラメータは、永続バッファが有効な場合（EnablePersistentBuffer=1）にのみ使用されます。

PersistentBufferPeriod

サーバーまたはプロキシへの接続がない場合に、データを保存しておく期間です。
これより古いデータは失われます。
ログデータは保持されます。
このパラメータは、永続バッファが有効な場合のみ使用されます（EnablePersistentBuffer=1）。

デフォルト: 1h
範囲: 1m-365d

PidFile

PIDファイルの名前

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

Plugins.<PluginName>.System.Capacity

<PluginName> プラグインごとに同時に実行できるチェックの上限。

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

Plugins.Log.MaxLinesPerSecond

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

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

Plugins.SystemRun.LogRemoteCommands

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

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

PluginSocket

ロード可能なプラグイン通信用のUNIXソケットへのPATH

デフォルト: /tmp/agent.plugin.sock

PluginTimeout

読み込み可能なプラグインとの接続のタイムアウト（秒単位）

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

RefreshActiveChecks

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

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

サーバー

カンマ区切りのIPアドレスのリストです。CIDR表記、またはZabbixサーバーやZabbixプロキシのDNS名も指定できます。 ここに一覧されたホストからの受信接続のみ受け付けます。 IPv6サポートが有効な場合、'127.0.0.1'、'::127.0.0.1'、'::ffff:127.0.0.1' は同等に扱われ、'::/0' を指定すると任意のIPv4またはIPv6アドレスを許可します。 '0.0.0.0/0' は任意のIPv4アドレスを許可するために使用できます。 スペースを含めることができます。 このパラメータが指定されていない場合、パッシブチェックは無効になり、エージェントはどのTCPポートでも待ち受けしません。

例:

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

ServerActive

アクティブチェックの取得元となるZabbixサーバー/プロキシのアドレス、またはクラスタ設定です。
サーバー/プロキシのアドレスは、IPアドレスまたはDNS名と、必要に応じてコロンで区切ったポート番号で指定します。
クラスタ設定は、1つ以上のサーバーまたはプロキシグループメンバーのアドレスをセミコロンで区切って指定します。
複数のZabbixサーバー/クラスタおよびZabbixプロキシを、カンマで区切って指定できます。
プロキシグループを使用する場合を除き、各Zabbixサーバー/クラスタごとに複数のZabbixプロキシを指定してはいけません。
Zabbixプロキシを指定した場合、そのプロキシに対応するZabbixサーバー/クラスタは指定してはいけません。
複数の独立したZabbixサーバーを並行して使用するために、カンマ区切りで複数のアドレスを指定できます。
スペースを含めることができます。
ポートを指定しない場合は、デフォルトのポートが使用されます。
IPv6アドレスでそのホストのポートを指定する場合、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 など）の実行時に接続を行う場合。

StatusPort

設定されている場合、エージェントはこのポートでHTTPステータスリクエスト（http://localhost:<port>/status）を待受します。

範囲: 1024-32767

タイムアウト

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

このパラメータは、以下を含むさまざまな通信処理の継続時間を定義します。

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

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

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

TLSAccept

受け入れる受信接続を指定します。
パッシブチェックで使用されます。
複数の値をカンマ区切りで指定できます:
unencrypted - 暗号化なしの接続を受け入れます（デフォルト）
psk - TLS および事前共有鍵（PSK）を使用する接続を受け入れます
cert - TLS および証明書を使用する接続を受け入れます

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

TLSCAFile

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

TLSCertFile

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

TLSCipherAll

OpenSSLの暗号文字列（TLS 1.2）。 証明書ベースおよびPSKベースの暗号化に対する、デフォルトの暗号スイート選択基準を上書きします。

例:

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

このパラメータは、Zabbix 7.0.4以降でサポートされています。

TLSCipherAll13

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

例:

TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256

このパラメータは Zabbix 7.0.4 以降でサポートされています。

TLSCipherCert

OpenSSLの暗号文字列（TLS 1.2）。 証明書ベースの暗号化に対するデフォルトの暗号スイート選択基準を上書きします。

例:

EECDH+aRSA+AES128:RSA+aRSA+AES128

このパラメータは TLSAccept=cert,psk と同時には使用できないことに注意してください。証明書接続（TLSConnect=cert）には、代わりにTLSCipherAllを使用してください。

このパラメータはZabbix 7.0.4以降でサポートされています。

TLSCipherCert13

OpenSSL 1.1.1 以降向けの OpenSSL 暗号文字列（TLS 1.3）です。
証明書ベースの暗号化における、デフォルトの暗号スイート選択基準を上書きします。

このパラメータは TLSAccept=cert,psk と同時には使用できないことに注意してください。証明書接続（TLSConnect=cert）には、代わりに TLSCipherAll13 を使用してください。

このパラメータは Zabbix 7.0.4 以降でサポートされています。

TLSCipherPSK

OpenSSLの暗号文字列（TLS 1.2）。 PSKベースの暗号化に対するデフォルトの暗号スイート選択基準を上書きします。

例:

kECDHEPSK+AES128:kPSK+AES128

このパラメータは、Zabbix 7.0.4以降でサポートされています。

TLSCipherPSK13

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

例:

TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256

このパラメータは、Zabbix 7.0.4以降でサポートされています。

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 - 許可する

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