Skip to main content

Apache Pulsar

Plugin: go.d.plugin Module: pulsar

Overview

This collector monitors Pulsar servers.

It collects broker statistics using Pulsar's Prometheus endpoint.

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 Pulsar instances running on localhost.

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.

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.

  • topic_* metrics are available when exposeTopicLevelMetricsInPrometheus is set to true.
  • subscription_* and namespace_subscription metrics are available when exposeTopicLevelMetricsInPrometheus si set to true.
  • replication* and namespace_replication* metrics are available when replication is configured and replicationMetricsEnabled is set to true.

Per Apache Pulsar instance

These metrics refer to the entire monitored application.

This scope has no labels.

Metrics:

MetricDimensionsUnit
pulsar.broker_componentsnamespaces, topics, subscriptions, producers, consumerscomponents
pulsar.messages_ratepublish, dispatchmessages/s
pulsar.throughput_ratepublish, dispatchKiB/s
pulsar.storage_sizeusedKiB
pulsar.storage_operations_rateread, writemessage batches/s
pulsar.msg_backlogbacklogmessages
pulsar.storage_write_latency<=0.5ms, <=1ms, <=5ms, =10ms, <=20ms, <=50ms, <=100ms, <=200ms, <=1s, >1sentries/s
pulsar.entry_size<=128B, <=512B, <=1KB, <=2KB, <=4KB, <=16KB, <=100KB, <=1MB, >1MBentries/s
pulsar.subscription_delayeddelayedmessage batches
pulsar.subscription_msg_rate_redeliverredeliveredmessages/s
pulsar.subscription_blocked_on_unacked_messagesblockedsubscriptions
pulsar.replication_ratein, outmessages/s
pulsar.replication_throughput_ratein, outKiB/s
pulsar.replication_backlogbacklogmessages

Per namespace

TBD

This scope has no labels.

Metrics:

MetricDimensionsUnit
pulsar.namespace_broker_componentstopics, subscriptions, producers, consumerscomponents
pulsar.namespace_messages_ratepublish, dispatchmessages/s
pulsar.namespace_throughput_ratepublish, dispatchKiB/s
pulsar.namespace_storage_sizeusedKiB
pulsar.namespace_storage_operations_rateread, writemessage batches/s
pulsar.namespace_msg_backlogbacklogmessages
pulsar.namespace_storage_write_latency<=0.5ms, <=1ms, <=5ms, =10ms, <=20ms, <=50ms, <=100ms, <=200ms, <=1s, >1sentries/s
pulsar.namespace_entry_size<=128B, <=512B, <=1KB, <=2KB, <=4KB, <=16KB, <=100KB, <=1MB, >1MBentries/s
pulsar.namespace_subscription_delayeddelayedmessage batches
pulsar.namespace_subscription_msg_rate_redeliverredeliveredmessages/s
pulsar.namespace_subscription_blocked_on_unacked_messagesblockedsubscriptions
pulsar.namespace_replication_ratein, outmessages/s
pulsar.namespace_replication_throughput_ratein, outKiB/s
pulsar.namespace_replication_backlogbacklogmessages
pulsar.topic_producersa dimension per topicproducers
pulsar.topic_subscriptionsa dimension per topicsubscriptions
pulsar.topic_consumersa dimension per topicconsumers
pulsar.topic_messages_rate_ina dimension per topicpublishes/s
pulsar.topic_messages_rate_outa dimension per topicdispatches/s
pulsar.topic_throughput_rate_ina dimension per topicKiB/s
pulsar.topic_throughput_rate_outa dimension per topicKiB/s
pulsar.topic_storage_sizea dimension per topicKiB
pulsar.topic_storage_read_ratea dimension per topicmessage batches/s
pulsar.topic_storage_write_ratea dimension per topicmessage batches/s
pulsar.topic_msg_backloga dimension per topicmessages
pulsar.topic_subscription_delayeda dimension per topicmessage batches
pulsar.topic_subscription_msg_rate_redelivera dimension per topicmessages/s
pulsar.topic_subscription_blocked_on_unacked_messagesa dimension per topicblocked subscriptions
pulsar.topic_replication_rate_ina dimension per topicmessages/s
pulsar.topic_replication_rate_outa dimension per topicmessages/s
pulsar.topic_replication_throughput_rate_ina dimension per topicmessages/s
pulsar.topic_replication_throughput_rate_outa dimension per topicmessages/s
pulsar.topic_replication_backloga dimension per topicmessages

Alerts

There are no alerts configured by default for this integration.

Setup

Prerequisites

No action required.

Configuration

File

The configuration file name for this integration is go.d/pulsar.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/pulsar.conf

Options

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

Config options
NameDescriptionDefaultRequired
update_everyData collection frequency.1no
autodetection_retryRecheck interval in seconds. Zero means no recheck will be scheduled.0no
urlServer URL.http://127.0.0.1:8080/metricsyes
timeoutHTTP request timeout.1no
usernameUsername for basic HTTP authentication.no
passwordPassword for basic HTTP authentication.no
proxy_urlProxy URL.no
proxy_usernameUsername for proxy basic HTTP authentication.no
proxy_passwordPassword for proxy basic HTTP authentication.no
methodHTTP request method.GETno
bodyHTTP request body.no
headersHTTP request headers.no
not_follow_redirectsRedirect handling policy. Controls whether the client follows redirects.nono
tls_skip_verifyServer certificate chain and hostname validation policy. Controls whether the client performs this check.nono
tls_caCertification authority that the client uses when verifying the server's certificates.no
tls_certClient TLS certificate.no
tls_keyClient TLS key.no

Examples

Basic

A basic example configuration.

jobs:
- name: local
url: http://127.0.0.1:8080/metrics

HTTP authentication

Basic HTTP authentication.

Config
jobs:
- name: local
url: http://127.0.0.1:8080/metrics
username: username
password: password

HTTPS with self-signed certificate

Do not validate server certificate chain and hostname.

Config
jobs:
- name: local
url: https://127.0.0.1:8080/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.

Config
jobs:
- name: local
url: http://127.0.0.1:8080/metrics

- name: remote
url: http://192.0.2.1:8080/metrics

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 pulsar 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 pulsar

Getting Logs

If you're encountering problems with the pulsar 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 pulsar

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 pulsar /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 pulsar

Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.