open-telemetry / opentelemetry-collector-contrib

Contrib repository for the OpenTelemetry Collector
https://opentelemetry.io
Apache License 2.0
2.72k stars 2.15k forks source link

New component: netflow receiver #32732

Open dlopes7 opened 2 months ago

dlopes7 commented 2 months ago

The purpose and use-cases of the new component

The netflow receiver is capable of listening for netflow, sflow or IPFIX UDP traffic and generating log entries based on the flow content.

This gives Opentelemetry users the capability of monitoring network traffic, and answer questions like:

The receiver will listen for flows and decode them using the templates that are sent by the flow producers. The data then is converted to JSON and produces structured log records.

Example configuration for the component

receivers:
  netflow:
    listeners:
      - scheme: netflow
        port: 2055
        sockets: 1
        workers: 4

      - scheme: sflow
        port: 6443
        sockets: 1
        workers: 2
        queueSize: 1000

      - scheme: netflow
        host: "192.168.1.1"
        port: 2056
        sockets: 1
        workers: 2

Telemetry data types supported

Only logs for now

Is this a vendor-specific component?

Code Owner(s)

@dlopes7

Sponsor (optional)

No response

Additional context

Although originally NetFlow was developed by Cisco, the other types of network monitoring traffic are not vendor specific, so I am not sure if we must consider this a vendor specific receiver.

I believe that there is a lack of network monitoring visibility in Opentelemetry and this helps fill in that gap. I am committed to the development and maintenance of this receiver.

A similar idea was proposed in #18270, in this specific case I would like to contribute and already have this receiver mostly implemented in a custom collector of mine.

The receiver will be built upon the BSD-3 licensed goflow2 project, a battle tested collector, decoder and producer for flows. I have had a brief discussion with the maintainer about the feasibility of the project here and I am convinced it will be a valuable receiver for the Otel community

evan-bradley commented 3 weeks ago

I'll sponsor this.