influxdata/telegraf

Use payload key to define MongoDB Collection for Output

Open

#11,756 opened on Sep 4, 2022

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

Repository metrics

Stars
 (9,892 stars)
PR merge metrics
 (Avg merge 2d 12h) (136 merged PRs in 30d)

Description

Use Case

Currently the influxdb_v2 has a configurable "bucket_tag" property in the output configuration which allows for a payload tag to determine the bucket that the data is written to in InfluxDB. We use this tag to isolate metrics for sane retrieval later on.

It would be great if the MongoDB output had the option for a "collection_tag" which would allow for sorting of data into easily retrievable collections, rather than needing to aggregate multiple collections on retrieval.

Expected behavior

"collection_tag" in configuration defines the collection that the data is written to. (same behaviour as the influxdb_v2 bucket_tag)

Actual behavior

Currently the collection name seems to be defined by a key 'device_id' which separates every device into a separate collection making aggregate queries (queries with more than one device) unweildy.

Additional info

I am sure that for a Go programmer this would be a trivial change... but I'm having some difficulties wrapping my head around where the changes need to be made to allow for the change. Otherwise this would be a PR.

Contributor guide

Research direction
Examine the existing 'bucket tag' implementation in the influxdb v2 output plugin to understand the pattern, then replicate it for the MongoDB output by adding a 'collection tag' configuration option and updating the writer logic to use this tag to determine the collection name.
Tech stack
go
Domain
backend
Issue type
Feature
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoTelegraf plugin developmentMongoDB basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70