| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-cockroachdb |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: cockroachdb |
| 7 | monitored_instance: |
| 8 | name: CockroachDB |
| 9 | link: https://www.cockroachlabs.com/ |
| 10 | icon_filename: cockroachdb.svg |
| 11 | categories: |
| 12 | - data-collection.databases |
| 13 | keywords: |
| 14 | - cockroachdb |
| 15 | - databases |
| 16 | related_resources: |
| 17 | integrations: |
| 18 | list: [] |
| 19 | info_provided_to_referring_integrations: |
| 20 | description: "" |
| 21 | overview: |
| 22 | data_collection: |
| 23 | metrics_description: | |
| 24 | This collector monitors CockroachDB servers. |
| 25 | method_description: | |
| 26 | It scrapes Prometheus metrics from the CockroachDB `/_status/vars` endpoint. |
| 27 | |
| 28 | It also provides `top-queries` and `running-queries` functions using SQL statement statistics (`crdb_internal.cluster_statement_statistics`) and the `SHOW CLUSTER STATEMENTS` command. |
| 29 | supported_platforms: |
| 30 | include: [] |
| 31 | exclude: [] |
| 32 | multi_instance: true |
| 33 | additional_permissions: |
| 34 | description: | |
| 35 | The `top-queries` and `running-queries` functions require: |
| 36 | |
| 37 | - A SQL user with `VIEWACTIVITY` or `VIEWACTIVITYREDACTED` privileges. |
| 38 | - Access to `crdb_internal.cluster_statement_statistics` (may require `SET allow_unsafe_internals = on` on newer versions). |
| 39 | default_behavior: |
| 40 | auto_detection: |
| 41 | description: "" |
| 42 | limits: |
| 43 | description: "" |
| 44 | performance_impact: |
| 45 | description: "" |
| 46 | setup: |
| 47 | prerequisites: |
| 48 | list: [] |
| 49 | configuration: |
| 50 | file: |
| 51 | name: go.d/cockroachdb.conf |
| 52 | options: |
| 53 | description: | |
| 54 | The following options can be defined globally: update_every, autodetection_retry. |
| 55 | folding: |
| 56 | title: Config options |
| 57 | enabled: true |
| 58 | list: |
| 59 | - name: update_every |
| 60 | description: Data collection interval (seconds). |
| 61 | default_value: 10 |
| 62 | required: false |
| 63 | group: Collection |
| 64 | - name: autodetection_retry |
| 65 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 66 | default_value: 0 |
| 67 | required: false |
| 68 | group: Collection |
| 69 | |
| 70 | - name: url |
| 71 | description: Target endpoint URL. |
| 72 | default_value: http://127.0.0.1:8080/_status/vars |
| 73 | required: true |
| 74 | group: Target |
| 75 | - name: timeout |
| 76 | description: HTTP request timeout (seconds). |
| 77 | default_value: 1 |
| 78 | required: false |
| 79 | group: Target |
| 80 | |
| 81 | - name: username |
| 82 | description: Username for Basic HTTP authentication. |
| 83 | default_value: "" |
| 84 | required: false |
| 85 | group: HTTP Auth |
| 86 | - name: password |
| 87 | description: Password for Basic HTTP authentication. |
| 88 | default_value: "" |
| 89 | required: false |
| 90 | group: HTTP Auth |
| 91 | - name: bearer_token_file |
| 92 | description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)." |
| 93 | default_value: "" |
| 94 | required: false |
| 95 | group: HTTP Auth |
| 96 | |
| 97 | - name: tls_skip_verify |
| 98 | description: Skip TLS certificate and hostname verification (insecure). |
| 99 | default_value: no |
| 100 | required: false |
| 101 | group: TLS |
| 102 | - name: tls_ca |
| 103 | description: Path to CA bundle used to validate the server certificate. |
| 104 | default_value: "" |
| 105 | required: false |
| 106 | group: TLS |
| 107 | - name: tls_cert |
| 108 | description: Path to client TLS certificate (for mTLS). |
| 109 | default_value: "" |
| 110 | required: false |
| 111 | group: TLS |
| 112 | - name: tls_key |
| 113 | description: Path to client TLS private key (for mTLS). |
| 114 | default_value: "" |
| 115 | required: false |
| 116 | group: TLS |
| 117 | |
| 118 | - name: proxy_url |
| 119 | description: HTTP proxy URL. |
| 120 | default_value: "" |
| 121 | required: false |
| 122 | group: Proxy |
| 123 | - name: proxy_username |
| 124 | description: Username for proxy Basic HTTP authentication. |
| 125 | default_value: "" |
| 126 | required: false |
| 127 | group: Proxy |
| 128 | - name: proxy_password |
| 129 | description: Password for proxy Basic HTTP authentication. |
| 130 | default_value: "" |
| 131 | required: false |
| 132 | group: Proxy |
| 133 | |
| 134 | - name: method |
| 135 | description: HTTP method to use. |
| 136 | default_value: "GET" |
| 137 | required: false |
| 138 | group: Request |
| 139 | - name: body |
| 140 | description: Request body (e.g., for POST/PUT). |
| 141 | default_value: "" |
| 142 | required: false |
| 143 | group: Request |
| 144 | - name: headers |
| 145 | description: "Additional HTTP headers (one per line as key: value)." |
| 146 | default_value: "" |
| 147 | required: false |
| 148 | group: Request |
| 149 | - name: not_follow_redirects |
| 150 | description: Do not follow HTTP redirects. |
| 151 | default_value: no |
| 152 | required: false |
| 153 | group: Request |
| 154 | - name: force_http2 |
| 155 | description: Force HTTP/2 (including h2c over TCP). |
| 156 | default_value: no |
| 157 | required: false |
| 158 | group: Request |
| 159 | |
| 160 | - name: functions.dsn |
| 161 | description: SQL DSN (required for query functions). |
| 162 | default_value: "" |
| 163 | required: false |
| 164 | group: Functions |
| 165 | |
| 166 | - name: functions.top_queries.disabled |
| 167 | description: Disable the [top-queries](#top-queries) function. |
| 168 | default_value: false |
| 169 | required: false |
| 170 | group: Functions |
| 171 | - name: functions.top_queries.timeout |
| 172 | description: Query timeout (seconds). Uses collector timeout if not set. |
| 173 | default_value: "" |
| 174 | required: false |
| 175 | group: Functions |
| 176 | - name: functions.top_queries.limit |
| 177 | description: Maximum number of queries to return. |
| 178 | default_value: 500 |
| 179 | required: false |
| 180 | group: Functions |
| 181 | |
| 182 | - name: functions.running_queries.disabled |
| 183 | description: Disable the [running-queries](#running-queries) function. |
| 184 | default_value: false |
| 185 | required: false |
| 186 | group: Functions |
| 187 | - name: functions.running_queries.timeout |
| 188 | description: Query timeout (seconds). Uses collector timeout if not set. |
| 189 | default_value: "" |
| 190 | required: false |
| 191 | group: Functions |
| 192 | - name: functions.running_queries.limit |
| 193 | description: Maximum number of queries to return. |
| 194 | default_value: 500 |
| 195 | required: false |
| 196 | group: Functions |
| 197 | |
| 198 | - name: vnode |
| 199 | description: Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). |
| 200 | default_value: "" |
| 201 | required: false |
| 202 | group: Virtual Node |
| 203 | examples: |
| 204 | folding: |
| 205 | title: Config |
| 206 | enabled: true |
| 207 | list: |
| 208 | - name: Basic |
| 209 | description: An example configuration. |
| 210 | config: | |
| 211 | jobs: |
| 212 | - name: local |
| 213 | url: http://127.0.0.1:8080/_status/vars |
| 214 | - name: Top queries |
| 215 | description: Enable SQL query functions. |
| 216 | config: | |
| 217 | jobs: |
| 218 | - name: local |
| 219 | url: http://127.0.0.1:8080/_status/vars |
| 220 | functions: |
| 221 | dsn: postgres://root@127.0.0.1:26257/defaultdb?sslmode=disable |
| 222 | - name: HTTP authentication |
| 223 | description: Local server with basic HTTP authentication. |
| 224 | config: | |
| 225 | jobs: |
| 226 | - name: local |
| 227 | url: http://127.0.0.1:8080/_status/vars |
| 228 | username: username |
| 229 | password: password |
| 230 | - name: HTTPS with self-signed certificate |
| 231 | description: CockroachDB with enabled HTTPS and self-signed certificate. |
| 232 | config: | |
| 233 | jobs: |
| 234 | - name: local |
| 235 | url: https://127.0.0.1:8080/_status/vars |
| 236 | tls_skip_verify: yes |
| 237 | - name: Multi-instance |
| 238 | description: | |
| 239 | > **Note**: When you define multiple jobs, their names must be unique. |
| 240 | |
| 241 | Collecting metrics from local and remote instances. |
| 242 | config: | |
| 243 | jobs: |
| 244 | - name: local |
| 245 | url: http://127.0.0.1:8080/_status/vars |
| 246 | |
| 247 | - name: remote |
| 248 | url: http://203.0.113.10:8080/_status/vars |
| 249 | troubleshooting: |
| 250 | problems: |
| 251 | list: [] |
| 252 | alerts: |
| 253 | - name: cockroachdb_used_storage_capacity |
| 254 | metric: cockroachdb.storage_used_capacity_percentage |
| 255 | info: storage capacity utilization |
| 256 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/cockroachdb.conf |
| 257 | - name: cockroachdb_used_usable_storage_capacity |
| 258 | metric: cockroachdb.storage_used_capacity_percentage |
| 259 | info: storage usable space utilization |
| 260 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/cockroachdb.conf |
| 261 | - name: cockroachdb_unavailable_ranges |
| 262 | metric: cockroachdb.ranges_replication_problem |
| 263 | info: number of ranges with fewer live replicas than needed for quorum |
| 264 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/cockroachdb.conf |
| 265 | - name: cockroachdb_underreplicated_ranges |
| 266 | metric: cockroachdb.ranges_replication_problem |
| 267 | info: number of ranges with fewer live replicas than the replication target |
| 268 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/cockroachdb.conf |
| 269 | - name: cockroachdb_open_file_descriptors_limit |
| 270 | metric: cockroachdb.process_file_descriptors |
| 271 | info: "open file descriptors utilization (against softlimit)" |
| 272 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/cockroachdb.conf |
| 273 | functions: |
| 274 | description: | |
| 275 | This collector exposes real-time functions for interactive troubleshooting in the Live tab. |
| 276 | list: |
| 277 | - id: top-queries |
| 278 | name: Top Queries |
| 279 | description: | |
| 280 | Retrieves and aggregates SQL statement performance metrics from CockroachDB [crdb_internal.cluster_statement_statistics](https://www.cockroachlabs.com/docs/stable/crdb-internal#cluster_statement_statistics) table. |
| 281 | |
| 282 | This function queries cluster-wide statement statistics grouped by fingerprint (normalized query pattern). It provides aggregated metrics including execution counts, timing breakdowns, and row operation statistics. |
| 283 | |
| 284 | Use cases: |
| 285 | - Identify slow queries consuming the most total execution time |
| 286 | - Find frequently executed queries that may benefit from optimization |
| 287 | - Analyze row read/write patterns to detect inefficient queries |
| 288 | |
| 289 | Query text is truncated at 4096 characters for display purposes. |
| 290 | parameters: |
| 291 | - id: __sort |
| 292 | name: Filter By |
| 293 | description: Select the primary sort column. Options include total time, executions, rows read, rows written, and more. Defaults to total time to focus on most resource-intensive queries. |
| 294 | type: select |
| 295 | required: true |
| 296 | default: totalTime |
| 297 | options: [] |
| 298 | returns: |
| 299 | description: Aggregated SQL statement statistics grouped by fingerprint. Each row represents a unique query pattern with cumulative metrics across all executions. |
| 300 | columns: |
| 301 | - name: Fingerprint ID |
| 302 | type: string |
| 303 | unit: "" |
| 304 | visibility: hidden |
| 305 | description: "Unique hash identifier for the normalized query pattern. Queries with identical structure but different literal values share the same fingerprint." |
| 306 | - name: Query |
| 307 | type: string |
| 308 | unit: "" |
| 309 | description: "Normalized SQL statement text with literals replaced. Truncated to 4096 characters." |
| 310 | - name: Database |
| 311 | type: string |
| 312 | unit: "" |
| 313 | description: "Database name where the query was executed. Empty for queries without database context." |
| 314 | - name: Application |
| 315 | type: string |
| 316 | unit: "" |
| 317 | description: "Application name that executed the query. Useful for identifying query sources across services." |
| 318 | - name: Statement Type |
| 319 | type: string |
| 320 | unit: "" |
| 321 | visibility: hidden |
| 322 | description: "Type of SQL statement (SELECT, INSERT, UPDATE, DELETE, etc.)." |
| 323 | - name: Distributed |
| 324 | type: string |
| 325 | unit: "" |
| 326 | visibility: hidden |
| 327 | description: "Whether the query used DistSQL execution (true/false). Distributed queries span multiple nodes." |
| 328 | - name: Full Scan |
| 329 | type: string |
| 330 | unit: "" |
| 331 | visibility: hidden |
| 332 | description: "Whether the query performed a full table scan (true/false). Full scans may indicate missing indexes." |
| 333 | - name: Implicit Txn |
| 334 | type: string |
| 335 | unit: "" |
| 336 | visibility: hidden |
| 337 | description: "Whether the statement ran in an implicit transaction (true/false)." |
| 338 | - name: Vectorized |
| 339 | type: string |
| 340 | unit: "" |
| 341 | visibility: hidden |
| 342 | description: "Whether the query used vectorized execution (true/false). Vectorized execution improves performance for analytical queries." |
| 343 | - name: Executions |
| 344 | type: integer |
| 345 | unit: "" |
| 346 | description: "Total number of times this query pattern has been executed. High values indicate frequently run queries." |
| 347 | - name: Total Time |
| 348 | type: duration |
| 349 | unit: "milliseconds" |
| 350 | description: "Cumulative service latency across all executions (mean time × executions). High values indicate queries consuming significant cluster resources." |
| 351 | - name: Mean Time |
| 352 | type: duration |
| 353 | unit: "milliseconds" |
| 354 | description: "Average service latency per execution. Use this to compare typical performance across query patterns." |
| 355 | - name: Run Time |
| 356 | type: duration |
| 357 | unit: "milliseconds" |
| 358 | visibility: hidden |
| 359 | description: "Average time spent executing the query after planning. Excludes parse and plan time." |
| 360 | - name: Plan Time |
| 361 | type: duration |
| 362 | unit: "milliseconds" |
| 363 | visibility: hidden |
| 364 | description: "Average time spent generating the query execution plan. High values may indicate complex queries or stale statistics." |
| 365 | - name: Parse Time |
| 366 | type: duration |
| 367 | unit: "milliseconds" |
| 368 | visibility: hidden |
| 369 | description: "Average time spent parsing the SQL statement." |
| 370 | - name: Rows Read |
| 371 | type: integer |
| 372 | unit: "" |
| 373 | description: "Total rows read across all executions. High values relative to rows returned suggest missing indexes or inefficient scans." |
| 374 | - name: Rows Written |
| 375 | type: integer |
| 376 | unit: "" |
| 377 | description: "Total rows written across all executions. Indicates write workload for INSERT, UPDATE, DELETE statements." |
| 378 | - name: Rows Returned |
| 379 | type: integer |
| 380 | unit: "" |
| 381 | description: "Total rows returned to clients across all executions. Compare with rows read to assess query efficiency." |
| 382 | - name: Bytes Read |
| 383 | type: integer |
| 384 | unit: "" |
| 385 | visibility: hidden |
| 386 | description: "Total bytes read from storage across all executions. Indicates I/O load for the query pattern." |
| 387 | - name: Max Retries |
| 388 | type: integer |
| 389 | unit: "" |
| 390 | visibility: hidden |
| 391 | description: "Maximum number of automatic retries observed for this query pattern. High values indicate transaction contention." |
| 392 | performance: | |
| 393 | Queries the `crdb_internal.cluster_statement_statistics` table which aggregates data across the cluster:<br/>• On busy clusters with high query throughput, this query may take longer<br/>• Default limit of 500 rows balances usefulness with performance |
| 394 | security: | |
| 395 | Query text may contain unmasked literal values including potentially sensitive data:<br/>• Personal information in WHERE clauses or INSERT values<br/>• Business data and internal identifiers<br/>• Access should be restricted to authorized personnel only |
| 396 | prerequisites: |
| 397 | list: |
| 398 | - title: Grant `VIEWACTIVITY` access to cluster statement stats |
| 399 | description: | |
| 400 | The SQL user must have appropriate privileges to access statement statistics. |
| 401 | |
| 402 | 1. Grant `VIEWACTIVITY` (shows full query text) or `VIEWACTIVITYREDACTED` (masks literals): |
| 403 | |
| 404 | ```sql |
| 405 | GRANT SYSTEM VIEWACTIVITY TO netdata_user; |
| 406 | -- OR for privacy: |
| 407 | GRANT SYSTEM VIEWACTIVITYREDACTED TO netdata_user; |
| 408 | ``` |
| 409 | |
| 410 | 2. On newer CockroachDB versions, access to `crdb_internal` may require: |
| 411 | |
| 412 | ```sql |
| 413 | SET allow_unsafe_internals = on; |
| 414 | ``` |
| 415 | |
| 416 | :::info |
| 417 | |
| 418 | - The collector automatically sets `allow_unsafe_internals = on` for the session when querying `crdb_internal` tables (required on newer versions) |
| 419 | - `VIEWACTIVITYREDACTED` replaces literal values with underscores for privacy |
| 420 | - Statement statistics are collected by default but can be disabled via cluster settings |
| 421 | |
| 422 | ::: |
| 423 | availability: | |
| 424 | Available when:<br/>• The collector has successfully connected to CockroachDB<br/>• The SQL user has `VIEWACTIVITY` or `VIEWACTIVITYREDACTED` privileges<br/>• Returns HTTP 503 if the SQL connection cannot be established<br/>• Returns HTTP 500 if the query fails<br/>• Returns HTTP 504 if the query times out |
| 425 | require_cloud: true |
| 426 | - id: running-queries |
| 427 | name: Running Queries |
| 428 | description: | |
| 429 | Retrieves currently executing SQL statements across the CockroachDB cluster using [SHOW CLUSTER STATEMENTS](https://www.cockroachlabs.com/docs/stable/show-statements). |
| 430 | |
| 431 | This function provides a real-time snapshot of all active queries across all nodes in the cluster, including their execution phase, duration, and associated metadata. |
| 432 | |
| 433 | Use cases: |
| 434 | - Identify long-running queries that may be blocking other operations |
| 435 | - Monitor active workload distribution across the cluster |
| 436 | - Debug stuck or slow queries in real-time |
| 437 | |
| 438 | Query text is truncated at 4096 characters for display purposes. |
| 439 | parameters: |
| 440 | - id: __sort |
| 441 | name: Filter By |
| 442 | description: Select the primary sort column. Defaults to elapsed time to show longest-running queries first. |
| 443 | type: select |
| 444 | required: true |
| 445 | default: elapsedMs |
| 446 | options: [] |
| 447 | returns: |
| 448 | description: Real-time snapshot of currently executing SQL statements across all cluster nodes. Each row represents a single active query. |
| 449 | columns: |
| 450 | - name: Query ID |
| 451 | type: string |
| 452 | unit: "" |
| 453 | visibility: hidden |
| 454 | description: "Unique identifier for this specific query execution. Can be used with CANCEL QUERY if needed." |
| 455 | - name: Query |
| 456 | type: string |
| 457 | unit: "" |
| 458 | description: "The SQL statement currently being executed. Truncated to 4096 characters." |
| 459 | - name: User |
| 460 | type: string |
| 461 | unit: "" |
| 462 | description: "Database user executing the query. Useful for identifying workload by user." |
| 463 | - name: Application |
| 464 | type: string |
| 465 | unit: "" |
| 466 | description: "Application name from the client connection. Helps identify which service is running the query." |
| 467 | - name: Client Address |
| 468 | type: string |
| 469 | unit: "" |
| 470 | visibility: hidden |
| 471 | description: "IP address of the client connection. Useful for identifying query sources." |
| 472 | - name: Node ID |
| 473 | type: string |
| 474 | unit: "" |
| 475 | visibility: hidden |
| 476 | description: "CockroachDB node currently executing the query. Helps identify workload distribution." |
| 477 | - name: Session ID |
| 478 | type: string |
| 479 | unit: "" |
| 480 | visibility: hidden |
| 481 | description: "Session identifier for the connection. Multiple queries may share a session." |
| 482 | - name: Phase |
| 483 | type: string |
| 484 | unit: "" |
| 485 | description: "Current execution phase (executing, preparing, etc.). Indicates query progress." |
| 486 | - name: Distributed |
| 487 | type: string |
| 488 | unit: "" |
| 489 | visibility: hidden |
| 490 | description: "Whether the query is using distributed execution across multiple nodes." |
| 491 | - name: Start Time |
| 492 | type: string |
| 493 | unit: "" |
| 494 | visibility: hidden |
| 495 | description: "Timestamp when the query started executing." |
| 496 | - name: Elapsed |
| 497 | type: duration |
| 498 | unit: "milliseconds" |
| 499 | description: "Time elapsed since query started. High values indicate long-running queries that may need investigation." |
| 500 | performance: | |
| 501 | Executes the `SHOW CLUSTER STATEMENTS` command which queries all nodes in the cluster:<br/>• Lightweight operation with minimal overhead<br/>• Returns only currently active queries, typically a small result set |
| 502 | security: | |
| 503 | Query text may contain unmasked literal values including potentially sensitive data:<br/>• Personal information in WHERE clauses or VALUES<br/>• Session tokens or credentials<br/>• Access should be restricted to authorized personnel only |
| 504 | prerequisites: |
| 505 | list: |
| 506 | - title: Grant `VIEWACTIVITY` access to system tables |
| 507 | description: | |
| 508 | The SQL user must have appropriate privileges to view running statements. |
| 509 | |
| 510 | 1. Grant `VIEWACTIVITY` (shows full query text) or `VIEWACTIVITYREDACTED` (masks literals): |
| 511 | |
| 512 | ```sql |
| 513 | GRANT SYSTEM VIEWACTIVITY TO netdata_user; |
| 514 | -- OR for privacy: |
| 515 | GRANT SYSTEM VIEWACTIVITYREDACTED TO netdata_user; |
| 516 | ``` |
| 517 | |
| 518 | :::info |
| 519 | |
| 520 | - `SHOW CLUSTER STATEMENTS` shows queries across all nodes, not just the connected node |
| 521 | - `VIEWACTIVITYREDACTED` replaces literal values with underscores for privacy |
| 522 | - Queries shown are point-in-time snapshots and may complete between retrieval and display |
| 523 | |
| 524 | ::: |
| 525 | availability: | |
| 526 | Available when:<br/>• The collector has successfully connected to CockroachDB<br/>• The SQL user has `VIEWACTIVITY` or `VIEWACTIVITYREDACTED` privileges<br/>• Returns HTTP 503 if the SQL connection cannot be established<br/>• Returns HTTP 500 if the query fails<br/>• Returns HTTP 504 if the query times out |
| 527 | require_cloud: true |
| 528 | metrics: |
| 529 | folding: |
| 530 | title: Metrics |
| 531 | enabled: false |
| 532 | description: "" |
| 533 | availability: [] |
| 534 | scopes: |
| 535 | - name: global |
| 536 | description: These metrics refer to the entire monitored application. |
| 537 | labels: [] |
| 538 | metrics: |
| 539 | - name: cockroachdb.process_cpu_time_combined_percentage |
| 540 | description: Combined CPU Time Percentage, Normalized 0-1 by Number of Cores |
| 541 | unit: percentage |
| 542 | chart_type: line |
| 543 | dimensions: |
| 544 | - name: used |
| 545 | - name: cockroachdb.process_cpu_time_percentage |
| 546 | description: CPU Time Percentage |
| 547 | unit: percentage |
| 548 | chart_type: stacked |
| 549 | dimensions: |
| 550 | - name: user |
| 551 | - name: sys |
| 552 | - name: cockroachdb.process_cpu_time |
| 553 | description: CPU Time |
| 554 | unit: ms |
| 555 | chart_type: stacked |
| 556 | dimensions: |
| 557 | - name: user |
| 558 | - name: sys |
| 559 | - name: cockroachdb.process_memory |
| 560 | description: Memory Usage |
| 561 | unit: KiB |
| 562 | chart_type: line |
| 563 | dimensions: |
| 564 | - name: rss |
| 565 | - name: cockroachdb.process_file_descriptors |
| 566 | description: File Descriptors |
| 567 | unit: fd |
| 568 | chart_type: line |
| 569 | dimensions: |
| 570 | - name: open |
| 571 | - name: cockroachdb.process_uptime |
| 572 | description: Uptime |
| 573 | unit: seconds |
| 574 | chart_type: line |
| 575 | dimensions: |
| 576 | - name: uptime |
| 577 | - name: cockroachdb.host_disk_bandwidth |
| 578 | description: Host Disk Cumulative Bandwidth |
| 579 | unit: KiB |
| 580 | chart_type: area |
| 581 | dimensions: |
| 582 | - name: read |
| 583 | - name: write |
| 584 | - name: cockroachdb.host_disk_operations |
| 585 | description: Host Disk Cumulative Operations |
| 586 | unit: operations |
| 587 | chart_type: line |
| 588 | dimensions: |
| 589 | - name: reads |
| 590 | - name: writes |
| 591 | - name: cockroachdb.host_disk_iops_in_progress |
| 592 | description: Host Disk Cumulative IOPS In Progress |
| 593 | unit: iops |
| 594 | chart_type: line |
| 595 | dimensions: |
| 596 | - name: in_progress |
| 597 | - name: cockroachdb.host_network_bandwidth |
| 598 | description: Host Network Cumulative Bandwidth |
| 599 | unit: kilobits |
| 600 | chart_type: area |
| 601 | dimensions: |
| 602 | - name: received |
| 603 | - name: sent |
| 604 | - name: cockroachdb.host_network_packets |
| 605 | description: Host Network Cumulative Packets |
| 606 | unit: packets |
| 607 | chart_type: line |
| 608 | dimensions: |
| 609 | - name: received |
| 610 | - name: sent |
| 611 | - name: cockroachdb.live_nodes |
| 612 | description: Live Nodes in the Cluster |
| 613 | unit: nodes |
| 614 | chart_type: line |
| 615 | dimensions: |
| 616 | - name: live_nodes |
| 617 | - name: cockroachdb.node_liveness_heartbeats |
| 618 | description: Node Liveness Heartbeats |
| 619 | unit: heartbeats |
| 620 | chart_type: stacked |
| 621 | dimensions: |
| 622 | - name: successful |
| 623 | - name: failed |
| 624 | - name: cockroachdb.total_storage_capacity |
| 625 | description: Total Storage Capacity |
| 626 | unit: KiB |
| 627 | chart_type: line |
| 628 | dimensions: |
| 629 | - name: total |
| 630 | - name: cockroachdb.storage_capacity_usability |
| 631 | description: Storage Capacity Usability |
| 632 | unit: KiB |
| 633 | chart_type: stacked |
| 634 | dimensions: |
| 635 | - name: usable |
| 636 | - name: unusable |
| 637 | - name: cockroachdb.storage_usable_capacity |
| 638 | description: Storage Usable Capacity |
| 639 | unit: KiB |
| 640 | chart_type: stacked |
| 641 | dimensions: |
| 642 | - name: available |
| 643 | - name: used |
| 644 | - name: cockroachdb.storage_used_capacity_percentage |
| 645 | description: Storage Used Capacity Utilization |
| 646 | unit: percentage |
| 647 | chart_type: line |
| 648 | dimensions: |
| 649 | - name: total |
| 650 | - name: usable |
| 651 | - name: cockroachdb.sql_connections |
| 652 | description: Active SQL Connections |
| 653 | unit: connections |
| 654 | chart_type: line |
| 655 | dimensions: |
| 656 | - name: active |
| 657 | - name: cockroachdb.sql_bandwidth |
| 658 | description: SQL Bandwidth |
| 659 | unit: KiB |
| 660 | chart_type: area |
| 661 | dimensions: |
| 662 | - name: received |
| 663 | - name: sent |
| 664 | - name: cockroachdb.sql_statements_total |
| 665 | description: SQL Statements Total |
| 666 | unit: statements |
| 667 | chart_type: area |
| 668 | dimensions: |
| 669 | - name: started |
| 670 | - name: executed |
| 671 | - name: cockroachdb.sql_errors |
| 672 | description: SQL Statements and Transaction Errors |
| 673 | unit: errors |
| 674 | chart_type: line |
| 675 | dimensions: |
| 676 | - name: statement |
| 677 | - name: transaction |
| 678 | - name: cockroachdb.sql_started_ddl_statements |
| 679 | description: SQL Started DDL Statements |
| 680 | unit: statements |
| 681 | chart_type: line |
| 682 | dimensions: |
| 683 | - name: ddl |
| 684 | - name: cockroachdb.sql_executed_ddl_statements |
| 685 | description: SQL Executed DDL Statements |
| 686 | unit: statements |
| 687 | chart_type: line |
| 688 | dimensions: |
| 689 | - name: ddl |
| 690 | - name: cockroachdb.sql_started_dml_statements |
| 691 | description: SQL Started DML Statements |
| 692 | unit: statements |
| 693 | chart_type: stacked |
| 694 | dimensions: |
| 695 | - name: select |
| 696 | - name: update |
| 697 | - name: delete |
| 698 | - name: insert |
| 699 | - name: cockroachdb.sql_executed_dml_statements |
| 700 | description: SQL Executed DML Statements |
| 701 | unit: statements |
| 702 | chart_type: stacked |
| 703 | dimensions: |
| 704 | - name: select |
| 705 | - name: update |
| 706 | - name: delete |
| 707 | - name: insert |
| 708 | - name: cockroachdb.sql_started_tcl_statements |
| 709 | description: SQL Started TCL Statements |
| 710 | unit: statements |
| 711 | chart_type: stacked |
| 712 | dimensions: |
| 713 | - name: begin |
| 714 | - name: commit |
| 715 | - name: rollback |
| 716 | - name: savepoint |
| 717 | - name: savepoint_cockroach_restart |
| 718 | - name: release_savepoint_cockroach_restart |
| 719 | - name: rollback_to_savepoint_cockroach_restart |
| 720 | - name: cockroachdb.sql_executed_tcl_statements |
| 721 | description: SQL Executed TCL Statements |
| 722 | unit: statements |
| 723 | chart_type: stacked |
| 724 | dimensions: |
| 725 | - name: begin |
| 726 | - name: commit |
| 727 | - name: rollback |
| 728 | - name: savepoint |
| 729 | - name: savepoint_cockroach_restart |
| 730 | - name: release_savepoint_cockroach_restart |
| 731 | - name: rollback_to_savepoint_cockroach_restart |
| 732 | - name: cockroachdb.sql_active_distributed_queries |
| 733 | description: Active Distributed SQL Queries |
| 734 | unit: queries |
| 735 | chart_type: line |
| 736 | dimensions: |
| 737 | - name: active |
| 738 | - name: cockroachdb.sql_distributed_flows |
| 739 | description: Distributed SQL Flows |
| 740 | unit: flows |
| 741 | chart_type: stacked |
| 742 | dimensions: |
| 743 | - name: active |
| 744 | - name: queued |
| 745 | - name: cockroachdb.live_bytes |
| 746 | description: Used Live Data |
| 747 | unit: KiB |
| 748 | chart_type: line |
| 749 | dimensions: |
| 750 | - name: applications |
| 751 | - name: system |
| 752 | - name: cockroachdb.logical_data |
| 753 | description: Logical Data |
| 754 | unit: KiB |
| 755 | chart_type: stacked |
| 756 | dimensions: |
| 757 | - name: keys |
| 758 | - name: values |
| 759 | - name: cockroachdb.logical_data_count |
| 760 | description: Logical Data Count |
| 761 | unit: num |
| 762 | chart_type: stacked |
| 763 | dimensions: |
| 764 | - name: keys |
| 765 | - name: values |
| 766 | - name: cockroachdb.kv_transactions |
| 767 | description: KV Transactions |
| 768 | unit: transactions |
| 769 | chart_type: area |
| 770 | dimensions: |
| 771 | - name: committed |
| 772 | - name: fast-path_committed |
| 773 | - name: aborted |
| 774 | - name: cockroachdb.kv_transaction_restarts |
| 775 | description: KV Transaction Restarts |
| 776 | unit: restarts |
| 777 | chart_type: stacked |
| 778 | dimensions: |
| 779 | - name: write_too_old |
| 780 | - name: write_too_old_multiple |
| 781 | - name: forwarded_timestamp |
| 782 | - name: possible_reply |
| 783 | - name: async_consensus_failure |
| 784 | - name: read_within_uncertainty_interval |
| 785 | - name: aborted |
| 786 | - name: push_failure |
| 787 | - name: unknown |
| 788 | - name: cockroachdb.ranges |
| 789 | description: Ranges |
| 790 | unit: ranges |
| 791 | chart_type: line |
| 792 | dimensions: |
| 793 | - name: ranges |
| 794 | - name: cockroachdb.ranges_replication_problem |
| 795 | description: Ranges Replication Problems |
| 796 | unit: ranges |
| 797 | chart_type: stacked |
| 798 | dimensions: |
| 799 | - name: unavailable |
| 800 | - name: under_replicated |
| 801 | - name: over_replicated |
| 802 | - name: cockroachdb.range_events |
| 803 | description: Range Events |
| 804 | unit: events |
| 805 | chart_type: stacked |
| 806 | dimensions: |
| 807 | - name: split |
| 808 | - name: add |
| 809 | - name: remove |
| 810 | - name: merge |
| 811 | - name: cockroachdb.range_snapshot_events |
| 812 | description: Range Snapshot Events |
| 813 | unit: events |
| 814 | chart_type: stacked |
| 815 | dimensions: |
| 816 | - name: generated |
| 817 | - name: applied_raft_initiated |
| 818 | - name: applied_learner |
| 819 | - name: applied_preemptive |
| 820 | - name: cockroachdb.rocksdb_read_amplification |
| 821 | description: RocksDB Read Amplification |
| 822 | unit: reads/query |
| 823 | chart_type: line |
| 824 | dimensions: |
| 825 | - name: reads |
| 826 | - name: cockroachdb.rocksdb_table_operations |
| 827 | description: RocksDB Table Operations |
| 828 | unit: operations |
| 829 | chart_type: line |
| 830 | dimensions: |
| 831 | - name: compactions |
| 832 | - name: flushes |
| 833 | - name: cockroachdb.rocksdb_cache_usage |
| 834 | description: RocksDB Block Cache Usage |
| 835 | unit: KiB |
| 836 | chart_type: area |
| 837 | dimensions: |
| 838 | - name: used |
| 839 | - name: cockroachdb.rocksdb_cache_operations |
| 840 | description: RocksDB Block Cache Operations |
| 841 | unit: operations |
| 842 | chart_type: stacked |
| 843 | dimensions: |
| 844 | - name: hits |
| 845 | - name: misses |
| 846 | - name: cockroachdb.rocksdb_cache_hit_rate |
| 847 | description: RocksDB Block Cache Hit Rate |
| 848 | unit: percentage |
| 849 | chart_type: area |
| 850 | dimensions: |
| 851 | - name: hit_rate |
| 852 | - name: cockroachdb.rocksdb_sstables |
| 853 | description: RocksDB SSTables |
| 854 | unit: sstables |
| 855 | chart_type: line |
| 856 | dimensions: |
| 857 | - name: sstables |
| 858 | - name: cockroachdb.replicas |
| 859 | description: Number of Replicas |
| 860 | unit: replicas |
| 861 | chart_type: line |
| 862 | dimensions: |
| 863 | - name: replicas |
| 864 | - name: cockroachdb.replicas_quiescence |
| 865 | description: Replicas Quiescence |
| 866 | unit: replicas |
| 867 | chart_type: stacked |
| 868 | dimensions: |
| 869 | - name: quiescent |
| 870 | - name: active |
| 871 | - name: cockroachdb.replicas_leaders |
| 872 | description: Number of Raft Leaders |
| 873 | unit: replicas |
| 874 | chart_type: area |
| 875 | dimensions: |
| 876 | - name: leaders |
| 877 | - name: not_leaseholders |
| 878 | - name: cockroachdb.replicas_leaseholders |
| 879 | description: Number of Leaseholders |
| 880 | unit: leaseholders |
| 881 | chart_type: line |
| 882 | dimensions: |
| 883 | - name: leaseholders |
| 884 | - name: cockroachdb.queue_processing_failures |
| 885 | description: Queues Processing Failures |
| 886 | unit: failures |
| 887 | chart_type: stacked |
| 888 | dimensions: |
| 889 | - name: gc |
| 890 | - name: replica_gc |
| 891 | - name: replication |
| 892 | - name: split |
| 893 | - name: consistency |
| 894 | - name: raft_log |
| 895 | - name: raft_snapshot |
| 896 | - name: time_series_maintenance |
| 897 | - name: cockroachdb.rebalancing_queries |
| 898 | description: Rebalancing Average Queries |
| 899 | unit: queries/s |
| 900 | chart_type: line |
| 901 | dimensions: |
| 902 | - name: avg |
| 903 | - name: cockroachdb.rebalancing_writes |
| 904 | description: Rebalancing Average Writes |
| 905 | unit: writes/s |
| 906 | chart_type: line |
| 907 | dimensions: |
| 908 | - name: avg |
| 909 | - name: cockroachdb.timeseries_samples |
| 910 | description: Time Series Written Samples |
| 911 | unit: samples |
| 912 | chart_type: line |
| 913 | dimensions: |
| 914 | - name: written |
| 915 | - name: cockroachdb.timeseries_write_errors |
| 916 | description: Time Series Write Errors |
| 917 | unit: errors |
| 918 | chart_type: line |
| 919 | dimensions: |
| 920 | - name: write |
| 921 | - name: cockroachdb.timeseries_write_bytes |
| 922 | description: Time Series Bytes Written |
| 923 | unit: KiB |
| 924 | chart_type: line |
| 925 | dimensions: |
| 926 | - name: written |
| 927 | - name: cockroachdb.slow_requests |
| 928 | description: Slow Requests |
| 929 | unit: requests |
| 930 | chart_type: stacked |
| 931 | dimensions: |
| 932 | - name: acquiring_latches |
| 933 | - name: acquiring_lease |
| 934 | - name: in_raft |
| 935 | - name: cockroachdb.code_heap_memory_usage |
| 936 | description: Heap Memory Usage |
| 937 | unit: KiB |
| 938 | chart_type: stacked |
| 939 | dimensions: |
| 940 | - name: go |
| 941 | - name: cgo |
| 942 | - name: cockroachdb.goroutines |
| 943 | description: Number of Goroutines |
| 944 | unit: goroutines |
| 945 | chart_type: line |
| 946 | dimensions: |
| 947 | - name: goroutines |
| 948 | - name: cockroachdb.gc_count |
| 949 | description: GC Runs |
| 950 | unit: invokes |
| 951 | chart_type: line |
| 952 | dimensions: |
| 953 | - name: gc |
| 954 | - name: cockroachdb.gc_pause |
| 955 | description: GC Pause Time |
| 956 | unit: us |
| 957 | chart_type: line |
| 958 | dimensions: |
| 959 | - name: pause |
| 960 | - name: cockroachdb.cgo_calls |
| 961 | description: Cgo Calls |
| 962 | unit: calls |
| 963 | chart_type: line |
| 964 | dimensions: |
| 965 | - name: cgo |