diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index e52dfb1fd..069abd127 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1123,6 +1123,8 @@ /celerdata/assets/dashboards @yandongxiao yandongxiao@starrocks.com @DataDog/documentation @DataDog/reporting-and-sharing @DataDog/agent-integrations /celerdata/assets/monitors @yandongxiao yandongxiao@starrocks.com @DataDog/documentation @DataDog/alerting-product @DataDog/agent-integrations +/oceanbasecloud/ @kyle-oceanbase kyle.sj@oceanbase.com @DataDog/ecosystems-review + # LEAVE THE FOLLOWING LOG OWNERSHIP LAST IN THE FILE # Make sure logs team is the full owner for all logs related files **/assets/logs/ @DataDog/logs-backend diff --git a/oceanbasecloud/CHANGELOG.md b/oceanbasecloud/CHANGELOG.md new file mode 100644 index 000000000..0ae40f4d6 --- /dev/null +++ b/oceanbasecloud/CHANGELOG.md @@ -0,0 +1,8 @@ +# CHANGELOG - OceanBaseCloud + +## 1.0.0 / 2024-10-03 + +***Added***: + +* Initial Release + diff --git a/oceanbasecloud/README.md b/oceanbasecloud/README.md new file mode 100644 index 000000000..42b2d73af --- /dev/null +++ b/oceanbasecloud/README.md @@ -0,0 +1,53 @@ +# OceanBase Cloud Integration + +## Overview + +[OceanBase Database][1] is a distributed relational database. OceanBase Database adopts an independently developed integrated architecture, which encompasses both the scalability of a distributed architecture and the performance advantage of a centralized architecture. + +[OceanBase Cloud][2] provides fully managed database services with elastic scalability, ultra-fast performance, and high compatibility on global cloud infrastructure. + +With the Oceanbase Cloud integration, users can collect various monitoring data for database clusters created on OceanBase Cloud in Datadog, including operating status, cluster performance, and cluster health. + +## Setup + +To set up the OceanBase Cloud Datadog integration for your cluster, please refer to the following steps +1. Log in to the Datadog console. + a. Choose the right site from [Datadog sites][3]. + b. Log in using your Dotadog credentials. +2. Log in to the OceanBase Cloud console using your OceanBase Cloud credentials, navigate to the [Integrations][4] page, and search for the Datadog integration. +3. Click Connect. You will be redirected to the Datadog authorization page. If you have not logged in to Datadog before this step, you will need to select the appropriate site and log in on the opened authorization page. +4. Click Authorize. You will then be redirected back to the OceanBase Cloud console. A notification will appear if the authorization is successful. Contact OceanBase Cloud technical support if an error occurs. +5. Search for OceanBase in the Datadog console, and click Install. The monitoring data for your OceanBase Cloud instance will appear in a few minutes on the Datadog Dashboards page. + +## Uninstallation + +1. Log in to the OceanBase Cloud console, go to [OceanBase Cloud Integrations][4], and search the Datadog product. +2. Click remove button, a notification will be displayed if successful. + +Once this integration has been uninstalled, any previous authorizations are revoked. +Additionally, ensure that all API keys associated with this integration have been disabled by searching for the integration name on the API Keys page. + +## Data Collected + +### Metrics + +See [metadata.csv][5] for a list of metrics provided by this check. + +### Service Checks + +The OceanBase Cloud integration does not include any service checks. + +### Events + +The OceanBase Cloud integration does not include any events. + +## Troubleshooting + +Need help? Contact [OceanBase support][6]. + +[1]: https://en.oceanbase.com +[2]: https://en.oceanbase.com/product/cloud +[3]: https://docs.datadoghq.com/getting_started/site +[4]: https://cloud.oceanbase.com/integrations +[5]: https://github.com/DataDog/integrations-extras/blob/master/oceanbasecloud/metadata.csv +[6]: https://en.oceanbase.com/docs/oceanbase-cloud diff --git a/oceanbasecloud/assets/dashboards/oceanbasecloud_overview.json b/oceanbasecloud/assets/dashboards/oceanbasecloud_overview.json new file mode 100644 index 000000000..855aaebac --- /dev/null +++ b/oceanbasecloud/assets/dashboards/oceanbasecloud_overview.json @@ -0,0 +1,1155 @@ +{ + "title": "OceanBase Cloud Overview", + "description": "OceanBase Database is an enterprise-level, native distributed database. This dashboard showcases important insights and metrics enabling you to monitor your clusters on OceanBase Cloud", + "widgets": [ + { + "id": 5956115988175004, + "definition": { + "title": "", + "background_color": "blue", + "show_title": false, + "type": "group", + "layout_type": "ordered", + "widgets": [ + { + "id": 3350333673681556, + "definition": { + "type": "image", + "url": "https://mass-office.alipay.com/design_kitchen/afts/img/mETQR7_-Sh8AAAAAAAAAABAADmmSAQBr/original", + "sizing": "contain", + "margin": "md", + "has_background": false, + "has_border": false, + "vertical_align": "center", + "horizontal_align": "right" + }, + "layout": { + "x": 0, + "y": 0, + "width": 6, + "height": 2 + } + }, + { + "id": 2461329472428800, + "definition": { + "type": "note", + "content": "**About OceanBase**\n\nOceanBase Database is an enterprise-level, native distributed database. This dashboard provides a high-level overview of OceanBase clusters to track host, sql and transaction performance.\n", + "background_color": "white", + "font_size": "14", + "text_align": "left", + "vertical_align": "top", + "show_tick": false, + "tick_pos": "50%", + "tick_edge": "left", + "has_padding": true + }, + "layout": { + "x": 0, + "y": 2, + "width": 3, + "height": 3 + } + }, + { + "id": 3155758642319508, + "definition": { + "type": "note", + "content": "**Further reading:** \n\n- [Monitor data of OceanBase Cloud with Datadog](https://en.oceanbase.com/docs/cloud-oceanbase-cloud-10000000001576416)", + "background_color": "white", + "font_size": "14", + "text_align": "left", + "vertical_align": "top", + "show_tick": false, + "tick_pos": "50%", + "tick_edge": "left", + "has_padding": true + }, + "layout": { + "x": 3, + "y": 2, + "width": 3, + "height": 3 + } + } + ] + }, + "layout": { + "x": 0, + "y": 0, + "width": 6, + "height": 6 + } + }, + { + "id": 8630190554999190, + "definition": { + "title": "Overview", + "background_color": "vivid_pink", + "show_title": true, + "type": "group", + "layout_type": "ordered", + "widgets": [ + { + "id": 102530281599378, + "definition": { + "type": "note", + "content": "A high-level overview of OceanBase clusters. ", + "background_color": "blue", + "font_size": "14", + "text_align": "center", + "vertical_align": "center", + "show_tick": false, + "tick_pos": "50%", + "tick_edge": "left", + "has_padding": true + }, + "layout": { + "x": 0, + "y": 0, + "width": 6, + "height": 1 + } + }, + { + "id": 4041328274158394, + "definition": { + "title": "Cluster QPS top5", + "title_size": "16", + "title_align": "left", + "type": "toplist", + "requests": [ + { + "queries": [ + { + "data_source": "metrics", + "name": "query1", + "query": "max:oceanbasecloud.all_session{$ob_cluster_name} by {ob_cluster_name}", + "aggregator": "avg" + } + ], + "response_format": "scalar", + "formulas": [ + { + "formula": "query1" + } + ], + "sort": { + "count": 5, + "order_by": [ + { + "type": "formula", + "index": 0, + "order": "desc" + } + ] + } + } + ], + "style": { + "display": { + "type": "stacked", + "legend": "automatic" + } + } + }, + "layout": { + "x": 0, + "y": 1, + "width": 3, + "height": 4 + } + }, + { + "id": 2158465339267900, + "definition": { + "title": "Cluster Load top5", + "title_size": "16", + "title_align": "left", + "type": "toplist", + "requests": [ + { + "queries": [ + { + "data_source": "metrics", + "name": "query1", + "query": "max:oceanbasecloud.load1{$ob_cluster_name} by {ob_cluster_name}", + "aggregator": "avg" + } + ], + "response_format": "scalar", + "formulas": [ + { + "formula": "query1" + } + ], + "sort": { + "count": 5, + "order_by": [ + { + "type": "formula", + "index": 0, + "order": "desc" + } + ] + } + } + ], + "style": { + "display": { + "type": "stacked", + "legend": "automatic" + } + } + }, + "layout": { + "x": 3, + "y": 1, + "width": 3, + "height": 4 + } + } + ] + }, + "layout": { + "x": 6, + "y": 0, + "width": 6, + "height": 6 + } + }, + { + "id": 7564094925683824, + "definition": { + "title": "Performance and SQL", + "title_align": "center", + "background_color": "vivid_orange", + "show_title": true, + "type": "group", + "layout_type": "ordered", + "widgets": [ + { + "id": 1193205640149151, + "definition": { + "type": "note", + "content": "These metrics help analyze SQL performance.", + "background_color": "blue", + "font_size": "14", + "text_align": "center", + "vertical_align": "center", + "show_tick": false, + "tick_pos": "50%", + "tick_edge": "left", + "has_padding": true + }, + "layout": { + "x": 0, + "y": 0, + "width": 12, + "height": 1 + } + }, + { + "id": 8839969714398146, + "definition": { + "title": "QPS", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1" + } + ], + "queries": [ + { + "data_source": "metrics", + "name": "query1", + "query": "avg:oceanbasecloud.sql_all_count{$tenant_name} by {ob_cluster_name,tenant_name}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "dog_classic", + "order_by": "values", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 0, + "y": 1, + "width": 6, + "height": 4 + } + }, + { + "id": 856861007312992, + "definition": { + "title": "Sql Request Time", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1", + "number_format": { + "unit": { + "type": "canonical_unit", + "unit_name": "millisecond" + } + } + } + ], + "queries": [ + { + "data_source": "metrics", + "name": "query1", + "query": "avg:oceanbasecloud.sql_all_rt{$ob_cluster_name,$tenant_name} by {ob_cluster_name,tenant_name}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "dog_classic", + "order_by": "values", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 6, + "y": 1, + "width": 6, + "height": 4 + } + }, + { + "id": 7602096901735852, + "definition": { + "title": "Number of sessions", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1" + } + ], + "queries": [ + { + "data_source": "metrics", + "name": "query1", + "query": "avg:oceanbasecloud.all_session{$ob_cluster_name,$tenant_name} by {ob_cluster_name,tenant_name}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "dog_classic", + "order_by": "values", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 0, + "y": 5, + "width": 6, + "height": 4 + } + }, + { + "id": 5889700880357092, + "definition": { + "title": "Request waiting queue time consuming", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1", + "number_format": { + "unit": { + "type": "canonical_unit", + "unit_name": "microsecond" + } + } + } + ], + "queries": [ + { + "data_source": "metrics", + "name": "query1", + "query": "avg:oceanbasecloud.request_queue_time{$ob_cluster_name,$tenant_name} by {ob_cluster_name,tenant_name}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "dog_classic", + "order_by": "values", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 6, + "y": 5, + "width": 6, + "height": 4 + } + } + ] + }, + "layout": { + "x": 0, + "y": 6, + "width": 12, + "height": 10 + } + }, + { + "id": 6721016273444172, + "definition": { + "title": "Transaction", + "title_align": "center", + "background_color": "vivid_orange", + "show_title": true, + "type": "group", + "layout_type": "ordered", + "widgets": [ + { + "id": 971308017505021, + "definition": { + "type": "note", + "content": "Display metrics related to database transactions.", + "background_color": "blue", + "font_size": "14", + "text_align": "center", + "vertical_align": "center", + "show_tick": false, + "tick_pos": "50%", + "tick_edge": "left", + "has_padding": true + }, + "layout": { + "x": 0, + "y": 0, + "width": 12, + "height": 1 + } + }, + { + "id": 258303558111630, + "definition": { + "title": "TPS", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1" + } + ], + "queries": [ + { + "data_source": "metrics", + "name": "query1", + "query": "avg:oceanbasecloud.transaction_count{$ob_cluster_name,$tenant_name} by {ob_cluster_name,tenant_name}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "dog_classic", + "order_by": "values", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 0, + "y": 1, + "width": 6, + "height": 4 + } + }, + { + "id": 1900797583681240, + "definition": { + "title": "Transaction response time", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1", + "number_format": { + "unit": { + "type": "canonical_unit", + "unit_name": "millisecond" + } + } + } + ], + "queries": [ + { + "data_source": "metrics", + "name": "query1", + "query": "avg:oceanbasecloud.transaction_rt{$ob_cluster_name,$tenant_name} by {ob_cluster_name,tenant_name}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "dog_classic", + "order_by": "values", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 6, + "y": 1, + "width": 6, + "height": 4 + } + }, + { + "id": 3021928820277280, + "definition": { + "title": "Trans Log Commit Count", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1" + } + ], + "queries": [ + { + "data_source": "metrics", + "name": "query1", + "query": "avg:oceanbasecloud.trans_commit_log_count{$ob_cluster_name,$tenant_name} by {ob_cluster_name,tenant_name}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "dog_classic", + "order_by": "values", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 0, + "y": 5, + "width": 6, + "height": 4 + } + }, + { + "id": 6503063283527044, + "definition": { + "title": "Transaction log size submitted", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1", + "number_format": { + "unit": { + "type": "canonical_unit", + "unit_name": "byte" + } + } + } + ], + "queries": [ + { + "data_source": "metrics", + "name": "query1", + "query": "avg:oceanbasecloud.clog_trans_log_total_size{$ob_cluster_name,$tenant_name} by {ob_cluster_name,tenant_name}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "dog_classic", + "order_by": "values", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 6, + "y": 5, + "width": 6, + "height": 4 + } + } + ] + }, + "layout": { + "x": 0, + "y": 16, + "width": 12, + "height": 10 + } + }, + { + "id": 4282240643153284, + "definition": { + "title": "Host Performance", + "title_align": "center", + "background_color": "vivid_orange", + "show_title": true, + "type": "group", + "layout_type": "ordered", + "widgets": [ + { + "id": 2116558682089828, + "definition": { + "type": "note", + "content": "Display performance metrics of nodes, facilitating analysis of performance bottlenecks.", + "background_color": "blue", + "font_size": "14", + "text_align": "center", + "vertical_align": "center", + "show_tick": false, + "tick_pos": "50%", + "tick_edge": "left", + "has_padding": true + }, + "layout": { + "x": 0, + "y": 0, + "width": 12, + "height": 1 + } + }, + { + "id": 8755331197405978, + "definition": { + "title": "Load", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1" + } + ], + "queries": [ + { + "data_source": "metrics", + "name": "query1", + "query": "avg:oceanbasecloud.load1{$ob_cluster_name,$host_name} by {host_name,ob_cluster_name}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "dog_classic", + "order_by": "values", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 0, + "y": 1, + "width": 6, + "height": 4 + } + }, + { + "id": 2363424764926658, + "definition": { + "title": "CPU Percent", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1", + "number_format": { + "unit": { + "type": "canonical_unit", + "unit_name": "percent" + } + } + } + ], + "queries": [ + { + "data_source": "metrics", + "name": "query1", + "query": "avg:oceanbasecloud.cpu_percent{$ob_cluster_name,$host_name} by {ob_cluster_name,host_name}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "dog_classic", + "order_by": "values", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 6, + "y": 1, + "width": 6, + "height": 4 + } + }, + { + "id": 5100067898298036, + "definition": { + "title": "Memory", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1", + "number_format": { + "unit": { + "type": "canonical_unit", + "unit_name": "percent" + } + } + } + ], + "queries": [ + { + "data_source": "metrics", + "name": "query1", + "query": "avg:oceanbasecloud.memory_used{$ob_cluster_name,$host_name} by {ob_cluster_name,host_name}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "dog_classic", + "order_by": "values", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 0, + "y": 5, + "width": 6, + "height": 4 + } + }, + { + "id": 3014500845399474, + "definition": { + "title": "Network Throughput", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1", + "number_format": { + "unit": { + "type": "canonical_unit", + "unit_name": "mebibyte" + } + } + } + ], + "queries": [ + { + "data_source": "metrics", + "name": "query1", + "query": "avg:oceanbasecloud.net_throughput{$ob_cluster_name,$host_name} by {ob_cluster_name,host_name}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "dog_classic", + "order_by": "values", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 6, + "y": 5, + "width": 6, + "height": 4 + } + }, + { + "id": 7183857442264658, + "definition": { + "title": "OB Clog Disk Usage", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1", + "number_format": { + "unit": { + "type": "canonical_unit", + "unit_name": "percent" + } + } + } + ], + "queries": [ + { + "data_source": "metrics", + "name": "query1", + "query": "avg:oceanbasecloud.ob_clog_disk_percent{$ob_cluster_name,$host_name} by {ob_cluster_name,host_name}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "dog_classic", + "order_by": "values", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 0, + "y": 9, + "width": 6, + "height": 4 + } + }, + { + "id": 2391245474255482, + "definition": { + "title": "OB Data Disk Usage", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1", + "number_format": { + "unit": { + "type": "canonical_unit", + "unit_name": "percent" + } + } + } + ], + "queries": [ + { + "data_source": "metrics", + "name": "query1", + "query": "avg:oceanbasecloud.ob_data_disk_percent{$ob_cluster_name,$host_name} by {ob_cluster_name,host_name}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "dog_classic", + "order_by": "values", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 6, + "y": 9, + "width": 6, + "height": 4 + } + }, + { + "id": 353434617129980, + "definition": { + "title": "OB Process Exists Status", + "title_size": "16", + "title_align": "left", + "show_legend": true, + "legend_layout": "auto", + "legend_columns": [ + "avg", + "min", + "max", + "value", + "sum" + ], + "type": "timeseries", + "requests": [ + { + "formulas": [ + { + "formula": "query1" + } + ], + "queries": [ + { + "data_source": "metrics", + "name": "query1", + "query": "avg:oceanbasecloud.ob_process_exists{$ob_cluster_name,$host_name} by {ob_cluster_name,host_name}" + } + ], + "response_format": "timeseries", + "style": { + "palette": "dog_classic", + "order_by": "values", + "line_type": "solid", + "line_width": "normal" + }, + "display_type": "line" + } + ] + }, + "layout": { + "x": 0, + "y": 13, + "width": 6, + "height": 4 + } + } + ] + }, + "layout": { + "x": 0, + "y": 0, + "width": 12, + "height": 18, + "is_column_break": true + } + } + ], + "template_variables": [ + { + "name": "ob_cluster_name", + "prefix": "ob_cluster_name", + "available_values": [], + "default": "*" + }, + { + "name": "host_name", + "prefix": "host_name", + "available_values": [], + "default": "*" + }, + { + "name": "tenant_name", + "prefix": "tenant_name", + "available_values": [], + "default": "*" + } + ], + "layout_type": "ordered", + "notify_list": [], + "template_variable_presets": [ + { + "name": "test", + "template_variables": [ + { + "name": "ob_cluster_name", + "value": "ob5o8us4o266tc" + }, + { + "name": "host_name", + "value": "i-02b3be929ed06bd60" + } + ] + } + ], + "reflow_type": "fixed" +} \ No newline at end of file diff --git a/oceanbasecloud/assets/oauth_clients.json b/oceanbasecloud/assets/oauth_clients.json new file mode 100644 index 000000000..09058f453 --- /dev/null +++ b/oceanbasecloud/assets/oauth_clients.json @@ -0,0 +1,15 @@ +{ + "integration": { + "scopes": [ + "api_keys_write" + ], + "client_role": "integration", + "name": "oceanbasecloud", + "onboarding_url": "http://oceanbasei-lupr-tern.dev.alipay.net/integrations/Datadog", + "description": "oceanbasecloud oauth", + "redirect_uris": [ + "https://oceanbaseintlconsole-main.test.alipay.net/integrations/Datadog" + ], + "id": "e5cc2972-5890-11ef-b267-da7ad0900002" + } +} diff --git a/oceanbasecloud/assets/service_checks.json b/oceanbasecloud/assets/service_checks.json new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/oceanbasecloud/assets/service_checks.json @@ -0,0 +1 @@ +[] diff --git a/oceanbasecloud/images/logo.svg b/oceanbasecloud/images/logo.svg new file mode 100644 index 000000000..cf0ccd485 --- /dev/null +++ b/oceanbasecloud/images/logo.svg @@ -0,0 +1,680 @@ + + + + diff --git a/oceanbasecloud/images/ob-dashboard.jpg b/oceanbasecloud/images/ob-dashboard.jpg new file mode 100644 index 000000000..92af26628 Binary files /dev/null and b/oceanbasecloud/images/ob-dashboard.jpg differ diff --git a/oceanbasecloud/images/ob-host.jpg b/oceanbasecloud/images/ob-host.jpg new file mode 100644 index 000000000..d0f203eef Binary files /dev/null and b/oceanbasecloud/images/ob-host.jpg differ diff --git a/oceanbasecloud/images/ob-sql.jpg b/oceanbasecloud/images/ob-sql.jpg new file mode 100644 index 000000000..80af8d2c0 Binary files /dev/null and b/oceanbasecloud/images/ob-sql.jpg differ diff --git a/oceanbasecloud/images/ob-transaction.jpg b/oceanbasecloud/images/ob-transaction.jpg new file mode 100644 index 000000000..1ecfbda9c Binary files /dev/null and b/oceanbasecloud/images/ob-transaction.jpg differ diff --git a/oceanbasecloud/manifest.json b/oceanbasecloud/manifest.json new file mode 100644 index 000000000..0a63fb3bc --- /dev/null +++ b/oceanbasecloud/manifest.json @@ -0,0 +1,74 @@ +{ + "manifest_version": "2.0.0", + "app_uuid": "a42252f6-63f8-4da8-bce9-c765f30e7771", + "app_id": "oceanbase-cloud", + "display_on_public_website": true, + "tile": { + "overview": "README.md#Overview", + "configuration": "README.md#Setup", + "uninstallation": "README.md#Uninstallation", + "support": "README.md#Support", + "changelog": "CHANGELOG.md", + "description": "Monitoring OceanBase Cloud clusters with Datadog", + "title": "OceanBase Cloud", + "media": [ + { + "media_type": "image", + "caption": "Overview of the OceanBase Cloud Datadog dashboard", + "image_url": "images/ob-dashboard.jpg" + }, + { + "media_type": "image", + "caption": "Host performance metrics from the OceanBase Cloud Datadog dashboard", + "image_url": "images/ob-host.jpg" + }, + { + "media_type": "image", + "caption": "SQL performance metrics from the OceanBase Cloud Datadog dashboard", + "image_url": "images/ob-sql.jpg" + }, + { + "media_type": "image", + "caption": "Transaction metrics from the OceanBase Cloud Datadog dashboard", + "image_url": "images/ob-transaction.jpg" + } + ], + "classifier_tags": [ + "Supported OS::Linux", + "Supported OS::Windows", + "Supported OS::macOS", + "Offering::Integration", + "Category::Cloud", + "Submitted Data Type::Metrics" + ] + }, + "author": { + "support_email": "eco-products@service.oceanbase.com", + "name": "OceanBase", + "homepage": "https://en.oceanbase.com", + "sales_email": "OceanBaseSales@oceanbase.com" + }, + "assets": { + "integration": { + "auto_install": true, + "source_type_id": 15206722, + "source_type_name": "OceanBase Cloud", + "configuration": {}, + "events": { + "creates_events": false + }, + "metrics": { + "prefix": "oceanbase_cloud", + "check": "oceanbase_cloud.sql_all_count", + "metadata_path": "metadata.csv" + }, + "service_checks": { + "metadata_path": "assets/service_checks.json" + } + }, + "dashboards": { + "OceanBase Cloud Overview": "assets/dashboards/oceanbasecloud_overview.json" + }, + "oauth": "assets/oauth_clients.json" + } +} \ No newline at end of file diff --git a/oceanbasecloud/metadata.csv b/oceanbasecloud/metadata.csv new file mode 100644 index 000000000..1dd58758e --- /dev/null +++ b/oceanbasecloud/metadata.csv @@ -0,0 +1,16 @@ +metric_name,metric_type,interval,unit_name,per_unit_name,description,orientation,integration,short_name,curated_metric +oceanbase_cloud.load1,gauge,,,,Average load over the past one minute,1,oceanbase_cloud,, +oceanbase_cloud.cpu_percent,gauge,,percent,,CPU Percent,1,oceanbase_cloud,, +oceanbase_cloud.memory_used,gauge,,percent,,Used physical memory percent,1,oceanbase_cloud,, +oceanbase_cloud.net_throughput,gauge,,mebibyte,,Network throughput,1,oceanbase_cloud,, +oceanbase_cloud.ob_data_disk_percent,gauge,,percent,,OB Data Disk Usage,1,oceanbase_cloud,, +oceanbase_cloud.ob_clog_disk_percent,gauge,,percent,,OB Clog Disk Usage,1,oceanbase_cloud,, +oceanbase_cloud.ob_process_exists,gauge,,,,OB process existence status,1,oceanbase_cloud,, +oceanbase_cloud.sql_all_count,gauge,,execution,,Number of SQL statements processed per second,1,oceanbase_cloud,, +oceanbase_cloud.sql_all_rt,gauge,,millisecond,,The average processing time of each SQL statement,1,oceanbase_cloud,, +oceanbase_cloud.all_session,gauge,,,,Number of current sessions,1,oceanbase_cloud,, +oceanbase_cloud.request_queue_time,gauge,,microsecond,,Time spent waiting in the request queue,1,oceanbase_cloud,, +oceanbase_cloud.transaction_count,gauge,,transaction,,Transactions per second,1,oceanbase_cloud,, +oceanbase_cloud.transaction_rt,gauge,,millisecond,,Transaction response time,1,oceanbase_cloud,, +oceanbase_cloud.trans_commit_log_count,gauge,,,,Number of transaction logs submitted per second,1,oceanbase_cloud,, +oceanbase_cloud.clog_trans_log_total_size,gauge,,byte,,Transaction log size submitted per second,1,oceanbase_cloud,,