All Integrations / NATS and Sensu Integration

NATS and Sensu Integration

Powerful performance with an easy integration, powered by Telegraf, the open source data connector built by InfluxData.

Get This Integration for Free
info

This is not the recommended configuration for real-time query at scale. For query and compression optimization, high-speed ingest, and high availability, you may want to consider <a href="/integrations/nats_consumer-influxdb/">NATS and InfluxDB</a>.

5B+

Telegraf downloads

#1

Time series database
Source: DB Engines

1B+

Downloads of InfluxDB

2,800+

Contributors

Table of Contents

Useful Links

Documentation

Telegraf Quickstart Training

Infrastructure Monitoring with Telegraf

Powerful Performance, Limitless Scale

Collect, organize, and act on massive volumes of high-velocity data. Any data is more valuable when you think of it as time series data. with InfluxDB, the #1 time series platform built to scale with Telegraf.

See Ways to Get Started

Input and output integration overview

<p>The NATS Consumer Input Plugin enables real-time data consumption from NATS messaging subjects, integrating seamlessly into the Telegraf data pipeline for monitoring and metrics gathering.</p>

<p>This plugin writes metrics events to Sensu via its HTTP events API, enabling seamless integration with the Sensu monitoring platform.</p>

Integration details

NATS

<p>The NATS Consumer Plugin allows Telegraf to read metrics from specified NATS subjects and create metrics based on supported input data formats. Utilizing a Queue Group allows multiple instances of Telegraf to read from a NATS cluster in parallel, enhancing throughput and reliability. This plugin also supports various authentication methods, including username/password, NATS credentials files, and nkey seed files, ensuring secure communication with the NATS servers. It is particularly useful in environments where data persistence and message reliability are critical, thanks to features such as JetStream that facilitate the consumption of historical messages. Additionally, the ability to configure various operational parameters makes this plugin suitable for high-throughput scenarios while maintaining performance integrity.</p>

Sensu

<p>This plugin writes metrics events to Sensu via its HTTP events API. Sensu is a monitoring system that enables users to collect, analyze, and manage metrics from various components in their infrastructure. The plugin facilitates the integration of Telegraf, a server agent for collecting and reporting metrics, with the Sensu monitoring platform. Users can configure settings such as backend and agent API URLs, API keys for authentication, and optional TLS settings. The plugin’s core functionality is centered around sending metric events, including check and entity specifications, to Sensu, allowing for comprehensive monitoring and alerting. The API reference provides extensive details about the events and metrics structure, ensuring users can efficiently leverage Sensu’s capabilities for observability and incident response.</p>

Configuration

NATS

<pre><code class="language-toml">[[inputs.nats_consumer]] ## urls of NATS servers servers = ["nats://localhost:4222"] ## subject(s) to consume ## If you use jetstream you need to set the subjects ## in jetstream_subjects subjects = ["telegraf"] ## jetstream subjects ## jetstream is a streaming technology inside of nats. ## With jetstream the nats-server persists messages and ## a consumer can consume historical messages. This is ## useful when telegraf needs to restart it don't miss a ## message. You need to configure the nats-server. ## https://docs.nats.io/nats-concepts/jetstream. jetstream_subjects = ["js_telegraf"] ## name a queue group queue_group = "telegraf_consumers" ## Optional authentication with username and password credentials # username = "" # password = "" ## Optional authentication with NATS credentials file (NATS 2.0) # credentials = "/etc/telegraf/nats.creds" ## Optional authentication with nkey seed file (NATS 2.0) # nkey_seed = "/etc/telegraf/seed.txt" ## Use Transport Layer Security # secure = false ## Optional TLS Config # tls_ca = "/etc/telegraf/ca.pem" # tls_cert = "/etc/telegraf/cert.pem" # tls_key = "/etc/telegraf/key.pem" ## Use TLS but skip chain &amp; host verification # insecure_skip_verify = false ## Sets the limits for pending msgs and bytes for each subscription ## These shouldn't need to be adjusted except in very high throughput scenarios # pending_message_limit = 65536 # pending_bytes_limit = 67108864 ## Max undelivered messages ## This plugin uses tracking metrics, which ensure messages are read to ## outputs before acknowledging them to the original broker to ensure data ## is not lost. This option sets the maximum messages to read from the ## broker that have not been written by an output. ## ## This value needs to be picked with awareness of the agent's ## metric_batch_size value as well. Setting max undelivered messages too high ## can result in a constant stream of data batches to the output. While ## setting it too low may never flush the broker's messages. # max_undelivered_messages = 1000 ## Data format to consume. ## Each data format has its own unique set of configuration options, read ## more about them here: ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md data_format = "influx" </code></pre>

Sensu

<pre><code class="language-toml">[[outputs.sensu]] ## BACKEND API URL is the Sensu Backend API root URL to send metrics to ## (protocol, host, and port only). The output plugin will automatically ## append the corresponding backend API path ## /api/core/v2/namespaces/:entity_namespace/events/:entity_name/:check_name). ## ## Backend Events API reference: ## https://docs.sensu.io/sensu-go/latest/api/events/ ## ## AGENT API URL is the Sensu Agent API root URL to send metrics to ## (protocol, host, and port only). The output plugin will automatically ## append the correspeonding agent API path (/events). ## ## Agent API Events API reference: ## https://docs.sensu.io/sensu-go/latest/api/events/ ## ## NOTE: if backend_api_url and agent_api_url and api_key are set, the output ## plugin will use backend_api_url. If backend_api_url and agent_api_url are ## not provided, the output plugin will default to use an agent_api_url of ## http://127.0.0.1:3031 ## # backend_api_url = "http://127.0.0.1:8080" # agent_api_url = "http://127.0.0.1:3031" ## API KEY is the Sensu Backend API token ## Generate a new API token via: ## ## $ sensuctl cluster-role create telegraf --verb create --resource events,entities ## $ sensuctl cluster-role-binding create telegraf --cluster-role telegraf --group telegraf ## $ sensuctl user create telegraf --group telegraf --password REDACTED ## $ sensuctl api-key grant telegraf ## ## For more information on Sensu RBAC profiles &amp; API tokens, please visit: ## - https://docs.sensu.io/sensu-go/latest/reference/rbac/ ## - https://docs.sensu.io/sensu-go/latest/reference/apikeys/ ## # api_key = "${SENSU_API_KEY}" ## Optional TLS Config # tls_ca = "/etc/telegraf/ca.pem" # tls_cert = "/etc/telegraf/cert.pem" # tls_key = "/etc/telegraf/key.pem" ## Use TLS but skip chain &amp; host verification # insecure_skip_verify = false ## Timeout for HTTP message # timeout = "5s" ## HTTP Content-Encoding for write request body, can be set to "gzip" to ## compress body or "identity" to apply no encoding. # content_encoding = "identity" ## NOTE: Due to the way TOML is parsed, tables must be at the END of the ## plugin definition, otherwise additional config options are read as part of ## the table ## Sensu Event details ## ## Below are the event details to be sent to Sensu. The main portions of the ## event are the check, entity, and metrics specifications. For more information ## on Sensu events and its components, please visit: ## - Events - https://docs.sensu.io/sensu-go/latest/reference/events ## - Checks - https://docs.sensu.io/sensu-go/latest/reference/checks ## - Entities - https://docs.sensu.io/sensu-go/latest/reference/entities ## - Metrics - https://docs.sensu.io/sensu-go/latest/reference/events#metrics ## ## Check specification ## The check name is the name to give the Sensu check associated with the event ## created. This maps to check.metadata.name in the event. [outputs.sensu.check] name = "telegraf" ## Entity specification ## Configure the entity name and namespace, if necessary. This will be part of ## the entity.metadata in the event. ## ## NOTE: if the output plugin is configured to send events to a ## backend_api_url and entity_name is not set, the value returned by ## os.Hostname() will be used; if the output plugin is configured to send ## events to an agent_api_url, entity_name and entity_namespace are not used. # [outputs.sensu.entity] # name = "server-01" # namespace = "default" ## Metrics specification ## Configure the tags for the metrics that are sent as part of the Sensu event # [outputs.sensu.tags] # source = "telegraf" ## Configure the handler(s) for processing the provided metrics # [outputs.sensu.metrics] # handlers = ["influxdb","elasticsearch"] </code></pre>

Input and output integration examples

NATS

<ol> <li> <p><strong>Real-Time Analytics Dashboard</strong>: Utilize the NATS plugin to gather metrics from various NATS subjects in real time and feed them into a centralized analytics dashboard. This setup allows for immediate visibility into live application performance, enabling teams to react swiftly to operational issues or performance degradation.</p> </li> <li> <p><strong>Distributed System Monitoring</strong>: Deploy multiple instances of Telegraf configured with the NATS plugin across a distributed architecture. This approach allows teams to aggregate metrics from various microservices efficiently, providing a holistic view of system health and performance while ensuring no messages are dropped during transmission.</p> </li> <li> <p><strong>Historical Message Recovery</strong>: Leverage the capabilities of NATS JetStream along with this plugin to recover and process historical messages after Telegraf has been restarted. This feature is particularly beneficial for applications that require high reliability, ensuring that no critical metrics are lost even in case of service disruptions.</p> </li> <li> <p><strong>Dynamic Load Balancing</strong>: Implement a dynamic load balancing scenario where Telegraf instances consume messages from a NATS cluster based on load. Adjust the queue group settings to control the number of active consumers, allowing for better resource utilization and performance scaling as demand fluctuations occur.</p> </li> </ol>

Sensu

<ol> <li> <p><strong>Real-Time Infrastructure Monitoring</strong>: Utilize the Sensu plugin to send performance metrics from various servers and services directly to Sensu. This real-time data flow enables teams to visualize infrastructure health, track resource usage, and receive immediate alerts for any anomalies detected. By centralizing monitoring through Sensu, organizations can create a holistic view of their systems and respond swiftly to issues.</p> </li> <li> <p><strong>Automated Incident Response Workflows</strong>: Leverage the plugin to automatically trigger incident response workflows based on the metrics events sent to Sensu. For example, if CPU usage exceeds a defined threshold, the Sensu system can be configured to alert the operations team, which can then initiate automated remediation processes, reducing downtime and maintaining system reliability. This integration allows for proactive management of system resources.</p> </li> <li> <p><strong>Dynamic Scaling of Resources</strong>: Use the Sensu plugin to feed metrics into an auto-scaling system that adjusts resources based on demand. By tracking metrics like request load and resource utilization, organizations can automatically scale their infrastructure up or down, ensuring optimal performance and cost efficiency without manual intervention.</p> </li> <li> <p><strong>Centralized Logging and Monitoring</strong>: Combine the Sensu with logging tools to send logs and performance metrics to a centralized monitoring system. This comprehensive approach allows teams to correlate logs with metric events, providing deeper insights into system behavior and performance, which aids in troubleshooting and performance optimization over time.</p> </li> </ol>

Feedback

Thank you for being part of our community! If you have any general feedback or found any bugs on these pages, we welcome and encourage your input. Please submit your feedback in the InfluxDB community Slack.

Useful Links

Documentation

Telegraf Quickstart Training

Infrastructure Monitoring with Telegraf

Powerful Performance, Limitless Scale

Collect, organize, and act on massive volumes of high-velocity data. Any data is more valuable when you think of it as time series data. with InfluxDB, the #1 time series platform built to scale with Telegraf.

See Ways to Get Started

Related Integrations

HTTP and InfluxDB Integration

The HTTP plugin collects metrics from one or more HTTP(S) endpoints. It supports various authentication methods and configuration options for data formats.

View Integration

Kafka and InfluxDB Integration

This plugin reads messages from Kafka and allows the creation of metrics based on those messages. It supports various configurations including different Kafka settings and message processing options.

View Integration

Kinesis and InfluxDB Integration

The Kinesis plugin allows for reading metrics from AWS Kinesis streams. It supports multiple input data formats and offers checkpointing features with DynamoDB for reliable message processing.

View Integration

Start building now

Download Telegraf today or learn more about InfluxDB.

telegraf Get started with InfluxDB
Product & Solutions
Developers
Company

548 Market St, PMB 77953
San Francisco, California 94104

© 2025 InfluxData Inc. All Rights Reserved.

Legal Security Cookie Policy Comparison