OpenTelemetry and OSI PI Integration

Input and output integration overview

This plugin receives traces, metrics, and logs from OpenTelemetry clients and agents via gRPC, enabling comprehensive observability of applications.

This setup converts Telegraf into a lightweight PI Web API publisher, letting you push any Telegraf metric into the OSI PI System with a simple HTTP POST.

Integration details

OpenTelemetry

The OpenTelemetry plugin is designed to receive telemetry data such as traces, metrics, and logs from clients and agents implementing OpenTelemetry via gRPC. This plugin initiates a gRPC service that listens for incoming telemetry data, making it distinct from standard plugins that collect metrics at defined intervals. The OpenTelemetry ecosystem aids developers in observing and understanding their applications’ performance by providing a vendor-neutral way to instrument, generate, collect, and export telemetry data. Key features of this plugin include customizable connection timeouts, adjustable maximum message sizes for incoming data, and options for specifying span, log, and profile dimensions to tag the incoming metrics. With this flexibility, organizations can tailor their telemetry collection to meet precise observability requirements and ensure seamless data integration into systems like InfluxDB.

OSI PI

OSI PI is an data management and analytics platform used in energy, manufacturing, and critical infrastructure. The PI Web API is its REST interface, exposing endpoints such as /piwebapi/streams/{WebId}/value that accept JSON payloads containing a Timestamp and Value. By pairing Telegraf’s flexible HTTP output with this endpoint, any metric Telegraf collects—SNMP counters, Modbus readings, Kubernetes stats—can be written directly into PI without installing proprietary interfaces. The configuration above authenticates with Basic or Kerberos, serializes each batch to JSON, and renders a minimal body template that aligns with PI Web API’s single-value write contract. Because Telegraf already supports batching, TLS, proxies, and custom headers, this approach scales from edge gateways to cloud VMs, allowing organizations to back-fill historical data, stream live telemetry, or mirror non-PI sources (e.g., Prometheus) into the PI data archive. It also sidesteps older SDK dependencies and enables hybrid architectures where PI remains on-prem while Telegraf agents run in containers or IIoT devices.

Configuration

OpenTelemetry

[[inputs.opentelemetry]]
  ## Override the default (0.0.0.0:4317) destination OpenTelemetry gRPC service
  ## address:port
  # service_address = "0.0.0.0:4317"

  ## Override the default (5s) new connection timeout
  # timeout = "5s"

  ## gRPC Maximum Message Size
  # max_msg_size = "4MB"

  ## Override the default span attributes to be used as line protocol tags.
  ## These are always included as tags:
  ## - trace ID
  ## - span ID
  ## Common attributes can be found here:
  ## - https://github.com/open-telemetry/opentelemetry-collector/tree/main/semconv
  # span_dimensions = ["service.name", "span.name"]

  ## Override the default log record attributes to be used as line protocol tags.
  ## These are always included as tags, if available:
  ## - trace ID
  ## - span ID
  ## Common attributes can be found here:
  ## - https://github.com/open-telemetry/opentelemetry-collector/tree/main/semconv
  ## When using InfluxDB for both logs and traces, be certain that log_record_dimensions
  ## matches the span_dimensions value.
  # log_record_dimensions = ["service.name"]

  ## Override the default profile attributes to be used as line protocol tags.
  ## These are always included as tags, if available:
  ## - profile_id
  ## - address
  ## - sample
  ## - sample_name
  ## - sample_unit
  ## - sample_type
  ## - sample_type_unit
  ## Common attributes can be found here:
  ## - https://github.com/open-telemetry/opentelemetry-collector/tree/main/semconv
  # profile_dimensions = []

  ## Override the default (prometheus-v1) metrics schema.
  ## Supports: "prometheus-v1", "prometheus-v2"
  ## For more information about the alternatives, read the Prometheus input
  ## plugin notes.
  # metrics_schema = "prometheus-v1"

  ## Optional TLS Config.
  ## For advanced options: https://github.com/influxdata/telegraf/blob/v1.18.3/docs/TLS.md
  ##
  ## Set one or more allowed client CA certificate file names to
  ## enable mutually authenticated TLS connections.
  # tls_allowed_cacerts = ["/etc/telegraf/clientca.pem"]
  ## Add service certificate and key.
  # tls_cert = "/etc/telegraf/cert.pem"
  # tls_key = "/etc/telegraf/key.pem"

OSI PI

[[outputs.http]]
  ## PI Web API endpoint for writing a single value to a PI Point by Web ID
  url = "https://${PI_HOST}/piwebapi/streams/${WEB_ID}/value"

  ## Use POST for each batch
  method       = "POST"
  content_type = "application/json"

  ## Basic-auth header (base64-encoded "DOMAIN\\user:password")
  headers = { Authorization = "Basic ${BASIC_AUTH}" }

  ## Serialize Telegraf metrics as JSON
  data_format           = "json"
  json_timestamp_units  = "1ms"

  ## Render the JSON body that PI Web API expects
  body_template = """
  {{ range .Metrics -}}
  { "Timestamp": "{{ .timestamp | formatDate \"2006-01-02T15:04:05Z07:00\" }}", "Value": {{ index .fields 0 }} }
  {{ end -}}
  """

  ## Tune networking / batching if needed
  # timeout     = "10s"
  # batch_size  = 1

Input and output integration examples

OpenTelemetry

1. Unified Monitoring Across Services: Use the OpenTelemetry plugin to collect and consolidate telemetry data from various microservices within a Kubernetes environment. By instrumenting each service with OpenTelemetry, you can utilize this plugin to gather a holistic view of application performance and dependencies in real-time, enabling faster troubleshooting and improved reliability of complex systems.

2. Enhanced Debugging with Traces: Implement this plugin to capture end-to-end traces of requests flowing through multiple services. For instance, when a user initiates a transaction that triggers several backend services, the OpenTelemetry plugin can record detailed traces that highlight performance bottlenecks, giving developers the necessary insights to debug issues and optimize their code.

3. Dynamic Load Testing and Performance Monitoring: Leverage the capabilities of this plugin during load testing phases by collecting live metrics and traces under simulated higher loads. This approach helps to evaluate the resilience of the application components and identify potential performance degradations preemptively, ensuring a smooth user experience in production.

4. Integrated Logging and Metrics for Real-Time Monitoring: Combine the OpenTelemetry plugin with logging frameworks to gather real-time logs alongside metric data, creating a powerful observability platform. For example, integrate it within a CI/CD pipeline to monitor builds and deployments, while collecting logs that help diagnose failures or performance issues in real-time.

OSI PI

1. Remote Pump Stations Telemetry Bridge: Install Telegraf on edge gateways at oil-field pump stations, gather flow-meter and vibration readings over Modbus, and POST them to the PI Web API. Operations teams view real-time data in PI Vision without deploying heavyweight PI interfaces, while bandwidth-friendly batching keeps satellite links economical.

2. Green-Energy Micro-Grid Dashboard: Export inverter, battery, and weather metrics from MQTT into Telegraf, which relays them to PI. PI AF analytics can calculate real-time power balance and feed a campus dashboard; historical deltas inform sustainability reports.

3. Brownfield SCADA Modernization: Legacy PLCs logged to CSV are ingested by Telegraf’s tail input; each row is parsed and immediately sent to PI via HTTP, creating a live data stream that co-exists with archival files while the SCADA upgrade proceeds incrementally.

4. Synthetic Data Generator for Training: Telegraf’s exec input can run a script that emits simulated sensor patterns. Posting those metrics to a non-production PI server through the Web API supplies realistic datasets for PI Vision training sessions without risking production tags.

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.