influxdata/telegraf

Deprecate `processors.ifname` plugin

Open

#16,152 opened on Nov 6, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Go (9,892 stars) (4,161 forks)batch import
feature requesthelp wanted

Description

Use Case

With the addition of the processors.snmp_lookup, the processors.ifname has become redundant.

Expected behavior

Users of processors.ifname plugin should receive a deprecation warning.

Actual behavior

No deprecation warning.

Additional info

The following config will use the same ifDescr fallback as processors.ifname when there is no ifName value on the device.

[[processors.snmp_lookup]]
  agent_tag = "agent"
  index_tag = "ifIndex"

  [[processors.snmp_lookup.tag]]
    oid = ".1.3.6.1.2.1.2.2.1.2"
    name = "ifName"

  [[processors.snmp_lookup.tag]]
    oid = ".1.3.6.1.2.1.31.1.1.1.1"
    name = "ifName"

- foo,agent=127.0.0.1,ifIndex=2 field=123
+ foo,agent=127.0.0.1,ifIndex=2,ifName=eth0 field=123

Contributor guide

Tech stack
go
Domain
backend
Issue type
chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic Go programmingFamiliarity with Telegraf processor plugins
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Add a deprecation warning in the `processors.ifname` plugin. Locate the plugin code in `plugins/processors/ifname/`. Look for an existing deprecation pattern in other Telegraf plugins (e.g., using `log.Printf` or a dedicated warning function). Modify the plugin's `Init` or `Start` method to log a deprecation message when the plugin is loaded. Ensure the warning is user visible but does not break functionality. Test the change by running Telegraf with an ifname config to confirm the warning appears.