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
The gnatsd_streaming check is not included in the Datadog Agent package, so you need to install it.
Installation
For Agent v7.21+ / v6.21+, follow the instructions below to install the gnatsd_streaming check on your host. See Use Community Integrations to install with the Docker Agent or earlier versions of the Agent.
Run the following command to install the Agent integration:
datadog-agent integration install -t datadog-gnatsd_streaming==<INTEGRATION_VERSION>
Configure your integration similar to core integrations.
Configuration
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.
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 currently 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 is issued when the status of a server changes between FT_STANDBY and FT_ACTIVE.
Service Checks
gnatsd_streaming.can_connect
Returns CRITICAL if the Agent can’t connect to the Gnastd Streaming endpoint, OK otherwise
Statuses: ok, critical
Troubleshooting
Need help? Contact Datadog support.
