By default, the telemetry mode of OceanBase Deployer (OBD) is enabled. If you run any of the following commands, OBD collects and desensitizes the host information, cluster information, and operation results of plug-ins, and sends the desensitized information to OceanBase Database.
obd cluster autodeploy
obd cluster deploy
obd cluster start
obd cluster stop
obd cluster reload
obd cluster upgrade
For more information about the preceding commands, see Cluster commands.
Note
OBD 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 performance of OceanBase Database.
Manage telemetry commands
You can enable or disable the telemetry mode by setting the environment variable TELEMETRY_MODE of OBD.
To disable the telemetry mode, run the following command:
obd env set TELEMETRY_MODE 0
To enable the telemetry mode, run the following command:
obd env set TELEMETRY_MODE 1
You can enable or disable telemetry data logging by setting the environment variable TELEMETRY_LOG_MODE of OBD. By default, it is disabled. Once enabled, the telemetry data will be printed to the log file located at ~/.obd/log/obd.
To enable telemetry data logging, run the following command:
obd env set TELEMETRY_LOG_MODE 1
View the collected data
You can open the obd file in the ~/.obd/log/ directory and search for telemetry_data to view the information collected by OBD.
