influxdata/telegraf

Allow debug setting override per plugin instance

Open

#10,688 opened on Feb 21, 2022

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

Description

Feature Request

Opening a feature request kicks off a discussion.

Proposal:

Allow debug setting override per plugin instance.

Current behavior:

Debug setting is global and affects all plugins.

Desired behavior:

Ability to override the default per input instance (debug = true | false)

Use case:

There's some debug output (like output.influxdb buffer fulness and batch write metrics) that is useful to keep enabled. If the global is enabled, suddenly a change to a plugin may cause massive amount of debug messages being output, and the only possibility is to disable the setting globally. With this feature, we can chose to silence just one plugin, or enforce debug for just one plugin (for example)

Contributor guide

Tech stack
go
Domain
backenddevops
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Go programmingTelegraf plugin architecture
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate how debug setting is currently implemented globally in Telegraf's agent configuration. Examine existing plugin instances to understand how configuration is passed. Look into adding a per plugin 'debug' field in the plugin config struct and wiring it to the logging output. Consider backward compatibility and documentation changes.