observer.px_collect_log|V3.0.0|OceanBase Diagnostic Tool |docs|OceanBase Documentations

If OceanBase Diagnostic Tool (obdiag) is independently deployed, you can specify the·observer.px_collect_log scenario in the obdiag gather scene run command to collect the information required for analyzing parallel execution (PX) errors. The command helps address the pain point in collecting information on distributed nodes.

Syntax

obdiag gather scene run --scene=observer.px_collect_log [options]

The following table describes the options.

Option	Required?	Data type	Default value	Description
--scene	Yes	string	Empty	The name of the scenario. You can run the `obd obdiag gather scene list` command to view the scenarios supported by the current version.
--env	Yes	string	Empty	Additional parameters to be collected for this scenario.
--store_dir	No	string	The current path where the command is executed	The local path where the results are stored.
-c	No	string	`~/.obdiag/config.yml`	The path of the configuration file.
--temp_dir	No	string	`/tmp`	The directory where temporary files generated by the remote node during log collection are stored.
--inner_config	No	string	Empty	The configurations of obdiag.
--config	No	string	Empty	The configurations of the cluster diagnosed by obdiag, in the format of `--config key1=value1 --config key2=value2`. Note For information about the parameters supported by this option, see Configure obdiag.

Examples

Method 1: Use the command out-of-the-box without a configuration file

# Collect information for PX errors. If you do not specify any other options, the command collects the information of the last 30 minutes.
obdiag gather scene run --scene=observer.px_collect_log --env "{trace_id='Yxx', estimated_time='2024-08-08 23:17:59'}"  \
    --config db_host=xx.xx.xx.xx \
    --config db_port=xxxx \
    --config tenant_sys.user=root@sys \
    --config tenant_sys.password=*** \
    --config obcluster.servers.global.ssh_username=test \
    --config obcluster.servers.global.ssh_password=****** \
    --config obcluster.servers.global.home_path=/home/admin/oceanbase

Method 2: Use the command with a configuration file

Before you run the command, make sure that you have configured the logon information of the target nodes in the config.yml configuration file of obdiag. For more information, see Configure obdiag.

# Collect information for PX errors. If you do not specify any other options, the command collects the information of the last 30 minutes.
obdiag gather scene run --scene=observer.px_collect_log --env "{trace_id='Yxx', estimated_time='2024-08-08 23:17:59'}"

Results

The command generates a folder in the specified directory. A sample folder name is obdiag_gather_pack_20240808105846.

#tree
.
├── ob_log_xx.xx.xx.xx_20240611190059_20240611193159.zip # The PX logs of the source node that reports an error.
├── result_summary.txt

Cases

When a PX error occurs, you can run the following command to collect the information required for diagnostics. Then, you can post the information on theOceanBase community forum or send it to OceanBase Technical Support.

obdiag gather scene run --scene=observer.px_collect_log --env "{trace_id='Yxx', estimated_time='2024-08-08 23:17:59'}" \
    --config db_host=xx.xx.xx.xx \
    --config db_port=xxxx \
    --config tenant_sys.user=root@sys \
    --config tenant_sys.password=*** \
    --config obcluster.servers.global.ssh_username=test \
    --config obcluster.servers.global.ssh_password=****** \
    --config obcluster.servers.global.home_path=/home/admin/oceanbase