github.com/netdata/go.d.plugin@v0.58.1/modules/cockroachdb/metadata.yaml (about) 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.database-servers 13 keywords: 14 - cockroachdb 15 - databases 16 related_resources: 17 integrations: 18 list: [] 19 info_provided_to_referring_integrations: 20 description: "" 21 most_popular: false 22 overview: 23 data_collection: 24 metrics_description: | 25 This collector monitors CockroachDB servers. 26 method_description: "" 27 supported_platforms: 28 include: [] 29 exclude: [] 30 multi_instance: true 31 additional_permissions: 32 description: "" 33 default_behavior: 34 auto_detection: 35 description: "" 36 limits: 37 description: "" 38 performance_impact: 39 description: "" 40 setup: 41 prerequisites: 42 list: [] 43 configuration: 44 file: 45 name: go.d/cockroachdb.conf 46 options: 47 description: | 48 The following options can be defined globally: update_every, autodetection_retry. 49 folding: 50 title: Config options 51 enabled: true 52 list: 53 - name: update_every 54 description: Data collection frequency. 55 default_value: 10 56 required: false 57 - name: autodetection_retry 58 description: Recheck interval in seconds. Zero means no recheck will be scheduled. 59 default_value: 0 60 required: false 61 - name: url 62 description: Server URL. 63 default_value: http://127.0.0.1:8080/_status/vars 64 required: true 65 - name: timeout 66 description: HTTP request timeout. 67 default_value: 1 68 required: false 69 - name: username 70 description: Username for basic HTTP authentication. 71 default_value: "" 72 required: false 73 - name: password 74 description: Password for basic HTTP authentication. 75 default_value: "" 76 required: false 77 - name: proxy_url 78 description: Proxy URL. 79 default_value: "" 80 required: false 81 - name: proxy_username 82 description: Username for proxy basic HTTP authentication. 83 default_value: "" 84 required: false 85 - name: proxy_password 86 description: Password for proxy basic HTTP authentication. 87 default_value: "" 88 required: false 89 - name: method 90 description: HTTP request method. 91 default_value: GET 92 required: false 93 - name: body 94 description: HTTP request body. 95 default_value: "" 96 required: false 97 - name: headers 98 description: HTTP request headers. 99 default_value: "" 100 required: false 101 - name: not_follow_redirects 102 description: Redirect handling policy. Controls whether the client follows redirects. 103 default_value: false 104 required: false 105 - name: tls_skip_verify 106 description: Server certificate chain and hostname validation policy. Controls whether the client performs this check. 107 default_value: false 108 required: false 109 - name: tls_ca 110 description: Certification authority that the client uses when verifying the server's certificates. 111 default_value: "" 112 required: false 113 - name: tls_cert 114 description: Client TLS certificate. 115 default_value: "" 116 required: false 117 - name: tls_key 118 description: Client TLS key. 119 default_value: "" 120 required: false 121 examples: 122 folding: 123 title: Config 124 enabled: true 125 list: 126 - name: Basic 127 description: An example configuration. 128 config: | 129 jobs: 130 - name: local 131 url: http://127.0.0.1:8080/_status/vars 132 - name: HTTP authentication 133 description: Local server with basic HTTP authentication. 134 config: | 135 jobs: 136 - name: local 137 url: http://127.0.0.1:8080/_status/vars 138 username: username 139 password: password 140 - name: HTTPS with self-signed certificate 141 description: CockroachDB with enabled HTTPS and self-signed certificate. 142 config: | 143 jobs: 144 - name: local 145 url: https://127.0.0.1:8080/_status/vars 146 tls_skip_verify: yes 147 - name: Multi-instance 148 description: | 149 > **Note**: When you define multiple jobs, their names must be unique. 150 151 Collecting metrics from local and remote instances. 152 config: | 153 jobs: 154 - name: local 155 url: http://127.0.0.1:8080/_status/vars 156 157 - name: remote 158 url: http://203.0.113.10:8080/_status/vars 159 troubleshooting: 160 problems: 161 list: [] 162 alerts: 163 - name: cockroachdb_used_storage_capacity 164 metric: cockroachdb.storage_used_capacity_percentage 165 info: storage capacity utilization 166 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/cockroachdb.conf 167 - name: cockroachdb_used_usable_storage_capacity 168 metric: cockroachdb.storage_used_capacity_percentage 169 info: storage usable space utilization 170 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/cockroachdb.conf 171 - name: cockroachdb_unavailable_ranges 172 metric: cockroachdb.ranges_replication_problem 173 info: number of ranges with fewer live replicas than needed for quorum 174 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/cockroachdb.conf 175 - name: cockroachdb_underreplicated_ranges 176 metric: cockroachdb.ranges_replication_problem 177 info: number of ranges with fewer live replicas than the replication target 178 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/cockroachdb.conf 179 - name: cockroachdb_open_file_descriptors_limit 180 metric: cockroachdb.process_file_descriptors 181 info: "open file descriptors utilization (against softlimit)" 182 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/cockroachdb.conf 183 metrics: 184 folding: 185 title: Metrics 186 enabled: false 187 description: "" 188 availability: [] 189 scopes: 190 - name: global 191 description: These metrics refer to the entire monitored application. 192 labels: [] 193 metrics: 194 - name: cockroachdb.process_cpu_time_combined_percentage 195 description: Combined CPU Time Percentage, Normalized 0-1 by Number of Cores 196 unit: percentage 197 chart_type: line 198 dimensions: 199 - name: used 200 - name: cockroachdb.process_cpu_time_percentage 201 description: CPU Time Percentage 202 unit: percentage 203 chart_type: stacked 204 dimensions: 205 - name: user 206 - name: sys 207 - name: cockroachdb.process_cpu_time 208 description: CPU Time 209 unit: ms 210 chart_type: stacked 211 dimensions: 212 - name: user 213 - name: sys 214 - name: cockroachdb.process_memory 215 description: Memory Usage 216 unit: KiB 217 chart_type: line 218 dimensions: 219 - name: rss 220 - name: cockroachdb.process_file_descriptors 221 description: File Descriptors 222 unit: fd 223 chart_type: line 224 dimensions: 225 - name: open 226 - name: cockroachdb.process_uptime 227 description: Uptime 228 unit: seconds 229 chart_type: line 230 dimensions: 231 - name: uptime 232 - name: cockroachdb.host_disk_bandwidth 233 description: Host Disk Cumulative Bandwidth 234 unit: KiB 235 chart_type: area 236 dimensions: 237 - name: read 238 - name: write 239 - name: cockroachdb.host_disk_operations 240 description: Host Disk Cumulative Operations 241 unit: operations 242 chart_type: line 243 dimensions: 244 - name: reads 245 - name: writes 246 - name: cockroachdb.host_disk_iops_in_progress 247 description: Host Disk Cumulative IOPS In Progress 248 unit: iops 249 chart_type: line 250 dimensions: 251 - name: in_progress 252 - name: cockroachdb.host_network_bandwidth 253 description: Host Network Cumulative Bandwidth 254 unit: kilobits 255 chart_type: area 256 dimensions: 257 - name: received 258 - name: sent 259 - name: cockroachdb.host_network_packets 260 description: Host Network Cumulative Packets 261 unit: packets 262 chart_type: line 263 dimensions: 264 - name: received 265 - name: sent 266 - name: cockroachdb.live_nodes 267 description: Live Nodes in the Cluster 268 unit: nodes 269 chart_type: line 270 dimensions: 271 - name: live_nodes 272 - name: cockroachdb.node_liveness_heartbeats 273 description: Node Liveness Heartbeats 274 unit: heartbeats 275 chart_type: stacked 276 dimensions: 277 - name: successful 278 - name: failed 279 - name: cockroachdb.total_storage_capacity 280 description: Total Storage Capacity 281 unit: KiB 282 chart_type: line 283 dimensions: 284 - name: total 285 - name: cockroachdb.storage_capacity_usability 286 description: Storage Capacity Usability 287 unit: KiB 288 chart_type: stacked 289 dimensions: 290 - name: usable 291 - name: unusable 292 - name: cockroachdb.storage_usable_capacity 293 description: Storage Usable Capacity 294 unit: KiB 295 chart_type: stacked 296 dimensions: 297 - name: available 298 - name: used 299 - name: cockroachdb.storage_used_capacity_percentage 300 description: Storage Used Capacity Utilization 301 unit: percentage 302 chart_type: line 303 dimensions: 304 - name: total 305 - name: usable 306 - name: cockroachdb.sql_connections 307 description: Active SQL Connections 308 unit: connections 309 chart_type: line 310 dimensions: 311 - name: active 312 - name: cockroachdb.sql_bandwidth 313 description: SQL Bandwidth 314 unit: KiB 315 chart_type: area 316 dimensions: 317 - name: received 318 - name: sent 319 - name: cockroachdb.sql_statements_total 320 description: SQL Statements Total 321 unit: statements 322 chart_type: area 323 dimensions: 324 - name: started 325 - name: executed 326 - name: cockroachdb.sql_errors 327 description: SQL Statements and Transaction Errors 328 unit: errors 329 chart_type: line 330 dimensions: 331 - name: statement 332 - name: transaction 333 - name: cockroachdb.sql_started_ddl_statements 334 description: SQL Started DDL Statements 335 unit: statements 336 chart_type: line 337 dimensions: 338 - name: ddl 339 - name: cockroachdb.sql_executed_ddl_statements 340 description: SQL Executed DDL Statements 341 unit: statements 342 chart_type: line 343 dimensions: 344 - name: ddl 345 - name: cockroachdb.sql_started_dml_statements 346 description: SQL Started DML Statements 347 unit: statements 348 chart_type: stacked 349 dimensions: 350 - name: select 351 - name: update 352 - name: delete 353 - name: insert 354 - name: cockroachdb.sql_executed_dml_statements 355 description: SQL Executed DML Statements 356 unit: statements 357 chart_type: stacked 358 dimensions: 359 - name: select 360 - name: update 361 - name: delete 362 - name: insert 363 - name: cockroachdb.sql_started_tcl_statements 364 description: SQL Started TCL Statements 365 unit: statements 366 chart_type: stacked 367 dimensions: 368 - name: begin 369 - name: commit 370 - name: rollback 371 - name: savepoint 372 - name: savepoint_cockroach_restart 373 - name: release_savepoint_cockroach_restart 374 - name: rollback_to_savepoint_cockroach_restart 375 - name: cockroachdb.sql_executed_tcl_statements 376 description: SQL Executed TCL Statements 377 unit: statements 378 chart_type: stacked 379 dimensions: 380 - name: begin 381 - name: commit 382 - name: rollback 383 - name: savepoint 384 - name: savepoint_cockroach_restart 385 - name: release_savepoint_cockroach_restart 386 - name: rollback_to_savepoint_cockroach_restart 387 - name: cockroachdb.sql_active_distributed_queries 388 description: Active Distributed SQL Queries 389 unit: queries 390 chart_type: line 391 dimensions: 392 - name: active 393 - name: cockroachdb.sql_distributed_flows 394 description: Distributed SQL Flows 395 unit: flows 396 chart_type: stacked 397 dimensions: 398 - name: active 399 - name: queued 400 - name: cockroachdb.live_bytes 401 description: Used Live Data 402 unit: KiB 403 chart_type: line 404 dimensions: 405 - name: applications 406 - name: system 407 - name: cockroachdb.logical_data 408 description: Logical Data 409 unit: KiB 410 chart_type: stacked 411 dimensions: 412 - name: keys 413 - name: values 414 - name: cockroachdb.logical_data_count 415 description: Logical Data Count 416 unit: num 417 chart_type: stacked 418 dimensions: 419 - name: keys 420 - name: values 421 - name: cockroachdb.kv_transactions 422 description: KV Transactions 423 unit: transactions 424 chart_type: area 425 dimensions: 426 - name: committed 427 - name: fast-path_committed 428 - name: aborted 429 - name: cockroachdb.kv_transaction_restarts 430 description: KV Transaction Restarts 431 unit: restarts 432 chart_type: stacked 433 dimensions: 434 - name: write_too_old 435 - name: write_too_old_multiple 436 - name: forwarded_timestamp 437 - name: possible_reply 438 - name: async_consensus_failure 439 - name: read_within_uncertainty_interval 440 - name: aborted 441 - name: push_failure 442 - name: unknown 443 - name: cockroachdb.ranges 444 description: Ranges 445 unit: ranges 446 chart_type: line 447 dimensions: 448 - name: ranges 449 - name: cockroachdb.ranges_replication_problem 450 description: Ranges Replication Problems 451 unit: ranges 452 chart_type: stacked 453 dimensions: 454 - name: unavailable 455 - name: under_replicated 456 - name: over_replicated 457 - name: cockroachdb.range_events 458 description: Range Events 459 unit: events 460 chart_type: stacked 461 dimensions: 462 - name: split 463 - name: add 464 - name: remove 465 - name: merge 466 - name: cockroachdb.range_snapshot_events 467 description: Range Snapshot Events 468 unit: events 469 chart_type: stacked 470 dimensions: 471 - name: generated 472 - name: applied_raft_initiated 473 - name: applied_learner 474 - name: applied_preemptive 475 - name: cockroachdb.rocksdb_read_amplification 476 description: RocksDB Read Amplification 477 unit: reads/query 478 chart_type: line 479 dimensions: 480 - name: reads 481 - name: cockroachdb.rocksdb_table_operations 482 description: RocksDB Table Operations 483 unit: operations 484 chart_type: line 485 dimensions: 486 - name: compactions 487 - name: flushes 488 - name: cockroachdb.rocksdb_cache_usage 489 description: RocksDB Block Cache Usage 490 unit: KiB 491 chart_type: area 492 dimensions: 493 - name: used 494 - name: cockroachdb.rocksdb_cache_operations 495 description: RocksDB Block Cache Operations 496 unit: operations 497 chart_type: stacked 498 dimensions: 499 - name: hits 500 - name: misses 501 - name: cockroachdb.rocksdb_cache_hit_rate 502 description: RocksDB Block Cache Hit Rate 503 unit: percentage 504 chart_type: area 505 dimensions: 506 - name: hit_rate 507 - name: cockroachdb.rocksdb_sstables 508 description: RocksDB SSTables 509 unit: sstables 510 chart_type: line 511 dimensions: 512 - name: sstables 513 - name: cockroachdb.replicas 514 description: Number of Replicas 515 unit: replicas 516 chart_type: line 517 dimensions: 518 - name: replicas 519 - name: cockroachdb.replicas_quiescence 520 description: Replicas Quiescence 521 unit: replicas 522 chart_type: stacked 523 dimensions: 524 - name: quiescent 525 - name: active 526 - name: cockroachdb.replicas_leaders 527 description: Number of Raft Leaders 528 unit: replicas 529 chart_type: area 530 dimensions: 531 - name: leaders 532 - name: not_leaseholders 533 - name: cockroachdb.replicas_leaseholders 534 description: Number of Leaseholders 535 unit: leaseholders 536 chart_type: line 537 dimensions: 538 - name: leaseholders 539 - name: cockroachdb.queue_processing_failures 540 description: Queues Processing Failures 541 unit: failures 542 chart_type: stacked 543 dimensions: 544 - name: gc 545 - name: replica_gc 546 - name: replication 547 - name: split 548 - name: consistency 549 - name: raft_log 550 - name: raft_snapshot 551 - name: time_series_maintenance 552 - name: cockroachdb.rebalancing_queries 553 description: Rebalancing Average Queries 554 unit: queries/s 555 chart_type: line 556 dimensions: 557 - name: avg 558 - name: cockroachdb.rebalancing_writes 559 description: Rebalancing Average Writes 560 unit: writes/s 561 chart_type: line 562 dimensions: 563 - name: avg 564 - name: cockroachdb.timeseries_samples 565 description: Time Series Written Samples 566 unit: samples 567 chart_type: line 568 dimensions: 569 - name: written 570 - name: cockroachdb.timeseries_write_errors 571 description: Time Series Write Errors 572 unit: errors 573 chart_type: line 574 dimensions: 575 - name: write 576 - name: cockroachdb.timeseries_write_bytes 577 description: Time Series Bytes Written 578 unit: KiB 579 chart_type: line 580 dimensions: 581 - name: written 582 - name: cockroachdb.slow_requests 583 description: Slow Requests 584 unit: requests 585 chart_type: stacked 586 dimensions: 587 - name: acquiring_latches 588 - name: acquiring_lease 589 - name: in_raft 590 - name: cockroachdb.code_heap_memory_usage 591 description: Heap Memory Usage 592 unit: KiB 593 chart_type: stacked 594 dimensions: 595 - name: go 596 - name: cgo 597 - name: cockroachdb.goroutines 598 description: Number of Goroutines 599 unit: goroutines 600 chart_type: line 601 dimensions: 602 - name: goroutines 603 - name: cockroachdb.gc_count 604 description: GC Runs 605 unit: invokes 606 chart_type: line 607 dimensions: 608 - name: gc 609 - name: cockroachdb.gc_pause 610 description: GC Pause Time 611 unit: us 612 chart_type: line 613 dimensions: 614 - name: pause 615 - name: cockroachdb.cgo_calls 616 description: Cgo Calls 617 unit: calls 618 chart_type: line 619 dimensions: 620 - name: cgo