This topic describes how to use OceanBase Diagnostic Tool (obdiag) that is independently deployed to display the information about leaders in an OceanBase cluster.
Syntax
obdiag display scene run --scene=observer.leader [options]
The following table describes the options.
| Option | Required? | Data type | Default value | Description |
|---|---|---|---|---|
| -c | No | string | ~/.obdiag/config.yml |
The path of the configuration file. |
| --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.
NoteFor information about the parameters supported by this option, see Configure obdiag. |
| --env | Yes | string | Empty | Additional parameters required for the obdiag display command, in the format of --env level=${level}, where level specifies the scope of leaders to be queried. Valid values of level are as follows:
|
Examples
Method 1: Use obdiag out-of-the-box without a configuration file
obdiag display scene run --scene=observer.leader --env level=all \
--config db_host=xx.xx.xx.xx \
--config db_port=xxxx \
--config tenant_sys.user=root@sys \
--config tenant_sys.password=***
Method 2: Use obdiag with a configuration file
Before you use obdiag, make sure that you have configured the login information of the target nodes in the config.yml configuration file of obdiag. For more information, see Configure obdiag.
$ obdiag display scene run --scene=observer.leader --env level=all
