8 MSSQLプラグイン

概要

Zabbix agent 2 の設定ファイルは、プラグインを設定するために使用されます。これらの Zabbix agent 2 設定パラメータは、MSSQL プラグインの動作に対応しています。

これらは専用の設定ファイル(例: mssql.conf)に指定し、その後 Include ディレクティブを使用してこのファイルを Zabbix agent 2 の設定に追加することを推奨します。

MSSQL プラグインはロード可能なプラグインであり、MSSQL plugin repository で利用可能で、完全に説明されています。

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

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

オプション

Parameter Description
-V --version プラグインのバージョンおよびライセンス情報を表示します。
-h --help ヘルプ情報を表示します(短縮形)。
-t, --test <item key> テスト用にプラグインを起動します(プラグイン設定は無視されます)。

パラメータ

Parameter Mandatory Range Default Description
Plugins.MSSQL.CustomQueriesDir no Unixシステムでは /usr/local/share/zabbix/custom-queries/mssql

Windowsシステムでは *:\Program Files\Zabbix Agent 2\Custom Queries\MSSQL。ここで *ProgramFiles 環境変数のドライブ名です
プラグインが実行できるカスタムクエリを含む、ユーザー定義の .sql ファイルが格納されたディレクトリへのファイルパスを指定します。プラグインは起動時に、設定されたディレクトリ内の利用可能な .sql ファイルをすべて読み込みます。つまり、カスタムクエリファイルへの変更は、プラグインを再起動するまで反映されません。プラグインは Zabbix エージェント 2 とともに起動および停止します。
Plugins.MSSQL.CustomQueriesEnabled no false 設定すると、mssql.custom.query アイテムキーの実行を有効にします。無効な場合、カスタムクエリディレクトリパスからクエリは読み込まれません。
Plugins.MSSQL.Default.CACertPath no MSSQL サーバーの証明書を発行した認証局 (CA) の公開鍵証明書へのデフォルトのファイルパスです。証明書は PEM 形式である必要があります。
Plugins.MSSQL.Default.Database no 接続先のデフォルトのデータベース名です。
Plugins.MSSQL.Default.Encrypt no デフォルトの接続暗号化タイプを指定します。指定可能な値は次のとおりです。
true - プラグインとサーバー間で送信されるデータは暗号化されます。
false - プラグインとサーバー間で送信されるデータは、ログインパケットを除いて暗号化されません。
strict - プラグインとサーバー間で送信されるデータは、TDS8 を使用して E2E で暗号化されます。
disable - プラグインとサーバー間で送信されるデータは暗号化されません。
Plugins.MSSQL.Default.HostNameInCertificate no デフォルトで使用する MSSQL サーバー証明書のコモンネーム (CN) です。
Plugins.MSSQL.Default.Password no 保護された MSSQL サーバーにデフォルトで送信するパスワードです。
Plugins.MSSQL.Default.TLSMinVersion no デフォルトで使用する最小 TLS バージョンです。指定可能な値は 1.0, 1.1, 1.2, 1.3 です。
Plugins.MSSQL.Default.TrustServerCertificate no デフォルトで、プラグインがサーバー証明書を検証せずに信頼するかどうかを指定します。指定可能な値: true, false
Plugins.MSSQL.Default.Uri no sqlserver://localhost:1433 接続先のデフォルト URI です。サポートされるスキーマは sqlserver:// のみです。スキーマは省略できます。埋め込み認証情報は無視されます。
Plugins.MSSQL.Default.User no 保護された MSSQL サーバーにデフォルトで送信するユーザー名です。
Plugins.MSSQL.KeepAlive no 60-900 300 未使用のプラグイン接続を閉じるまでの最大待機時間 (秒) です。
Plugins.MSSQL.Sessions.<SessionName>.CACertPath no 名前付きセッション用の MSSQL サーバー証明書を発行した認証局 (CA) の公開鍵証明書へのファイルパスです。証明書は PEM 形式である必要があります。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.MSSQL.Sessions.<SessionName>.Database no 名前付きセッションの接続先データベース名です。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.MSSQL.Sessions.<SessionName>.Encrypt no 名前付きセッションの接続暗号化タイプを指定します。指定可能な値は次のとおりです。
true - プラグインとサーバー間で送信されるデータは暗号化されます。
false - プラグインとサーバー間で送信されるデータは、ログインパケットを除いて暗号化されません。
strict - プラグインとサーバー間で送信されるデータは、TDS8 を使用して E2E で暗号化されます。
disable - プラグインとサーバー間で送信されるデータは暗号化されません。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.MSSQL.Sessions.<SessionName>.HostNameInCertificate no 名前付きセッション用の MSSQL サーバー証明書のコモンネーム (CN) です。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.MSSQL.Sessions.<SessionName>.Password no 保護された MSSQL サーバーに名前付きセッション用として送信するパスワードです。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.MSSQL.Sessions.<SessionName>.TLSMinVersion no 名前付きセッションで使用する最小 TLS バージョンです。指定可能な値は 1.0, 1.1, 1.2, 1.3 です。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.MSSQL.Sessions.<SessionName>.TrustServerCertificate no 名前付きセッションで、プラグインがサーバー証明書を検証せずに信頼するかどうかを指定します。指定可能な値: true, false
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.MSSQL.Sessions.<SessionName>.Uri no sqlserver://localhost:1433 名前付きセッションの接続先 URI です。サポートされるスキーマは sqlserver:// のみです。スキーマは省略できます。埋め込み認証情報は無視されます。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.MSSQL.Sessions.<SessionName>.User no 保護された MSSQL サーバーに名前付きセッション用として送信するユーザー名です。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.MSSQL.System.Path no MSSQL プラグイン実行ファイルへのパスです。
MSSQL プラグインのグローバル設定です。すべての接続に適用されます。
使用例: Plugins.MSSQL.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-mssql
Plugins.MSSQL.Timeout no 1-30 global timeout 最初の接続時およびセッション内の後続操作で、サーバーからの応答を待機する時間 (秒) です。

関連項目: