This article is applicable to the scenario of independent deployment of obdiag. It can retrieve the troubleshooting information needed to troubleshoot obproxy restart problems with one click, solving the pain point of difficulty in retrieving distributed node information.
Instructions for use
obdiag gather scene run --scene=obproxy.restart [options]
The options are explained below:
Option name |
Is it required |
Data type |
Default value |
Description |
|---|---|---|---|---|
| --scene | Yes | string | Default is empty | Scene name, you can use obdiag gather scene list to see which scenes the current version supports |
| --from | No | string | Default is empty | The start time of log collection, the format is: yyyy-mm-dd hh:mm:ss.
ExplanationIf the obdiag used is a version before V2.0.0, there is no need to add quotation marks when configuring this option, otherwise an error will be reported. V2.0.0 and later versions no longer limit whether to include quotes when configuring this option. |
| --to | No | string | Default is empty | The end time of log collection, the format is: yyyy-mm-dd hh:mm:ss.
ExplanationIf the obdiag used is a version before V2.0.0, there is no need to add quotation marks when configuring this option, otherwise an error will be reported. V2.0.0 and later versions no longer limit whether to include quotes when configuring this option. |
| --since | No | string | Default is empty | The log collects the most recent period of time in the format: <n> <m|h|d>, where n represents the time number to be entered, m represents the minute, h represents the hour, and d represents the day. For example, 30m represents collecting the logs of the last 30 minutes. |
| --store_dir | No | string | Defaults to the current path where the command is executed | The local path where the results are stored. |
| -c | No | string | ~/.obdiag/config.yml |
Configuration file path. |
| --inner_config | No | string | Default is empty | obdiag's own configuration. |
| --config | No | string | Default is empty | Configuration of the cluster to be diagnosed by obdiag, fixed style: --config key1=value1 --config key2=value2.
ExplanationThe parameters that support configuration through this option can be found in obdiag configuration. |
| --config_password | No | string | Default is empty | obdiag When using an encrypted configuration file, you need to pass in the corresponding password through this option.
ExplanationFor details, see Configuration file encryption. |
Usage example
Method 1: Use without configuration file (out of the box)
# OBProxy unexpected restart: collect last 30m by default
obdiag gather scene run --scene=obproxy.restart \
--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
# Use --since for OBProxy restart collection window
obdiag gather scene run --scene=obproxy.restart --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
# Use --from/--to for OBProxy restart time range
obdiag gather scene run --scene=obproxy.restart --from "2022-06-30 16:25:00" --to "2022-06-30 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.nodes[2].ip=xx.xx.xx.3 \
--config obproxy.servers.global.home_path=/home/admin/obproxy
Method 2: Use with configuration file
You need to ensure that the login information of the node to be collected has been configured in the obdiag configuration file config.yml. For related detailed configuration introduction, see obdiag configuration.
# OBProxy unexpected restart: collect last 30m by default
obdiag gather scene run --scene=obproxy.restart
# Use --since for OBProxy restart collection window
obdiag gather scene run --scene=obproxy.restart --since 30m
# Use --from/--to for OBProxy restart time range
obdiag gather scene run --scene=obproxy.restart --from "2022-06-30 16:25:00" --to "2022-06-30 18:30:00"
Interpretation of results
After the command is executed, a folder will be generated in the specified directory. The folder looks like: obdiag_gather_pack_20240808105846
# tree
.
├── result_summary.txt
├── shell_result.txt # Node info for OBProxy unexpected restart
└── obproxy_log_remote_xx.xx.xx.xx_20240808201458_20240808204558.zip # OBProxy node logs
Practical cases
Case: A user encounters the problem of obproxy restarting for no reason and needs to troubleshoot. Directly execute the following command to package the information required for diagnosis and send it to the community forum or frontline support personnel.
obdiag gather scene run --scene=obproxy.restart \
--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