ActiveMQ and OSI PI Integration

Input and output integration overview

The ActiveMQ Input Plugin collects metrics from the ActiveMQ message broker through its Console API, providing insights into the performance and status of message queues, topics, and subscribers.

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

ActiveMQ

The ActiveMQ Input Plugin interfaces with the ActiveMQ Console API to gather metrics related to queues, topics, and subscribers. ActiveMQ, a widely-used open-source message broker, supports various messaging protocols and provides a robust Web Console for management and monitoring. This plugin allows users to track essential metrics including queue sizes, consumer counts, and message counts across different ActiveMQ entities, thereby enhancing observability within messaging systems. Users can configure various parameters such as the WebConsole URL and basic authentication credentials to tailor the plugin to their environment. The metrics collected can be used for monitoring the health and performance of messaging applications, facilitating proactive management and troubleshooting.

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

ActiveMQ

[[inputs.activemq]]
  ## ActiveMQ WebConsole URL
  url = "http://127.0.0.1:8161"

  ## Required ActiveMQ Endpoint
  ##   deprecated in 1.11; use the url option
  # server = "192.168.50.10"
  # port = 8161

  ## Credentials for basic HTTP authentication
  # username = "admin"
  # password = "admin"

  ## Required ActiveMQ webadmin root path
  # webadmin = "admin"

  ## Maximum time to receive response.
  # response_timeout = "5s"

  ## 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

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

ActiveMQ

1. Proactive Queue Monitoring: Use the ActiveMQ plugin to monitor queue sizes in real-time for a high-volume trading application. This implementation allows teams to receive alerts when queue sizes exceed a certain threshold, enabling rapid response to potential downtime caused by backlogs, thereby ensuring continuous availability of trading operations.

2. Performance Baselines and Anomaly Detection: Integrate this plugin with machine learning frameworks to establish performance baselines for message throughput. By analyzing historical data collected through this plugin, teams can flag anomalies in processing rates, leading to quicker identification of issues impacting service reliability and performance.

3. Cross-Messaging System Analytics: Combine metrics from ActiveMQ with those from other messaging systems in a centralized dashboard. Users can visualize and compare performance data, such as enqueue and dequeue rates, providing valuable insights into the overall messaging architecture and assisting in optimizing the message flow between different brokers.

4. Subscriber Performance Insights: Leverage the subscriber metrics collected by this plugin to analyze behavior patterns and optimize configuration for consumer applications. Understanding metrics such as dispatched queue size and counter values can guide adjustments to improve processing efficiency and resource allocation.

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.