This topic explains how to monitor OceanBase Cloud instances using Datadog.
Background information
Datadog is a comprehensive cloud monitoring and analytics platform that provides developers and IT operations teams with real-time insights into the status of their entire technology stack, including applications, services, servers, and containers. Since its creation in 2010, Datadog has rapidly grown to become a popular monitoring solution, especially in cloud computing environments and microservice architectures.
OceanBase Cloud supports integration with Datadog, allowing you to push monitoring data from database clusters to the Datadog platform. The integration process uses OAuth to connect with Datadog, eliminating the need to input an API key, which makes the integration more secure and convenient. Datadog authorization is bound to the OceanBase Cloud user, so the user must have the required roles, such as Project Admin, Instance Admin, or Data Read/Write role. If you are monitoring instances from multiple projects, the user must be granted permissions for each project.
Note
Data push is currently only supported for Dedicated instances.
Prerequisites
The account to be bound must have instance permissions, and the project member must have one of the following roles: Project Admin, Instance Admin, or Data Read/Write. For detailed information on project member permissions, please refer to Manage members.
Configure integration with Datadog
Visit the Datadog Console and log in to your Datadog account.
Complete the configuration in the OceanBase Cloud console.
Navigate to the OceanBase Cloud console.
Click Integrations in the left-side navigation pane.
On the Integrations page, search for Datadog, and click Datadog to open the details page.
Click Connect.
On the authorization page, review the authorization details and click Authorize.
Note
This authorization page will only appear the first time you authorize. Subsequent authorizations will simply notify you of success or failure.
In the Datadog console, navigate to Integrations and search for OceanBase. Add the OceanBase Cloud Dashboard.
After completing the configuration, you will be able to see OceanBase Cloud’s instance monitoring data in the dashboard.
Note
It may take a few minutes for monitoring data to be pushed to Datadog after the initial configuration.
Delete Datadog configuration
Navigate to the OceanBase Cloud console.
Click Integrations in the left-side navigation pane.
On the Integrations page, search for Datadog, and click Datadog to open the details page.
Click Remove. After deletion, OceanBase Cloud will stop pushing monitoring data to Datadog.
Delete the OceanBase API key in the Datadog console.
Note
After clicking Remove, you will also need to delete the Datadog API key. Otherwise, clicking Connect again will result in an error.
Log in to the Datadog console.
Navigate to Organization Settings > API Keys.
Delete the corresponding API key under your profile.
Available monitoring metrics
Metric name |
Description |
|---|---|
| all_session | Current session count |
| clog_trans_log_total_size | Size of transaction logs submitted per second |
| cpu_percent | CPU usage rate |
| load1 | System average load over the past 1 minute |
| memory_used | Physical memory usage |
| net_throughput | Network throughput rate |
| ob_clog_disk_percent | OceanBase log disk usage rate |
| ob_data_disk_percent | Disk usage rate |
| ob_process_exists | OceanBase process status |
| request_queue_time | Time SQL requests spent in the wait queue |
| sql_all_count | Number of SQL statements processed per second |
| sql_all_rt | Average SQL statement processing time |
| transaction_count | Number of transactions processed per second |
| transaction_rt | Average transaction processing time on the server |
| trans_commit_log_count | Number of transaction logs submitted per second |
Common issues
Q: The following error occurs when clicking Connect: Authentication failed, please contact technical support.
A: This might occur because multiple Datadog accounts belong to the same organization, and only one account can successfully apply for an API key. You need to check the API keys information in Datadog to see if an OceanBase API key is already bound.