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

概要

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

Windows 用 Zabbixエージェント 2 の設定ファイル (zabbix_agent2.conf) でサポートされるパラメータを、このセクションに一覧表示します。

パラメータは追加情報なしで一覧表示されています。 詳細は、パラメータをクリックして確認してください。

すべてのパラメータは、明示的に必須と記載されていない限り、必須ではありません。

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

• デフォルト値は、配布される設定ファイル内の値ではなく、プロセスのデフォルト値を反映しています。
• 値では environment variables をサポートしています。
• Zabbix がサポートする設定ファイルは、BOM なしの UTF-8 エンコーディングのみです。
• "#" で始まるコメントは、行頭でのみサポートされます。

パラメータの詳細

Alias

アイテムキーのエイリアスを設定します。 長くて複雑なアイテムキーを、短くて簡単なものに置き換えるために使用できます。
複数の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: 同じディスカバリアイテムを処理する複数のローレベルディスカバリルールを実行する。

Alias=vfs.fs.discovery[*]:vfs.fs.discovery

これで、各ルールに異なるパラメータ(vfs.fs.discovery[foo]、vfs.fs.discovery[bar]など)を指定して、vfs.fs.discoveryを使用する複数のディスカバリルールを設定できます。

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が定義されていない場合にのみ使用されます。 ユーザーパラメータやエイリアスはサポートされていませんが、AllowKey/DenyKeyの値に関係なくsystem.run[]アイテムはサポートされています。

デフォルト: system.hostname

Include

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

例:

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に設定されている場合は必須、それ以外は不要

LogFileSize

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

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

LogType

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

デフォルト: file

PersistentBufferFile

Zabbix agent 2 が SQLite データベースを保持するファイル。 完全なファイル名でなければなりません。 このパラメータは、永続バッファが有効になっている場合 (EnablePersistentBuffer=1) のみ使用されます。

PersistentBufferPeriod

サーバーまたはプロキシへの接続がない場合にデータを保存する期間。 古いデータは失われます。 ログデータは保持されます。 このパラメータは、永続バッファが有効になっている場合（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分間のプロセッサ割り込み回数の平均値を取得したい場合は、次のように新しいパラメータ"interrupts"を定義できます。

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

パフォーマンスカウンタパスの周囲に二重引用符が必要であることに注意してください。 パラメータ名（interrupts）は、アイテム作成時のアイテムキーとして使用します。 平均値を計算するためのサンプルは毎秒取得されます。
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

Server

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または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=<キー>,<シェルコマンド>
シェルコマンドは空文字列やEOLのみを返してはいけません。 UserParameterDirパラメータが指定されている場合、シェルコマンドは相対パスを持つことができます。

例:

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

UserParameterDir

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

例:

UserParameterDir=C:\opt\myscripts