YugabyteDB icon

YugabyteDB

YugabyteDB

Plugin: go.d.plugin Module: yugabytedb

Overview

This collector monitors the activity and performance of YugabyteDB servers.

It sends HTTP requests to the YugabyteDB metric endpoints.

This collector is supported on all platforms.

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

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

Prerequisites

No action required.

Configuration

File

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

You can edit the configuration file using the edit-config script from the Netdata config directory.

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

Options

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

Name Description Default Required
update_every Data collection frequency. 5 no
autodetection_retry Recheck interval in seconds. Zero means no recheck will be scheduled. 0 no
url Server URL. http://127.0.0.1:7000/prometheus-metrics yes
timeout HTTP request timeout. 1 no
username Username for basic HTTP authentication. no
password Password for basic HTTP authentication. no
proxy_url Proxy URL. no
proxy_username Username for proxy basic HTTP authentication. no
proxy_password Password for proxy basic HTTP authentication. no
method HTTP request method. GET no
body HTTP request body. no
headers HTTP request headers. no
not_follow_redirects Redirect handling policy. Controls whether the client follows redirects. no no
tls_skip_verify Server certificate chain and hostname validation policy. Controls whether the client performs this check. no no
tls_ca Certification authority that the client uses when verifying the server’s certificates. no
tls_cert Client TLS certificate. no
tls_key Client TLS key. no

Examples

Basic

A basic example configuration.

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
HTTP authentication

Basic HTTP authentication.

jobs:
  - name: local
    url: http://127.0.0.1:7000/prometheus-metrics
    username: username
    password: password
HTTPS with self-signed certificate

NGINX with enabled HTTPS and self-signed certificate.

jobs:
  - name: local
    url: https://127.0.0.1:7000/prometheus-metrics
    tls_skip_verify: yes
Multi-instance

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

Collecting metrics from local and remote instances.

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

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

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 Dimensions Unit
yugabytedb.master_client_operations operations ops/s
yugabytedb.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 Dimensions Unit
yugabytedb.master_ddl_operations operations ops/s
yugabytedb.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 Dimensions Unit
yugabytedb.master_tabletserverservice_operations operations ops/s
yugabytedb.master_tabletserverservice_operations_latency latency microseconds
yugabytedb.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 Dimensions Unit
yugabytedb.master_pgclientservice_operations operations ops/s
yugabytedb.master_pgclientservice_operations_latency latency microseconds
yugabytedb.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 Dimensions Unit
yugabytedb.master_remotebootstrapservice_operations operations ops/s
yugabytedb.master_remotebootstrapservice_operations_latency latency microseconds
yugabytedb.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 Dimensions Unit
yugabytedb.master_consensus_operations operations ops/s
yugabytedb.master_consensus_operations_latency latency microseconds
yugabytedb.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 Dimensions Unit
yugabytedb.tserver_tabletserverservice_operations operations ops/s
yugabytedb.tserver_tabletserverservice_operations_latency latency microseconds
yugabytedb.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 Dimensions Unit
yugabytedb.tserver_tabletserveradminservice_operations operations ops/s
yugabytedb.tserver_tabletserveradminservice_operations_latency latency microseconds
yugabytedb.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 Dimensions Unit
yugabytedb.tserver_tabletserverbackupservice_operations operations ops/s
yugabytedb.tserver_tabletserverbackupservice_operations_latency latency microseconds
yugabytedb.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 Dimensions Unit
yugabytedb.tserver_pgclientservice_operations operations ops/s
yugabytedb.tserver_pgclientservice_operations_latency latency microseconds
yugabytedb.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 Dimensions Unit
yugabytedb.tserver_remotebootstrapservice_operations operations ops/s
yugabytedb.tserver_remotebootstrapservice_operations_latency latency microseconds
yugabytedb.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 Dimensions Unit
yugabytedb.tserver_consensus_operations operations ops/s
yugabytedb.tserver_consensus_operations_latency latency microseconds
yugabytedb.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 Dimensions Unit
yugabytedb.ycql_sql_statements statements statements/s
yugabytedb.yCql_sql_statements_latency latency microseconds

Per YSQL server

Metrics tracking connections on the YSQL server.

This scope has no labels.

Metrics:

Metric Dimensions Unit
yugabytedb.ysql_connection_usage available, used connections
yugabytedb.ysql_active_connections active connections
yugabytedb.ysql_established_connections established connections/s
yugabytedb.ysql_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 Dimensions Unit
yugabytedb.ysql_sql_statements statements statements/s
yugabytedb.ysql_sql_statements_latency latency microseconds

Alerts

There are no alerts configured by default for this integration.

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].

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

  • Switch to the netdata user.

    sudo -u netdata -s

  • Run the go.d.plugin to debug the collector:

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

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:

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:

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:

docker logs netdata 2>&1 | grep yugabytedb

The observability platform companies need to succeed

Sign up for free

Want a personalised demo of Netdata for your use case?

Book a Demo