Skip to content

Commit 99b5ab8

Browse files
everpcpcsoyeric128
everpcpc
authored and
soyeric128
committed
feat: update metrics list for cloud
1 parent 21be2f9 commit 99b5ab8

File tree

1 file changed

+40
-14
lines changed

1 file changed

+40
-14
lines changed

‎docs/en/guides/20-cloud/20-manage/03-metrics.md‎

Lines changed: 40 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Tracking Metrics with Prometheus
33
---
4+
45
import StepsWrap from '@site/src/components/StepsWrap';
56
import StepContent from '@site/src/components/Steps/step-content';
67

@@ -60,14 +61,14 @@ scrape_configs:
6061
region: <REGION>
6162
```
6263
63-
| Placeholder | Description | Example |
64-
|---------------------|--------------------------------------------------|--------------------------------------------------------|
65-
| `<USERNAME>` | The username for the SQL user. | `metrics` |
66-
| `<PASSWORD>` | The secure password for the SQL user. | `metrics_password` |
64+
| Placeholder | Description | Example |
65+
| ------------------- | ------------------------------------------------ | ------------------------------------------------- |
66+
| `<USERNAME>` | The username for the SQL user. | `metrics` |
67+
| `<PASSWORD>` | The secure password for the SQL user. | `metrics_password` |
6768
| `<TENANT_ENDPOINT>` | The endpoint URL for your Databend Cloud tenant. | `tnxxxxxxx.gw.aws-us-east-2.default.databend.com` |
68-
| `<TENANT_ID>` | Your tenant's unique identifier. | `tnxxxxxxx` |
69-
| `<PLATFORM>` | The cloud platform hosting the tenant. | `aws` |
70-
| `<REGION>` | The region where the tenant is hosted. | `us-east-2` |
69+
| `<TENANT_ID>` | Your tenant's unique identifier. | `tnxxxxxxx` |
70+
| `<PLATFORM>` | The cloud platform hosting the tenant. | `aws` |
71+
| `<REGION>` | The region where the tenant is hosted. | `us-east-2` |
7172

7273
2. Start Prometheus with the following command (replace `</path/to/prometheus.yml>` with the full path to your **prometheus.yml** file):
7374

@@ -94,12 +95,16 @@ You're all set! You can now query your tenant metrics directly from Prometheus.
9495

9596
Please note that all metrics are prefixed with `databend_cloud_`.
9697

98+
:::caution
99+
The following metrics are in alpha state and may change over time. We recommend that you monitor the metrics closely and adjust your monitoring setup accordingly.
100+
:::
101+
97102
### Query Metrics
98103

99104
The following is a list of query metrics available in Databend Cloud:
100105

101106
| Name | Type | Labels | Description |
102-
|----------------------|---------|------------------|-------------------------------------|
107+
| -------------------- | ------- | ---------------- | ----------------------------------- |
103108
| query_count | Counter | tenant,warehouse | Query counts made by clients |
104109
| query_errors | Counter | tenant,warehouse | Query error counts made by clients |
105110
| query_request_bytes | Counter | tenant,warehouse | Query request bytes from client |
@@ -110,21 +115,42 @@ The following is a list of query metrics available in Databend Cloud:
110115
The following is a list of storage metrics available in Databend Cloud:
111116

112117
| Name | Type | Labels | Description |
113-
|-------------------------------|-------|--------|-------------------------------------------------------|
118+
| ----------------------------- | ----- | ------ | ----------------------------------------------------- |
114119
| storage_total_size | Guage | tenant | Total size for backend object storage |
115120
| storage_staged_size | Guage | tenant | Total size for staged files on backend object storage |
116121
| storage_table_compressed_size | Guage | tenant | Total size for current tables backend object storage |
122+
| storage_non_current_size | Guage | tenant | Total size for non-current objects in backend storage |
117123

118124
### Warehouse Metrics
119125

120126
The following is a list of warehouse metrics available in Databend Cloud:
121127

122128
| Name | Type | Labels | Description |
123-
|----------------------------------|---------|------------------------------|-----------------------------------------------------|
129+
| -------------------------------- | ------- | ---------------------------- | --------------------------------------------------- |
124130
| warehouse_status | Guage | tenant,warehouse,size,status | Flag for warehouse status (Suspended,Running, etc.) |
125-
| warehouse_session_queued_queries | Guage | tenant,warehouse | Queries waiting in queue currently |
126-
| warehouse_session_connections | Guage | tenant,warehouse | Session Count currently |
127-
| warehouse_storage_requests_count | Counter | tenant,warehouse,scheme,op | Requests count to backend storage |
131+
| warehouse_connections | Guage | tenant,warehouse | Session Count currently |
132+
| warehouse_queries_queued | Guage | tenant,warehouse | Queries waiting in queue currently |
133+
| warehouse_queries_running | Guage | tenant,warehouse | Queries running currently |
134+
| warehouse_queries_start_total | Counter | tenant,warehouse | Queries started total |
135+
| warehouse_queries_failed_total | Counter | tenant,warehouse | Queries failed total |
136+
| warehouse_queries_success_total | Counter | tenant,warehouse | Queries success total |
137+
| warehouse_storage_requests_total | Counter | tenant,warehouse,scheme,op | Requests count to backend storage |
128138
| warehouse_storage_requests_bytes | Counter | tenant,warehouse,scheme,op | Requests bytes from backend storage |
129139
| warehouse_data_scan_rows | Counter | tenant,warehouse | Data rows scanned from backend storage |
130-
| warehouse_data_write_rows | Counter | tenant,warehouse | Data rows written to backend storage |
140+
| warehouse_data_write_rows | Counter | tenant,warehouse | Data rows written to backend storage |
141+
142+
### Task Metrics
143+
144+
The following is a list of task metrics available in Databend Cloud:
145+
146+
| Name | Type | Labels | Description |
147+
| ------------------------------- | ------- | --------------- | -------------------------------- |
148+
| task_scheduled_total | Counter | tenant,task | Total scheduled tasks |
149+
| task_query_requests_total | Counter | tenant,task | Query requests for tasks |
150+
| task_run_skipped_total | Counter | tenant,task | Skipped task runs |
151+
| task_accessor_requests_total | Counter | tenant,function | Accessor requests for tasks |
152+
| task_notification_success_total | Counter | tenant | Successful task notifications |
153+
| task_notification_errors_total | Counter | tenant | Task notification errors |
154+
| task_running_duration_seconds | Counter | tenant,task | Task running duration in seconds |
155+
| task_running | Counter | tenant,task | Running tasks |
156+
| task_scheduled_timestamp | Counter | tenant,task | Scheduled task timestamps |

0 commit comments

Comments
 (0)