Oracleプラグイン

概要

設定パラメータを使用すると、Oracleプラグインの動作をカスタマイズできます。

これらは、エージェント 2 の設定ファイルではなく、専用の設定ファイル（例: oracle.conf）に指定することを推奨します。その後、Include ディレクティブを使用して、このファイルを Zabbix エージェント 2 の設定に含めます。

パラメータが必須であると明示されていない限り、すべてのパラメータは任意です。

注意事項:

  • デフォルト値は、同梱されている設定ファイル内の値ではなく、プロセスのデフォルトを反映しています。
  • 値は環境変数をサポートします。
  • Zabbix がサポートする設定ファイルのエンコーディングは UTF-8 のみで、BOM は含められません。
  • \# で始まるコメントは、行頭でのみサポートされます。

Parameter details

Plugins.Oracle.CallTimeout

Specify the maximum wait time in seconds for a request to be completed.

Default: default timeout
Range: 1-30

Plugins.Oracle.ConnectTimeout

Specify the maximum wait time in seconds for a connection to be established.

Default: default timeout
Range: 1-30

Plugins.Oracle.CustomQueriesPath

Specify full pathname of the directory containing .sql files with custom queries.

Defaults:
/usr/local/share/zabbix/custom-queries/oracle - for Unix systems,
*:\Program Files\Zabbix Agent 2\Custom Queries\Oracle - for Windows systems (where * is the drive name from the ProgramFiles environment variable)

Example: 

/etc/zabbix/oracle/sql
Plugins.Oracle.CustomQueriesEnabled

Enable execution of the oracle.custom.query item key.
If disabled, no queries will be loaded from the custom query directory path.

Default: false
Range: true/false

Plugins.Oracle.Default.Password

Specify the default password for connecting to Oracle.
Used if no value is specified in an item key or named session.

Plugins.Oracle.Default.Service

Specify the default service name for connecting to Oracle (SID is not supported).
Used if no value is specified in an item key or named session.

Plugins.Oracle.Default.Uri

Specify the default URI for connecting to Oracle.
Used if no value is specified in an item key or named session.
Embedded credentials will be ignored.
Must match the URI format.
Supported schemes: tcp, tcps
The schema can be omitted.
The port can be omitted (default=1521).
It is also possible to specify the TNS key or TNS value as the connection string. The TNS value must be composed without whitespaces.

Examples: 

tcp://127.0.0.1:1521
localhost
zbx_tns_example (TNS key)
(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=xe))) (TNS value)
Plugins.Oracle.Default.User

Specify the default username for connecting to Oracle.
Used if no value is specified in an item key or named session.

Plugins.Oracle.KeepAlive

Set the maximum time of waiting (in seconds) before unused plugin connections are closed.

Default: 300
Range: 60-900

Plugins.Oracle.ResolveTNS

Specify how to interpret the connection string (ConnString) for connecting to the Oracle server.
If it is set to false the default scheme and port will be added to ConnString (if absent).
If the option is set to true, the default scheme and port will be omitted (unless explicitly specified in ConnString), and ConnString will be passed to the Oracle client as is. If the Oracle client finds ConnString in the tnsnames.ora file, the connection description found will be used to connect to the Oracle server.

Default: true
Range: true/false

Plugins.Oracle.Sessions.<SessionName>.Password

Specify the named session password for connecting to Oracle.
<SessionName> - define name of a session for using in item keys.

Plugins.Oracle.Sessions.<SessionName>.Service

Specify the named session service name for connecting to Oracle (SID is not supported).
<SessionName> - define name of a session for using in item keys.

Plugins.Oracle.Sessions.<SessionName>.Uri

Specify the named session URI for connecting to Oracle.
<SessionName> - define name of a session for using in item keys.
Embedded credentials will be ignored.
Must match the URI format.
Supported schemes: tcp, tcps
The schema can be omitted.
The port can be omitted (default=1521).
It is also possible to specify the TNS key or TNS value as the connection string. The TNS value must be composed without whitespaces.

Examples: 

tcp://127.0.0.1:1521
localhost
zbx_tns_example (TNS key)
(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=xe))) (TNS value)
Plugins.Oracle.Sessions.<SessionName>.User

Specify the named session username for connecting to Oracle.
<SessionName> - define name of a session for using in item keys.

パラメータ

Parameter Mandatory Range Default Description
Plugins.Oracle.CallTimeout no 1-30 global timeout リクエストの完了を待機する最大時間（秒）。
Plugins.Oracle.ConnectTimeout no 1-30 global timeout 接続の確立を待機する最大時間（秒）。
Plugins.Oracle.CustomQueriesPath no Unix システムでは /usr/local/share/zabbix/custom-queries/oracle

Windows システムでは *:\Program Files\Zabbix Agent 2\Custom Queries\Oracle。ここで * は ProgramFiles 環境変数のドライブ名		 カスタムクエリを含む .sql ファイルが置かれたディレクトリのフルパス。
例: /etc/zabbix/oracle/sql
Plugins.Oracle.CustomQueriesEnabled no false 設定すると、oracle.custom.query アイテムキーの実行を有効にします。無効の場合、カスタムクエリディレクトリのパスからクエリは読み込まれません。
Plugins.Oracle.Default.Password no Oracle への接続に使用するデフォルトパスワード。アイテムキーまたは名前付きセッションで値が指定されていない場合に使用されます。
Plugins.Oracle.Default.Service no Oracle への接続に使用するデフォルトのサービス名（SID はサポートされません）。アイテムキーまたは名前付きセッションで値が指定されていない場合に使用されます。
Plugins.Oracle.Default.Uri no Oracle への接続に使用するデフォルト URI。アイテムキーまたは名前付きセッションで値が指定されていない場合に使用されます。

埋め込み資格情報を含めないでください（無視されます）。
URI 形式に一致している必要があります。
tcp と tcps のスキームのみサポートされます。スキームは省略できます。
ポートは省略できます（default=1521）。
接続文字列として TNS キーまたは TNS 値を指定することもできます。TNS 値は空白を含めずに記述する必要があります。
例: tcp://127.0.0.1:1521
localhost
zbx_tns_example（TNS キー）
(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=xe)))（TNS 値）
Plugins.Oracle.Default.User no Oracle への接続に使用するデフォルトユーザー名。アイテムキーまたは名前付きセッションで値が指定されていない場合に使用されます。
Plugins.Oracle.KeepAlive no 60-900 300 未使用のプラグイン接続を閉じるまでの最大待機時間（秒）。
Plugins.Oracle.ResolveTNS no true / false true Oracle サーバーへの接続に使用する接続文字列（ConnString）の解釈方法を指定します。
false に設定すると、デフォルトのスキームとポートが ConnString に追加されます（存在しない場合）。true に設定すると、デフォルトのスキームとポートは省略され（ConnString に明示的に指定されている場合を除く）、ConnString はそのまま Oracle クライアントに渡されます。Oracle クライアントが tnsnames.ora ファイル内で ConnString を見つけた場合、見つかった接続記述を使用して Oracle サーバーに接続します。
Plugins.Oracle.Sessions.<SessionName>.Password no 名前付きセッションのパスワード。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.Oracle.Sessions.<SessionName>.Service no 接続に使用する名前付きセッションのサービス名（SID はサポートされません）。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.Oracle.Sessions.<SessionName>.Uri no Oracle 用の名前付きセッション接続文字列。
<SessionName> - アイテムキーで使用するセッション名を定義します。

埋め込み資格情報を含めないでください（無視されます）。
URI 形式に一致している必要があります。
tcp と tcps のスキームのみサポートされます。スキームは省略できます。
ポートは省略できます（default=1521）。
接続文字列として TNS キーまたは TNS 値を指定することもできます。TNS 値は空白を含めずに記述する必要があります。
例: tcp://127.0.0.1:1521
localhost
zbx_tns_example（TNS キー）
(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=xe)))（TNS 値）
Plugins.Oracle.Sessions.<SessionName>.User no 名前付きセッションのユーザー名。
<SessionName> - アイテムキーで使用するセッション名を定義します。

参照: