14 ODBC 監視

概要

ODBC監視は、Zabbixフロントエンドの Database monitor item タイプに相当します。

ODBCはデータベース管理システム(DBMS)にアクセスするためのC言語のミドルウェアAPIです。
ODBCのコンセプトはMicrosoftによって開発され、その後他のプラットフォームにも移植されました。

ZabbixはODBCでサポートされている全てのデータベースに問い合わせをすることができます。
そのため、Zabbixはデータベースに直接接続せず、ODBCインターフェースとODBCで設定されたドライバを利用します。
この機能により、例えば、特定のデータベースキューや利用統計の確認など、複数の目的で異なるデータベースを
より効率的に監視することが可能です。
Zabbixは最も一般的に利用されているオープンソースのODBC API実装の1つであるunixODBCをサポートしています。

unixODBC のインストール

unixODBC をインストールする推奨される方法は、Linux オペレーティングシステムのデフォルトパッケージリポジトリを
使用することです。最も人気のあるLinuxディストリビューションでは、unixODBCはデフォルトで
パッケージリポジトリに含まれています。
もし利用できない場合は、unixODBCのホームページで入手することができます。
http://www.unixodbc.org/download.html.

RedHat/Fedora ベースのシステムで yum パッケージマネージャを使用して unixODBC をインストールします。

shell> yum -y install unixODBC unixODBC-devel

SUSE ベースのシステムで zypper パッケージマネージャを使用して unixODBC をインストールします。

# zypper in unixODBC-devel

unixODBC ドライバのインストール

監視するデータベースには、unixODBCデータベースドライバをインストールする必要があります。
unixODBCには、サポートされているデータベースとドライバのリストがあります。
http://www.unixodbc.org/drivers.html
Linuxディストリビューションによっては、データベースドライバがパッケージリポジトリに含まれている場合があります。

RedHat/Fedora ベースのシステムで、yum パッケージマネージャを使用して MySQL データベースドライバをインストールする場合:

shell> yum install mysql-connector-odbc

SUSE ベースのシステムで、zypper パッケージマネージャを使用して MySQL データベースドライバをインストールする場合:

zypper で MyODBC-unixODBC

MySQL

MySQL unixODBC データベースドライバーをインストールするには、お使いのシステムのパッケージマネージャーを使用してください。

# Ubuntu/Debian システムの場合:
       apt install odbc-mariadb
       
       # RedHat/Fedora ベースのシステムの場合:
       dnf install mariadb-connector-odbc
       
       # SUSE ベースのシステムの場合:
       zypper install mariadb-connector-odbc

パッケージマネージャーを使用せずにデータベースドライバーをインストールするには、MySQL ドキュメント の mysql-connector-odbc または MariaDB ドキュメント の mariadb-connector-odbc を参照してください。

PostgreSQL

PostgreSQL unixODBC データベースドライバーをインストールするには、お使いのシステムのパッケージマネージャーを使用してください。

# Ubuntu/Debian システムの場合:
       apt install odbc-postgresql
       
       # RedHat/Fedora ベースのシステムの場合:
       dnf install postgresql-odbc
       
       # SUSE ベースのシステムの場合:
       zypper install psqlODBC

パッケージマネージャーを使用せずにデータベースドライバーをインストールするには、PostgreSQL ドキュメント を参照してください。

Oracle

unixODBC データベースドライバーをインストールするには、Oracle のドキュメント を参照してください。

MSSQL

Ubuntu/Debian システム用の MSSQL unixODBC データベースドライバーをインストールするには、お使いのシステムのパッケージマネージャーを使用してください。

# Ubuntu/Debian システムの場合:
       apt install tdsodbc
       
       # RedHat/Fedora ベースのシステム (EPEL パッケージ: https://docs.fedoraproject.org/en-US/epel/) の場合:
       dnf install epel-release
       dnf install freetds
       
       # SUSE ベースのシステムの場合:
       zypper install libtdsodbc0

パッケージマネージャーを使用せずにデータベースドライバーをインストールするには、FreeTDS ユーザーガイド を参照してください。

unixODBCの設定

ODBCの設定は、odbcinst.ini と odbc.ini ファイルを編集することによって行われます。
設定ファイルの場所を確認するには、次のように入力します。

shell> odbcinst -j

odbcinst.ini は、インストールされている ODBC データベースドライバーの一覧を表示するために使用されます。

[mysql]
       Description = ODBC for MySQL
       Driver      = /usr/lib/libmyodbc5.so

パラメータの詳細:

odbc.ini は、データソースの定義に使用されます:

[test]
       Description = MySQL test database
       Driver      = mysql
       Server      = 127.0.0.1
       User        = root
       Password    =
       Port        = 3306
       Database    = zabbix

パラメータの詳細:

ODBC接続が正常に動作しているかどうかを確認するために、データベースへの接続をテストする必要があります。
これは isql ユーティリティ（unixODBC パッケージに含まれています）で行うことができます。

shell> isql test
       +---------------------------------------+
       | Connected!                            |
       |                                       |
       | sql-statement                         |
       | help [tablename]                      |
       | quit                                  |
       |                                       |
       +---------------------------------------+
       SQL>

odbcinst.ini

odbcinst.ini ファイルには、インストールされている ODBC データベースドライバーがリストされます。 odbcinst.ini が見つからない場合は、手動で作成する必要があります。

[TEST_MYSQL]
       Description=ODBC for MySQL
       Driver=/usr/lib/libmyodbc5.so
       FileUsage=1

odbc.ini

odbc.ini ファイルは、データソースの設定に使用されます。 サポートされるパラメータのリストは、データベースドライバによって異なります（たとえば、Oracle データベースでは Server の代わりに ServerName が使用される場合があります）。

[TEST_MYSQL]
       Description=MySQL Test Database
       Driver=mysql
       Server=127.0.0.1
       User=root
       Password=
       Port=3306
       Socket=
       Database=zabbix

その他の設定パラメータオプションについては、MySQLドキュメントを参照してください。

PostgreSQL の odbc.ini ファイルには、追加のパラメータが含まれている場合があります。

[TEST_PSQL]
       Description=PostgreSQL テストデータベース
       Driver=postgresql
       Username=zbx_test
       Password=zabbix
       Servername=127.0.0.1
       Database=zabbix
       Port=5432
       ReadOnly=No
       Protocol=7.4+
       ShowOidColumn=No
       FakeOidIndex=No
       RowVersioning=No
       ShowSystemTables=No
       Fetch=Yes
       BoolsAsChar=Yes
       SSLmode=Require
       ConnSettings=

ODBC 接続のテスト

ODBC 接続が正常に動作しているかどうかをテストするには、isql ユーティリティ（unixODBC パッケージに含まれています）を使用できます。

isql test
       +---------------------------------------+
       | Connected!                            |
       |                                       |
       | sql-statement                         |
       | help [tablename]                      |
       | quit                                  |
       |                                       |
       +---------------------------------------+

Zabbixフロントエンドでの item 設定

データベース監視 item を設定します。

必須入力項目には、赤いアスタリスクが付けられています。

特にデータベース監視の項目について、入力する必要があります:

重要な注意事項

• server または proxy 設定でodbc pollerプロセスが起動されていない場合、データベース監視項目はサポートされなくなります。 ODBCポーラーを起動するには、Zabbix server 設定ファイルで StartODBCPollersパラメータを設定するか、proxy で実行するチェックの場合はZabbix [proxy] (/manual/appendix/config/zabbix_proxy) 設定ファイルで StartODBCPollers パラメータを設定します。
• Zabbixはクエリの実行時間を制限していません。妥当な時間で実行できるクエリを選択することはユーザにゆだねられています。
• Zabbix server のTimeoutパラメータの値はODBCログインタイムアウトとして 使用されます(ODBCドライバによっては、ログインタイムアウト設定が無視される場合があることに注意してください)。
• SQL コマンドは、select ... を使用した他のクエリと同様に結果セットを返す必要があります。 問い合わせの構文は、それを処理するRDBMSに依存します。ストレージプロシージャへのリクエストの構文は call キーワードで 開始する必要があります。

アイテムキーの詳細

山括弧のないパラメータは必須です。山括弧 < > でマークされたパラメータはオプションです。

db.odbc.select[<一意の短い説明>,<dsn>,<接続文字列>]

SQLクエリ結果の最初の行の最初の列を1つの値として返します。
戻り値: SQLクエリによって異なります。

パラメーター:

• 一意の短い説明 - 項目を識別するための一意の短い説明（トリガーなどで使用）
• dsn - データソース名（odbc.iniで指定）
• 接続文字列 - 接続文字列（ドライバー固有の引数を含む場合があります）

コメント:

• dsn と connection string はオプションのパラメーターですが、少なくともどちらか一方は必須です。両方定義されている場合、dsn は無視されます。
• クエリが複数の列を返す場合、最初の列のみが読み込まれます。クエリが複数行を返す場合、最初の行のみが読み取られます。

db.odbc.get[<一意の短い説明>,<dsn>,<接続文字列>]

SQLクエリの結果をJSON配列に変換します。
戻り値: JSONオブジェクト

パラメーター:

• 一意の短い説明 - 項目を識別するための一意の短い説明（トリガーなどで使用）
• dsn - データソース名（odbc.iniで指定）
• 接続文字列 - 接続文字列（ドライバー固有の引数を含む場合があります）

コメント:

• dsnとconnection stringはオプションのパラメーターですが、少なくともどちらか一方は必須です。両方定義されている場合、dsnは無視されます。
• JSON形式で複数の行/列が返される場合があります。 この項目は、1回のシステムコールですべてのデータを収集するマスター項目として使用できます。一方、依存項目ではJSONPath前処理を使用して個々の値を抽出できます。 詳細については、低レベル検出で使用される返される形式の例を参照してください。

例:

MySQL ODBCドライバー5の接続:

db.odbc.get[MySQL example,,"Driver=/usr/local/lib/libmyodbc5a.so;Database=master;Server=127.0.0.1;Port=3306"]

db.odbc.discovery[<一意の短い説明>,<dsn>,<接続文字列>]

SQLクエリ結果を低レベル検出で使用するJSON配列に変換します。 クエリ結果の列名は、検出されたフィールド値とペアになった低レベル検出マクロ名に変換されます。 これらのマクロは、アイテム、トリガーなどのプロトタイプの作成に使用できます。
戻り値: JSONオブジェクト

パラメーター:

• 一意の短い説明 - アイテムを識別するための一意の短い説明（トリガーなどで使用）
• dsn - データソース名（odbc.iniで指定）
• 接続文字列 - 接続文字列（ドライバー固有の引数を含む場合があります）

コメント:

• dsn と connection string はオプションのパラメータですが、少なくともどちらかは必須です。両方定義されている場合、dsn は無視されます。

エラーメッセージ

ODBCのエラーメッセージは、詳細な情報を提供するためにフィールドに分かれて構成されています。
たとえば、以下のようなものです。

Cannot execute ODBC query: [SQL_ERROR]:[42601][7][ERROR: syntax error at or near ";"; Error while executing the query]
       └───────────┬───────────┘  └────┬────┘ └──┬──┘└┬┘└─────────────────────────────┬─────────────────────────────────────┘
                   │                   │         │    └─ Native error code            └─ Native error message
                   │                   │         └─ SQLState
                   └─ Zabbix message   └─ ODBC return code

エラーメッセージの長さは2048バイトに制限されているため、メッセージは切り捨てられる可能性があることに注意してください。
複数のODBC診断レコードがある場合、Zabbixはそれらを(|で区切って)制限された長さになるように連結しようと試みます。