Netflow and Clarify Integration

Input and output integration overview

The Netflow plugin is designed to collect traffic flow data from devices using the Netflow v5, v9 and IPFIX protocols. By capturing detailed flow information, this plugin supports network observability and analysis, enabling administrators to monitor traffic patterns and performance metrics effectively.

The Clarify plugin allows users to publish Telegraf metrics directly to Clarify, enabling enhanced analysis and monitoring capabilities.

Integration details

Netflow

The Netflow plugin serves as a collector for flow data using protocols such as Netflow v5, Netflow v9, and IPFIX. This plugin allows users to gather important flow metrics from devices that support these protocols, including a variety of operational insights about traffic patterns, source/destination information, and protocol usage. The plugin leverages templates sent by flow devices to decode incoming data correctly, and it supports private enterprise number mappings for vendor-specific information. With features like adjustable service addresses and buffer sizes, the plugin provides flexibility in how it can be deployed within various network architectures, making it an essential tool for network monitoring and analysis.

Clarify

This plugin facilitates the writing of Telegraf metrics to Clarify, a platform for managing and analyzing time series data. By transforming metrics into Clarify signals, this output plugin enables seamless integration of collected telemetry data into the Clarify ecosystem. Users must obtain valid credentials, either through a credentials file or basic authentication, to configure the plugin. The configuration also provides options for fine-tuning how metrics are mapped to signals in Clarify, including the ability to specify unique identifiers using tags. Given that Clarify supports only floating point values, the plugin ensures that any unsupported types are effectively filtered out during the publishing process. This comprehensive connectivity aligns with use cases in monitoring, data analysis, and operational insights.

Configuration

Netflow

[[inputs.netflow]]
  ## Address to listen for netflow,ipfix or sflow packets.
  ##   example: service_address = "udp://:2055"
  ##            service_address = "udp4://:2055"
  ##            service_address = "udp6://:2055"
  service_address = "udp://:2055"

  ## Set the size of the operating system's receive buffer.
  ##   example: read_buffer_size = "64KiB"
  ## Uses the system's default if not set.
  # read_buffer_size = ""

  ## Protocol version to use for decoding.
  ## Available options are
  ##   "ipfix"      -- IPFIX / Netflow v10 protocol (also works for Netflow v9)
  ##   "netflow v5" -- Netflow v5 protocol
  ##   "netflow v9" -- Netflow v9 protocol (also works for IPFIX)
  ##   "sflow v5"   -- sFlow v5 protocol
  # protocol = "ipfix"

  ## Private Enterprise Numbers (PEN) mappings for decoding
  ## This option allows to specify vendor-specific mapping files to use during
  ## decoding.
  # private_enterprise_number_files = []

  ## Log incoming packets for tracing issues
  # log_level = "trace"

Clarify

[[outputs.clarify]]
  ## Credentials File (Oauth 2.0 from Clarify integration)
  credentials_file = "/path/to/clarify/credentials.json"

  ## Clarify username password (Basic Auth from Clarify integration)
  username = "i-am-bob"
  password = "secret-password"

  ## Timeout for Clarify operations
  # timeout = "20s"

  ## Optional tags to be included when generating the unique ID for a signal in Clarify
  # id_tags = []
  # clarify_id_tag = 'clarify_input_id'

Input and output integration examples

Netflow

1. Traffic Analysis and Visualization: Use the Netflow plugin to collect traffic flow data and visualize it in real-time using an analytics platform. Administrators can create dashboards that display traffic patterns and anomalies, helping them understand bandwidth usage and user behavior.

2. Network Performance Optimization: Integrate the Netflow plugin with performance monitoring tools to identify bottlenecks and optimize the network. Analyze collected metrics to pinpoint areas where network resources can be improved, enhancing overall system performance.

3. Anomaly Detection for Security: Leverage the Netflow data for security analysis by feeding it into an anomaly detection system. This can help identify unusual traffic patterns that may indicate potential security threats, enabling quicker responses to prevent breaches.

4. Customized Alerts for Network Events: Configure threshold-based alerts using the Netflow plugin metrics to notify network administrators of unusual spikes or drops in traffic. This proactive monitoring can help in quickly addressing potential issues before they escalate.

Clarify

1. Automated Data Monitoring: By integrating the Clarify plugin with sensor data collection, organizations can automate the monitoring of environmental conditions, such as temperature and humidity. The plugin processes metrics in real-time, sending updates to Clarify where they can be analyzed for trends, alerts, and historical tracking. This use case makes it easier to maintain optimal conditions in data centers or production environments, reducing the risk of equipment failures.

2. Performance Metrics Analysis: Companies can leverage this plugin to send application performance metrics to Clarify. By transmitting key indicators such as response times and error rates, developers and operations teams can utilize Clarify’s capabilities to visualize and analyze application performance over time. This insight can drive improvements in user experience and help identify areas in need of optimization.

3. Sensor Data Aggregation: Utilizing the plugin to push data from multiple sensors to Clarify allows for a comprehensive view of physical environments. This aggregation is particularly beneficial in sectors such as agriculture, where metrics from various sensors can be correlated to decision-making about resource allocations, pest control, and crop management. The plugin ensures the data is accurately mapped and transformed for effective analysis.

4. Real-Time Alerts and Notifications: Implement the Clarify plugin to trigger real-time alerts based on predefined thresholds within the metrics being sent. For instance, if temperature readings exceed certain levels, alerts can be generated and sent to operational staff. This proactive approach allows for immediate responses to potential issues, enhancing operational reliability and safety.

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.