Pulsar

Pulsar

Agent Check Agent Check

Linux Mac OS Windows OS Supported

Overview

This check monitors Pulsar through the Datadog Agent.

Setup

Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the Autodiscovery Integration Templates for guidance on applying these instructions.

Installation

To install the Pulsar check on your host:

  1. Install the developer toolkit on any machine.

  2. Clone the integrations-extras repository:

    git clone https://github.com/DataDog/integrations-extras.git.
    
  3. Update your ddev config with the integrations-extras/ path:

    ddev config set extras ./integrations-extras
    
  4. To build the Pulsar package, run:

    ddev -e release build pulsar
    
  5. Download the Datadog Agent.

  6. Upload the build artifact to any host with an Agent and run

    datadog-agent integration install -w path/to/pulsar/dist/<ARTIFACT_NAME>.whl
    

Configuration

  1. Edit the pulsar.d/conf.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your Pulsar performance data. See the sample pulsar.d/conf.yaml for all available configuration options.

  2. Restart the Agent.

Validation

Run the Agent’s status subcommand and look for pulsar under the Checks section.

Data Collected

Metrics

kesque.pulsar.consumer.available_permits
(gauge)
Consumer Available Permits
kesque.pulsar.consumer.blocked_on_unacked_messages
(gauge)
Consumer blocked on unacked message
kesque.pulsar.consumer.msg_rate_out
(gauge)
Outbound Message Rate
kesque.pulsar.consumer.msg_rate_redeliver
(gauge)
Message Redelivery Rate
kesque.pulsar.consumer.msg_throughput_out
(gauge)
Outbound Message Throughput Rate
kesque.pulsar.consumer.unacked_messages
(gauge)
This is the number of unacked message for this consumer
kesque.pulsar.consumers_count
(gauge)
Consumer counts
kesque.pulsar.entry_size_count
(gauge)
entry rate size of a namespace count
kesque.pulsar.entry_size_le_100_kb
(gauge)
The entry rate of a namespace that the entry size is less than 100KB
kesque.pulsar.entry_size_le_128
(gauge)
The entry rate of a namespace that the entry size is less than 128 bytes
kesque.pulsar.entry_size_le_16_kb
(gauge)
The entry rate of a namespace that the entry size is less than 16KB
kesque.pulsar.entry_size_le_1_kb
(gauge)
The entry rate of a namespace that the entry size is less than 1KB
kesque.pulsar.entry_size_le_1_mb
(gauge)
The entry rate of a namespace that the entry size is less than 1MB
kesque.pulsar.entry_size_le_2_kb
(gauge)
The entry rate of a namespace that the entry size is less than 2KB
kesque.pulsar.entry_size_le_4_kb
(gauge)
The entry rate of a namespace that the entry size is less than 4KB
kesque.pulsar.entry_size_le_512
(gauge)
The entry rate of a namespace that the entry size is less than 512 bytes
kesque.pulsar.entry_size_le_overflow
(gauge)
The entry rate of a namespace that the entry size is more than 1MB
kesque.pulsar.in_bytes_total
(count)
The total number of bytes received for this topic
kesque.pulsar.in_messages_total
(count)
The total number of messages received for this topic
kesque.pulsar.msg_backlog
(gauge)
The number of messages in the topic backlog
kesque.pulsar.out_bytes_total
(count)
The total number of bytes read from this topic
kesque.pulsar.out_messages_total
(count)
The total number of messages read from this topic
kesque.pulsar.producers_count
(gauge)
The number of active producers of the namespace connected to this broker
kesque.pulsar.rate_in
(gauge)
The total message rate of the namespace coming into this broker
kesque.pulsar.rate_out
(gauge)
The total message rate of the namespace going out from this broker
kesque.pulsar.replication.backlog
(gauge)
The total message backlog of the namespace replicating to remote cluster
kesque.pulsar.replication.rate_in
(gauge)
The total message rate of the namespace replicating from remote cluster
kesque.pulsar.replication.rate_out
(gauge)
The total message rate of the namespace replicating to remote cluster
kesque.pulsar.replication.throughput_in
(gauge)
The total throughput of the namespace replicating from remote cluster
kesque.pulsar.replication.throughput_out
(gauge)
The total throughput of the namespace replicating to remote cluster
kesque.pulsar.storage.backlog_quota_limit
(gauge)
The total bytes of the data in this topic that limit the backlog quota
kesque.pulsar.storage.backlog_size
(gauge)
The total number messages of a topic's backlog by this broker
kesque.pulsar.storage.read_rate
(gauge)
The total message batches (entries) read from the storage for this topic
kesque.pulsar.storage.offloaded_size
(gauge)
The total bytes of the data in this topic offloaded to the tiered storage
kesque.pulsar.storage.size
(gauge)
The total tiered storage size in this topic owned by this broker
kesque.pulsar.storage.write_latency_count
(gauge)
the count for the tiered storage write latency
kesque.pulsar.storage.write_latency_le_0_5
(gauge)
The entry rate of a namespace that the storage write latency is less than 0.5ms
kesque.pulsar.storage.write_latency_le_1
(gauge)
The entry rate of a namespace that the storage write latency is less than 1ms
kesque.pulsar.storage.write_latency_le_10
(gauge)
The entry rate of a namespace that the storage write latency is less than 10ms
kesque.pulsar.storage.write_latency_le_100
(gauge)
The entry rate of a namespace that the storage write latency is less than 100ms
kesque.pulsar.storage.write_latency_le_1000
(gauge)
The entry rate of a namespace that the storage write latency is less than 1s
kesque.pulsar.storage.write_latency_le_20
(gauge)
The entry rate of a namespace that the storage write latency is less than 20ms
kesque.pulsar.storage.write_latency_le_200
(gauge)
The entry rate of a namespace that the storage write latency is less than 200ms
kesque.pulsar.storage.write_latency_le_5
(gauge)
The entry rate of a namespace that the storage write latency is less than 5ms
kesque.pulsar.storage.write_latency_le_50
(gauge)
The entry rate of a namespace that the storage write latency is less than 50ms
kesque.pulsar.storage.write_latency_overflow
(gauge)
The entry rate of a namespace that the storage write latency is over 1s
kesque.pulsar.storage.write_latency_sum
(gauge)
The total storage write latency of a namespace
kesque.pulsar.storage.write_rate
(gauge)
The message batches rate written to the storage for this namespace
kesque.pulsar.subscription.back_log
(gauge)
The total message blacklog of a subscription
kesque.pulsar.subscription.back_log_no_delayed
(gauge)
The total message blacklog of a subscription with no delay
kesque.pulsar.subscription.blocked_on_unacked_messages
(gauge)
Message Redelivery Rate
kesque.pulsar.subscription.delayed
(gauge)
The total number of messages are delayed to be dispatched for a subscription
kesque.pulsar.subscription.msg_rate_out
(gauge)
The total message dispatch rate for a subscription
kesque.pulsar.subscription.msg_rate_redeliver
(gauge)
The total message rate for message being redelivered
kesque.pulsar.subscription.msg_throughput_out
(gauge)
The message dispatch throughput for a subscription
kesque.pulsar.subscription.unacked_messages
(gauge)
The total number of unacknowledged messages of a subscription
kesque.pulsar.subscriptions.count
(gauge)
The number of subscription for a topic
kesque.pulsar.throughput_in
(gauge)
The total throughput of the namespace coming into this broker
kesque.pulsar.throughput_out
(gauge)
The total throughput of the namespace going out from this broker
kesque.pulsar.topics_count
(gauge)
The number of Pulsar topics of the namespace owned by this broker
kesque.pulsar.broker.up
(gauge)
The broker status up or down

Service Checks

pulsar does not include any service checks.

Events

pulsar does not include any events.

Troubleshooting

Need help? Contact Datadog support.