3 Zabbix エージェント (UNIX)

概要

Zabbixエージェントの設定ファイル（zabbix_agentd.conf）でサポートされているパラメータをこのセクションに一覧表示します。

パラメータは追加情報なしでリストされています。 パラメータをクリックすると、詳細情報が表示されます。

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

注意:

• デフォルト値はデーモンのデフォルト値を反映しており、配布されている設定ファイルの値ではありません。
• 値は環境変数をサポートします。
• ZabbixはBOMなしのUTF-8エンコーディングのみの設定ファイルをサポートします。
• "#"で始まるコメントは行頭のみサポートされます。

パラメータの詳細

Alias

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

例1: ユーザー'zabbix'のIDを取得する。

Alias=zabbix.userid:vfs.file.regexp[/etc/passwd,"^zabbix:.:([0-9]+)",,,,\1]

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

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

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

これにより、cpu.utilキーを使用してデフォルトパラメータでCPU使用率のパーセンテージを取得したり、cpu.util[all, idle, avg15]を使用してCPU使用率に関する特定のデータを取得したりできます。

例3: 同じディスカバリアイテムを処理する複数のローレベルディスカバリルールを実行する。

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

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

AllowKey

パターンに一致するアイテムキーの実行を許可します。 キーのパターンはワイルドカード式であり、"*" 文字を使用して任意の文字列に一致させることができます。
DenyKeyと組み合わせて複数のキー一致ルールを定義できます。 パラメータは、記述された順に1つずつ処理されます。 参考: エージェントチェックの制限

AllowRoot

エージェントを 'root' として実行することを許可します。 無効にした場合、エージェントが 'root' によって開始された場合、代わりに 'zabbix' ユーザーに切り替えようとします。 通常のユーザーで開始した場合は効果がありません。

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

BufferSend

N秒を超えてバッファ内にデータを保持しません。

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

BufferSize

メモリバッファ内の値の最大数。 バッファがいっぱいになると、エージェントは収集したすべてのデータをZabbixサーバーまたはプロキシに送信します。

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

DebugLevel

デバッグレベルを指定します。
0 - Zabbix プロセスの起動と停止に関する基本情報
1 - 重要な情報
2 - エラー情報
3 - 警告
4 - デバッグ用（多くの情報を生成します）
5 - 拡張デバッグ（さらに多くの情報を生成します）

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

DenyKey

パターンに一致するアイテムキーの実行を拒否します。 キーのパターンはワイルドカード式であり、"*" 文字を使用して任意の文字列に一致させることができます。
AllowKeyと組み合わせて複数のキー一致ルールを定義できます。 パラメータは、記述順に1つずつ処理されます。 参考: エージェントチェックの制限

EnableRemoteCommands

Zabbixサーバーからのリモートコマンドを許可するかどうか。 このパラメータは非推奨です。代わりにAllowKey=system.run[*]またはDenyKey=system.run[*]を使用してください。
値に応じてAllowKey/DenyKeyパラメータの内部エイリアスです。
0 - DenyKey=system.run[*]
1 - AllowKey=system.run[*]

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

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

デフォルト: system.hostname

Include

個々のファイルまたはディレクトリ内のすべてのファイルを設定ファイルに含めることができます。 指定したディレクトリ内の関連ファイルのみを含めるために、パターンマッチング用のアスタリスクワイルドカード文字がサポートされています。
制限事項については特記事項を参照してください。

例:

Include=/absolute/path/to/config/files/*.conf

ListenBacklog

TCP キュー内の保留中の接続の最大数。
デフォルト値はシステムに依存するハードコードされた定数です。
サポートされる最大値はシステムに依存し、値が大きすぎる場合は'実装で指定された最大値' で自動的に切り捨てられる場合があります。

デフォルト: SOMAXCONN
範囲: 0 - INT_MAX

ListenIP

エージェントが待受するIPアドレスのカンマ区切りリスト

デフォルト: 0.0.0.0

ListenPort

エージェントは、サーバーからの接続をこのポートで待受します。

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

LoadModule

エージェントの起動時にロードするモジュール。 モジュールは、エージェントの機能を拡張するために使用されます。 モジュールは、LoadModulePathで指定されたディレクトリに配置するか、モジュール名の前にパスを付ける必要があります。 先頭のパスが絶対パス（'/'で始まる）場合は、LoadModulePathは無視されます。
フォーマット:
LoadModule=<module.so>
LoadModule=<path/module.so>
LoadModule=</abs_path/module.so>
複数のLoadModuleパラメータを含めることができます。

LoadModulePath

エージェントモジュールの場所へのフルパス。 デフォルトはコンパイルオプションによって異なります。

LogFile

ログファイル名

必須: LogType が file に設定されている場合は必須、それ以外の場合は必須ではありません。

LogFileSize

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

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

LogRemoteCommands

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

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

LogType

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

デフォルト: file

MaxLinesPerSecond

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

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

PidFile

PIDファイルの名前

デフォルト: /tmp/zabbix_agentd.pid

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アドレスを許可できます。 「IPv4互換IPv6アドレス」（0000::/96プレフィックス）はサポートされていますが、RFC4291で非推奨となっています。 スペースも許可されます。

例:

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

必須: StartAgentsが明示的に0に設定されていない場合は必須

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など）を実行する際の接続

StartAgents

パッシブチェックを処理するzabbix_agentdの事前フォークインスタンス数。 0に設定するとパッシブチェックが無効になり、エージェントはTCPポートで待ち受けしません。

デフォルト: 10
範囲: 0-100

Timeout

Zabbixプロキシまたはサーバーとの接続確立およびデータ交換を待機する時間（秒単位）を指定します。

このパラメータは、以下を含むさまざまな通信操作の期間を定義します。

• Zabbixサーバーからの応答を待つ
• アイテム設定リクエストやアクティブチェックのアイテムデータなど、Zabbixサーバーへのリクエスト送信
• logfileを介したログデータの取得
• ハートビートメッセージの送信
• vfs.*チェックの最大継続時間
• Zabbixエージェントモジュールによる使用
• タイムアウトなしでチェックを送信するバージョン7.0より前のサーバーまたはプロキシからのフォールバックとして機能

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

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

TLSAccept

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

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

TLSCAFile

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

TLSCertFile

Zabbix コンポーネントとの暗号化通信に使用されるエージェント証明書または証明書チェーンを含むファイルのフルパス名

TLSCipherAll

GnuTLSの優先順位文字列またはOpenSSL（TLS 1.2）の暗号文字列。 証明書およびPSKベースの暗号化のためのデフォルトの暗号スイート選択基準を上書きします。

例:

TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256

TLSCipherAll13

TLS 1.3でのOpenSSL 1.1.1以降の暗号文字列。 証明書ベースおよびPSKベースの暗号化のデフォルトの暗号スイート選択基準を上書きします。

GnuTLSの例:

NONE:+VERS-TLS1.2:+ECDHE-RSA:+RSA:+ECDHE-PSK:+PSK:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+SHA1:+CURVE-ALL:+COMP-NULL::+SIGN-ALL:+CTYPE-X.509

OpenSSLの例:

EECDH+aRSA+AES128:RSA+aRSA+AES128:kECDHEPSK+AES128:kPSK+AES128

TLSCipherCert

GnuTLSの優先度文字列またはOpenSSL（TLS 1.2）の暗号文字列。 証明書ベースの暗号化のためのデフォルトの暗号スイート選択基準を上書きします。

GnuTLSの例:

NONE:+VERS-TLS1.2:+ECDHE-RSA:+RSA:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+SHA1:+CURVE-ALL:+COMP-NULL:+SIGN-ALL:+CTYPE-X.509

OpenSSLの例:

EECDH+aRSA+AES128:RSA+aRSA+AES128

TLSCipherCert13

TLS 1.3でOpenSSL 1.1.1以降の暗号文字列。 証明書ベースの暗号化のためのデフォルトの暗号スイート選択基準を上書きします。

TLSCipherPSK

GnuTLSの優先順位文字列またはOpenSSL（TLS 1.2）の暗号文字列。 PSKベースの暗号化のためのデフォルトの暗号スイート選択基準を上書きします。

GnuTLSの例:

NONE:+VERS-TLS1.2:+ECDHE-PSK:+PSK:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+SHA1:+CURVE-ALL:+COMP-NULL:+SIGN-ALL

OpenSSLの例:

kECDHEPSK+AES128:kPSK+AES128

TLSCipherPSK13

TLS 1.3でOpenSSL 1.1.1以降の暗号文字列。 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 - 許可する

ユーザー

システム上の特定の既存ユーザーの権限を削除します。
'root'として実行され、AllowRoot が無効になっている場合にのみ有効です。

デフォルト: zabbix

UserParameter

監視するユーザー定義パラメータ。 ユーザー定義パラメータは複数指定できます。
フォーマット: UserParameter=<キー>,<シェルコマンド>
シェルコマンドは空文字列やEOLのみを返してはいけません。 UserParameterDirパラメータが指定されている場合、シェルコマンドは相対パスを使用できます。

例:

UserParameter=system.test,who|wc -l
       UserParameter=check_cpu,./custom_script.sh

UserParameterDir

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

例:

UserParameterDir=/opt/myscripts

参考

1. バージョン2.0.0以降のアクティブチェックとパッシブチェックのZabbixエージェント設定の違い