obproxy 日志收集

更新时间：2026-01-15 16:31:17

本文适用于独立部署 obdiag 的场景，使用 obdiag gather obproxy_log 命令可以一键收集所属 OceanBase 集群所依赖的 ODP 的日志。

如果是 obd 部署的集群，可直接通过 obd 侧诊断命令组对所选集群进行信息收集，详细命令可参考诊断工具命令组。

使用说明

obdiag gather obproxy_log [options]

选项说明如下：

选项名	是否必选	数据类型	默认值	说明
--from	否	string	默认为空	日志收集的开始时间，格式为: `yyyy-mm-dd hh:mm:ss`。说明若使用的 obdiag 为 V2.0.0 之前版本，配置该选项时无需加引号，否则会报错。V2.0.0 及之后版本不再限制配置该选项时是否加引号。
--to	否	string	默认为空	日志收集的结束时间，格式为: `yyyy-mm-dd hh:mm:ss`。说明若使用的 obdiag 为 V2.0.0 之前版本，配置该选项时无需加引号，否则会报错。V2.0.0 及之后版本不再限制配置该选项时是否加引号。
--since	否	string	默认为空	日志收集最近的某段时间，格式为: `<n> <m\|h\|d>`，其中，n 表示待输入的时间数字，m 表示分钟，h 表示小时，d 表示天，例如 `30m` 表示收集最近 30 分钟的日志。
--scope	否	string	all	选择查询的 obproxy 日志类型，可配置值为 `obproxy`、`obproxy_digest`、`obproxy_stat`、`obproxy_slow`、`obproxy_limit`、`all`。
--grep	否	string	默认为空	选择查询的关键字。
--store_dir	否	string	默认为命令执行的当前路径	存储结果的本地路径。
-c	否	string	`~/.obdiag/config.yml`	配置文件路径。
--inner_config	否	string	默认为空	obdiag 自用的配置。
--config	否	string	默认为空	需被 obdiag 诊断的集群的配置，固定样式：--config key1=value1 --config key2=value2。说明支持通过该选项配置的参数可参见 obdiag 配置。
--config_password	否	string	默认为空	obdiag 使用加密的配置文件时，需通过该选项传入对应的密码。说明详情可参见配置文件加密。

使用示例

方式一：无配置文件使用（开箱即用）

收集指定时间段的日志

obdiag gather obproxy_log --from "2022-06-25 10:25:00" --to "2022-06-25 18:30:00" \
    --config obproxy.servers.nodes[0].ip=xx.xx.xx.1 \
    --config obproxy.servers.nodes[1].ip=xx.xx.xx.2 \
    --config obproxy.servers.global.ssh_username=test \
    --config obproxy.servers.global.ssh_password=****** \
    --config obproxy.servers.global.home_path=/home/admin/obproxy

输出如下：

...
ZipFileInfo:
+------------------+-----------+
| Node             | LogSize   |
+==================+===========+
| xxx.xxx.xxx.xxx  | 36.184M   |
+------------------+-----------+
...

ZipFileInfo:
+-------------------+-----------+
| Node              | LogSize   |
+===================+===========+
| xxx.xxx.xxx.xxx   | 44.176M   |
+-------------------+-----------+
...

Gather ObProxy Log Summary:
+-------------------+-----------+----------+------------------+--------+------------------------------------------------------------------------------------+
| Node              | Status    | Size     | Password         | Time   | PackPath                                                                           |
+===================+===========+==========+==================+========+====================================================================================+
| xxx.xxx.xxx.xxx   | Completed | 36.762M  | HYmVourcUyRNP8Om | 19 s   | obdiag_gather_pack_20220701183246/obproxy_log_xxx.xxx.xxx.xxx_20220701183247.zip   |
+-------------------+-----------+----------+------------------+--------+------------------------------------------------------------------------------------+
| xxx.xxx.xxx.xxx   | Completed | 638.200M | 1RicMaiLUUNfemnj | 718 s  | obdiag_gather_pack_20220701183246/obproxy_log_xxx.xxx.xxx.xxx_20220701183918.zip   |
+-------------------+-----------+----------+------------------+--------+------------------------------------------------------------------------------------+

快捷收集最近一段时间的日志

# obdiag 到各被收集节点做了免密，收集最近一小时的日志
obdiag gather obproxy_log --since 1h \
  --config obproxy.servers.nodes[0].ip=xx.xx.xx.1 \
  --config obproxy.servers.nodes[1].ip=xx.xx.xx.2 \
  --config obproxy.servers.nodes[2].ip=xx.xx.xx.3 \
  --config obproxy.servers.global.home_path=/home/admin/obproxy

# obdiag 到各被收集节点做了免密，收集最近 30 分钟的日志
obdiag gather obproxy_log --since 30m \
  --config obproxy.servers.nodes[0].ip=xx.xx.xx.1 \
  --config obproxy.servers.nodes[1].ip=xx.xx.xx.2 \
  --config obproxy.servers.nodes[2].ip=xx.xx.xx.3 \
  --config obproxy.servers.global.home_path=/home/admin/obproxy

# 各 obproxy 节点信息不一致，收集最近 30 分钟的日志
obdiag gather obproxy_log --since 30m \
  --config obproxy.servers.nodes[0].ip=xx.xx.xx.1 \
  --config obproxy.servers.nodes[0].ssh_username=test1 \
  --config obproxy.servers.nodes[0].ssh_password=****** \
  --config obproxy.servers.nodes[0].home_path=/home/test1/obproxy \
  --config obproxy.servers.nodes[1].ip=xx.xx.xx.2
  --config obproxy.servers.nodes[1].ssh_username=test2 \
  --config obproxy.servers.nodes[1].ssh_password=****** \
  --config obproxy.servers.nodes[1].home_path=/home/test2/obproxy

方式二：有配置文件使用

需要确保已经在 obdiag 配置文件 config.yml 中配置好需要收集节点的登录信息。相关的详细配置介绍，参见 obdiag 配置。

obdiag gather obproxy_log --from "2022-06-25 10:25:00" --to "2022-06-25 18:30:00"

结果解读

命令执行后在指定目录下会生成一个文件夹，文件夹形如: obdiag_gather_pack_20240808105846。