New announcements for Serverless, Network, RUM, and more from Dash! New announcements from Dash!

Gnatsd_streaming

Agent Check Agent Check

Supported OS: Linux Mac OS Windows

Overview

Get metrics from gnatsd_streaming service in real time to:

  • Visualize and monitor gnatsd_streaming states
  • Be notified about gnatsd_streaming failovers and events.

Setup

Installation

If you are using Agent v6.8+ follow the instructions below to install the gnatsd_streaming check on your host. See our dedicated Agent guide for installing community integrations to install checks with the Agent prior v6.8 or the Docker Agent:

  1. Install the developer toolkit.
  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 gnatsd_streaming package, run:

    ddev -e release build gnatsd_streaming
    
  5. Download and launch the Datadog Agent.

  6. Run the following command to install the integrations wheel with the Agent:

    datadog-agent integration install -w <PATH_OF_GNATSD_STREAMING_ARTIFACT_>/<GNATSD_STREAMING_ARTIFACT_NAME>.whl
    
  7. Configure your integration like any other packaged integration.

Configuration

  1. Edit the gnatsd_streaming.d/conf.yaml file in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your GnatsD streaming metrics. See the sample gnatsd_streaming.d/conf.yaml for all available configuration options.

  2. Restart the Agent

Validation

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

Compatibility

The gnatsd_streaming check is compatible with all major platforms

Data Collected

Metrics

gnatsd.streaming.serverz.clients
(gauge)
The number of currectly connectied clients
Shown as unit
gnatsd.streaming.serverz.subscriptions
(count)
The number of subscriptions the server has handled
Shown as unit
gnatsd.streaming.serverz.channels
(gauge)
The number of currently active channels
Shown as unit
gnatsd.streaming.serverz.total_msgs
(count)
The total number of messages passed through the server
Shown as unit
gnatsd.streaming.serverz.total_bytes
(count)
The total number of bytes passed through the server
Shown as byte
gnatsd.streaming.storez.total_msgs
(count)
The total number of messages passed through the store
Shown as unit
gnatsd.streaming.storez.total_bytes
(count)
The total number of bytes passed through the store
Shown as byte
gnatsd.streaming.clientsz.total
(gauge)
The number of clients connected
Shown as unit
gnatsd.streaming.channelsz.total
(gauge)
The number of channels open
Shown as unit
gnatsd.streaming.channelsz.msgs
(count)
The total count of messages in a channel
Shown as unit
gnatsd.streaming.channelsz.bytes
(count)
The total bytes of messages in a channel
Shown as byte

Nats Streaming Server metrics are tagged with names like “nss-cluster_id”

Events

If you are running Nats Streaming Server in a Fault Tolerant group a Nats Streaming Failover event will be issued when the status of a Server changes between FT_STANDBY and FT_ACTIVE

Service Checks

This gnatsd_streaming check tags all service checks it collects with:

  • server_name:<server_name_in_yaml>
  • url:<host_in_yaml>

gnatsd_streaming.can_connect: Returns CRITICAL if the Agent fails to receive a 200 from the monitoring endpoint, otherwise returns OK.

Troubleshooting

Need help? Contact Datadog support.


Mistake in the docs? Feel free to contribute!