設定パラメーター: Zabbix エージェント 2 (Windows)

概要

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

パラメータ値は、Zabbixのエージェント 2設定ファイル（zabbix_agent2.conf）で指定します。パラメータが必須であることが明記されていない限り、すべてのパラメータは任意です。

このページは次の構成になっています。

• パラメータの概要（パラメータの詳細を確認するには、その名前をクリックしてください）
• パラメータの詳細

次の点に注意してください。

• デフォルト値は、提供されている設定ファイルの値ではなく、プロセスのデフォルト値を示します。
• 値では環境変数を使用できます。
• Zabbixがサポートする設定ファイルは、BOMなしのUTF-8エンコーディングのみです。
• #で始まるコメントは、行の先頭でのみ使用できます。

パラメーターの詳細

エイリアス

アイテムキーにエイリアスを設定します。 長く複雑なアイテムキーを、より短く簡単なものに置き換えるために使用できます。
複数の Alias パラメータを指定できます。 同じ Alias キーを持つ複数のパラメータは許可されません。
異なる Alias キーが同じアイテムキーを参照することはできます。
エイリアスは HostMetadataItem で使用できますが、HostnameItem パラメータでは使用できません。

例 1: サーバーからページングファイル使用率をパーセントで取得する。

Alias=pg_usage:perf_counter[\Paging File(_Total)\% Usage]

これで、短縮キー pg_usage を使用してデータを取得できます。

例 2: デフォルトパラメータとカスタムパラメータで CPU 使用率を取得する。

Alias=cpu.load:system.cpu.load
Alias=cpu.load[*]:system.cpu.load[*]

これにより、cpu.load キーを使用してデフォルトパラメータの CPU 使用率を取得できるほか、cpu.load[percpu,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、AllowKeyRegexp、DenyKeyRegexp と組み合わせて定義できます。 パラメータは、記載順に1つずつ処理されます。 この順序によって、どの一致ルールが優先されるかが決まります。 関連項目: エージェントチェックの制限。

AllowKeyRegexp

パターンに一致するアイテムキーの実行を許可します。 キーのパターンは 正規表現 です。
複数のキー一致ルールは、DenyKeyRegexp、AllowKey、および DenyKey と組み合わせて定義できます。 パラメータは、記述された順序に従って1つずつ処理されます。 この順序によって、どの一致ルールが優先されるかが決まります。 関連項目: エージェントチェックの制限。

BufferSend

バッファーから Zabbix サーバー/プロキシへ値を送信する頻度を設定します（秒単位）。
バッファーがいっぱいの場合は、データはより早く送信されることに注意してください。

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

BufferSize

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

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

ControlSocket

-R オプションを使用して実行時コマンドを送信するために使用される制御ソケットを指定します。

デフォルト: \\.\pipe\agent.sock

DebugLevel

デバッグレベルを設定します:

• 0 - Zabbixプロセスの開始と停止に関する基本情報;
• 1 - 重大な情報;
• 2 - エラー情報;
• 3 - 警告;
• 4 - デバッグ用（大量の情報を出力します）;
• 5 - 拡張デバッグ用（さらに多くの情報を出力します）。

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

DenyKey

パターンに一致するアイテムキーの実行を拒否します。 キーのパターンはワイルドカード式で、任意の数の任意の文字に一致する * 文字をサポートします。
複数のキー一致ルールは、AllowKey、AllowKeyRegexp、DenyKeyRegexp と組み合わせて定義できます。 パラメータは、記載順に従って1つずつ処理されます。 この順序によって、どの一致ルールが優先されるかが決まります。 関連項目: エージェントチェックの制限。

DenyKeyRegexp

パターンに一致するアイテムキーの実行を拒否します。 キーのパターンは 正規表現 です。
複数のキー一致ルールは、AllowKeyRegexp、AllowKey、および DenyKey と組み合わせて定義できます。 パラメータは、記載順に従って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名ではない値は拒否され、無効として報告されます。

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

ホスト名

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

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

HostnameItem

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

デフォルト: system.hostname

Include

構成ファイルに含めるディレクトリまたは個別のファイルを指定します（ZabbixエージェントをWindows MSIインストーラーパッケージを使用してインストールした場合、デフォルトでは C:\Program Files\Zabbix Agent 2 にあります。Zabbixエージェントをzipアーカイブとしてインストールした場合は、インストール時に指定したフォルダーにあります）。 Zabbixのインストール時、このパラメータは、コンパイル時に変更しない限り、/usr/local/etc に設定されます。

Include パラメータの一般的なルール：

• パスは zabbix_agent2.conf ファイルの場所を基準にした相対パスにできます（例：Include=.\zabbix_agent2.d\plugins.d\*.conf）。
• 1つの構成ファイルに複数の Include パラメータを指定できます。
• Zabbixは Include パラメータを読み取るとすぐに処理するため、構成ファイルの末尾に配置することを検討してください。

インクルードするファイルのルール：

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

ディレクトリまたはファイルパターンをインクルードする場合のルール：

• インクルードの順序を想定しないでください（ファイルはアルファベット順にインクルードされるとは限りません）。
• 同じパラメータを複数のインクルードファイルで定義しないでください（例：一般的な設定を特定の設定で上書きする場合）。どの値が使用されるかを予測できないためです。
• 一部のテキストエディターが自動的に作成するバックアップコピーに注意してください（例：include/my_specific.conf を編集すると、include/my_specific.conf.BAK が作成される場合があります）。この場合、両方のファイルがインクルードされます。

ディレクトリから関連するファイルのみをインクルードするには、パターンマッチングにワイルドカード（*）を使用します。

例：

Include=C:\Program Files\Zabbix Agent2\zabbix_agent2.d\*.conf

ListenIP

サーバー/プロキシからの接続を受け付けるエージェントの待受 IP アドレスを指定します。 カンマ区切りのリストです。
最初の IP アドレスは、アクティブチェックの一覧を取得するためにサーバーへ接続する場合、Zabbix サーバーに送信されます。

デフォルト: 0.0.0.0

ListenPort

サーバー/プロキシからの接続を受け付けるエージェントの待受ポートを指定します。

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

LogFile

エージェントのログファイルを指定します。

デフォルト: c:\zabbix_agent2.log
必須: LogType が file に設定されている場合は Yes、それ以外は no

LogFileSize

最大ログファイルサイズを MB 単位で設定します。
0 - 自動ログローテーションを無効にします。
注: ログファイルサイズの上限に達し、何らかの理由でファイルローテーションに失敗した場合、既存のログファイルは切り詰められ、新規に開始されます。

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

LogType

ログ出力タイプを指定します。

• file - LogFile パラメーターで指定したファイルにログを書き込みます。
• console - 標準出力にログを書き込みます。

デフォルト: file

PerfCounter

指定した時間期間 <period>（秒）におけるシステム パフォーマンス カウンター <perf_counter_path> の平均値となる新しいパラメーター <parameter_name> を定義します。
構文: <parameter_name>,"<perf_counter_path>",<period>

たとえば、直近 1 分間の 1 秒あたりのプロセッサ割り込みの平均回数を取得したい場合は、次のように新しいパラメーター "interrupts" を定義できます。

PerfCounter = interrupts,"\Processor(0)\Interrupts/sec",60

パフォーマンス カウンターのパスは二重引用符で囲む必要があることに注意してください。 パラメーター名（interrupts）は、アイテムを作成する際のアイテムキーとして使用します。 平均値を計算するためのサンプルは 1 秒ごとに取得されます。
Windows で利用可能なすべてのパフォーマンス カウンターの一覧を取得するには、typeperf -qx を実行してください。

PerfCounterEn

新しいパラメーター <parameter_name> を定義します。これは、指定した期間 <period>（秒単位）におけるシステム パフォーマンス カウンター <perf_counter_path> の平均値です。
PerfCounter と比較して、perfcounter のパスは英語で指定する必要があります。
Windows Server 2008/Vista 以降でのみサポートされます。
構文: <parameter_name>,"<perf_counter_path>",<period>

たとえば、直近 1 分間の 1 秒あたりのプロセッサー割り込みの平均回数を取得したい場合は、次のように新しいパラメーター "interrupts" を定義できます。

PerfCounterEn = interrupts,"\Processor(0)\Interrupts/sec",60

パフォーマンス カウンターのパスを二重引用符で囲むことに注意してください。
パラメーター名（interrupts）は、アイテムを作成する際のアイテムキーとして使用します。
平均値の計算用サンプルは 1 秒ごとに取得されます。
英語の文字列の一覧は、次のレジストリ キーを参照してください: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Perflib\009。

PersistentBufferFile

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

PersistentBufferPeriod

サーバーまたはプロキシへの接続がない場合にデータを保存する期間を設定します。 古いデータは失われます。 ログデータは保持されます。
このパラメーターは、persistent buffer が有効な場合 (EnablePersistentBuffer=1) にのみ使用されます。

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

プラグイン.<PluginName>.System.Capacity

同時に実行できる <PluginName> プラグインのチェック数の上限を設定します。

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

Plugins.Log.MaxLinesPerSecond

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

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

Plugins.SystemRun.LogRemoteCommands

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

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

PluginSocket

ロード可能なプラグイン通信に使用する Windows の名前付きパイプのパスを指定します。

デフォルト: \\.\pipe\agent.plugin.sock

PluginTimeout

ロード可能なプラグインとの接続のタイムアウトを秒単位で設定します。

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

RefreshActiveChecks

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

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

サーバー

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

例:

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

ServerActive

アクティブチェックを取得するための Zabbix サーバー/プロキシのアドレス、またはクラスタ構成を指定します。
このパラメータが指定されていない場合、アクティブチェックは無効になります。

サーバー/プロキシのアドレスは、IP アドレスまたは DNS 名で、必要に応じてコロンで区切ったポートを指定します。 ポートが指定されていない場合は、デフォルトのポートが使用されます。
IPv6 アドレスでは、そのホストのポートを指定する場合、角括弧で囲む必要があります。 ポートが指定されていない場合、IPv6 アドレスの角括弧は省略可能です。

クラスタ構成は、セミコロンで区切られた 1 つ以上のサーバーまたはプロキシグループメンバーのアドレスです。

複数の Zabbix サーバー/クラスタおよび Zabbix プロキシを、カンマ区切りで指定できます。

プロキシグループを使用しない場合、各 Zabbix サーバー/クラスタから 2 つ以上の Zabbix プロキシを指定しないでください。 Zabbix プロキシを指定した場合、そのプロキシに対応する Zabbix サーバー/クラスタは指定しないでください。

カンマ区切りの複数アドレスを指定して、複数の独立した Zabbix サーバーを並列に使用できます。 スペースは使用可能です。

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

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

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

TLSAccept

受信接続に必要な暗号化レベルを指定します。
パッシブチェックで使用されます。

複数の値を指定でき、カンマで区切ります。

• unencrypted - 暗号化なしの接続を受け入れます（デフォルト）。
• psk - TLS と事前共有鍵（PSK）を使用した接続を受け入れます。
• cert - TLS と証明書を使用した接続を受け入れます。

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

TLSCAFile

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

TLSCertFile

Zabbixコンポーネントとの暗号化通信に使用する、エージェントの証明書または証明書チェーンを含むファイルの完全なパス名を指定します。

TLSCipherAll13

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

例:

TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256

TLSCipherCert13

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

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

TLSCipherPSK13

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サーバーまたはプロキシとの暗号化通信に使用する、事前共有鍵のID文字列を指定します。

TLSServerCertIssuer

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

TLSServerCertSubject

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

UnsafeUserParameters

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

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

UserParameter

監視するユーザー定義パラメータを指定します。 ユーザー定義パラメータは複数指定できます。
形式: UserParameter=<key>,<shell command>
なお、シェルコマンドは空文字列または EOL のみを返してはなりません。 UserParameterDir パラメータが指定されている場合、シェルコマンドには相対パスを使用できます。

例:

UserParameter=system.test,dir /b | find /c /v ""
UserParameter=check_cpu,.\custom\_script.bat

UserParameterDir

UserParameter コマンドのデフォルト検索パスを指定します。 使用すると、エージェントはコマンドを実行する前に作業ディレクトリをここで指定したディレクトリに変更します。 これにより、UserParameter コマンドでは完全なパスの代わりに相対的な .\ プレフィックスを使用できます。
指定できるエントリは 1 つだけです。

例:

UserParameterDir=C:\opt\myscripts