This topic applies when obdiag is deployed standalone; one-click collect OBProxy (ODP) parameters.
Description
The obproxy.obproxy_parameter scenario is available since obdiag V3.6.0.
Instructions for use
obdiag gather scene run --scene=obproxy.obproxy_parameter [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 check which scenes are supported by the current version. |
| --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. Fixed style: --inner_config key1=value1 --inner_config key2=value2.
ExplanationThe parameters that support configuration through this option can be found in the obdiag configuration in the System configuration file (obdiag's own configuration) section. |
| --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 the User-side configuration file section of 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)
# Collect OBProxy parameters; default window last 30 minutes when no extra args
obdiag gather scene run --scene=obproxy.obproxy_parameter \
--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 (default path ~/.obdiag/config.yml). For related detailed configuration introduction, see obdiag configuration.
# One-click OBProxy parameter collection
obdiag gather scene run --scene=obproxy.obproxy_parameter
Interpretation of results
After the command is executed, a folder will be generated in the specified directory. The folder is in the shape of obdiag_gather_pack_xxxxx, and there is a file recording ODP parameters in the folder.
sql_result.txt # OBProxy parameters