influxdata/telegraf

Deprecate `processors.ifname` plugin

Open

#16.152 aberto em 6 de nov. de 2024

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)Go (4.161 forks)batch import
feature requesthelp wanted

Métricas do repositório

Stars
 (9.892 stars)
Métricas de merge de PR
 (Mesclagem média 2d 12h) (136 fundiu PRs em 30d)

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

Guia do colaborador

Direção de pesquisa
Adicione um aviso de descontinuação no plugin `processors.ifname`. Localize o código do plugin em `plugins/processors/ifname/`. Procure um padrão de descontinuação existente em outros plugins do Telegraf (por exemplo, usando `log.Printf` ou uma função de aviso dedicada). Modifique o método `Init` ou `Start` do plugin para registrar uma mensagem de descontinuação quando o plugin for carregado. Certifique se de que o aviso seja visível ao usuário, mas não quebre a funcionalidade. Teste a alteração executando o Telegraf com uma configuração ifname para confirmar que o aviso aparece.
Pilha de tecnologia
go
Domain
backend
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GoGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75