Hashicorp Vault and OpenObserve Integration

Input and output integration overview

The Hashicorp Vault plugin for Telegraf allows for the collection of metrics from Hashicorp Vault services, facilitating monitoring and operational insights.

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

Hashicorp Vault

The Hashicorp Vault plugin is designed to collect metrics from Vault agents running within a cluster. It enables Telegraf, an agent for collecting and reporting metrics, to interface with the Vault services, typically listening on a local address such as http://127.0.0.1:8200. This plugin requires a valid token for authorization, ensuring secure access to the Vault API. Users must configure either a token directly or provide a path to a token file, enhancing flexibility in authentication methods. Proper configuration of the timeout and optional TLS settings further relates to the security and responsiveness of the metrics collection process. As Vault is a critical tool in managing secrets and protecting sensitive data, monitoring its performance and health through this plugin is essential for maintaining operational security and efficiency.

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

Hashicorp Vault

[[inputs.vault]]
  ## URL for the Vault agent
  # url = "http://127.0.0.1:8200"

  ## Use Vault token for authorization.
  ## Vault token configuration is mandatory.
  ## If both are empty or both are set, an error is thrown.
  # token_file = "/path/to/auth/token"
  ## OR
  token = "s.CDDrgg5zPv5ssI0Z2P4qxJj2"

  ## Set response_timeout (default 5 seconds)
  # response_timeout = "5s"

  ## Optional TLS Config
  # tls_ca = /path/to/cafile
  # tls_cert = /path/to/certfile
  # tls_key = /path/to/keyfile

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

Hashicorp Vault

1. Centralized Secret Management Monitoring: Utilize the Vault plugin to monitor multiple Vault instances across a distributed system, allowing for a unified view of secret access patterns and system health. This setup can help DevOps teams quickly identify any anomalies in secret access, providing essential insights into security postures across different environments.

2. Audit Logging Integration: Configure this plugin to feed monitoring metrics into an audit logging system, enabling organizations to have a comprehensive view of their Vault interactions. By correlating audit logs with metrics, teams can investigate issues, optimize performance, and ensure compliance with security policies more effectively.

3. Performance Benchmarking During Deployments: During application deployments that interact with Vault, use the plugin to monitor the effects of those deployments on Vault performance. This allows engineering teams to understand how changes impact secret management workflows and to proactively address performance bottlenecks, ensuring smooth deployment processes.

4. Alerting for Threshold Exceedance: Integrate this plugin with alerting mechanisms to notify administrators when metrics exceed predefined thresholds. This proactive monitoring can help teams respond swiftly to potential issues, maintaining system reliability and uptime by allowing them to take action before any serious incidents arise.

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.