influxdata/telegraf

Deprecate `processors.ifname` plugin

Open

#16.152 geöffnet am 6. Nov. 2024

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Go (4.161 Forks)batch import
feature requesthelp wanted

Repository-Metriken

Stars
 (9.892 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 2T 12h) (136 gemergte PRs in 30 T)

Beschreibung

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

Research-Richtung
Füge eine Veraltungswarnung im `processors.ifname` Plugin hinzu. Finde den Plugin Code in `plugins/processors/ifname/`. Suche nach einem vorhandenen Veraltungsmuster in anderen Telegraf Plugins (z. B. unter Verwendung von `log.Printf` oder einer speziellen Warnfunktion). Ändere die `Init` oder `Start` Methode des Plugins, um eine Veraltungsmeldung zu protokollieren, wenn das Plugin geladen wird. Stelle sicher, dass die Warnung für den Benutzer sichtbar ist, aber die Funktionalität nicht beeinträchtigt. Teste die Änderung, indem du Telegraf mit einer ifname Konfiguration ausführst, um zu bestätigen, dass die Warnung erscheint.
Tech Stack
go
Domain
backend
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GoGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75