Skip to content

Commit 3409461

Browse files
authored
cloud: change tidbcloud to tidb_cloud in the names of metrics available to New Relic (#21671)
1 parent f63cc8e commit 3409461

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

tidb-cloud/monitor-new-relic-integration.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ New Relic tracks the following metrics for your TiDB clusters.
146146
| tidb_cloud.db_transaction_per_second| gauge | txn_mode: pessimistic\|optimistic<br/><br/>type: abort\|commit\|...<br/><br/>cluster_name: `<cluster name>`<br/><br/>instance: tidb-0\|tidb-1…<br/><br/>component: `tidb` | The number of transactions executed per second. |
147147
| tidb_cloud.node_storage_used_bytes | gauge | cluster_name: `<cluster name>`<br/><br/>instance: tikv-0\|tikv-1…\|tiflash-0\|tiflash-1…<br/><br/>component: tikv\|tiflash | The disk usage of TiKV/TiFlash nodes, in bytes. |
148148
| tidb_cloud.node_storage_capacity_bytes | gauge | cluster_name: `<cluster name>`<br/><br/>instance: tikv-0\|tikv-1…\|tiflash-0\|tiflash-1…<br/><br/>component: tikv\|tiflash | The disk capacity of TiKV/TiFlash nodes, in bytes. |
149-
| tidb_cloud.node_cpu_seconds_total | count | cluster_name: `<cluster name>`<br/><br/>instance: tidb-0\|tidb-1…\|tikv-0…\|tiflash-0…<br/><br/>component: tidb\|tikv\|tiflash | The CPU usage of TiDB/TiKV/TiFlash nodes. |
149+
| tidb_cloud.node_cpu_seconds_total (Beta only) | count | cluster_name: `<cluster name>`<br/><br/>instance: tidb-0\|tidb-1…\|tikv-0…\|tiflash-0…<br/><br/>component: tidb\|tikv\|tiflash | The CPU usage of TiDB/TiKV/TiFlash nodes. |
150150
| tidb_cloud.node_cpu_capacity_cores | gauge | cluster_name: `<cluster name>`<br/><br/>instance: tidb-0\|tidb-1…\|tikv-0…\|tiflash-0…<br/><br/>component: tidb\|tikv\|tiflash | The limit on CPU cores of TiDB/TiKV/TiFlash nodes. |
151151
| tidb_cloud.node_memory_used_bytes | gauge | cluster_name: `<cluster name>`<br/><br/>instance: tidb-0\|tidb-1…\|tikv-0…\|tiflash-0…<br/><br/>component: tidb\|tikv\|tiflash | The used memory of TiDB/TiKV/TiFlash nodes, in bytes. |
152152
| tidb_cloud.node_memory_capacity_bytes | gauge | cluster_name: `<cluster name>`<br/><br/>instance: tidb-0\|tidb-1…\|tikv-0…\|tiflash-0…<br/><br/>component: tidb\|tikv\|tiflash | The memory capacity of TiDB/TiKV/TiFlash nodes, in bytes. |
@@ -155,17 +155,20 @@ For New Relic integration (Preview), the following additional metrics are also a
155155

156156
| Metric name | Metric type | Labels | Description |
157157
| :------------| :---------- | :------| :----------------------------------------------------- |
158-
| tidbcloud.node_storage_available_bytes | gauge | instance: `tidb-0\|tidb-1\|...`<br/>component: `tikv\|tiflash`<br/>cluster_name: `<cluster name>` | The available disk space in bytes for TiKV or TiFlash nodes. |
159-
| tidbcloud.disk_read_latency | gauge | instance: `tidb-0\|tidb-1\|...`<br/>component: `tikv\|tiflash`<br/>cluster_name: `<cluster name>`<br/>`device`: `nvme.*\|dm.*` | The read latency (in seconds) per storage device. |
160-
| tidbcloud.disk_write_latency | gauge | instance: `tidb-0\|tidb-1\|...`<br/>component: `tikv\|tiflash`<br/>cluster_name: `<cluster name>`<br/>`device`: `nvme.*\|dm.*` | The write latency (in seconds) per storage device. |
161-
| tidbcloud.kv_request_duration | histogram | instance: `tidb-0\|tidb-1\|...`<br/>component: `tikv`<br/>cluster_name: `<cluster name>`<br/>`type`: `BatchGet\|Commit\|Prewrite\|...` | The duration (in seconds) of TiKV requests by type. |
162-
| tidbcloud.component_uptime | gauge | instance: `tidb-0\|tidb-1\|...`<br/>component: `tidb\|tikv\|tiflash`<br/>cluster_name: `<cluster name>` | The uptime (in seconds) of TiDB components. |
163-
| tidbcloud.ticdc_owner_checkpoint_ts_lag | gauge | changefeed_id: `<changefeed-id>`<br/>cluster_name: `<cluster name>`| The checkpoint timestamp lag (in seconds) for changefeed owner. |
164-
| tidbcloud.ticdc_owner_resolved_ts_lag | gauge | changefeed_id: `<changefeed-id>`<br/>cluster_name: `<cluster name>` | The resolved timestamp lag (in seconds) for the changefeed owner. |
165-
| tidbcloud.changefeed_status | gauge | changefeed_id: `<changefeed-id>`<br/>cluster_name: `<cluster name>` | Changefeed status:<br/>`-1`: Unknown<br/>`0`: Normal<br/>`1`: Warning<br/>`2`: Failed<br/>`3`: Stopped<br/>`4`: Finished<br/>`6`: Warning<br/>`7`: Other |
166-
| tidbcloud.resource_manager_resource_unit_read_request_unit | gauge | cluster_name: `<cluster name>`<br/>resource_group: `<group-name>` | The read request units (RUs) consumed by Resource Manager. |
167-
| tidbcloud.resource_manager_resource_unit_write_request_unit | gauge | cluster_name: `<cluster name>`<br/>resource_group: `<group-name>` | The write request units (RUs) consumed by Resource Manager. |
168-
| tidb_cloud.dm_task_state | gauge | instance: `instance`<br/>task: `task`<br/>cluster_name: `<cluster name>` | Task State of Data Migration:<br/>0: Invalid<br/>1: New<br/>2: Running<br/>3: Paused<br/>4: Stopped<br/>5: Finished<br/>15: Error |
169-
| tidb_cloud.dm_syncer_replication_lag_bucket | gauge | instance: `instance`<br/>cluster_name: `<cluster name>` | Replicate lag (bucket) of Data Migration. |
170-
| tidb_cloud.dm_syncer_replication_lag_gauge | gauge | instance: `instance`<br/>task: `task`<br/>cluster_name: `<cluster name>` | Replicate lag (gauge) of Data Migration. |
171-
| tidb_cloud.dm_relay_read_error_count | gauge | instance: `instance`<br/>cluster_name: `<cluster name>` | Fail to read binlog from master. |
158+
| tidb_cloud.node_storage_available_bytes | gauge | instance: `tidb-0\|tidb-1\|...`<br/><br/>component: `tikv\|tiflash`<br/><br/>cluster_name: `<cluster name>` | The available disk space in bytes for TiKV or TiFlash nodes. |
159+
| tidb_cloud.node_disk_read_latency | gauge | instance: `tidb-0\|tidb-1\|...`<br/><br/>component: `tikv\|tiflash`<br/><br/>cluster_name: `<cluster name>`<br/><br/>`device`: `nvme.*\|dm.*` | The read latency (in seconds) per storage device. |
160+
| tidb_cloud.node_disk_write_latency | gauge | instance: `tidb-0\|tidb-1\|...`<br/><br/>component: `tikv\|tiflash`<br/><br/>cluster_name: `<cluster name>`<br/><br/>`device`: `nvme.*\|dm.*` | The write latency (in seconds) per storage device. |
161+
| tidb_cloud.db_kv_request_duration | gauge | instance: `tidb-0\|tidb-1\|...`<br/><br/>component: `tikv`<br/><br/>cluster_name: `<cluster name>`<br/><br/>`type`: `BatchGet\|Commit\|Prewrite\|...` | The duration (in seconds) of TiKV requests by type. |
162+
| tidb_cloud.db_component_uptime | gauge | instance: `tidb-0\|tidb-1\|...`<br/><br/>component: `tidb\|tikv\|tiflash`<br/><br/>cluster_name: `<cluster name>` | The uptime (in seconds) of TiDB components. |
163+
| tidb_cloud.cdc_changefeed_latency (AKA cdc_changefeed_checkpoint_ts_lag) | gauge | changefeed_id: `<changefeed-id>`<br/><br/>cluster_name: `<cluster name>`| The checkpoint timestamp lag (in seconds) for changefeed owner. |
164+
| tidb_cloud.cdc_changefeed_resolved_ts_lag | gauge | changefeed_id: `<changefeed-id>`<br/><br/>cluster_name: `<cluster name>` | The resolved timestamp lag (in seconds) for the changefeed owner. |
165+
| tidb_cloud.cdc_changefeed_status | gauge | changefeed_id: `<changefeed-id>`<br/><br/>cluster_name: `<cluster name>` | Changefeed status:<br/><br/>`-1`: Unknown<br/><br/>`0`: Normal<br/><br/>`1`: Warning<br/><br/>`2`: Failed<br/><br/>`3`: Stopped<br/><br/>`4`: Finished<br/><br/>`6`: Warning<br/><br/>`7`: Other |
166+
| tidb_cloud.resource_manager_resource_unit_read_request_unit | gauge | cluster_name: `<cluster name>`<br/><br/>resource_group: `<group-name>` | The read request units (RUs) consumed by Resource Manager. |
167+
| tidb_cloud.resource_manager_resource_unit_write_request_unit | gauge | cluster_name: `<cluster name>`<br/><br/>resource_group: `<group-name>` | The write request units (RUs) consumed by Resource Manager. |
168+
| tidb_cloud.dm_task_state | gauge | instance: `instance`<br/><br/>task: `task`<br/><br/>cluster_name: `<cluster name>` | Task State of Data Migration:<br/><br/>`0`: Invalid<br/><br/>`1`: New<br/><br/>`2`: Running<br/><br/>`3`: Paused<br/><br/>`4`: Stopped<br/><br/>`5`: Finished<br/><br/>`15`: Error |
169+
| tidb_cloud.dm_syncer_replication_lag_bucket | gauge | instance: `instance`<br/><br/>cluster_name: `<cluster name>` | Replicate lag (bucket) of Data Migration. |
170+
| tidb_cloud.dm_syncer_replication_lag_gauge | gauge | instance: `instance`<br/><br/>task: `task`<br/><br/>cluster_name: `<cluster name>` | Replicate lag (gauge) of Data Migration. |
171+
| tidb_cloud.dm_relay_read_error_count | gauge | instance: `instance`<br/><br/>cluster_name: `<cluster name>` | Fail to read binlog from master. |
172+
| tidb_cloud.node_memory_available_bytes | gauge | cluster_name: `<cluster name>`<br/><br/>instance: tidb-0\|tidb-1…\|tikv-0…\|tiflash-0…<br/><br/>component: tidb\|tikv\|tiflash | The available memory of TiDB/TiKV/TiFlash nodes, in bytes. |
173+
| tidb_cloud.cdc_changefeed_replica_rows | gauge | changefeed_id: `<changefeed-id>`<br/><br/>cluster_name: `<cluster name>` | The number of events that TiCDC nodes write to the downstream per second. |
174+
| tidb_cloud.node_cpu_seconds_total_rate | gauge | cluster_name: `<cluster name>`<br/><br/>instance: tidb-0\|tidb-1…\|tikv-0…\|tiflash-0…<br/><br/>component: tidb\|tikv\|tiflash | The CPU usage of TiDB/TiKV/TiFlash nodes. |

0 commit comments

Comments
 (0)