6 Zabbix エージェント 2 (Windows)

概要

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

Windows の Zabbix agent 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 と組み合わせて、複数のキー一致ルールを定義できます。 パラメーターは、記載順に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 と組み合わせて、複数のキー一致ルールを定義できます。 パラメーターは、記載順に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文字、1行あたり2048文字。

デフォルト: HostnameItemで設定

HostnameItem

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

デフォルト: system.hostname

Include

設定ファイルには、個別のファイルまたはディレクトリ内のすべてのファイルを含めることができます（Zabbix エージェントが Windows MSI インストーラーパッケージを使用してインストールされている場合、既定では C:\Program Files\Zabbix Agent 2 に配置されます。Zabbix エージェントが zip アーカイブとしてインストールされている場合は、インストール時に指定したフォルダーに配置されます）。 含めるすべてのファイルは 正しい構文である必要があります。そうでない場合、エージェントは起動しません。 パスは zabbix_agent2.conf ファイルの場所を基準にした相対パスにできます（例: Include=.\zabbix_agent2.d\plugins.d\*.conf）。
指定したディレクトリ内で関連するファイルのみを含めるには、パターン一致のためにアスタリスクのワイルドカード文字がサポートされています。
制限については、special notes を参照してください。

例:

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

ListenIP

エージェントがリッスンするIPアドレスのカンマ区切りリスト。 アクティブチェックのリストを取得するためにZabbixサーバーに接続する場合、最初の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

PersistentBufferFile

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

PersistentBufferPeriod

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

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

Plugins.<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

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

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

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

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

パフォーマンスカウンターパスの周囲のダブルクォーテーションに注意してください。 パラメータ名（interrupts）は、アイテム作成時のアイテムキーとして使用します。 平均値を計算するためのサンプルは毎秒取得されます。
英語の文字列のリストは、次のレジストリキーを参照してください: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Perflib\009。

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

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またはWindowsイベントログ監視によるログデータの取得
• ハートビートメッセージの送信
• vfs.*チェックの最大継続時間
• タイムアウトなしでチェックを送信するバージョン7.0より前のサーバーまたはプロキシからのフォールバックとして機能

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

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

TLSAccept

受信接続に必要な暗号化レベルです。
パッシブチェックで使用されます。
複数の値をカンマ区切りで指定できます:

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

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

TLSCAFile

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

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