influxdata/telegraf

postgresql_extensible: query.tagvalue is strangely a CSV rather than a TOML array

Open

#13,730 opened on Aug 7, 2023

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

Description

Use Case

When creating custom queries tagvalue is widely used to define result columns to be used as tag. Given that whole config file is a TOML syntax, use of CSV string format for tagvalue feels less natural than what TOML array would be.

Expected behavior

Supporting 2 types for the same config param can be messy, so I propose deprecate tagvalue and introduce tagvalues parameter with array type.

Actual behavior

tagvalue is a CSV string.

Additional info

No response

Contributor guide

Tech stack
go
Domain
backenddatabase
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.
half day
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.
clear
Prerequisites
Go programmingTOML syntaxTelegraf plugin development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
The issue proposes deprecating `tagvalue` and introducing `tagvalues` as a TOML array in the postgresql extensible plugin. Start by examining the handling of `tagvalue` in the plugin's config parsing (likely in `plugins/inputs/postgresql extensible/postgresql extensible.go`). Understand how the CSV string is parsed and used. Then, design the new parameter following TOML array syntax, implement deprecation warnings, and update documentation accordingly. No existing PRs are linked, so this is a fresh implementation task.