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

概要

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

Zabbix エージェント 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 - 有効

EnableProfiler

エージェントの起動時に、定期的な Go プロファイリングを有効にします。
プロファイリングは、実行時に -R オプションを使用して有効または無効にすることもできます。
periodic_prof_execute がプロファイルを収集している間は、すべてのプロファイラー実行時コマンドがビジー状態として拒否されます。
このパラメータは Zabbix 7.4.15 以降でサポートされています。

デフォルト: 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名ではない値は拒否され、無効として報告されます。

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

ホスト名

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

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

HostnameItem

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

デフォルト: system.hostname

Include

設定ファイルに含めるディレクトリまたは個別のファイルを指定します。
Zabbixのインストール時、このパラメータは /usr/local/etc に設定されますが、コンパイル時に変更した場合はその設定が反映されます。

Include パラメータに関する一般的なルール:

• パスは zabbix_agent2.conf ファイルの場所からの相対パスにできます。
• 1つの設定ファイル内で複数の Include パラメータを指定できます。
• Zabbixは Include パラメータを読み取るとすぐに処理するため、設定ファイルの末尾に配置することを検討してください。

含まれるファイルに関するルール:

• 各ファイルは読み取り可能でなければなりません。
• 各ファイルは正しい構文でなければなりません。そうでない場合、コンポーネントは起動しません。

ディレクトリまたはファイルパターンを含める際のルール:

• 読み込み順序を前提にしないでください（たとえば、ファイルはアルファベット順には読み込まれません）。
• 1つの設定を上書きする目的であっても、同じパラメータを複数の含まれるファイルに定義しないでください。どの値が使用されるか予測できないためです。
• テキストエディタが自動的に作成するバックアップコピーに注意してください（たとえば、include/my_specific.conf を編集すると include/my_specific.conf.BAK が作成される場合があります）。両方のファイルが含まれてしまいます。

ディレクトリ内の関連ファイルのみを含めるには、ワイルドカード (*) を使ってパターンマッチングを行います。

例:

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

サーバーまたはプロキシへの接続がない場合にデータを保存する期間です。 古いデータは失われます。 ログデータは保持されます。 このパラメーターは、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秒あたりに Zabbix サーバーまたはプロキシへ送信する新しい行の最大数です。 指定した値は、log および logrt のアイテムキーで指定される maxlines パラメータによって上書きされます。
注: Zabbix は、ログアイテム内で必要な文字列を検索するために、MaxLinesPerSecond に設定された値の10倍の新しい行を処理します。

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

Plugins.SystemRun.LogRemoteCommands

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

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

PluginSocket

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

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

PluginTimeout

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

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

ProfilerDir

プロファイリングデータが書き込まれるディレクトリです。 このパラメータは Zabbix 7.4.15 以降でサポートされています。

デフォルト: /tmp/zabbix_agent2_profiles

ProfilerMaxFilesPerProfile

各プロファイルタイプで保持するファイルの最大数です。 この制限は、各プロファイルダンプ後に完了したファイルに適用されます。 アクティブなCPUプロファイルは非表示の一時ファイルに収集され、制限にはカウントされません。 periodic_prof_execute によって作成されたファイルも制限の対象です。 このパラメータはZabbix 7.4.15以降でサポートされています。

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

ProfilerInterval

プロファイリングデータの書き込み間隔（秒単位）。

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

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

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アドレスの角括弧は省略可能です。
このパラメータが指定されていない場合、アクティブチェックは無効になります。

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

Timeout

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

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

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

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

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

TLSCipherAll13

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

例:

TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256

TLSCipherCert

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

例:

EECDH+aRSA+AES128:RSA+aRSA+AES128

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

TLSCipherCert13

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

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

TLSCipherPSK

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

例:

kECDHEPSK+AES128:kPSK+AES128

TLSCipherPSK13

OpenSSL 1.1.1以降用のOpenSSL暗号文字列（TLS 1.3）。 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サーバーまたはプロキシとの暗号化通信に使用される、事前共有鍵の識別文字列。

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