| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-yugabytedb |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: yugabytedb |
| 7 | monitored_instance: |
| 8 | name: YugabyteDB |
| 9 | link: https://www.yugabyte.com/yugabytedb |
| 10 | categories: |
| 11 | - data-collection.databases |
| 12 | icon_filename: yugabytedb.svg |
| 13 | related_resources: |
| 14 | integrations: |
| 15 | list: [] |
| 16 | alternative_monitored_instances: [] |
| 17 | info_provided_to_referring_integrations: |
| 18 | description: "" |
| 19 | keywords: |
| 20 | - db |
| 21 | - database |
| 22 | - yb |
| 23 | - yugabyte |
| 24 | overview: |
| 25 | data_collection: |
| 26 | metrics_description: | |
| 27 | This collector monitors the activity and performance of YugabyteDB servers. |
| 28 | method_description: | |
| 29 | It sends HTTP requests to the YugabyteDB [metric endpoints](https://docs.yugabyte.com/preview/launch-and-manage/monitor-and-alert/metrics/#metric-endpoints). |
| 30 | |
| 31 | It also provides `top-queries` and `running-queries` functions using `pg_stat_statements` and `pg_stat_activity` from YSQL. |
| 32 | default_behavior: |
| 33 | auto_detection: |
| 34 | description: | |
| 35 | By default, it detects YugabyteDB instances running on localhost. |
| 36 | On startup, it tries to collect metrics from: |
| 37 | |
| 38 | - http://127.0.0.1:7000/prometheus-metrics (Master) |
| 39 | - http://127.0.0.1:9000/prometheus-metrics (Tablet Server) |
| 40 | - http://127.0.0.1:12000/prometheus-metrics (YCQL) |
| 41 | - http://127.0.0.1:13000/prometheus-metrics (YSQL) |
| 42 | limits: |
| 43 | description: "" |
| 44 | performance_impact: |
| 45 | description: "" |
| 46 | additional_permissions: |
| 47 | description: | |
| 48 | The `top-queries` function requires the `pg_stat_statements` extension to be installed in the target database. |
| 49 | |
| 50 | Viewing all running queries via `pg_stat_activity` may require elevated privileges (e.g., `pg_read_all_stats`). |
| 51 | multi_instance: true |
| 52 | supported_platforms: |
| 53 | include: [] |
| 54 | exclude: [] |
| 55 | setup: |
| 56 | prerequisites: |
| 57 | list: [] |
| 58 | configuration: |
| 59 | file: |
| 60 | name: go.d/yugabytedb.conf |
| 61 | options: |
| 62 | description: | |
| 63 | The following options can be defined globally: update_every, autodetection_retry. |
| 64 | folding: |
| 65 | title: Config options |
| 66 | enabled: true |
| 67 | list: |
| 68 | - name: update_every |
| 69 | description: Data collection interval (seconds). |
| 70 | default_value: 5 |
| 71 | required: false |
| 72 | group: Collection |
| 73 | - name: autodetection_retry |
| 74 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 75 | default_value: 0 |
| 76 | required: false |
| 77 | group: Collection |
| 78 | |
| 79 | - name: url |
| 80 | description: Target endpoint URL. |
| 81 | default_value: http://127.0.0.1:7000/prometheus-metrics |
| 82 | required: true |
| 83 | group: Target |
| 84 | - name: timeout |
| 85 | description: HTTP request timeout (seconds). |
| 86 | default_value: 1 |
| 87 | required: false |
| 88 | group: Target |
| 89 | |
| 90 | - name: username |
| 91 | description: Username for Basic HTTP authentication. |
| 92 | default_value: "" |
| 93 | required: false |
| 94 | group: HTTP Auth |
| 95 | - name: password |
| 96 | description: Password for Basic HTTP authentication. |
| 97 | default_value: "" |
| 98 | required: false |
| 99 | group: HTTP Auth |
| 100 | - name: bearer_token_file |
| 101 | description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)." |
| 102 | default_value: "" |
| 103 | required: false |
| 104 | group: HTTP Auth |
| 105 | |
| 106 | - name: tls_skip_verify |
| 107 | description: Skip TLS certificate and hostname verification (insecure). |
| 108 | default_value: no |
| 109 | required: false |
| 110 | group: TLS |
| 111 | - name: tls_ca |
| 112 | description: Path to CA bundle used to validate the server certificate. |
| 113 | default_value: "" |
| 114 | required: false |
| 115 | group: TLS |
| 116 | - name: tls_cert |
| 117 | description: Path to client TLS certificate (for mTLS). |
| 118 | default_value: "" |
| 119 | required: false |
| 120 | group: TLS |
| 121 | - name: tls_key |
| 122 | description: Path to client TLS private key (for mTLS). |
| 123 | default_value: "" |
| 124 | required: false |
| 125 | group: TLS |
| 126 | |
| 127 | - name: proxy_url |
| 128 | description: HTTP proxy URL. |
| 129 | default_value: "" |
| 130 | required: false |
| 131 | group: Proxy |
| 132 | - name: proxy_username |
| 133 | description: Username for proxy Basic HTTP authentication. |
| 134 | default_value: "" |
| 135 | required: false |
| 136 | group: Proxy |
| 137 | - name: proxy_password |
| 138 | description: Password for proxy Basic HTTP authentication. |
| 139 | default_value: "" |
| 140 | required: false |
| 141 | group: Proxy |
| 142 | |
| 143 | - name: method |
| 144 | description: HTTP method to use. |
| 145 | default_value: "GET" |
| 146 | required: false |
| 147 | group: Request |
| 148 | - name: body |
| 149 | description: Request body (e.g., for POST/PUT). |
| 150 | default_value: "" |
| 151 | required: false |
| 152 | group: Request |
| 153 | - name: headers |
| 154 | description: "Additional HTTP headers (one per line as key: value)." |
| 155 | default_value: "" |
| 156 | required: false |
| 157 | group: Request |
| 158 | - name: not_follow_redirects |
| 159 | description: Do not follow HTTP redirects. |
| 160 | default_value: no |
| 161 | required: false |
| 162 | group: Request |
| 163 | - name: force_http2 |
| 164 | description: Force HTTP/2 (including h2c over TCP). |
| 165 | default_value: no |
| 166 | required: false |
| 167 | group: Request |
| 168 | |
| 169 | - name: functions.dsn |
| 170 | description: SQL DSN (required for query functions). |
| 171 | default_value: "" |
| 172 | required: false |
| 173 | group: Functions |
| 174 | |
| 175 | - name: functions.top_queries.disabled |
| 176 | description: Disable the [top-queries](#top-queries) function. |
| 177 | default_value: false |
| 178 | required: false |
| 179 | group: Functions |
| 180 | - name: functions.top_queries.timeout |
| 181 | description: Query timeout (seconds). Uses collector timeout if not set. |
| 182 | default_value: "" |
| 183 | required: false |
| 184 | group: Functions |
| 185 | - name: functions.top_queries.limit |
| 186 | description: Maximum number of queries to return. |
| 187 | default_value: 500 |
| 188 | required: false |
| 189 | group: Functions |
| 190 | |
| 191 | - name: functions.running_queries.disabled |
| 192 | description: Disable the [running-queries](#running-queries) function. |
| 193 | default_value: false |
| 194 | required: false |
| 195 | group: Functions |
| 196 | - name: functions.running_queries.timeout |
| 197 | description: Query timeout (seconds). Uses collector timeout if not set. |
| 198 | default_value: "" |
| 199 | required: false |
| 200 | group: Functions |
| 201 | - name: functions.running_queries.limit |
| 202 | description: Maximum number of queries to return. |
| 203 | default_value: 500 |
| 204 | required: false |
| 205 | group: Functions |
| 206 | |
| 207 | - name: vnode |
| 208 | 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). |
| 209 | default_value: "" |
| 210 | required: false |
| 211 | group: Virtual Node |
| 212 | examples: |
| 213 | folding: |
| 214 | title: Config |
| 215 | enabled: true |
| 216 | list: |
| 217 | - name: Basic |
| 218 | description: A basic example configuration. |
| 219 | folding: |
| 220 | enabled: false |
| 221 | config: | |
| 222 | jobs: |
| 223 | - name: local |
| 224 | url: http://127.0.0.1:7000/prometheus-metrics # Master |
| 225 | # url: http://127.0.0.1:9000/prometheus-metrics # Tablet Server |
| 226 | # url: http://127.0.0.1:12000/prometheus-metrics # YCQL |
| 227 | # url: http://127.0.0.1:13000/prometheus-metrics # YSQL |
| 228 | - name: Top queries |
| 229 | description: Enable SQL query functions (YSQL). |
| 230 | config: | |
| 231 | jobs: |
| 232 | - name: local |
| 233 | url: http://127.0.0.1:7000/prometheus-metrics |
| 234 | functions: |
| 235 | dsn: postgres://yugabyte@127.0.0.1:5433/yugabyte?sslmode=disable |
| 236 | - name: HTTP authentication |
| 237 | description: Basic HTTP authentication. |
| 238 | config: | |
| 239 | jobs: |
| 240 | - name: local |
| 241 | url: http://127.0.0.1:7000/prometheus-metrics |
| 242 | username: username |
| 243 | password: password |
| 244 | - name: HTTPS with self-signed certificate |
| 245 | description: NGINX with enabled HTTPS and self-signed certificate. |
| 246 | config: | |
| 247 | jobs: |
| 248 | - name: local |
| 249 | url: https://127.0.0.1:7000/prometheus-metrics |
| 250 | tls_skip_verify: yes |
| 251 | - name: Multi-instance |
| 252 | description: | |
| 253 | > **Note**: When you define multiple jobs, their names must be unique. |
| 254 | |
| 255 | Collecting metrics from local and remote instances. |
| 256 | config: | |
| 257 | jobs: |
| 258 | - name: local |
| 259 | url: http://127.0.0.1:7000/prometheus-metrics |
| 260 | |
| 261 | - name: remote |
| 262 | url: http://192.0.2.1:7000/prometheus-metrics |
| 263 | troubleshooting: |
| 264 | problems: |
| 265 | list: [] |
| 266 | alerts: [] |
| 267 | functions: |
| 268 | description: | |
| 269 | This collector exposes real-time functions for interactive troubleshooting in the Live tab. |
| 270 | list: |
| 271 | - id: top-queries |
| 272 | name: Top Queries |
| 273 | description: | |
| 274 | Retrieves aggregated query statistics from the PostgreSQL-compatible [pg_stat_statements](https://docs.yugabyte.com/preview/explore/query-1-performance/pg-stat-statements/) extension in YSQL. |
| 275 | |
| 276 | This function queries the `pg_stat_statements` view which tracks execution statistics for all SQL statements executed on the YSQL layer. It provides timing metrics, execution counts, and row statistics for each unique query pattern. |
| 277 | |
| 278 | Use cases: |
| 279 | - Identify slow queries consuming excessive total execution time |
| 280 | - Find high-frequency queries that may benefit from optimization |
| 281 | - Analyze query patterns by database and user |
| 282 | |
| 283 | Query text is truncated at 4096 characters for display purposes. |
| 284 | parameters: |
| 285 | - id: __sort |
| 286 | name: Filter By |
| 287 | description: Select the primary sort column. Options include total time, mean time, max time, calls, and rows. Defaults to total time to focus on most resource-intensive queries. |
| 288 | type: select |
| 289 | required: true |
| 290 | default: totalTime |
| 291 | options: [] |
| 292 | returns: |
| 293 | description: Aggregated query statistics from `pg_stat_statements`. Each row represents a unique query pattern with cumulative metrics across all executions. |
| 294 | columns: |
| 295 | - name: Query ID |
| 296 | type: string |
| 297 | unit: "" |
| 298 | visibility: hidden |
| 299 | description: Internal hash identifier for the normalized query pattern. |
| 300 | - name: Query |
| 301 | type: string |
| 302 | unit: "" |
| 303 | description: Normalized SQL query text with literals replaced by parameter placeholders. Truncated to 4096 characters. |
| 304 | - name: Database |
| 305 | type: string |
| 306 | unit: "" |
| 307 | description: Database name where the query was executed. Useful for multi-database workload analysis. |
| 308 | - name: User |
| 309 | type: string |
| 310 | unit: "" |
| 311 | description: YSQL user who executed the query. Useful for identifying workload by user or application. |
| 312 | - name: Calls |
| 313 | type: integer |
| 314 | unit: "" |
| 315 | description: Total number of times this query pattern has been executed. High values indicate frequently run queries. |
| 316 | - name: Total Time |
| 317 | type: duration |
| 318 | unit: "milliseconds" |
| 319 | description: Cumulative execution time across all calls. Primary metric for identifying resource-intensive queries. |
| 320 | - name: Mean Time |
| 321 | type: duration |
| 322 | unit: "milliseconds" |
| 323 | description: Average execution time per call. Compare with total time to distinguish slow queries from frequently called ones. |
| 324 | - name: Min Time |
| 325 | type: duration |
| 326 | unit: "milliseconds" |
| 327 | visibility: hidden |
| 328 | description: Minimum execution time observed for this query pattern. |
| 329 | - name: Max Time |
| 330 | type: duration |
| 331 | unit: "milliseconds" |
| 332 | visibility: hidden |
| 333 | description: Maximum execution time observed. Large gaps between min and max may indicate parameter sensitivity or lock contention. |
| 334 | - name: Rows |
| 335 | type: integer |
| 336 | unit: "" |
| 337 | description: Total number of rows retrieved or affected by the query across all executions. |
| 338 | - name: Stddev Time |
| 339 | type: duration |
| 340 | unit: "milliseconds" |
| 341 | visibility: hidden |
| 342 | description: Standard deviation of execution times. High values indicate inconsistent query performance. |
| 343 | performance: | |
| 344 | Queries the `pg_stat_statements` view via YSQL connection:<br/>• Default limit of 500 rows balances completeness with performance<br/>• Use `sql_timeout` to prevent long-running queries |
| 345 | security: | |
| 346 | Query text may contain unmasked literal values including potentially sensitive data:<br/>• Personal information in WHERE clauses or INSERT values<br/>• Business data embedded in queries<br/>• Access should be restricted to authorized personnel only |
| 347 | prerequisites: |
| 348 | list: |
| 349 | - title: Enable pg_stat_statements extension |
| 350 | description: | |
| 351 | The `pg_stat_statements` extension must be installed in the target YSQL database. |
| 352 | |
| 353 | 1. Install the extension: |
| 354 | |
| 355 | ```sql |
| 356 | CREATE EXTENSION IF NOT EXISTS pg_stat_statements; |
| 357 | ``` |
| 358 | |
| 359 | 2. Verify access: |
| 360 | |
| 361 | ```sql |
| 362 | SELECT * FROM pg_stat_statements LIMIT 1; |
| 363 | ``` |
| 364 | |
| 365 | :::info |
| 366 | |
| 367 | - The extension tracks statistics for all SQL statements executed |
| 368 | - Statistics can be reset with `SELECT pg_stat_statements_reset()` |
| 369 | - YugabyteDB uses PostgreSQL-compatible extensions |
| 370 | |
| 371 | ::: |
| 372 | availability: | |
| 373 | Available when:<br/>• The collector has successfully connected to YSQL<br/>• The `pg_stat_statements` extension is installed<br/>• Returns HTTP 503 if the SQL connection cannot be established or extension is not installed<br/>• Returns HTTP 500 if the query fails<br/>• Returns HTTP 504 if the query times out |
| 374 | require_cloud: true |
| 375 | - id: running-queries |
| 376 | name: Running Queries |
| 377 | description: | |
| 378 | Retrieves currently executing statements from the PostgreSQL-compatible [pg_stat_activity](https://www.postgresql.org/docs/current/monitoring-stats.html#MONITORING-PG-STAT-ACTIVITY-VIEW) view in YSQL. |
| 379 | |
| 380 | This function queries `pg_stat_activity` to show all non-idle backend processes with their current query, state, and timing information. It excludes idle connections to focus on active workload. |
| 381 | |
| 382 | Use cases: |
| 383 | - Identify long-running queries that may need investigation |
| 384 | - Monitor active connections and their current state |
| 385 | - Investigate blocked or waiting queries |
| 386 | |
| 387 | Query text is truncated at 4096 characters for display purposes. |
| 388 | parameters: |
| 389 | - id: __sort |
| 390 | name: Filter By |
| 391 | description: Select the primary sort column. Defaults to elapsed time to focus on longest-running queries. |
| 392 | type: select |
| 393 | required: true |
| 394 | default: elapsedMs |
| 395 | options: [] |
| 396 | returns: |
| 397 | description: Currently running SQL statements from `pg_stat_activity`. Each row represents an active backend process with its current query and execution context. |
| 398 | columns: |
| 399 | - name: PID |
| 400 | type: string |
| 401 | unit: "" |
| 402 | visibility: hidden |
| 403 | description: Backend process ID. Can be used with pg_terminate_backend() to cancel a query. |
| 404 | - name: Query |
| 405 | type: string |
| 406 | unit: "" |
| 407 | description: The SQL statement currently being executed. Truncated to 4096 characters. |
| 408 | - name: Database |
| 409 | type: string |
| 410 | unit: "" |
| 411 | description: Database name the backend is connected to. |
| 412 | - name: User |
| 413 | type: string |
| 414 | unit: "" |
| 415 | description: YSQL user name of the backend process. |
| 416 | - name: State |
| 417 | type: string |
| 418 | unit: "" |
| 419 | description: Current state of the backend (active, idle in transaction, fastpath function call, etc.). |
| 420 | - name: Wait Event Type |
| 421 | type: string |
| 422 | unit: "" |
| 423 | visibility: hidden |
| 424 | description: Type of event the backend is waiting for (Lock, LWLock, IO, etc.). Null if not waiting. |
| 425 | - name: Wait Event |
| 426 | type: string |
| 427 | unit: "" |
| 428 | visibility: hidden |
| 429 | description: Specific wait event name. Useful for diagnosing lock contention or I/O bottlenecks. |
| 430 | - name: Application |
| 431 | type: string |
| 432 | unit: "" |
| 433 | visibility: hidden |
| 434 | description: Application name set by the client connection. Useful for identifying which application is running the query. |
| 435 | - name: Client Address |
| 436 | type: string |
| 437 | unit: "" |
| 438 | visibility: hidden |
| 439 | description: IP address of the client connection. |
| 440 | - name: Query Start |
| 441 | type: string |
| 442 | unit: "" |
| 443 | visibility: hidden |
| 444 | description: Timestamp when the current query began execution. |
| 445 | - name: Elapsed |
| 446 | type: duration |
| 447 | unit: "milliseconds" |
| 448 | description: Time elapsed since the query started. High values indicate long-running queries that may need investigation. |
| 449 | performance: | |
| 450 | Queries the `pg_stat_activity` view via YSQL connection:<br/>• Returns only non-idle connections to reduce result size<br/>• Default limit of 500 rows balances completeness with performance<br/>• Use `sql_timeout` to prevent long-running queries |
| 451 | security: | |
| 452 | Query text may contain unmasked literal values including potentially sensitive data:<br/>• Personal information in WHERE clauses or INSERT values<br/>• Business data embedded in queries<br/>• Access should be restricted to authorized personnel only |
| 453 | prerequisites: |
| 454 | list: |
| 455 | - title: Grant access to all queries (optional) |
| 456 | description: | |
| 457 | By default, users can only see their own queries in `pg_stat_activity`. To view all users' queries, grant the `pg_read_all_stats` role: |
| 458 | |
| 459 | ```sql |
| 460 | GRANT pg_read_all_stats TO your_user; |
| 461 | ``` |
| 462 | |
| 463 | :::info |
| 464 | |
| 465 | - The `yugabyte` superuser can see all queries by default |
| 466 | - Without elevated privileges, only the user's own queries are visible |
| 467 | - Idle connections are filtered out from results |
| 468 | |
| 469 | ::: |
| 470 | availability: | |
| 471 | Available when:<br/>• The collector has successfully connected to YSQL<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 |
| 472 | require_cloud: true |
| 473 | metrics: |
| 474 | folding: |
| 475 | title: Metrics |
| 476 | enabled: false |
| 477 | description: "" |
| 478 | availability: [] |
| 479 | scopes: |
| 480 | - name: Master Client operations (Master) |
| 481 | description: Metrics tracking latency and counts of Master Client RPC operations. |
| 482 | labels: |
| 483 | - name: operation |
| 484 | description: The specific MasterClient RPC operation name. |
| 485 | metrics: |
| 486 | - name: yugabytedb.master_client_operations |
| 487 | description: Master Client Operations |
| 488 | unit: ops/s |
| 489 | chart_type: line |
| 490 | dimensions: |
| 491 | - name: operations |
| 492 | - name: yugabytedb.master_client_operations_latency |
| 493 | description: Master Client Operations Latency |
| 494 | unit: microseconds |
| 495 | chart_type: line |
| 496 | dimensions: |
| 497 | - name: latency |
| 498 | - name: Master DDL operations |
| 499 | description: Metrics tracking Data Definition Language (DDL) operations performed on the Master server. |
| 500 | labels: |
| 501 | - name: operation |
| 502 | description: The specific DDL operation handler name. |
| 503 | metrics: |
| 504 | - name: yugabytedb.master_ddl_operations |
| 505 | description: Master DDL Operations |
| 506 | unit: ops/s |
| 507 | chart_type: line |
| 508 | dimensions: |
| 509 | - name: operations |
| 510 | - name: yugabytedb.master_ddl_operations_latency |
| 511 | description: Master DDL Operations Latency |
| 512 | unit: microseconds |
| 513 | chart_type: line |
| 514 | dimensions: |
| 515 | - name: latency |
| 516 | - name: TabletServerService (Master) |
| 517 | description: Metrics tracking latency and counts of TabletServer RPC operations on the Master server. |
| 518 | labels: |
| 519 | - name: op |
| 520 | description: The specific TabletServer RPC operation name. |
| 521 | metrics: |
| 522 | - name: yugabytedb.master_tabletserverservice_operations |
| 523 | description: Master TabletServerService Operations |
| 524 | unit: ops/s |
| 525 | chart_type: line |
| 526 | dimensions: |
| 527 | - name: operations |
| 528 | - name: yugabytedb.master_tabletserverservice_operations_latency |
| 529 | description: Master TabletServerService Operations Latency |
| 530 | unit: microseconds |
| 531 | chart_type: line |
| 532 | dimensions: |
| 533 | - name: latency |
| 534 | - name: yugabytedb.master_tabletserverservice_traffic |
| 535 | description: Master TabletServerService Traffic |
| 536 | unit: bytes/s |
| 537 | chart_type: area |
| 538 | dimensions: |
| 539 | - name: received |
| 540 | - name: sent |
| 541 | - name: PgClientService (Master) |
| 542 | description: Metrics tracking latency and counts of PostgreSQL client service RPC operations on the Master server. |
| 543 | labels: |
| 544 | - name: operation |
| 545 | description: The specific PgClientService RPC operation name that handles PostgreSQL protocol requests and responses. |
| 546 | metrics: |
| 547 | - name: yugabytedb.master_pgclientservice_operations |
| 548 | description: Master PgClientService Operations |
| 549 | unit: ops/s |
| 550 | chart_type: line |
| 551 | dimensions: |
| 552 | - name: operations |
| 553 | - name: yugabytedb.master_pgclientservice_operations_latency |
| 554 | description: Master PgClientService Operations Latency |
| 555 | unit: microseconds |
| 556 | chart_type: line |
| 557 | dimensions: |
| 558 | - name: latency |
| 559 | - name: yugabytedb.master_pgclientservice_traffic |
| 560 | description: Master PgClientService Traffic |
| 561 | unit: bytes/s |
| 562 | chart_type: area |
| 563 | dimensions: |
| 564 | - name: received |
| 565 | - name: sent |
| 566 | - name: RemoteBootstrapService (Master) |
| 567 | description: Metrics tracking latency and counts of RemoteBootstrap RPC operations on the Master server. |
| 568 | labels: |
| 569 | - name: operation |
| 570 | description: The specific RemoteBootstrap RPC operation name. |
| 571 | metrics: |
| 572 | - name: yugabytedb.master_remotebootstrapservice_operations |
| 573 | description: Master RemoteBootstrapService Operations |
| 574 | unit: ops/s |
| 575 | chart_type: line |
| 576 | dimensions: |
| 577 | - name: operations |
| 578 | - name: yugabytedb.master_remotebootstrapservice_operations_latency |
| 579 | description: Master RemoteBootstrapService Operations Latency |
| 580 | unit: microseconds |
| 581 | chart_type: line |
| 582 | dimensions: |
| 583 | - name: latency |
| 584 | - name: yugabytedb.master_remotebootstrapservice_traffic |
| 585 | description: Master RemoteBootstrapService Traffic |
| 586 | unit: bytes/s |
| 587 | chart_type: area |
| 588 | dimensions: |
| 589 | - name: received |
| 590 | - name: sent |
| 591 | - name: Raft operations (Master) |
| 592 | description: Metrics tracking latency and counts of Raft consensus protocol operations on the Master server. |
| 593 | labels: |
| 594 | - name: operation |
| 595 | description: The specific Raft protocol operation name. |
| 596 | metrics: |
| 597 | - name: yugabytedb.master_consensus_operations |
| 598 | description: Master Consensus Operations |
| 599 | unit: ops/s |
| 600 | chart_type: line |
| 601 | dimensions: |
| 602 | - name: operations |
| 603 | - name: yugabytedb.master_consensus_operations_latency |
| 604 | description: Master Consensus Operations Operations Latency |
| 605 | unit: microseconds |
| 606 | chart_type: line |
| 607 | dimensions: |
| 608 | - name: latency |
| 609 | - name: yugabytedb.master_consensus_traffic |
| 610 | description: Master Consensus Traffic |
| 611 | unit: bytes/s |
| 612 | chart_type: area |
| 613 | dimensions: |
| 614 | - name: received |
| 615 | - name: sent |
| 616 | - name: TabletServerService (Tablet Server) |
| 617 | description: Metrics tracking latency and counts of TabletServer RPC operations on the Tablet server. |
| 618 | labels: |
| 619 | - name: op |
| 620 | description: The specific TabletServer RPC operation name. |
| 621 | metrics: |
| 622 | - name: yugabytedb.tserver_tabletserverservice_operations |
| 623 | description: TServer TabletServerService Operations |
| 624 | unit: ops/s |
| 625 | chart_type: line |
| 626 | dimensions: |
| 627 | - name: operations |
| 628 | - name: yugabytedb.tserver_tabletserverservice_operations_latency |
| 629 | description: TServer TabletServerService Operations Latency |
| 630 | unit: microseconds |
| 631 | chart_type: line |
| 632 | dimensions: |
| 633 | - name: latency |
| 634 | - name: yugabytedb.tserver_tabletserverservice_traffic |
| 635 | description: TServer TabletServerService Traffic |
| 636 | unit: bytes/s |
| 637 | chart_type: area |
| 638 | dimensions: |
| 639 | - name: received |
| 640 | - name: sent |
| 641 | - name: TabletServerAdminService (Tablet Server) |
| 642 | description: Metrics tracking latency and counts of TabletServerAdmin RPC operations on the Tablet server. |
| 643 | labels: |
| 644 | - name: op |
| 645 | description: The specific TabletServerAdmin RPC operation name. |
| 646 | metrics: |
| 647 | - name: yugabytedb.tserver_tabletserveradminservice_operations |
| 648 | description: TServer TabletServerAdminService Operations |
| 649 | unit: ops/s |
| 650 | chart_type: line |
| 651 | dimensions: |
| 652 | - name: operations |
| 653 | - name: yugabytedb.tserver_tabletserveradminservice_operations_latency |
| 654 | description: TServer TabletServerAdminService Operations Latency |
| 655 | unit: microseconds |
| 656 | chart_type: line |
| 657 | dimensions: |
| 658 | - name: latency |
| 659 | - name: yugabytedb.tserver_tabletserveradminservice_traffic |
| 660 | description: TServer TabletServerAdminService Traffic |
| 661 | unit: bytes/s |
| 662 | chart_type: area |
| 663 | dimensions: |
| 664 | - name: received |
| 665 | - name: sent |
| 666 | - name: TabletServerBackupService (Tablet Server) |
| 667 | description: Metrics tracking latency and counts of TabletServerBackup RPC operations on the Tablet server. |
| 668 | labels: |
| 669 | - name: op |
| 670 | description: The specific TabletServerBackup RPC operation name. |
| 671 | metrics: |
| 672 | - name: yugabytedb.tserver_tabletserverbackupservice_operations |
| 673 | description: TServer TabletServerBackupService Operations |
| 674 | unit: ops/s |
| 675 | chart_type: line |
| 676 | dimensions: |
| 677 | - name: operations |
| 678 | - name: yugabytedb.tserver_tabletserverbackupservice_operations_latency |
| 679 | description: TServer TabletServerBackupService Operations Latency |
| 680 | unit: microseconds |
| 681 | chart_type: line |
| 682 | dimensions: |
| 683 | - name: latency |
| 684 | - name: yugabytedb.tserver_tabletserverbackupservice_traffic |
| 685 | description: TServer TabletServerBackupService Traffic |
| 686 | unit: bytes/s |
| 687 | chart_type: area |
| 688 | dimensions: |
| 689 | - name: received |
| 690 | - name: sent |
| 691 | - name: PgClientService (Tablet Server) |
| 692 | description: Metrics tracking latency and counts of PostgreSQL client service RPC operations on the Tablet server. |
| 693 | labels: |
| 694 | - name: operation |
| 695 | description: The specific PgClientService RPC operation name that handles PostgreSQL protocol requests and responses. |
| 696 | metrics: |
| 697 | - name: yugabytedb.tserver_pgclientservice_operations |
| 698 | description: TServer PgClientService Operations |
| 699 | unit: ops/s |
| 700 | chart_type: line |
| 701 | dimensions: |
| 702 | - name: operations |
| 703 | - name: yugabytedb.tserver_pgclientservice_operations_latency |
| 704 | description: TServer PgClientService Operations Latency |
| 705 | unit: microseconds |
| 706 | chart_type: line |
| 707 | dimensions: |
| 708 | - name: latency |
| 709 | - name: yugabytedb.tserver_pgclientservice_traffic |
| 710 | description: TServer PgClientService Traffic |
| 711 | unit: bytes/s |
| 712 | chart_type: area |
| 713 | dimensions: |
| 714 | - name: received |
| 715 | - name: sent |
| 716 | - name: RemoteBootstrapService (Tablet Server) |
| 717 | description: Metrics tracking latency and counts of RemoteBootstrap RPC operations on the Tablet server. |
| 718 | labels: |
| 719 | - name: operation |
| 720 | description: The specific RemoteBootstrap RPC operation name. |
| 721 | metrics: |
| 722 | - name: yugabytedb.tserver_remotebootstrapservice_operations |
| 723 | description: TServer RemoteBootstrapService Operations |
| 724 | unit: ops/s |
| 725 | chart_type: line |
| 726 | dimensions: |
| 727 | - name: operations |
| 728 | - name: yugabytedb.tserver_remotebootstrapservice_operations_latency |
| 729 | description: TServer RemoteBootstrapService Operations Latency |
| 730 | unit: microseconds |
| 731 | chart_type: line |
| 732 | dimensions: |
| 733 | - name: latency |
| 734 | - name: yugabytedb.tserver_remotebootstrapservice_traffic |
| 735 | description: TServer RemoteBootstrapService Traffic |
| 736 | unit: bytes/s |
| 737 | chart_type: area |
| 738 | dimensions: |
| 739 | - name: received |
| 740 | - name: sent |
| 741 | - name: Raft operations (Tablet Server) |
| 742 | description: Metrics tracking latency and counts of Raft consensus protocol operations on the Tablet server. |
| 743 | labels: |
| 744 | - name: operation |
| 745 | description: The specific Raft protocol operation name. |
| 746 | metrics: |
| 747 | - name: yugabytedb.tserver_consensus_operations |
| 748 | description: TServer Consensus Operations |
| 749 | unit: ops/s |
| 750 | chart_type: line |
| 751 | dimensions: |
| 752 | - name: operations |
| 753 | - name: yugabytedb.tserver_consensus_operations_latency |
| 754 | description: TServer Consensus Operations Operations Latency |
| 755 | unit: microseconds |
| 756 | chart_type: line |
| 757 | dimensions: |
| 758 | - name: latency |
| 759 | - name: yugabytedb.tserver_consensus_traffic |
| 760 | description: TServer Consensus Traffic |
| 761 | unit: bytes/s |
| 762 | chart_type: area |
| 763 | dimensions: |
| 764 | - name: received |
| 765 | - name: sent |
| 766 | - name: SQL Statements (YCQL) |
| 767 | description: Metrics tracking latency and counts of SQL statements on the YCQL server. |
| 768 | labels: |
| 769 | - name: statement |
| 770 | description: The specific SQL statement name. |
| 771 | metrics: |
| 772 | - name: yugabytedb.ycql_sql_statements |
| 773 | description: YCQL SQL Statements |
| 774 | unit: statements/s |
| 775 | chart_type: line |
| 776 | dimensions: |
| 777 | - name: statements |
| 778 | - name: yugabytedb.yCql_sql_statements_latency |
| 779 | description: YCQL SQL Statements Latency |
| 780 | unit: microseconds |
| 781 | chart_type: line |
| 782 | dimensions: |
| 783 | - name: latency |
| 784 | - name: YSQL server |
| 785 | description: Metrics tracking connections on the YSQL server. |
| 786 | labels: [] |
| 787 | metrics: |
| 788 | - name: yugabytedb.ysql_connection_usage |
| 789 | description: YSQL Connections Usage |
| 790 | unit: connections |
| 791 | chart_type: stacked |
| 792 | dimensions: |
| 793 | - name: available |
| 794 | - name: used |
| 795 | - name: yugabytedb.ysql_active_connections |
| 796 | description: YSQL Active Connections |
| 797 | unit: connections |
| 798 | chart_type: line |
| 799 | dimensions: |
| 800 | - name: active |
| 801 | - name: yugabytedb.ysql_established_connections |
| 802 | description: YSQL Established Connections |
| 803 | unit: connections/s |
| 804 | chart_type: line |
| 805 | dimensions: |
| 806 | - name: established |
| 807 | - name: yugabytedb.ysql_over_limit_connections |
| 808 | description: YSQL Rejected Over Limit Connections |
| 809 | unit: rejects/s |
| 810 | chart_type: line |
| 811 | dimensions: |
| 812 | - name: over_limit |
| 813 | - name: SQL Statements (YSQL) |
| 814 | description: Metrics tracking latency and counts of SQL statements on the YSQL server. |
| 815 | labels: |
| 816 | - name: statement |
| 817 | description: The specific SQL statement name. |
| 818 | metrics: |
| 819 | - name: yugabytedb.ysql_sql_statements |
| 820 | description: YSQL SQL Statements |
| 821 | unit: statements/s |
| 822 | chart_type: line |
| 823 | dimensions: |
| 824 | - name: statements |
| 825 | - name: yugabytedb.ysql_sql_statements_latency |
| 826 | description: YSQL SQL Statements Latency |
| 827 | unit: microseconds |
| 828 | chart_type: line |
| 829 | dimensions: |
| 830 | - name: latency |