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

概要

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

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

注意点:

• デフォルト値は、出荷時設定ファイルの値ではなく、プロセスのデフォルト値です。
• ZabbixはBOMなしのUTF-8エンコーディングでのみ構成ファイルをサポートします。
• 行の先頭が"＃"で始まった場合のみコメントとして認識されます。

パラメータの詳細

エイリアス

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

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

Alias=pg_usage:perf_counter[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

ホストインターフェースを定義する追加パラメーターです。ホストインターフェースは、ホストの自動登録プロセスで使用されます。定義されていない場合は、HostInterfaceItemから値が取得されます。
値が255文字の制限を超える場合、エージェントはエラーを通知して起動しません。

範囲: 0-255文字

HostInterfaceItem

ホストインターフェースの取得に使用するアイテムを定義する追加パラメータです。
ホストインターフェースは、ホストの自動登録プロセスで使用されます。このオプションは、HostInterfaceが定義されていない場合にのみ使用されます。
system.run[]アイテムは、AllowKey/DenyKeyの値に関係なくサポートされます。
自動ディスカバリリクエスト中に、指定された項目によって返される値が255文字の制限を超えている場合、エージェントは警告メッセージをログに記録します。

HostMetadata

ホストメタデータを定義する追加パラメータです。ホストメタデータは、ホスト自動登録プロセス（アクティブエージェント）でのみ使用されます。定義されていない場合は、HostMetadataItem から値が取得されます。
指定された値が2034バイトの制限を超える場合、またはUTF-8以外の文字列の場合、エージェントはエラーを通知して起動しません。

範囲: 0-2034バイト

HostMetadataItem

ホストメタデータの取得に使用する項目を定義する追加パラメータです。このオプションは、HostMetadata が定義されていない場合にのみ使用されます。ユーザーパラメータとエイリアスがサポートされています。system.run[] 項目は、AllowKey/DenyKey の値に関係なくサポートされます。
HostMetadataItem の値は、自動登録の試行ごとに取得され、ホストの自動登録プロセスでのみ使用されます。
自動登録リクエスト中、指定されたアイテムによって返される値が UTF-8 コードポイントの上限である 65535 を超える場合、エージェントは警告メッセージをログに記録します。アイテムによって返される値は UTF-8 文字列である必要があります。そうでない場合は無視されます。

ホスト名

カンマ区切りの、大文字と小文字を区別する一意のホスト名のリストです。アクティブチェックに必須で、サーバーに設定されているホスト名と一致する必要があります。値が未定義の場合は、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_agent2.confファイルの場所からの相対パスで指定できます。（例： Include=.\zabbix_agent2.d\plugins.d\*.conf）
指定したディレクトリ内の関連ファイルのみを含めるには、パターンマッチングでアスタリスクワイルドカード文字を使用できます。
制限事項については、特記事項を参照してください。

例：

Include=C:FilesAgent2_agent2.d*.conf

ListenIP

エージェントがListenするIPアドレスをカンマ区切りで指定します。最初のIPアドレスは、Zabbixサーバーに接続している場合、アクティブなチェックリストを取得するために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'アクティブチェックを処理する際に、エージェントがZabbixサーバーまたはプロキシに送信する1秒あたりの新規行の最大数。ここで指定した値は、'log'、'logrt'、'eventlog'アイテムキーで指定された'maxlines'パラメータによって上書きされます。
注: Zabbixは、ログアイテム内で必要な文字列を検索するために、MaxLinesPerSecondで設定された値の10倍の新規行を処理します。

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

Plugins.SystemRun.LogRemoteCommands

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

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

PluginSocket

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

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

PluginTimeout

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

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

PerfCounter

システムパフォーマンスカウンタ <perf_counter_path> の、指定された期間 <period> (秒単位) における平均値を表す新しいパラメータ <parameter_name> を定義します。
構文: <parameter_name>,"<perf_counter_path>",<period>

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

PerfCounter = interrupts,"(0)/sec",60

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

PerfCounterEn

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

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

PerfCounterEn = interrupts,"(0)/sec",60

パフォーマンスカウンタのパスを二重引用符で囲んでいることに注意してください。パラメータ名 (interrupts) は、アイテム作成時にアイテムキーとして使用されます。平均値を計算するためのサンプルは 1 秒ごとに取得されます。
英語環境用の文字列のリストは、次のレジストリ キーを表示すると確認出来ます。: 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

複数サーバーの例:

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サーバーからの応答を待機
- Zabbixサーバーへのリクエストの送信（アクティブチェック、設定リクエスト、アイテムデータなど）
- ログファイルまたはWindowsイベントログ監視によるログデータの取得
- ハートビートメッセージの送信
- vfs.*チェックの最大実行時間
- バージョン7.0より前のサーバーまたはプロキシがタイムアウトなしでチェックを送信する場合のフォールバック

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

TLSAccept

受け入れる受信接続。パッシブチェックに使用します。複数の値をカンマで区切って指定できます。
unencrypted - 暗号化なしの接続に応答します（デフォルト）
psk - TLSと事前共有鍵（PSK）を使用した接続に応答します。
cert - TLSと証明書を使用した接続に応答します。

必須：TLS証明書またはPSKパラメータが定義されている場合は必須、そうでない場合は必須ではありません。

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パラメータが定義されている場合は必須、そうでない場合は必須ではない。

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,._script.bat

UserParameterDir

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

例:

UserParameterDir=C: