Amazon CloudWatch and OSI PI Integration

Input and output integration overview

This plugin will pull Metric Statistics from Amazon CloudWatch, streamlining the process of monitoring and analyzing AWS resources.

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

Amazon CloudWatch

The Amazon CloudWatch Plugin allows users to pull detailed metric statistics from Amazon’s CloudWatch service. As a monitoring solution, CloudWatch enables users to track various metrics related to AWS resources and applications, facilitating improved operational and performance insights. The plugin uses a structured authentication method that prioritizes security and flexibility through a combination of STS (Security Token Service), shared credentials, environment variables, and EC2 instance profiles, ensuring robust access control to AWS resources. Key features include the ability to define specific metric namespaces, aggregated periods for metrics, and optional inclusion of linked accounts for cross-account monitoring. A significant aspect of this plugin is its capacity to handle both sparse and dense metric formats, allowing for varied output structures depending on user preference. Thus, it supports versatile use cases in cloud monitoring and analytics by providing comprehensive, timely data directly from CloudWatch.

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

Amazon CloudWatch

[[inputs.cloudwatch]]
  region = "us-east-1"
  # access_key = ""
  # secret_key = ""
  # token = ""
  # role_arn = ""
  # web_identity_token_file = ""
  # role_session_name = ""
  # profile = ""
  # shared_credential_file = ""
  # include_linked_accounts = false
  # endpoint_url = ""
  # use_system_proxy = false
  # http_proxy_url = "http://localhost:8888"
  period = "5m"
  delay = "5m"
  interval = "5m"
  #recently_active = "PT3H"
  # cache_ttl = "1h"
  namespaces = ["AWS/ELB"]
  # metric_format = "sparse"
  # ratelimit = 25
  # timeout = "5s"
  # batch_size = 500
  # statistic_include = ["average", "sum", "minimum", "maximum", sample_count]
  # statistic_exclude = []
  # [[inputs.cloudwatch.metrics]]
  #  names = ["Latency", "RequestCount"]
  #  [[inputs.cloudwatch.metrics.dimensions]]
  #    name = "LoadBalancerName"
  #    value = "p-example"

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

Amazon CloudWatch

1. Cross-Account Monitoring: Utilize this plugin to monitor resources across multiple AWS accounts by enabling the include_linked_accounts option. This scenario allows companies managing multiple AWS accounts to aggregate metrics into a central monitoring dashboard, providing a unified view of all metrics while ensuring secure data access and compliance through proper role management.

2. Dynamic Alerting System: Integrate this plugin with alerting tools to create an automated system that triggers alerts based on defined thresholds for CloudWatch metrics. For instance, if latency metrics exceed specified limits, alerts can be sent to relevant teams, enabling proactive responses to performance issues and reducing downtime.

3. Cost Management Dashboard: Use the metrics gathered from the plugin to build a cost management dashboard that visualizes AWS service usage metrics over time. By correlating these metrics with billing data, organizations can identify high-cost services and take informed actions to optimize their resource usage and spending.

4. Performance Benchmarking for Applications: Leverage the metrics collected from applications running on AWS to perform performance benchmarks. For example, by tracking latency and request count metrics for an ELB, developers can assess the impact of application changes on its performance, making data-driven decisions for optimization.

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.