SNMP Trap and OSI PI Integration

Input and output integration overview

The SNMP Trap Telegraf plugin enables the receipt of SNMP notifications, facilitating comprehensive network monitoring by capturing important events from network devices.

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

SNMP Trap

The SNMP Trap plugin serves as a receiving endpoint for SNMP notifications, known as traps and inform requests. Operating over UDP, it listens for incoming notifications, which can be configured to arrive on a specific port. This plugin is integral to network monitoring and management, allowing systems to collect and respond to SNMP traps sent from various devices across the network, including routers, switches, and servers. The plugin supports secure transmission options through SNMPv3, enabling authentication and encryption parameters to protect sensitive data. Additionally, it gives users the flexibility to configure multiple aspects of SNMP like MIB file locations, making it adaptable for various environments and use cases. Transitioning from the deprecated netsnmp backend to the more current gosmi backend is recommended to leverage its enhanced features and support. Users implementing this plugin can effectively monitor network events, automate responses to traps, and maintain a robust network monitoring infrastructure.

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

SNMP Trap

[[inputs.snmp_trap]]
  ## Transport, local address, and port to listen on.  Transport must
  ## be "udp://".  Omit local address to listen on all interfaces.
  ##   example: "udp://127.0.0.1:1234"
  ##
  ## Special permissions may be required to listen on a port less than
  ## 1024.  See README.md for details
  ##
  # service_address = "udp://:162"
  ##
  ## Path to mib files
  ## Used by the gosmi translator.
  ## To add paths when translating with netsnmp, use the MIBDIRS environment variable
  # path = ["/usr/share/snmp/mibs"]
  ##
  ## Deprecated in 1.20.0; no longer running snmptranslate
  ## Timeout running snmptranslate command
  # timeout = "5s"
  ## Snmp version; one of "1", "2c" or "3".
  # version = "2c"
  ## SNMPv3 authentication and encryption options.
  ##
  ## Security Name.
  # sec_name = "myuser"
  ## Authentication protocol; one of "MD5", "SHA", "SHA224", "SHA256", "SHA384", "SHA512" or "".
  # auth_protocol = "MD5"
  ## Authentication password.
  # auth_password = "pass"
  ## Security Level; one of "noAuthNoPriv", "authNoPriv", or "authPriv".
  # sec_level = "authNoPriv"
  ## Privacy protocol used for encrypted messages; one of "DES", "AES", "AES192", "AES192C", "AES256", "AES256C" or "".
  # priv_protocol = ""
  ## Privacy password used for encrypted messages.
  # priv_password = ""

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

SNMP Trap

1. Centralized Network Monitoring: Integrate the SNMP Trap plugin into a centralized monitoring solution to receive alerts about network devices in real-time. By configuring the plugin to listen for traps from various routers and switches, network administrators can swiftly react to issues, such as device outages or critical thresholds being surpassed. This setup enables proactive management and quick resolutions to network problems, ensuring minimal downtime.

2. Automated Incident Response: Use the SNMP Trap plugin to trigger automated incident response workflows whenever specific traps are received. For instance, if a trap indicating a hardware failure is detected, an automated script could be initiated to gather diagnostics, notify support personnel, or even attempt a remediation action. This approach enhances the efficiency of IT operations by reducing manual interference and speeding up response times.

3. Network Performance Analytics: Deploy the SNMP Trap plugin to collect performance metrics along with traps for a comprehensive view of network health. By aggregating this data into analytics platforms, network teams can analyze trends, identify bottlenecks, and optimize performance based on historical data. This allows for informed decision-making and strategic planning around network upgrades or changes.

4. Integrating with Alerting Systems: Connect the SNMP Trap plugin to third-party alerting systems like PagerDuty or Slack. Upon receiving predefined traps, the plugin can send alerts to these systems, enabling teams to be instantly notified of important network events. This integration ensures that the right people are informed at the right time, helping maintain high service levels and quick issue resolution.

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.