<!--startmeta
custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/yugabytedb/README.md"
meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/yugabytedb/metadata.yaml"
sidebar_label: "YugabyteDB"
learn_status: "Published"
learn_rel_path: "Collecting Metrics/Collectors/Databases"
keywords: ['db', 'database', 'yb', 'yugabyte']
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
endmeta-->

# YugabyteDB


<img src="https://netdata.cloud/img/yugabytedb.svg" width="150"/>


Plugin: go.d.plugin
Module: yugabytedb

<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />

## Overview

This collector monitors the activity and performance of YugabyteDB servers.


It sends HTTP requests to the YugabyteDB [metric endpoints](https://docs.yugabyte.com/preview/launch-and-manage/monitor-and-alert/metrics/#metric-endpoints).

It also provides `top-queries` and `running-queries` functions using `pg_stat_statements` and `pg_stat_activity` from YSQL.


This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.

The `top-queries` function requires the `pg_stat_statements` extension to be installed in the target database.

Viewing all running queries via `pg_stat_activity` may require elevated privileges (e.g., `pg_read_all_stats`).


### Default Behavior

#### Auto-Detection

By default, it detects YugabyteDB instances running on localhost.
On startup, it tries to collect metrics from:

- http://127.0.0.1:7000/prometheus-metrics (Master)
- http://127.0.0.1:9000/prometheus-metrics (Tablet Server)
- http://127.0.0.1:12000/prometheus-metrics (YCQL)
- http://127.0.0.1:13000/prometheus-metrics (YSQL)


#### Limits

The default configuration for this integration does not impose any limits on data collection.

#### Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

## Setup


You can configure the **yugabytedb** collector in two ways:

| Method                | Best for                                                                                 | How to                                                                                                                                 |
|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
| [**UI**](#via-ui)     | Fast setup without editing files                                                         | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **yugabytedb**, then click **+** to add a job. |
| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/yugabytedb.conf` and add a job.                                                                        |

:::important

UI configuration requires paid Netdata Cloud plan.

:::


### Prerequisites

No action required.

### Configuration

#### Options

The following options can be defined globally: update_every, autodetection_retry.


<details open><summary>Config options</summary>



| Group | Option | Description | Default | Required |
|:------|:-----|:------------|:--------|:---------:|
| **Collection** | update_every | Data collection interval (seconds). | 5 | no |
|  | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
| **Target** | url | Target endpoint URL. | http://127.0.0.1:7000/prometheus-metrics | yes |
|  | timeout | HTTP request timeout (seconds). | 1 | no |
| **HTTP Auth** | username | Username for Basic HTTP authentication. |  | no |
|  | password | Password for Basic HTTP authentication. |  | no |
|  | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). |  | no |
| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
|  | tls_ca | Path to CA bundle used to validate the server certificate. |  | no |
|  | tls_cert | Path to client TLS certificate (for mTLS). |  | no |
|  | tls_key | Path to client TLS private key (for mTLS). |  | no |
| **Proxy** | proxy_url | HTTP proxy URL. |  | no |
|  | proxy_username | Username for proxy Basic HTTP authentication. |  | no |
|  | proxy_password | Password for proxy Basic HTTP authentication. |  | no |
| **Request** | method | HTTP method to use. | GET | no |
|  | body | Request body (e.g., for POST/PUT). |  | no |
|  | headers | Additional HTTP headers (one per line as key: value). |  | no |
|  | not_follow_redirects | Do not follow HTTP redirects. | no | no |
|  | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
| **Functions** | functions.dsn | SQL DSN (required for query functions). |  | no |
|  | functions.top_queries.disabled | Disable the [top-queries](#top-queries) function. | no | no |
|  | functions.top_queries.timeout | Query timeout (seconds). Uses collector timeout if not set. |  | no |
|  | functions.top_queries.limit | Maximum number of queries to return. | 500 | no |
|  | functions.running_queries.disabled | Disable the [running-queries](#running-queries) function. | no | no |
|  | functions.running_queries.timeout | Query timeout (seconds). Uses collector timeout if not set. |  | no |
|  | functions.running_queries.limit | Maximum number of queries to return. | 500 | no |
| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). |  | no |


</details>


#### via UI

Configure the **yugabytedb** collector from the Netdata web interface:

1. Go to **Nodes**.
2. Select the node **where you want the yugabytedb data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
3. The **Collectors → Jobs** view opens by default.
4. In the Search box, type _yugabytedb_ (or scroll the list) to locate the **yugabytedb** collector.
5. Click the **+** next to the **yugabytedb** collector to add a new job.
6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
    - **Test** runs the job with the provided settings and shows whether data can be collected.
    - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.


#### via File

The configuration file name for this integration is `go.d/yugabytedb.conf`.

The file format is YAML. Generally, the structure is:

```yaml
update_every: 1
autodetection_retry: 0
jobs:
  - name: some_name1
  - name: some_name2
```
You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).

```bash
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/yugabytedb.conf
```

##### Examples

###### Basic

A basic example configuration.

```yaml
jobs:
  - name: local
    url: http://127.0.0.1:7000/prometheus-metrics     # Master
    # url: http://127.0.0.1:9000/prometheus-metrics   # Tablet Server
    # url: http://127.0.0.1:12000/prometheus-metrics  # YCQL
    # url: http://127.0.0.1:13000/prometheus-metrics  # YSQL

```
###### Top queries

Enable SQL query functions (YSQL).

<details open><summary>Config</summary>

```yaml
jobs:
  - name: local
    url: http://127.0.0.1:7000/prometheus-metrics
    functions:
      dsn: postgres://yugabyte@127.0.0.1:5433/yugabyte?sslmode=disable

```
</details>

###### HTTP authentication

Basic HTTP authentication.

<details open><summary>Config</summary>

```yaml
jobs:
  - name: local
    url: http://127.0.0.1:7000/prometheus-metrics
    username: username
    password: password

```
</details>

###### HTTPS with self-signed certificate

NGINX with enabled HTTPS and self-signed certificate.

<details open><summary>Config</summary>

```yaml
jobs:
  - name: local
    url: https://127.0.0.1:7000/prometheus-metrics
    tls_skip_verify: yes

```
</details>

###### Multi-instance

> **Note**: When you define multiple jobs, their names must be unique.

Collecting metrics from local and remote instances.


<details open><summary>Config</summary>

```yaml
jobs:
  - name: local
    url: http://127.0.0.1:7000/prometheus-metrics

  - name: remote
    url: http://192.0.2.1:7000/prometheus-metrics

```
</details>



## Alerts

There are no alerts configured by default for this integration.



## Metrics

Metrics grouped by *scope*.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.




### Per Master Client operations (Master)

Metrics tracking latency and counts of Master Client RPC operations.

Labels:

| Label      | Description     |
|:-----------|:----------------|
| operation | The specific MasterClient RPC operation name. |

Metrics:

| Metric | Description | Dimensions | Unit |
|:------|:------------|:----------|:----|
| yugabytedb.master_client_operations | Master Client Operations | operations | ops/s |
| yugabytedb.master_client_operations_latency | Master Client Operations Latency | latency | microseconds |


### Per Master DDL operations

Metrics tracking Data Definition Language (DDL) operations performed on the Master server.

Labels:

| Label      | Description     |
|:-----------|:----------------|
| operation | The specific DDL operation handler name. |

Metrics:

| Metric | Description | Dimensions | Unit |
|:------|:------------|:----------|:----|
| yugabytedb.master_ddl_operations | Master DDL Operations | operations | ops/s |
| yugabytedb.master_ddl_operations_latency | Master DDL Operations Latency | latency | microseconds |


### Per TabletServerService (Master)

Metrics tracking latency and counts of TabletServer RPC operations on the Master server.

Labels:

| Label      | Description     |
|:-----------|:----------------|
| op | The specific TabletServer RPC operation name. |

Metrics:

| Metric | Description | Dimensions | Unit |
|:------|:------------|:----------|:----|
| yugabytedb.master_tabletserverservice_operations | Master TabletServerService Operations | operations | ops/s |
| yugabytedb.master_tabletserverservice_operations_latency | Master TabletServerService Operations Latency | latency | microseconds |
| yugabytedb.master_tabletserverservice_traffic | Master TabletServerService Traffic | received, sent | bytes/s |


### Per PgClientService (Master)

Metrics tracking latency and counts of PostgreSQL client service RPC operations on the Master server.

Labels:

| Label      | Description     |
|:-----------|:----------------|
| operation | The specific PgClientService RPC operation name that handles PostgreSQL protocol requests and responses. |

Metrics:

| Metric | Description | Dimensions | Unit |
|:------|:------------|:----------|:----|
| yugabytedb.master_pgclientservice_operations | Master PgClientService Operations | operations | ops/s |
| yugabytedb.master_pgclientservice_operations_latency | Master PgClientService Operations Latency | latency | microseconds |
| yugabytedb.master_pgclientservice_traffic | Master PgClientService Traffic | received, sent | bytes/s |


### Per RemoteBootstrapService (Master)

Metrics tracking latency and counts of RemoteBootstrap RPC operations on the Master server.

Labels:

| Label      | Description     |
|:-----------|:----------------|
| operation | The specific RemoteBootstrap RPC operation name. |

Metrics:

| Metric | Description | Dimensions | Unit |
|:------|:------------|:----------|:----|
| yugabytedb.master_remotebootstrapservice_operations | Master RemoteBootstrapService Operations | operations | ops/s |
| yugabytedb.master_remotebootstrapservice_operations_latency | Master RemoteBootstrapService Operations Latency | latency | microseconds |
| yugabytedb.master_remotebootstrapservice_traffic | Master RemoteBootstrapService Traffic | received, sent | bytes/s |


### Per Raft operations (Master)

Metrics tracking latency and counts of Raft consensus protocol operations on the Master server.

Labels:

| Label      | Description     |
|:-----------|:----------------|
| operation | The specific Raft protocol operation name. |

Metrics:

| Metric | Description | Dimensions | Unit |
|:------|:------------|:----------|:----|
| yugabytedb.master_consensus_operations | Master Consensus Operations | operations | ops/s |
| yugabytedb.master_consensus_operations_latency | Master Consensus Operations Operations Latency | latency | microseconds |
| yugabytedb.master_consensus_traffic | Master Consensus Traffic | received, sent | bytes/s |


### Per TabletServerService (Tablet Server)

Metrics tracking latency and counts of TabletServer RPC operations on the Tablet server.

Labels:

| Label      | Description     |
|:-----------|:----------------|
| op | The specific TabletServer RPC operation name. |

Metrics:

| Metric | Description | Dimensions | Unit |
|:------|:------------|:----------|:----|
| yugabytedb.tserver_tabletserverservice_operations | TServer TabletServerService Operations | operations | ops/s |
| yugabytedb.tserver_tabletserverservice_operations_latency | TServer TabletServerService Operations Latency | latency | microseconds |
| yugabytedb.tserver_tabletserverservice_traffic | TServer TabletServerService Traffic | received, sent | bytes/s |


### Per TabletServerAdminService (Tablet Server)

Metrics tracking latency and counts of TabletServerAdmin RPC operations on the Tablet server.

Labels:

| Label      | Description     |
|:-----------|:----------------|
| op | The specific TabletServerAdmin RPC operation name. |

Metrics:

| Metric | Description | Dimensions | Unit |
|:------|:------------|:----------|:----|
| yugabytedb.tserver_tabletserveradminservice_operations | TServer TabletServerAdminService Operations | operations | ops/s |
| yugabytedb.tserver_tabletserveradminservice_operations_latency | TServer TabletServerAdminService Operations Latency | latency | microseconds |
| yugabytedb.tserver_tabletserveradminservice_traffic | TServer TabletServerAdminService Traffic | received, sent | bytes/s |


### Per TabletServerBackupService (Tablet Server)

Metrics tracking latency and counts of TabletServerBackup RPC operations on the Tablet server.

Labels:

| Label      | Description     |
|:-----------|:----------------|
| op | The specific TabletServerBackup RPC operation name. |

Metrics:

| Metric | Description | Dimensions | Unit |
|:------|:------------|:----------|:----|
| yugabytedb.tserver_tabletserverbackupservice_operations | TServer TabletServerBackupService Operations | operations | ops/s |
| yugabytedb.tserver_tabletserverbackupservice_operations_latency | TServer TabletServerBackupService Operations Latency | latency | microseconds |
| yugabytedb.tserver_tabletserverbackupservice_traffic | TServer TabletServerBackupService Traffic | received, sent | bytes/s |


### Per PgClientService (Tablet Server)

Metrics tracking latency and counts of PostgreSQL client service RPC operations on the Tablet server.

Labels:

| Label      | Description     |
|:-----------|:----------------|
| operation | The specific PgClientService RPC operation name that handles PostgreSQL protocol requests and responses. |

Metrics:

| Metric | Description | Dimensions | Unit |
|:------|:------------|:----------|:----|
| yugabytedb.tserver_pgclientservice_operations | TServer PgClientService Operations | operations | ops/s |
| yugabytedb.tserver_pgclientservice_operations_latency | TServer PgClientService Operations Latency | latency | microseconds |
| yugabytedb.tserver_pgclientservice_traffic | TServer PgClientService Traffic | received, sent | bytes/s |


### Per RemoteBootstrapService (Tablet Server)

Metrics tracking latency and counts of RemoteBootstrap RPC operations on the Tablet server.

Labels:

| Label      | Description     |
|:-----------|:----------------|
| operation | The specific RemoteBootstrap RPC operation name. |

Metrics:

| Metric | Description | Dimensions | Unit |
|:------|:------------|:----------|:----|
| yugabytedb.tserver_remotebootstrapservice_operations | TServer RemoteBootstrapService Operations | operations | ops/s |
| yugabytedb.tserver_remotebootstrapservice_operations_latency | TServer RemoteBootstrapService Operations Latency | latency | microseconds |
| yugabytedb.tserver_remotebootstrapservice_traffic | TServer RemoteBootstrapService Traffic | received, sent | bytes/s |


### Per Raft operations (Tablet Server)

Metrics tracking latency and counts of Raft consensus protocol operations on the Tablet server.

Labels:

| Label      | Description     |
|:-----------|:----------------|
| operation | The specific Raft protocol operation name. |

Metrics:

| Metric | Description | Dimensions | Unit |
|:------|:------------|:----------|:----|
| yugabytedb.tserver_consensus_operations | TServer Consensus Operations | operations | ops/s |
| yugabytedb.tserver_consensus_operations_latency | TServer Consensus Operations Operations Latency | latency | microseconds |
| yugabytedb.tserver_consensus_traffic | TServer Consensus Traffic | received, sent | bytes/s |


### Per SQL Statements (YCQL)

Metrics tracking latency and counts of SQL statements on the YCQL server.

Labels:

| Label      | Description     |
|:-----------|:----------------|
| statement | The specific SQL statement name. |

Metrics:

| Metric | Description | Dimensions | Unit |
|:------|:------------|:----------|:----|
| yugabytedb.ycql_sql_statements | YCQL SQL Statements | statements | statements/s |
| yugabytedb.yCql_sql_statements_latency | YCQL SQL Statements Latency | latency | microseconds |


### Per YSQL server

Metrics tracking connections on the YSQL server.

This scope has no labels.

Metrics:

| Metric | Description | Dimensions | Unit |
|:------|:------------|:----------|:----|
| yugabytedb.ysql_connection_usage | YSQL Connections Usage | available, used | connections |
| yugabytedb.ysql_active_connections | YSQL Active Connections | active | connections |
| yugabytedb.ysql_established_connections | YSQL Established Connections | established | connections/s |
| yugabytedb.ysql_over_limit_connections | YSQL Rejected Over Limit Connections | over_limit | rejects/s |


### Per SQL Statements (YSQL)

Metrics tracking latency and counts of SQL statements on the YSQL server.

Labels:

| Label      | Description     |
|:-----------|:----------------|
| statement | The specific SQL statement name. |

Metrics:

| Metric | Description | Dimensions | Unit |
|:------|:------------|:----------|:----|
| yugabytedb.ysql_sql_statements | YSQL SQL Statements | statements | statements/s |
| yugabytedb.ysql_sql_statements_latency | YSQL SQL Statements Latency | latency | microseconds |



## Live Data

This collector exposes real-time functions for interactive troubleshooting in the Live tab.


### Top Queries

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.

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.

Use cases:
- Identify slow queries consuming excessive total execution time
- Find high-frequency queries that may benefit from optimization
- Analyze query patterns by database and user

Query text is truncated at 4096 characters for display purposes.


| Aspect | Description |
|:-------|:------------|
| Name | `Yugabytedb:top-queries` |
| Require Cloud | yes |
| Performance | 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 |
| Security | 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 |
| Availability | 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 |

#### Prerequisites

##### Enable pg_stat_statements extension

The `pg_stat_statements` extension must be installed in the target YSQL database.

1. Install the extension:

   ```sql
   CREATE EXTENSION IF NOT EXISTS pg_stat_statements;
   ```

2. Verify access:

   ```sql
   SELECT * FROM pg_stat_statements LIMIT 1;
   ```

:::info

- The extension tracks statistics for all SQL statements executed
- Statistics can be reset with `SELECT pg_stat_statements_reset()`
- YugabyteDB uses PostgreSQL-compatible extensions

:::



#### Parameters

| Parameter | Type | Description | Required | Default | Options |
|:---------|:-----|:------------|:--------:|:--------|:--------|
| Filter By | select | 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. | yes | totalTime |  |

#### Returns

Aggregated query statistics from `pg_stat_statements`. Each row represents a unique query pattern with cumulative metrics across all executions.

| Column | Type | Unit | Visibility | Description |
|:-------|:-----|:-----|:-----------|:------------|
| Query ID | string |  | hidden | Internal hash identifier for the normalized query pattern. |
| Query | string |  |  | Normalized SQL query text with literals replaced by parameter placeholders. Truncated to 4096 characters. |
| Database | string |  |  | Database name where the query was executed. Useful for multi-database workload analysis. |
| User | string |  |  | YSQL user who executed the query. Useful for identifying workload by user or application. |
| Calls | integer |  |  | Total number of times this query pattern has been executed. High values indicate frequently run queries. |
| Total Time | duration | milliseconds |  | Cumulative execution time across all calls. Primary metric for identifying resource-intensive queries. |
| Mean Time | duration | milliseconds |  | Average execution time per call. Compare with total time to distinguish slow queries from frequently called ones. |
| Min Time | duration | milliseconds | hidden | Minimum execution time observed for this query pattern. |
| Max Time | duration | milliseconds | hidden | Maximum execution time observed. Large gaps between min and max may indicate parameter sensitivity or lock contention. |
| Rows | integer |  |  | Total number of rows retrieved or affected by the query across all executions. |
| Stddev Time | duration | milliseconds | hidden | Standard deviation of execution times. High values indicate inconsistent query performance. |

### Running Queries

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.

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.

Use cases:
- Identify long-running queries that may need investigation
- Monitor active connections and their current state
- Investigate blocked or waiting queries

Query text is truncated at 4096 characters for display purposes.


| Aspect | Description |
|:-------|:------------|
| Name | `Yugabytedb:running-queries` |
| Require Cloud | yes |
| Performance | 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 |
| Security | 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 |
| Availability | 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 |

#### Prerequisites

##### Grant access to all queries (optional)

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:

```sql
GRANT pg_read_all_stats TO your_user;
```

:::info

- The `yugabyte` superuser can see all queries by default
- Without elevated privileges, only the user's own queries are visible
- Idle connections are filtered out from results

:::



#### Parameters

| Parameter | Type | Description | Required | Default | Options |
|:---------|:-----|:------------|:--------:|:--------|:--------|
| Filter By | select | Select the primary sort column. Defaults to elapsed time to focus on longest-running queries. | yes | elapsedMs |  |

#### Returns

Currently running SQL statements from `pg_stat_activity`. Each row represents an active backend process with its current query and execution context.

| Column | Type | Unit | Visibility | Description |
|:-------|:-----|:-----|:-----------|:------------|
| PID | string |  | hidden | Backend process ID. Can be used with pg_terminate_backend() to cancel a query. |
| Query | string |  |  | The SQL statement currently being executed. Truncated to 4096 characters. |
| Database | string |  |  | Database name the backend is connected to. |
| User | string |  |  | YSQL user name of the backend process. |
| State | string |  |  | Current state of the backend (active, idle in transaction, fastpath function call, etc.). |
| Wait Event Type | string |  | hidden | Type of event the backend is waiting for (Lock, LWLock, IO, etc.). Null if not waiting. |
| Wait Event | string |  | hidden | Specific wait event name. Useful for diagnosing lock contention or I/O bottlenecks. |
| Application | string |  | hidden | Application name set by the client connection. Useful for identifying which application is running the query. |
| Client Address | string |  | hidden | IP address of the client connection. |
| Query Start | string |  | hidden | Timestamp when the current query began execution. |
| Elapsed | duration | milliseconds |  | Time elapsed since the query started. High values indicate long-running queries that may need investigation. |



## Troubleshooting

### Debug Mode

**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.

To troubleshoot issues with the `yugabytedb` collector, run the `go.d.plugin` with the debug option enabled. The output
should give you clues as to why the collector isn't working.

- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
  your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.

  ```bash
  cd /usr/libexec/netdata/plugins.d/
  ```

- Switch to the `netdata` user.

  ```bash
  sudo -u netdata -s
  ```

- Run the `go.d.plugin` to debug the collector:

  ```bash
  ./go.d.plugin -d -m yugabytedb
  ```

  To debug a specific job:

  ```bash
  ./go.d.plugin -d -m yugabytedb -j jobName
  ```

### Getting Logs

If you're encountering problems with the `yugabytedb` collector, follow these steps to retrieve logs and identify potential issues:

- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
- **Examine the output** for any warnings or error messages that might indicate issues.  These messages should provide clues about the root cause of the problem.

#### System with systemd

Use the following command to view logs generated since the last Netdata service restart:

```bash
journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep yugabytedb
```

#### System without systemd

Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:

```bash
grep yugabytedb /var/log/netdata/collector.log
```

**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.

#### Docker Container

If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:

```bash
docker logs netdata 2>&1 | grep yugabytedb
```
