JTI OpenConfig Telemetry and GroundWork Integration

Input and output integration overview

The JTI OpenConfig Telemetry plugin allows users to collect real-time telemetry data from devices running Juniper’s implementation of the OpenConfig model, leveraging the Junos Telemetry Interface for efficient data retrieval.

This plugin writes to a GroundWork Monitor instance, allowing for effective metrics management and monitoring in a centralized manner.

Integration details

JTI OpenConfig Telemetry

This plugin reads data from Juniper Networks’ OpenConfig telemetry implementation using the Junos Telemetry Interface (JTI). OpenConfig is an initiative aimed at enabling standardized and open network device telemetry through a common model for various devices and protocols. The JTI allows for the collection of this telemetry data in a real-time manner from various sensors defined within the configuration. Configurable parameters for this plugin include the ability to specify device addresses, authentication credentials, sampling frequency, and multiple sensors with potentially different reporting rates. The plugin uniquely handles time-stamping either through the collection time or the timestamp provided in the data, allowing for flexibility in how data is processed. Given its support for TLS for secure communication, the plugin is well-suited for integration into both traditional and modern network management systems, enhancing visibility into network performance and reliability.

GroundWork

The GroundWork plugin enables Telegraf to send metrics to a GroundWork Monitor instance, specifically supporting GW8 and newer versions. This integration allows users to leverage the robust monitoring capabilities of GroundWork, enabling comprehensive oversight of metrics collected from diverse sources. Users can specify various parameters such as the GroundWork instance URL, agent IDs, and authentication credentials, allowing for a tailored fit within their existing monitoring setups. It also supports secret-store secrets to enhance security for sensitive fields like username and password. Tags used within the plugin provide fine-grained control over how metrics are categorized and displayed within the GroundWork interface, allowing for custom configurations that adapt to different monitoring needs. However, users should be aware that string metrics are currently not supported by GroundWork, impacting how they manage their data.

Configuration

JTI OpenConfig Telemetry

[[inputs.jti_openconfig_telemetry]]
  ## List of device addresses to collect telemetry from
  servers = ["localhost:1883"]

  ## Authentication details. Username and password are must if device expects
  ## authentication. Client ID must be unique when connecting from multiple instances
  ## of telegraf to the same device
  username = "user"
  password = "pass"
  client_id = "telegraf"

  ## Frequency to get data
  sample_frequency = "1000ms"

  ## Sensors to subscribe for
  ## A identifier for each sensor can be provided in path by separating with space
  ## Else sensor path will be used as identifier
  ## When identifier is used, we can provide a list of space separated sensors.
  ## A single subscription will be created with all these sensors and data will
  ## be saved to measurement with this identifier name
  sensors = [
   "/interfaces/",
   "collection /components/ /lldp",
  ]

  ## We allow specifying sensor group level reporting rate. To do this, specify the
  ## reporting rate in Duration at the beginning of sensor paths / collection
  ## name. For entries without reporting rate, we use configured sample frequency
  sensors = [
   "1000ms customReporting /interfaces /lldp",
   "2000ms collection /components",
   "/interfaces",
  ]

  ## Timestamp Source
  ## Set to 'collection' for time of collection, and 'data' for using the time
  ## provided by the _timestamp field.
  # timestamp_source = "collection"

  ## Optional TLS Config
  # enable_tls = false
  # tls_ca = "/etc/telegraf/ca.pem"
  # tls_cert = "/etc/telegraf/cert.pem"
  # tls_key = "/etc/telegraf/key.pem"
  ## Minimal TLS version to accept by the client
  # tls_min_version = "TLS12"
  ## Use TLS but skip chain & host verification
  # insecure_skip_verify = false

  ## Delay between retry attempts of failed RPC calls or streams. Defaults to 1000ms.
  ## Failed streams/calls will not be retried if 0 is provided
  retry_delay = "1000ms"

  ## Period for sending keep-alive packets on idle connections
  ## This is helpful to identify broken connections to the server
  # keep_alive_period = "10s"

  ## To treat all string values as tags, set this to true
  str_as_tags = false

GroundWork

[[outputs.groundwork]]
  ## URL of your groundwork instance.
  url = "https://groundwork.example.com"

  ## Agent uuid for GroundWork API Server.
  agent_id = ""

  ## Username and password to access GroundWork API.
  username = ""
  password = ""

  ## Default application type to use in GroundWork client
  # default_app_type = "TELEGRAF"

  ## Default display name for the host with services(metrics).
  # default_host = "telegraf"

  ## Default service state.
  # default_service_state = "SERVICE_OK"

  ## The name of the tag that contains the hostname.
  # resource_tag = "host"

  ## The name of the tag that contains the host group name.
  # group_tag = "group"

Input and output integration examples

JTI OpenConfig Telemetry

1. Network Performance Monitoring: Use the JTI OpenConfig Telemetry plugin to monitor network performance metrics from multiple Juniper devices in real-time. By configuring various sensors, operators can gain insights into interface performance, traffic patterns, and error rates, allowing for proactive troubleshooting and optimization of the network.

2. Automated Fault Detection: Integrate the telemetry data collected via this plugin with a fault detection system that triggers alerts based on predefined thresholds. For example, when a specific sensor indicates a fault or threshold breach, automated scripts can be initiated to remediate the situation, dramatically improving response times.

3. Historical Performance Analysis: By forwarding the collected telemetry data into a time-series database, organizations can perform historical analysis on network performance. This enables teams to identify trends over time, spot anomalies, and make more informed decisions regarding network capacity planning and resource allocation.

4. Real-Time Dashboards for Network Operations: Leverage the real-time data gathered through this plugin to power visualization dashboards that provide network operators with live insights into performance metrics. This facilitates better operational awareness and quicker decision-making during critical events.

GroundWork

1. Centralized Monitoring Dashboard: Use the GroundWork plugin to aggregate metrics from multiple Telegraf instances into a single GroundWork Monitor dashboard. This configuration offers complete visibility into system health across various components, enabling swift identification of performance bottlenecks and improved incident response times.

2. Service Health Monitoring with Alerts: Configure this plugin to send critical service metrics to GroundWork, establishing a robust alerting system. Metrics such as CPU usage and service statuses can trigger alerts based on threshold values, informing administrators of potential issues before they escalate, thereby enhancing system reliability.

3. Historical Data Analysis: Leverage the historical metric capabilities of GroundWork using this plugin to conduct trend analysis over time. This application allows organizations to make data-driven decisions based on comprehensive historical performance metrics, which can assist in capacity planning and optimize resource allocation.

4. Custom Service Tags for Enhanced Monitoring: Extend the functionality of this plugin by utilizing custom tags for different services and hosts. By customizing these tags, users can filter and categorize metrics more effectively within their monitoring framework, leading to tailored monitoring experiences that align specifically with business objectives.

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.