Nginx and OpenObserve Integration

Input and output integration overview

The Nginx plugin for Telegraf is designed to collect status metrics from Nginx web servers, providing real-time insights into server operation metrics.

This configuration pairs Telegraf’s HTTP output with OpenObserve’s native JSON ingestion API, turning any Telegraf agent into a first-class OpenObserve collector.

Integration details

Nginx

This plugin gathers status metrics from Nginx. It utilizes the ngx_http_stub_status_module to collect basic metrics related to the server’s performance. The plugin provides valuable insights into active connections, requests handled, and the current state of various metrics. This real-time data is essential for monitoring web server performance and ensuring optimal operations. The configuration allows users to specify the URL for the Nginx status endpoint, set timeouts, and configure TLS settings if necessary.

OpenObserve

OpenObserve is an open source observability platform written in Rust that stores data cost-effectively on object storage or local disk. It exposes REST endpoints such as /api/{org}/ingest/metrics/_json that accept batched metric documents conforming to a concise JSON schema, making it an attractive drop-in replacement for Loki or Elasticsearch stacks. The Telegraf HTTP output plugin streams metrics to arbitrary HTTP targets; when the "data_format = "json"" serializer is selected, Telegraf batches its metric objects into a payload that matches OpenObserve’s ingestion contract. The plugin supports configurable batch size, custom headers, TLS, and compression, allowing operators to authenticate with Basic or Bearer tokens and to enforce back-pressure without additional collectors. By reusing existing Telegraf agents already collecting system, application, or SNMP data, organizations can funnel rich telemetry into OpenObserve dashboards and SQL-like analytics with minimal overhead, enabling unified observability, long-term retention, and real-time alerting without vendor lock-in.

Configuration

Nginx

[[inputs.nginx]]
  ## An array of Nginx stub_status URI to gather stats.
  urls = ["http://localhost/server_status"]

  ## 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 & host verification
  # insecure_skip_verify = false

  ## HTTP response timeout (default: 5s)
  response_timeout = "5s"

OpenObserve

[[outputs.http]]
  ## OpenObserve JSON metrics ingestion endpoint
  url = "https://api.openobserve.ai/api/default/ingest/metrics/_json"

  ## Use POST to push batches
  method = "POST"

  ## Basic auth header (base64 encoded "username:password")
  headers = { Authorization = "Basic dXNlcjpwYXNzd29yZA==" }

  ## Timeout for HTTP requests
  timeout = "10s"

  ## Override Content-Type to match OpenObserve expectation
  content_type = "application/json"

  ## Force Telegraf to batch and serialize metrics as JSON
  data_format = "json"

  ## JSON serializer specific options
  json_timestamp_units = "1ms"

  ## Uncomment to restrict batch size
  # batch_size = 5000

Input and output integration examples

Nginx

1. Web Performance Monitoring: Use the Nginx plugin to gather performance metrics from various Nginx servers across your infrastructure. By visualizing these metrics in real-time dashboards, teams can track performance trends, identify bottlenecks, and enhance the user experience on their web applications. Implementing such monitoring allows businesses to proactively address performance issues before they impact end-users.

2. Load Balancer Monitoring: Integrate this plugin with your load balancers to track the performance of backend Nginx servers. By collecting statistics like ‘active connections’ and ‘requests handled’, your operations team can ensure that traffic is flowing optimally and that no single server is overwhelmed. This proactive approach to load balancing prevents service downtime and enhances user experience.

3. Automated Alerting Systems: Combine the Nginx plugin with alerting services to automatically notify your team when a server’s metrics exceed predefined thresholds. For instance, if the number of active connections is too high, the system can trigger alerts so that corrective actions can be taken immediately, thus maintaining service quality and reliability.

4. Historical Data Analysis: Store the metrics collected by the Nginx plugin in a time-series database to analyze historical performance trends. This analysis can uncover periods of high traffic or poor performance, allowing for data-driven decisions about infrastructure scaling and optimization. By understanding past trends, organizations can better prepare for future demands.

OpenObserve

1. Edge Device Health Mirror: Deploy Telegraf on thousands of industrial IoT devices to capture temperature, vibration, and power metrics, then use this output to push JSON batches to OpenObserve. Plant operators gain a real-time overview of machine health and can trigger maintenance based on anomalies without relying on heavyweight collectors.

2. Blue-Green Deployment Canary: Attach a lightweight Telegraf sidecar to each Kubernetes release-candidate pod that scrapes /metrics and forwards container stats to a dedicated “canary” stream in OpenObserve. Continuous comparison of error rates between blue and green versions empowers the CI pipeline to auto-roll back poor performers within seconds.

3. Multi-Tenant SaaS Billing Pipeline: Emit per-customer usage counters via Telegraf and tag them with tenant_id; the HTTP plugin posts them to OpenObserve where SQL reports aggregate usage into invoices, eliminating separate metering services and simplifying compliance audits.

4. Security Threat Scoring: Fuse Suricata events and host resource metrics in Telegraf, deliver them to OpenObserve’s analytics engine, and run stream-processing rules that correlate spikes in suspicious traffic with CPU saturation to produce an actionable threat score and automatically open tickets in a SOAR platform.

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.