Overview

This article applies to the scenario of independently deploying obdiag. Using the obdiag gather command can help collect diagnostic information related to the OceanBase database. The scenes gather command can be executed with one click to retrieve the troubleshooting information required for certain problem scenarios, solving the pain point of difficulty in obtaining distributed node information.

Prerequisites

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.

View currently supported scenarios

obdiag gather scene list

obdiag gather scene run use

obdiag gather scene run --scene={SceneName}

The options are explained below:

Usage example

Method 1: Use without configuration file (out of the box)

obdiag gather scene run --scene={SceneName} \
    --config db_host=xx.xx.xx.xx \
    --config db_port=xxxx \
    --config tenant_sys.user=root@sys \
    --config tenant_sys.password=*** \
    --config obcluster.servers.nodes[0].ip=xx.xx.xx.1 \
    --config obcluster.servers.nodes[1].ip=xx.xx.xx.2 \
    --config obcluster.servers.nodes[2].ip=xx.xx.xx.3 \
    --config obcluster.servers.global.ssh_username=test \
    --config obcluster.servers.global.ssh_password=****** \
    --config obcluster.servers.global.home_path=/home/admin/oceanbase \
    --config obproxy.servers.nodes[0].ip=xx.xx.xx.3 \
    --config obproxy.servers.nodes[1].ip=xx.xx.xx.4 \
    --config obproxy.servers.global.ssh_username=test \
    --config obproxy.servers.global.ssh_password=****** \
    --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.

obdiag gather scene run --scene={SceneName}

Custom scene writing tutorial

A task represents an independent scenario, which can be understood as a professional script file written in yaml and recognized by obdiag.

Before starting to write

Before writing, you need to determine where the yaml needs to be placed.

You can first enter the directory identified by gather.scenes_base_path in the /opt/oceanbase-diagnostic-tool/conf/inner_config.yml file to see if the collection scene you wrote belongs to an existing category. If not, create a folder to declare this category.

Example:```

ssh script

cd ~/.obdiag/gather/tasks/observer touch test.yaml

The above completes the steps before writing

### Start writing

To start writing, start editing our test.yaml

```yaml
# Describe what this scenario does (human-readable summary)

info: "for test"

Simple content is over, complex writing begins, pay attention to details

Scene writing

The function of task is to declare the steps for scene collection execution. In order to be compatible with the differences in steps that may occur in different versions, its basic structure is a list.

The structure of an element of task is as follows

The following is an example

info: testinfo
task:
  - version: "[3.1.0,3.2.4]"
    steps:
     {steps_object}
  - version: [4.2.0.0,4.3.0.0]
    steps:
     {steps_object}

steps is also a list, used to represent multiple specific execution processes.

The structure of an element of steps is a single process, as follows

Examples of various types are as follows. "step:" is just a mark and has no actual effect.

ssh

Execute instructions remotely and obtain the corresponding return value

step:
  type: ssh
  ssh: wc -l /proc/${task_OBServer_pid}/maps | awk '{print $1}'
  global: false # Per-node: true runs once on first node only; false runs on every node

sql

Execute sql and get the corresponding value

step:
 type: sql
 sql: select tenant_name from oceanbase.__all_tenant;
 global: false

log

Collect logs from OceanBase database

step:
 type: log
 grep: "" # Filter pattern
 global: false

obproxy_log

Collect OBProxy logs

step:
 type: obproxy_log
 grep: "" # Filter pattern
 global: false

sysstat

Collect host information

step:
 type: sysstat
 sysstat: ""
 global: false
```<main id="notice" type='explain'>
  <h4>Description</h4>
  <p> The global field is relative to the node. When it is marked true, it will only be executed once when the first node is executed. If it is marked false, it will be executed on each node</p>
</main>