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

概要

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

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

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

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

注意:

• デフォルト値は、配布される設定ファイル内の値ではなく、プロセスのデフォルト値を反映しています。
• 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 を使用する複数のディスカバリルールを設定できるようになります。たとえば、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文字、行全体で2048文字

デフォルト: HostnameItem によって設定

HostnameItem

ホスト名の取得に使用するアイテムを定義するオプションのパラメータです。
このオプションは、Hostname が定義されていない場合にのみ使用されます。
User parameters または aliases はサポートされませんが、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）。
指定したディレクトリ内で必要なファイルのみを含めるために、パターンマッチング用のアスタリスクワイルドカード文字をサポートしています。
制限事項については、特記事項を参照してください。

例:

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 に設定されている場合ははい、それ以外の場合はいいえ

LogFileSize

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

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

LogType

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

デフォルト: file

PersistentBufferFile

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

PersistentBufferPeriod

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

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

Plugins.<PluginName>.System.Capacity

<PluginName> プラグインごとに同時に実行できるチェックの上限。

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

Plugins.Log.MaxLinesPerSecond

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

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

Plugins.SystemRun.LogRemoteCommands

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

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

PluginSocket

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

デフォルト: \\.\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 分間の 1 秒あたりのプロセッサ割り込み数の平均を受信したい場合、次のように新しいパラメータ "interrupts" を定義できます。

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

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

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

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

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

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

TLSCipherCert13

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

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

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

TLSCipherPSK13

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,dir /b | find /c /v ""
UserParameter=check_cpu,.\custom\_script.bat

UserParameterDir

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

例:

UserParameterDir=C:\opt\myscripts