ODBC监控对应于Zabbix前端中的 数据库监控 监控项类型。
ODBC 是一种用于访问数据库管理系统(DBMS)的 C 语言中间件应用程序接口。 ODBC 的概念最初由微软公司开发,后来被移植到其他平台。
Zabbix may query any database, which is supported by ODBC. To do that, Zabbix does not directly connect to the databases, but uses the ODBC interface and drivers set up in ODBC. This allows for more efficient monitoring of different databases for multiple purposes (for example, checking specific database queues, usage statistics, etc.).Zabbix 能够查询任何由 ODBC 支持的数据库。 为了实现这一点,Zabbix 不是直接连接到数据库,而是通过使用ODBC接口并在ODBC中设置的驱动程序。 这使得更有效地监控不同数据库的多种用途(例如,检测特定的数据库队列、使用统计信息等)。
Zabbix 支持 unixODBC,它是最常用的开源 ODBC API 实现之一。
关于ODBC检查的更多信息,请参见: 已知问题 。
安装unixODBC的建议方法是使用 Linux 操作系统的默认标准包库。 在主流的 Linux 发行版中,默认情况下unixODBC包含在镜像库中。 如果包不可用,可以在 unixODBC 的官网下载源代码文件:http://www.unixodbc.org/download.html
要安装 unixODBC,请使用所选择的系统的软件包管理工具:
# 对于 Ubuntu/Debian 系统:
apt install unixodbc unixodbc-dev
# 对于 RedHat/Fedora-based 系统:
dnf install unixODBC unixODBC-devel
# 对于 SUSE-based 系统:
zypper in unixODBC-devel
The unixodbc-dev
or unixODBC-devel
package is necessary to compile Zabbix with unixODBC support. To enable ODBC support, Zabbix should be compiled with the following unixodbc-dev
或 unixODBC-devel
包是编译支持 unixODBC 的 Zabbix 所必需的。 要启用 ODBC 支持,Zabbix 应用如下配置选项进行编译:
unixODBC 数据库驱动程序应该为将要监控的数据库安装。 要查看支持的数据库和驱动程序列表,请访问 unixODBC 主页:: http://www.unixodbc.org/drivers.html.
在某些 Linux 发行版中,数据库驱动程序包含在软件包库中。
要安装 MySQL 的 unixODBC 数据库驱动程序,请使用您所选择的系统的软件包管理工具:
# 对于 Ubuntu/Debian 系统:
apt install odbc-mariadb
# 对于 RedHat/Fedora-based 系统:
dnf install mariadb-connector-odbc
# 对于 SUSE-based 系统:
zypper install mariadb-connector-odbc
如果不使用包管理器安装数据库驱动程序,请参考mysql-connector-odbc
MySQL 文档 , 或 mariadb-connector-odbc
MariaDB 文档 。
要安装 PostgreSQL 的 unixODBC 数据库驱动程序,请使用您所选择的系统的软件包管理工具:
# 对于 Ubuntu/Debian 系统:
apt install odbc-postgresql
# 对于 RedHat/Fedora-based 系统:
dnf install postgresql-odbc
# 对于 SUSE-based 系统:
zypper install psqlODBC
如果不使用包管理器安装数据库驱动程序,请参考PostgreSQL 文档.
要安装 unixODBC 数据库驱动程序,请参考 Oracle documentation.
要为 Ubuntu/Debian 系统安装 MSSQL 的 unixODBC 数据库驱动程序,请使用您所选择的系统的软件包管理工具:
# 对于 Ubuntu/Debian 系统:
apt install tdsodbc
# 对于 RedHat/Fedora-based 系统 (EPEL 包: https://docs.fedoraproject.org/en-US/epel/):
dnf install epel-release
dnf install freetds
# 对 SUSE-based 系统:
zypper install libtdsodbc0
如果不使用包管理器安装数据库驱动程序,请参考 FreeTDS 用户指南.
要对 unixODBC 进行配置,需编辑 odbcinst.ini
和 odbc.ini
文件。 可通过执行如下命令来确认这些文件的位置:
命令的输出应该包含类似于以下内容信息:
unixODBC 2.3.9
DRIVERS............: /etc/odbcinst.ini
SYSTEM DATA SOURCES: /etc/odbc.ini
FILE DATA SOURCES..: /etc/ODBCDataSources
odbcinst.ini
文件列出已安装的 ODBC 数据库驱动程序。 如果缺少 odbcinst.ini
文件,则需手动创建它。
参数 | 描述 |
---|---|
TEST_MYSQL | 数据库驱动名称. |
Description | 数据库驱动描述. |
Driver | 数据库驱动库位置. |
FileUsage | 确定数据库驱动是否支持在没有访问本地文件支持的情况下连接到数据库服务器(0);支持从文件读取数据(1);支持将数据写入文件(2)。 |
Threading | 线程串行化级别。PostgreSQL 支持此功能。 自 1.6 版本起,如果驱动管理器构建时包含了线程支持,您可能可以添加另一个驱动程序条目。 |
odbc.ini
文件用于配置数据源。
[TEST_MYSQL]
Description=MySQL Test Database
Driver=mysql
Server=127.0.0.1
User=root
Password=
Port=3306
Socket=
Database=zabbix
参数 | 描述 |
---|---|
TEST_MYSQL | 数据源名称(DSN)。 |
Description | 数据源描述。 |
Driver | 数据库驱动程序名称(如在 odbcinst.ini 文件中所指定)。 |
Server | 数据库服务器 IP/DNS。 |
User | 用于连接数据库的用户。 |
Password | 用于连接数据库的密码。 |
Port | 用于连接数据库的端口。 |
Socket | 用于连接数据库的socket。 |
Database | 数据库名称。 |
对于其他可能的配置参数选项,请参考 MySQL documentation.
odbc.ini
文件在用于 PostgreSQL 时可能包含一些额外的参数:
[TEST_PSQL]
Description=PostgreSQL Test Database
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=
参数 | 描述 |
---|---|
ReadOnly | 指定数据库连接是否只允许进行读操作(SELECT 查询),并限制进行修改操作(INSERT 、UPDATE 和 DELETE 语句);这在需要保持数据不变的情况下非常有用。 |
Protocol | PostgreSQL 后端通信协议的版本号(当使用 SSL 连接时,此设置会被忽略)。 |
ShowOidColumn | 指定是否在 SQLColumns 中包含对象标识符(OID)。 |
FakeOidIndex | 指定是否在对象标识符(OID)上创建一个假的(模拟的)唯一索引。 |
RowVersioning | 指定是否允许应用程序检测当您尝试更新一行数据时,该数据是否已被其他用户修改。请注意,这个参数可以加快更新过程,因为更新一行数据时,不需要在 WHERE 子句中指定每一个单独的列。 |
ShowSystemTables | 指定数据库驱动程序是否应在 SQLTables 中将系统表视为普通表;这对于可访问性很有用,因为它允许查看系统表。 |
Fetch | 指定驱动程序是否应该自动使用声明游标/获取的方式来处理 SELECT 语句,并维持一个包含 100 行的缓存。 |
BoolsAsChar | 控制布尔类型如何被映射。 如果设置为“是”,则布尔值会被映射到 SQL_CHAR 类型;如果不是,则会被映射到 SQL_BIT 类型。 |
SSLmode | 指定连接使用的 SSL 安全模式。 |
ConnSettings | 在连接时发送给后端的附加设置。 |
要检验 ODBC 连接是否成功建立,您可以使用 isql
工具(包含在 unixODBC
软件包内):
isql test
+---------------------------------------+
| Connected! |
| |
| sql-statement |
| help [tablename] |
| quit |
| |
+---------------------------------------+
配置一个 **数据库监控* 监控项.
标红色星号字段为必填项。
对于数据库监控项,需指定如下:
类型 | 在这里选择 "数据库监控"。 |
键值 | 输入一个受支持的监控项key: db.odbc.select[] - 这个监控项返回一个值(SQL 查询结果中的第一行第一列的数据); db.odbc.get[] - 这个监控项以 JSON 格式返回多个行或多个列的数据; db.odbc.discovery[] - 此监控项返回低级发现数据。 |
User name | 输入数据库用户名(最多255个字符)。 如果在 odbc.ini 文件中已指定数据库用户名,则此参数是可选的。如果使用了连接字符串,并且“用户名”字段不为空,则它将作为 UID=<user> 添加到连接字符串中。 |
Password | 输入数据库用户的密码(最多255个字符)。 如果在 odbc.ini 文件中已指定密码,则此参数是可选的。如果使用了连接字符串,并且“密码”字段非空,那么它会被附加到连接字符串中,格式为 PWD=<密码> 。如果密码中包含分号,应该使用大括号将其括起来,例如: {P?;)*word} 。密码将在用户名之后追加到连接字符串中,格式为 UID=<username>;PWD={P?;)*word} 。要测试最终生成的连接字符串,您可以执行以下命令: isql -v -k 'Driver=libmaodbc.so;Database=zabbix;UID=zabbix;PWD={P?;)*word}' |
SQL query | 输入 SQL 查询。 请注意,使用 db.odbc.select[] 时,查询必须仅返回一个值。 |
Type of information | 在这里选择查询将返回的信息类型。 如果选择的信息类型不正确,该监控项将显示不支持。 |
不带尖角括号的参数必填项。用尖角括号 < > 标记的参数是可选的。
返回一个值,即 SQL 查询结果中第一行的第一列。
返回值:根据 SQL 查询而定。
参数:
odbc.ini
中指定的);注释:
dsn
will be ignored.尽管 dsn
和 connection string
是可选参数,但至少需要其中一个;如果两个都被定义了,dsn
将被忽略。
将 SQL 查询结果转换成 JSON 格式的数组。
返回值:JSON object。
参数:
odbc.ini
文件中指定的)。注释:
dsn
和 connection string
是可选参数,但至少需要其中一个;如果两个都被定义了,dsn
将被忽略。示例:
# MySQL ODBC 驱动程序 5 的连接配置:
db.odbc.get[MySQL example,,"Driver=/usr/local/lib/libmyodbc5a.so;Database=master;Server=127.0.0.1;Port=3306"]
将 SQL 查询结果转换为 JSON 数组,用于 低级别自动发现. 查询结果中的列名被转换为与发现字段值配对的低级发现宏名称。 这些宏可以在创建监控项、触发器等原型时使用。
返回值:JSON object。
参数:
odbc.ini
文件中指定的)。注释:
dsn
和 connection string
是可选参数,但至少需要其中一个;如果两个都被定义了,dsn
将被忽略。注意事项
StartODBCPollers
参数,请在 Zabbixserver 配置文件中或对于由proxy监控,在 Zabbix proxyproxy 配置文件中进行设置。select
语句的任何查询一样。 查询的语法将取决于将处理它们的 RDBMS(关系数据库管理系统)。 向存储过程发出的请求的语法必须以 call
关键字开始。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 会尽量在长度限制范围内将它们拼接起来(各记录之间用 |
符号分隔)。