Join us at the Dash conference! July 16-17, NYC

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

To install the Gnatsd_streaming check on your host:

  1. Install the developer toolkit on any machine.
  2. Run ddev release build gnatsd_streaming to build the package.
  3. Download the Datadog Agent.
  4. Upload the build artifact to any host with an Agent and run datadog-agent integration install -w path/to/gnatsd_streaming/dist/<ARTIFACT_NAME>.whl.

Configuration

Edit the gnatsd_streaming.yaml file to point to your server and port, set the masters to monitor

You can change the number of channels returned in a single HTTP request with the pagination parameter in the conf.yaml file.

Validation

When you run datadog-agent info you should see something like the following:

Checks
======

    gnatsd_streaming
    -----------
      - instance #0 [OK]
      - Collected 39 metrics, 0 events & 7 service checks

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!