From f1aa4b1f2d05b6a8942b5abc76b7b57b0c11930a Mon Sep 17 00:00:00 2001 From: "ksahu@digitalocean.com" Date: Tue, 24 Feb 2026 17:34:01 +0530 Subject: [PATCH 1/3] dbaas metrics endpoints --- specification/DigitalOcean-public.v2.yaml | 44 ++++++++++ ...onitoring_get_database_mysql_cpu_usage.yml | 34 ++++++++ ...nitoring_get_database_mysql_disk_usage.yml | 34 ++++++++ ...tabase_mysql_index_vs_sequential_reads.yml | 33 +++++++ .../monitoring_get_database_mysql_load.yml | 35 ++++++++ ...toring_get_database_mysql_memory_usage.yml | 34 ++++++++ ...monitoring_get_database_mysql_op_rates.yml | 34 ++++++++ ...ring_get_database_mysql_schema_latency.yml | 35 ++++++++ ...g_get_database_mysql_schema_throughput.yml | 35 ++++++++ ...ring_get_database_mysql_threads_active.yml | 31 +++++++ ...g_get_database_mysql_threads_connected.yml | 31 +++++++ ...et_database_mysql_threads_created_rate.yml | 31 +++++++ .../resources/monitoring/parameters.yml | 87 +++++++++++++++++++ 13 files changed, 498 insertions(+) create mode 100644 specification/resources/monitoring/monitoring_get_database_mysql_cpu_usage.yml create mode 100644 specification/resources/monitoring/monitoring_get_database_mysql_disk_usage.yml create mode 100644 specification/resources/monitoring/monitoring_get_database_mysql_index_vs_sequential_reads.yml create mode 100644 specification/resources/monitoring/monitoring_get_database_mysql_load.yml create mode 100644 specification/resources/monitoring/monitoring_get_database_mysql_memory_usage.yml create mode 100644 specification/resources/monitoring/monitoring_get_database_mysql_op_rates.yml create mode 100644 specification/resources/monitoring/monitoring_get_database_mysql_schema_latency.yml create mode 100644 specification/resources/monitoring/monitoring_get_database_mysql_schema_throughput.yml create mode 100644 specification/resources/monitoring/monitoring_get_database_mysql_threads_active.yml create mode 100644 specification/resources/monitoring/monitoring_get_database_mysql_threads_connected.yml create mode 100644 specification/resources/monitoring/monitoring_get_database_mysql_threads_created_rate.yml diff --git a/specification/DigitalOcean-public.v2.yaml b/specification/DigitalOcean-public.v2.yaml index 8186078a4..94c931203 100644 --- a/specification/DigitalOcean-public.v2.yaml +++ b/specification/DigitalOcean-public.v2.yaml @@ -1657,6 +1657,50 @@ paths: get: $ref: "resources/monitoring/monitoring_get_droplet_autoscale_target_memory_utilization.yml" + /v2/monitoring/metrics/database/mysql/cpu_usage: + get: + $ref: "resources/monitoring/monitoring_get_database_mysql_cpu_usage.yml" + + /v2/monitoring/metrics/database/mysql/load: + get: + $ref: "resources/monitoring/monitoring_get_database_mysql_load.yml" + + /v2/monitoring/metrics/database/mysql/memory_usage: + get: + $ref: "resources/monitoring/monitoring_get_database_mysql_memory_usage.yml" + + /v2/monitoring/metrics/database/mysql/disk_usage: + get: + $ref: "resources/monitoring/monitoring_get_database_mysql_disk_usage.yml" + + /v2/monitoring/metrics/database/mysql/threads_connected: + get: + $ref: "resources/monitoring/monitoring_get_database_mysql_threads_connected.yml" + + /v2/monitoring/metrics/database/mysql/threads_created_rate: + get: + $ref: "resources/monitoring/monitoring_get_database_mysql_threads_created_rate.yml" + + /v2/monitoring/metrics/database/mysql/threads_active: + get: + $ref: "resources/monitoring/monitoring_get_database_mysql_threads_active.yml" + + /v2/monitoring/metrics/database/mysql/index_vs_sequential_reads: + get: + $ref: "resources/monitoring/monitoring_get_database_mysql_index_vs_sequential_reads.yml" + + /v2/monitoring/metrics/database/mysql/op_rates: + get: + $ref: "resources/monitoring/monitoring_get_database_mysql_op_rates.yml" + + /v2/monitoring/metrics/database/mysql/schema_throughput: + get: + $ref: "resources/monitoring/monitoring_get_database_mysql_schema_throughput.yml" + + /v2/monitoring/metrics/database/mysql/schema_latency: + get: + $ref: "resources/monitoring/monitoring_get_database_mysql_schema_latency.yml" + /v2/monitoring/sinks/destinations: post: $ref: "resources/monitoring/monitoring_create_destination.yml" diff --git a/specification/resources/monitoring/monitoring_get_database_mysql_cpu_usage.yml b/specification/resources/monitoring/monitoring_get_database_mysql_cpu_usage.yml new file mode 100644 index 000000000..2e139a3ff --- /dev/null +++ b/specification/resources/monitoring/monitoring_get_database_mysql_cpu_usage.yml @@ -0,0 +1,34 @@ +operationId: monitoring_get_database_mysql_cpu_usage + +summary: Retrieve MySQL CPU Usage + +description: >- + Retrieve CPU usage (percent) for a MySQL cluster. Response is a time series of + cluster-level CPU usage. Use **aggregate** to get avg, max, or min over the range. + +tags: + - Monitoring + +parameters: + - $ref: 'parameters.yml#/db_id' + - $ref: 'parameters.yml#/aggregate_avg_max_min' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +responses: + "200": + $ref: responses/metric_response.yml + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/specification/resources/monitoring/monitoring_get_database_mysql_disk_usage.yml b/specification/resources/monitoring/monitoring_get_database_mysql_disk_usage.yml new file mode 100644 index 000000000..a0052352c --- /dev/null +++ b/specification/resources/monitoring/monitoring_get_database_mysql_disk_usage.yml @@ -0,0 +1,34 @@ +operationId: monitoring_get_database_mysql_disk_usage + +summary: Retrieve MySQL Disk Usage + +description: >- + Retrieve disk usage (percent) for a MySQL cluster. Use **aggregate** (avg, max, + or min) over the time range. + +tags: + - Monitoring + +parameters: + - $ref: 'parameters.yml#/db_id' + - $ref: 'parameters.yml#/aggregate_avg_max_min' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +responses: + "200": + $ref: responses/metric_response.yml + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/specification/resources/monitoring/monitoring_get_database_mysql_index_vs_sequential_reads.yml b/specification/resources/monitoring/monitoring_get_database_mysql_index_vs_sequential_reads.yml new file mode 100644 index 000000000..5dd26eda8 --- /dev/null +++ b/specification/resources/monitoring/monitoring_get_database_mysql_index_vs_sequential_reads.yml @@ -0,0 +1,33 @@ +operationId: monitoring_get_database_mysql_index_vs_sequential_reads + +summary: Retrieve MySQL Index vs Sequential Reads + +description: >- + Retrieve index vs sequential reads ratio (percent) for a MySQL service — i.e. + percentage of reads using an index. + +tags: + - Monitoring + +parameters: + - $ref: 'parameters.yml#/db_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +responses: + "200": + $ref: responses/metric_response.yml + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/specification/resources/monitoring/monitoring_get_database_mysql_load.yml b/specification/resources/monitoring/monitoring_get_database_mysql_load.yml new file mode 100644 index 000000000..928472741 --- /dev/null +++ b/specification/resources/monitoring/monitoring_get_database_mysql_load.yml @@ -0,0 +1,35 @@ +operationId: monitoring_get_database_mysql_load + +summary: Retrieve MySQL Load Average + +description: >- + Retrieve load average for a MySQL cluster. Use **metric** for load1, load5, or + load15 and **aggregate** for avg or max. + +tags: + - Monitoring + +parameters: + - $ref: 'parameters.yml#/db_id' + - $ref: 'parameters.yml#/metric_load' + - $ref: 'parameters.yml#/aggregate_avg_max' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +responses: + "200": + $ref: responses/metric_response.yml + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/specification/resources/monitoring/monitoring_get_database_mysql_memory_usage.yml b/specification/resources/monitoring/monitoring_get_database_mysql_memory_usage.yml new file mode 100644 index 000000000..310bbfa64 --- /dev/null +++ b/specification/resources/monitoring/monitoring_get_database_mysql_memory_usage.yml @@ -0,0 +1,34 @@ +operationId: monitoring_get_database_mysql_memory_usage + +summary: Retrieve MySQL Memory Usage + +description: >- + Retrieve memory usage (percent) for a MySQL cluster. Use **aggregate** (avg, max, + or min) over the time range. + +tags: + - Monitoring + +parameters: + - $ref: 'parameters.yml#/db_id' + - $ref: 'parameters.yml#/aggregate_avg_max_min' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +responses: + "200": + $ref: responses/metric_response.yml + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/specification/resources/monitoring/monitoring_get_database_mysql_op_rates.yml b/specification/resources/monitoring/monitoring_get_database_mysql_op_rates.yml new file mode 100644 index 000000000..0a2718821 --- /dev/null +++ b/specification/resources/monitoring/monitoring_get_database_mysql_op_rates.yml @@ -0,0 +1,34 @@ +operationId: monitoring_get_database_mysql_op_rates + +summary: Retrieve MySQL Operations Throughput + +description: >- + Retrieve operations rate (per second) for a MySQL service. Use **metric** to + choose select, insert, update, or delete. + +tags: + - Monitoring + +parameters: + - $ref: 'parameters.yml#/db_id' + - $ref: 'parameters.yml#/metric_op_rates' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +responses: + "200": + $ref: responses/metric_response.yml + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/specification/resources/monitoring/monitoring_get_database_mysql_schema_latency.yml b/specification/resources/monitoring/monitoring_get_database_mysql_schema_latency.yml new file mode 100644 index 000000000..00ec76164 --- /dev/null +++ b/specification/resources/monitoring/monitoring_get_database_mysql_schema_latency.yml @@ -0,0 +1,35 @@ +operationId: monitoring_get_database_mysql_schema_latency + +summary: Retrieve MySQL Schema Latency + +description: >- + Retrieve table I/O latency (seconds) for a schema. Requires **schema** and + **metric** (insert, fetch, update, delete). + +tags: + - Monitoring + +parameters: + - $ref: 'parameters.yml#/db_id' + - $ref: 'parameters.yml#/schema' + - $ref: 'parameters.yml#/metric_schema_io' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +responses: + "200": + $ref: responses/metric_response.yml + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/specification/resources/monitoring/monitoring_get_database_mysql_schema_throughput.yml b/specification/resources/monitoring/monitoring_get_database_mysql_schema_throughput.yml new file mode 100644 index 000000000..f8df84466 --- /dev/null +++ b/specification/resources/monitoring/monitoring_get_database_mysql_schema_throughput.yml @@ -0,0 +1,35 @@ +operationId: monitoring_get_database_mysql_schema_throughput + +summary: Retrieve MySQL Schema Throughput + +description: >- + Retrieve table I/O throughput (rows per second) for a schema. Requires **schema** + and **metric** (insert, fetch, update, delete). + +tags: + - Monitoring + +parameters: + - $ref: 'parameters.yml#/db_id' + - $ref: 'parameters.yml#/schema' + - $ref: 'parameters.yml#/metric_schema_io' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +responses: + "200": + $ref: responses/metric_response.yml + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/specification/resources/monitoring/monitoring_get_database_mysql_threads_active.yml b/specification/resources/monitoring/monitoring_get_database_mysql_threads_active.yml new file mode 100644 index 000000000..162723135 --- /dev/null +++ b/specification/resources/monitoring/monitoring_get_database_mysql_threads_active.yml @@ -0,0 +1,31 @@ +operationId: monitoring_get_database_mysql_threads_active + +summary: Retrieve MySQL Threads Active + +description: Retrieve active (running) threads for a MySQL service. + +tags: + - Monitoring + +parameters: + - $ref: 'parameters.yml#/db_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +responses: + "200": + $ref: responses/metric_response.yml + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/specification/resources/monitoring/monitoring_get_database_mysql_threads_connected.yml b/specification/resources/monitoring/monitoring_get_database_mysql_threads_connected.yml new file mode 100644 index 000000000..99356325a --- /dev/null +++ b/specification/resources/monitoring/monitoring_get_database_mysql_threads_connected.yml @@ -0,0 +1,31 @@ +operationId: monitoring_get_database_mysql_threads_connected + +summary: Retrieve MySQL Threads Connected + +description: Retrieve current threads connected for a MySQL service (gauge). + +tags: + - Monitoring + +parameters: + - $ref: 'parameters.yml#/db_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +responses: + "200": + $ref: responses/metric_response.yml + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/specification/resources/monitoring/monitoring_get_database_mysql_threads_created_rate.yml b/specification/resources/monitoring/monitoring_get_database_mysql_threads_created_rate.yml new file mode 100644 index 000000000..b1b6982b5 --- /dev/null +++ b/specification/resources/monitoring/monitoring_get_database_mysql_threads_created_rate.yml @@ -0,0 +1,31 @@ +operationId: monitoring_get_database_mysql_threads_created_rate + +summary: Retrieve MySQL Threads Created Rate + +description: Retrieve threads created rate for a MySQL service (per second). + +tags: + - Monitoring + +parameters: + - $ref: 'parameters.yml#/db_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +responses: + "200": + $ref: responses/metric_response.yml + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/specification/resources/monitoring/parameters.yml b/specification/resources/monitoring/parameters.yml index 72f7561eb..7bf9fceb3 100644 --- a/specification/resources/monitoring/parameters.yml +++ b/specification/resources/monitoring/parameters.yml @@ -119,3 +119,90 @@ sink_uuid: schema: type: string example: 78b172b6-52c3-4a4b-96d5-78d3f1a0b18c + +# DBaaS MySQL monitoring metrics parameters + +db_id: + in: query + name: db_id + required: true + description: The DBaaS cluster UUID (database ID). + schema: + type: string + format: uuid + example: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + +aggregate_avg_max_min: + in: query + name: aggregate + required: true + description: Aggregation over the time range: avg, max, or min. + schema: + type: string + enum: + - avg + - max + - min + example: avg + +aggregate_avg_max: + in: query + name: aggregate + required: true + description: Aggregation over the time range: avg or max. + schema: + type: string + enum: + - avg + - max + example: avg + +metric_load: + in: query + name: metric + required: true + description: Load average window: load1, load5, or load15. + schema: + type: string + enum: + - load1 + - load5 + - load15 + example: load1 + +metric_op_rates: + in: query + name: metric + required: true + description: Operation type: select, insert, update, or delete. + schema: + type: string + enum: + - select + - insert + - update + - delete + example: select + +metric_schema_io: + in: query + name: metric + required: true + description: Table I/O operation: insert, fetch, update, or delete. + schema: + type: string + enum: + - insert + - fetch + - update + - delete + example: insert + +schema: + in: query + name: schema + required: true + description: The schema (database) name. + schema: + type: string + example: defaultdb From e9c3b902c9a69ee5ff0232a28628c628c0622479 Mon Sep 17 00:00:00 2001 From: "ksahu@digitalocean.com" Date: Tue, 24 Feb 2026 17:53:07 +0530 Subject: [PATCH 2/3] correct metrics display name --- .../monitoring/monitoring_get_database_mysql_cpu_usage.yml | 2 +- .../monitoring/monitoring_get_database_mysql_disk_usage.yml | 2 +- .../monitoring_get_database_mysql_index_vs_sequential_reads.yml | 2 +- .../resources/monitoring/monitoring_get_database_mysql_load.yml | 2 +- .../monitoring/monitoring_get_database_mysql_memory_usage.yml | 2 +- .../monitoring/monitoring_get_database_mysql_op_rates.yml | 2 +- .../monitoring/monitoring_get_database_mysql_schema_latency.yml | 2 +- .../monitoring_get_database_mysql_schema_throughput.yml | 2 +- .../monitoring/monitoring_get_database_mysql_threads_active.yml | 2 +- .../monitoring_get_database_mysql_threads_connected.yml | 2 +- .../monitoring_get_database_mysql_threads_created_rate.yml | 2 +- 11 files changed, 11 insertions(+), 11 deletions(-) diff --git a/specification/resources/monitoring/monitoring_get_database_mysql_cpu_usage.yml b/specification/resources/monitoring/monitoring_get_database_mysql_cpu_usage.yml index 2e139a3ff..ff8faa330 100644 --- a/specification/resources/monitoring/monitoring_get_database_mysql_cpu_usage.yml +++ b/specification/resources/monitoring/monitoring_get_database_mysql_cpu_usage.yml @@ -1,6 +1,6 @@ operationId: monitoring_get_database_mysql_cpu_usage -summary: Retrieve MySQL CPU Usage +summary: Get Database MySQL CPU Usage Metrics description: >- Retrieve CPU usage (percent) for a MySQL cluster. Response is a time series of diff --git a/specification/resources/monitoring/monitoring_get_database_mysql_disk_usage.yml b/specification/resources/monitoring/monitoring_get_database_mysql_disk_usage.yml index a0052352c..0b8aa0da9 100644 --- a/specification/resources/monitoring/monitoring_get_database_mysql_disk_usage.yml +++ b/specification/resources/monitoring/monitoring_get_database_mysql_disk_usage.yml @@ -1,6 +1,6 @@ operationId: monitoring_get_database_mysql_disk_usage -summary: Retrieve MySQL Disk Usage +summary: Get Database MySQL Disk Usage Metrics description: >- Retrieve disk usage (percent) for a MySQL cluster. Use **aggregate** (avg, max, diff --git a/specification/resources/monitoring/monitoring_get_database_mysql_index_vs_sequential_reads.yml b/specification/resources/monitoring/monitoring_get_database_mysql_index_vs_sequential_reads.yml index 5dd26eda8..10a805023 100644 --- a/specification/resources/monitoring/monitoring_get_database_mysql_index_vs_sequential_reads.yml +++ b/specification/resources/monitoring/monitoring_get_database_mysql_index_vs_sequential_reads.yml @@ -1,6 +1,6 @@ operationId: monitoring_get_database_mysql_index_vs_sequential_reads -summary: Retrieve MySQL Index vs Sequential Reads +summary: Get Database MySQL Index vs Sequential Reads Metrics description: >- Retrieve index vs sequential reads ratio (percent) for a MySQL service — i.e. diff --git a/specification/resources/monitoring/monitoring_get_database_mysql_load.yml b/specification/resources/monitoring/monitoring_get_database_mysql_load.yml index 928472741..96400661d 100644 --- a/specification/resources/monitoring/monitoring_get_database_mysql_load.yml +++ b/specification/resources/monitoring/monitoring_get_database_mysql_load.yml @@ -1,6 +1,6 @@ operationId: monitoring_get_database_mysql_load -summary: Retrieve MySQL Load Average +summary: Get Database MySQL Load Average Metrics description: >- Retrieve load average for a MySQL cluster. Use **metric** for load1, load5, or diff --git a/specification/resources/monitoring/monitoring_get_database_mysql_memory_usage.yml b/specification/resources/monitoring/monitoring_get_database_mysql_memory_usage.yml index 310bbfa64..9691e37cd 100644 --- a/specification/resources/monitoring/monitoring_get_database_mysql_memory_usage.yml +++ b/specification/resources/monitoring/monitoring_get_database_mysql_memory_usage.yml @@ -1,6 +1,6 @@ operationId: monitoring_get_database_mysql_memory_usage -summary: Retrieve MySQL Memory Usage +summary: Get Database MySQL Memory Usage Metrics description: >- Retrieve memory usage (percent) for a MySQL cluster. Use **aggregate** (avg, max, diff --git a/specification/resources/monitoring/monitoring_get_database_mysql_op_rates.yml b/specification/resources/monitoring/monitoring_get_database_mysql_op_rates.yml index 0a2718821..801508137 100644 --- a/specification/resources/monitoring/monitoring_get_database_mysql_op_rates.yml +++ b/specification/resources/monitoring/monitoring_get_database_mysql_op_rates.yml @@ -1,6 +1,6 @@ operationId: monitoring_get_database_mysql_op_rates -summary: Retrieve MySQL Operations Throughput +summary: Get Database MySQL Operations Throughput Metrics description: >- Retrieve operations rate (per second) for a MySQL service. Use **metric** to diff --git a/specification/resources/monitoring/monitoring_get_database_mysql_schema_latency.yml b/specification/resources/monitoring/monitoring_get_database_mysql_schema_latency.yml index 00ec76164..ac0a24a5c 100644 --- a/specification/resources/monitoring/monitoring_get_database_mysql_schema_latency.yml +++ b/specification/resources/monitoring/monitoring_get_database_mysql_schema_latency.yml @@ -1,6 +1,6 @@ operationId: monitoring_get_database_mysql_schema_latency -summary: Retrieve MySQL Schema Latency +summary: Get Database MySQL Schema Latency Metrics description: >- Retrieve table I/O latency (seconds) for a schema. Requires **schema** and diff --git a/specification/resources/monitoring/monitoring_get_database_mysql_schema_throughput.yml b/specification/resources/monitoring/monitoring_get_database_mysql_schema_throughput.yml index f8df84466..206cc2672 100644 --- a/specification/resources/monitoring/monitoring_get_database_mysql_schema_throughput.yml +++ b/specification/resources/monitoring/monitoring_get_database_mysql_schema_throughput.yml @@ -1,6 +1,6 @@ operationId: monitoring_get_database_mysql_schema_throughput -summary: Retrieve MySQL Schema Throughput +summary: Get Database MySQL Schema Throughput Metrics description: >- Retrieve table I/O throughput (rows per second) for a schema. Requires **schema** diff --git a/specification/resources/monitoring/monitoring_get_database_mysql_threads_active.yml b/specification/resources/monitoring/monitoring_get_database_mysql_threads_active.yml index 162723135..f9534212b 100644 --- a/specification/resources/monitoring/monitoring_get_database_mysql_threads_active.yml +++ b/specification/resources/monitoring/monitoring_get_database_mysql_threads_active.yml @@ -1,6 +1,6 @@ operationId: monitoring_get_database_mysql_threads_active -summary: Retrieve MySQL Threads Active +summary: Get Database MySQL Threads Active Metrics description: Retrieve active (running) threads for a MySQL service. diff --git a/specification/resources/monitoring/monitoring_get_database_mysql_threads_connected.yml b/specification/resources/monitoring/monitoring_get_database_mysql_threads_connected.yml index 99356325a..3c2366aca 100644 --- a/specification/resources/monitoring/monitoring_get_database_mysql_threads_connected.yml +++ b/specification/resources/monitoring/monitoring_get_database_mysql_threads_connected.yml @@ -1,6 +1,6 @@ operationId: monitoring_get_database_mysql_threads_connected -summary: Retrieve MySQL Threads Connected +summary: Get Database MySQL Threads Connected Metrics description: Retrieve current threads connected for a MySQL service (gauge). diff --git a/specification/resources/monitoring/monitoring_get_database_mysql_threads_created_rate.yml b/specification/resources/monitoring/monitoring_get_database_mysql_threads_created_rate.yml index b1b6982b5..8b2ca433e 100644 --- a/specification/resources/monitoring/monitoring_get_database_mysql_threads_created_rate.yml +++ b/specification/resources/monitoring/monitoring_get_database_mysql_threads_created_rate.yml @@ -1,6 +1,6 @@ operationId: monitoring_get_database_mysql_threads_created_rate -summary: Retrieve MySQL Threads Created Rate +summary: Get Database MySQL Threads Created Rate Metrics description: Retrieve threads created rate for a MySQL service (per second). From 1b1dad43db6643d1650ce76801c745939bdf3062 Mon Sep 17 00:00:00 2001 From: "ksahu@digitalocean.com" Date: Tue, 24 Feb 2026 18:19:23 +0530 Subject: [PATCH 3/3] update load metrics desc --- .../monitoring_get_database_mysql_load.yml | 5 +++-- specification/resources/monitoring/parameters.yml | 14 ++++++++------ 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/specification/resources/monitoring/monitoring_get_database_mysql_load.yml b/specification/resources/monitoring/monitoring_get_database_mysql_load.yml index 96400661d..2de4dc17e 100644 --- a/specification/resources/monitoring/monitoring_get_database_mysql_load.yml +++ b/specification/resources/monitoring/monitoring_get_database_mysql_load.yml @@ -3,8 +3,9 @@ operationId: monitoring_get_database_mysql_load summary: Get Database MySQL Load Average Metrics description: >- - Retrieve load average for a MySQL cluster. Use **metric** for load1, load5, or - load15 and **aggregate** for avg or max. + Retrieve load metrics for a MySQL cluster. Use **metric** for the window: **load1** (1-minute), + **load5** (5-minute), or **load15** (15-minute). Use **aggregate** to get either the average (avg) + or maximum (max) over that window over the time range. tags: - Monitoring diff --git a/specification/resources/monitoring/parameters.yml b/specification/resources/monitoring/parameters.yml index 7bf9fceb3..750eca70f 100644 --- a/specification/resources/monitoring/parameters.yml +++ b/specification/resources/monitoring/parameters.yml @@ -136,7 +136,7 @@ aggregate_avg_max_min: in: query name: aggregate required: true - description: Aggregation over the time range: avg, max, or min. + description: Aggregation over the time range (avg, max, or min). schema: type: string enum: @@ -149,7 +149,7 @@ aggregate_avg_max: in: query name: aggregate required: true - description: Aggregation over the time range: avg or max. + description: Aggregation over the time range (avg or max). schema: type: string enum: @@ -161,7 +161,9 @@ metric_load: in: query name: metric required: true - description: Load average window: load1, load5, or load15. + description: >- + Load window: **load1** (1-minute), **load5** (5-minute), **load15** (15-minute). The value is + either average or max over that window, depending on the **aggregate** parameter (avg or max). schema: type: string enum: @@ -174,7 +176,7 @@ metric_op_rates: in: query name: metric required: true - description: Operation type: select, insert, update, or delete. + description: Operation type (select, insert, update, or delete). schema: type: string enum: @@ -188,7 +190,7 @@ metric_schema_io: in: query name: metric required: true - description: Table I/O operation: insert, fetch, update, or delete. + description: Table I/O operation (insert, fetch, update, or delete). schema: type: string enum: @@ -205,4 +207,4 @@ schema: description: The schema (database) name. schema: type: string - example: defaultdb + example: defaultdb \ No newline at end of file