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

概要

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

Zabbix agent 2 の設定ファイル (zabbix_agent2.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つずつ処理されます。 関連項目: エージェントチェックの制限。

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

ホスト autoregistration プロセス中に使用されるホストインターフェース（IPアドレスまたはDNS名）を定義する任意のパラメーターです。 この値は、新しく作成されるホストのインターフェースを設定するために使用され、IPアドレスまたはDNSアドレスのいずれかを明示的に指定できます。 詳細については、Using DNS as default interface を参照してください。

定義されていない場合、値は 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

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

デフォルト: system.hostname

含める

設定ファイルには、個別のファイルまたはディレクトリ内のすべてのファイルを含めることができます。 インストール時に、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 に設定されている場合は Yes、それ以外は no

LogFileSize

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

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

LogType

ログ出力の種類:

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

デフォルト: file

PersistentBufferFile

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

PersistentBufferPeriod

サーバーまたはプロキシへの接続がない場合に、データを保存する期間です。 古いデータは失われます。 ログデータは保持されます。 このパラメーターは、persistent buffer が有効な場合にのみ使用されます (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秒あたりにサーバーまたはプロキシへ送信する新しい行の最大数です。 指定した値は、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

サーバー

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アドレスを許可できます。
スペースは使用できます。
このパラメータを指定しない場合、パッシブチェックは無効になり、エージェントは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サーバーまたはプロキシとの暗号化通信に使用される、事前共有鍵の識別文字列。

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