OceanBase¶

·

支持采集 OceanBase 监控指标。目标支持 OceanBase 企业版本的 Oracle 租户模式和 MySQL 租户模式的采集。

已测试的版本：

OceanBase 3.2.4 企业版

配置¶

前置条件¶

创建监控账号

Oracle 租户模式：

-- Create the datakit user. Replace the password placeholder with a secure password.
CREATE USER datakit IDENTIFIED BY <PASSWORD>;

-- Grant access to the datakit user.
GRANT CONNECT, CREATE SESSION TO datakit;
GRANT SELECT_CATALOG_ROLE to datakit;
GRANT SELECT ON GV$LOCK TO datakit;
GRANT SELECT ON GV$CONCURRENT_LIMIT_SQL TO datakit;
GRANT SELECT ON GV$INSTANCE TO datakit;
GRANT SELECT ON GV$MEMORY TO datakit;
GRANT SELECT ON GV$MEMSTORE TO datakit;
GRANT SELECT ON GV$OB_SQL_WORKAREA_MEMORY_INFO TO datakit;
GRANT SELECT ON GV$PLAN_CACHE_STAT TO datakit;
GRANT SELECT ON GV$PS_STAT TO datakit;
GRANT SELECT ON GV$SESSION_WAIT TO datakit;
GRANT SELECT ON GV$SQL_AUDIT TO datakit;

MySQL 租户模式：

CREATE USER 'datakit'@'localhost' IDENTIFIED BY '<UNIQUEPASSWORD>';

-- MySQL 8.0+ create the datakit user with the caching_sha2_password method
CREATE USER 'datakit'@'localhost' IDENTIFIED WITH caching_sha2_password by '<UNIQUEPASSWORD>';

-- 授权
GRANT PROCESS ON *.* TO 'datakit'@'localhost';
GRANT SELECT ON *.* TO 'datakit'@'localhost';
show databases like 'performance_schema';
GRANT SELECT ON performance_schema.* TO 'datakit'@'localhost';
GRANT SELECT ON mysql.user TO 'datakit'@'localhost';
GRANT replication client on *.*  to 'datakit'@'localhost';

Attention

如用 localhost 时发现采集器有如下报错，需要将上述步骤的 localhost 换成 ::1
Error 1045: Access denied for user 'datakit'@'localhost' (using password: YES)
以上创建、授权操作，均限定了 datakit 这个用户，只能在 MySQL 主机上（localhost）访问 MySQL。如果需要对 MySQL 进行远程采集，建议将 localhost 替换成 %（表示 DataKit 可以在任意机器上访问 MySQL），也可用特定的 DataKit 安装机器地址。

安装依赖包

根据操作系统和 OceanBase 版本选择安装对应的安装包，如：

x86_64 系统ARM64 系统

下载 libobclient 和 obci：

wget https://static.guance.com/oceanbase/x86/libobclient-2.1.4.1-20230510140123.el7.alios7.x86_64.rpm
wget https://static.guance.com/oceanbase/x86/obci-2.0.6.odpi.go-20230510112726.el7.alios7.x86_64.rpm

MD5 (libobclient-2.1.4.1-20230510140123.el7.alios7.x86_64.rpm) = f27b27224dbe43cd166d9777dd1a249d
MD5 (obci-2.0.6.odpi.go-20230510112726.el7.alios7.x86_64.rpm) = fd031c517998ee742dea762bbead853e

安装以上包（需要 root 权限）：

rpm -ivh libobclient-2.1.4.1-20230510140123.el7.alios7.x86_64.rpm
rpm -ivh obci-2.0.6.odpi.go-20230510112726.el7.alios7.x86_64.rpm

下载 libobclient 和 obci：

wget https://static.guance.com/oceanbase/arm/libobclient-2.1.4.1-20230510140123.el7.alios7.aarch64.rpm
wget https://static.guance.com/oceanbase/arm/obci-2.0.6.odpi.go-20230815181729.el7.alios7.aarch64.rpm

MD5 (libobclient-2.1.4.1-20230510140123.el7.alios7.aarch64.rpm) = 8d7209447593034a37af395a650fd225
MD5 (obci-2.0.6.odpi.go-20230815181729.el7.alios7.aarch64.rpm) = a8727898c2f9a04edfb41d409da1da9c

安装以上包（需要 root 权限）：

rpm -ivh libobclient-2.1.4.1-20230510140123.el7.alios7.aarch64.rpm
rpm -ivh obci-2.0.6.odpi.go-20230815181729.el7.alios7.aarch64.rpm

将安装后的目录文件路径 /u01/obclient/lib 添加到以下配置信息中的 LD_LIBRARY_PATH 环境变量路径中。

部分系统需要安装额外的依赖库：

apt-get install -y libaio-dev libaio1

采集器配置¶

主机安装Kubernetes

进入 DataKit 安装目录下的 conf.d/db 目录，复制 oceanbase.conf.sample 并命名为 oceanbase.conf。示例如下：

[[inputs.external]]
  daemon = true
  name   = "oceanbase"
  cmd    = "/usr/local/datakit/externals/oceanbase"

  ## Set true to enable election
  election = true

  ## Modify below if necessary.
  ## The password use environment variable named "ENV_INPUT_OCEANBASE_PASSWORD".
  args = [
    "--interval"        , "1m"                              ,
    "--host"            , "<your-oceanbase-host>"           ,
    "--port"            , "2883"                            ,
    "--tenant"          , "oraclet"                         ,
    "--cluster"         , "obcluster"                       ,
    "--username"        , "<oceanbase-user-name>"           ,
    "--database"        , "oceanbase"                       ,
    "--mode"            , "oracle"                          ,
    "--service-name"    , "<oceanbase-service-name>"        ,
    "--slow-query-time" , "0s"                              ,
    "--log"             , "/var/log/datakit/oceanbase.log"  ,
  ]
  envs = [
    "ENV_INPUT_OCEANBASE_PASSWORD=<oceanbase-password>",
    "LD_LIBRARY_PATH=/u01/obclient/lib:$LD_LIBRARY_PATH",
  ]

  [inputs.external.tags]
    # some_tag = "some_value"
    # more_tag = "some_other_value"

  ## Run a custom SQL query and collect corresponding metrics.
  # [[inputs.external.custom_queries]]
  #   sql = '''
  #     SELECT
  #       GROUP_ID, METRIC_NAME, VALUE
  #     FROM GV$SYSMETRIC
  #   '''
  #   metric = "oceanbase_custom"
  #   tags = ["GROUP_ID", "METRIC_NAME"]
  #   fields = ["VALUE"]

  #############################
  # Parameter Description (Marked with * is mandatory field)
  #############################
  # *--interval                      : Collect interval (Default is 1m).
  # *--host                          : OceanBase instance address (IP).
  # *--port                          : OceanBase listen port (Default is 2883).
  # *--tenant                        : OceanBase tenant name (Default is oraclet).
  # *--cluster                       : OceanBase cluster name (Default is obcluster).
  # *--username                      : OceanBase username.
  # *--database                      : OceanBase database name. Generally, fill in 'oceanbase'.
  # *--mode                          : OceanBase tenant mode, fill in 'oracle' or 'mysql'.
  # *--service-name                  : OceanBase service name.
  # *--slow-query-time               : OceanBase slow query time threshold defined. If larger than this, the executed sql will be reported.
  # *--log                           : Collector log path.
  # *ENV_INPUT_OCEANBASE_PASSWORD    : OceanBase password.

配置好后，重启 DataKit 即可。

目前可以通过 ConfigMap 方式注入采集器配置来开启采集器。

Tip

上述配置会以命令行形式展示在进程列表中（包括密码），如果想隐藏密码，可以通过将密码写进环境变量 ENV_INPUT_OCEANBASE_PASSWORD 形式实现，示例：

envs = [
    "ENV_INPUT_OCEANBASE_PASSWORD=<YOUR-SAFE-PASSWORD>"
]

该环境变量在读取密码时有最高优先级，即只要出现该环境变量，那密码就以该环境变量中的值为准。

指标¶

以下所有数据采集，默认会追加名为 host 的全局 tag（tag 值为 DataKit 所在主机名），也可以在配置中通过 [inputs.oceanbase.tags] 指定其它标签：

 [inputs.oceanbase.tags]
  # some_tag = "some_value"
  # more_tag = "some_other_value"
  # ...

`oceanbase`¶

标签

Tag	Description
`host`	Host name.
`ob_host_name`	Server address where the instance is located.
`ob_version`	The version of the database instance.
`oceanbase_server`	The address of the database instance (including port).
`oceanbase_service`	OceanBase service name.

指标列表

Metric	Description	Type	Unit
`ob_concurrent_limit_sql_count`	Number of throttled SQL.	int	count
`ob_database_status`	The status of the database. 1: Normal (active).	int	count
`ob_lock_count`	The number of database row locks.	int	count
`ob_lock_max_ctime`	Maximum database lock time (seconds).	int	s
`ob_mem_sum_count`	The number of memory units in use by all tenants.	int	count
`ob_mem_sum_used`	The memory value currently used by all tenants.	int	B
`ob_memstore_active_rate`	Memory activity rate of Memtable for all tenants on all servers.	float	percent
`ob_plancache_avg_hit_rate`	The average hit rate of plan_cache across all servers.	float	percent
`ob_plancache_mem_used_rate`	Overall memory usage of plan_cache across all servers (memory used divided by memory held).	float	percent
`ob_plancache_sum_plan_num`	The total number of plans on all servers.	int	count
`ob_ps_hit_rate`	PS (Prepared Statement) Cache hit rate.	float	percent
`ob_session_avg_wait_time`	The average waiting time of the current or last wait event for all Sessions on all servers.	float	μs
`ob_workarea_global_mem_bound`	In auto mode, the global maximum available memory size.	int	B
`ob_workarea_max_auto_workarea_size`	The maximum memory size managed by auto under the current workarea.	int	B
`ob_workarea_mem_target`	The target size of the memory available to the current workarea.	int	B

`oceanbase_log`¶

标签

Tag	Description
`host`	Hostname.
`oceanbase_server`	The address of the database instance (including port).
`oceanbase_service`	OceanBase service name.

指标列表

Metric	Description	Type	Unit
`message`	The text of the logging.	string	-
`status`	The status of the logging, only supported `info/emerg/alert/critical/error/warning/debug/OK/unknown`.	string	-

慢查询支持¶

Datakit 可以将执行超过用户自定义时间的 SQL 语句报告给观测云，在日志中显示，来源名是 oceanbase_log。

该功能默认情况下是关闭的，用户可以在 OceanBase 的配置文件中将其打开，方法如下：

将 --slow-query-time 后面的值从 0s 改成用户心中的阈值，最小值 1 毫秒。一般推荐 10 秒。

  args = [
    ...
    '--slow-query-time' , '10s'                        ,
  ]

字段说明

failed_obfuscate：SQL 脱敏失败的原因。只有在 SQL 脱敏失败才会出现。SQL 脱敏失败后原 SQL 会被上报。更多字段解释可以查看这里。

重要信息

如果值是 0s 或空或小于 1 毫秒，则不会开启 OceanBase 采集器的慢查询功能，即默认状态。
没有执行完成的 SQL 语句不会被查询到。

FAQ¶

如何查看 OceanBase 采集器的运行日志？¶

由于 OceanBase 采集器是外部采集器，其日志是默认单独存放在 [Datakit 安装目录]/externals/oceanbase.log 中。

另外，可以在配置文件中通过 --log 参数来指定日志文件位置。

配置好 OceanBase 采集之后，为何 monitor 中无数据显示？¶

大概原因有如下几种可能：

OceanBase 动态库依赖有问题

即使你本机当前可能已经有对应的 OceanBase 包，仍然建议使用上面文档中指定的依赖包且确保其安装路径跟 LD_LIBRARY_PATH 所指定的路径一致。

glibc 版本有问题

由于 OceanBase 采集器是独立编译的，且开启了 CGO，故其运行时需要 glibc 的依赖在 Linux 上可通过如下命令检查当前机器的 glibc 依赖是否有问题：

$ ldd <DataKit 安装目录>/externals/oceanbase
    linux-vdso.so.1 (0x00007ffed33f9000)
    libdl.so.2 => /lib/x86_64-linux-gnu/libdl.so.2 (0x00007f70144e1000)
    libpthread.so.0 => /lib/x86_64-linux-gnu/libpthread.so.0 (0x00007f70144be000)
    libc.so.6 => /lib/x86_64-linux-gnu/libc.so.6 (0x00007f70142cc000)
    /lib64/ld-linux-x86-64.so.2 (0x00007f70144fc000)

如果有报告如下信息，则基本是当前机器上的 glibc 版本较低导致：

externals/oceanbase: /lib64/libc.so.6: version  `GLIBC_2.14` not found (required by externals/oceanbase)

OceanBase 采集器只能在 Linux amd64/ARM64 架构的 DataKit 使用，其它平台均不支持

这意味着 OceanBase 这个采集器只能在 amd64/ARM64 的 Linux 上运行，其它平台一律无法运行当前的 OceanBase 采集器。