OceanBase
English日本語简体中文
Docs Home
Products
Integrations
Release Notes

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service
OceanBase DatabaseOceanBase Cloud ToolsConnectors and MiddlewareLifecycle Support Policy

OceanBase Diagnostic Tool

V1.5.0
  • Overview
  • Install obdiag
  • Configure obdiag
  • Clustor monitor
    • Use obdiag to inspect an OceanBase cluster
    • Inspection metrics
  • Use obdiag to collect information
  • Use obdiag for diagnostic analysis
  • Telemetry mode
  • FAQ
  • Relase note
    • obdiag V1.5.0
    • obdiag V1.4.0
    • obdiag V1.3.0

Download PDF

Document Feedback
  1. Documentation Center
  2. OceanBase Diagnostic Tool
  3. V1.5.0

Telemetry mode

Last Updated:2026-09-04 08:22:11

Manage telemetry commands
View the collected data

By default, the telemetry mode of OceanBase Diagnostic Tool (obdiag) is enabled. If you run an obdiag command, obdiag collects cluster information, tenant information, and the names of failed inspection items.

obdiag desensitizes the sensitive data, such as IP addresses, that is collected in telemetry mode. With the collected data, OceanBase can better understand how users manipulate OceanBase Database and identify possible issues, thereby improving the structure of obdiag and the performance of OceanBase Database.

Manage telemetry commands

You can enable or disable the telemetry mode by setting the _telemetry parameter_ in the configuration file of obdiag. The path of the configuration file is ${obdiag_install_dir}/conf/inner_config.yml. The following sample code disables the telemetry mode:

obdiag:
  basic:
    config_path: ~/.obdiag/config.yml
    config_backup_dir: ~/.obdiag/backup_conf
    file_number_limit: 20
    file_size_limit: 2G
    telemetry: False



*******
******
****

View the collected data

You can open the .obdiag_telemetry.txt file in the ~/.obdiag/ directory to view the information collected by obdiag.

Previous topic

Use obdiag for diagnostic analysis
Last

Next topic

FAQ
Next
on this page
Manage telemetry commands
View the collected data