docs(specs): Labels and Selectors for Plugin Enablement #16884

neelayu · 2025-04-26T13:03:38Z

Summary

Provides a spec for Plugin enable and disablement using labels and selectors.

Checklist

No AI generated code was used in this PR

Related issues

resolves NA
related #16704

Hipska

The content of the spec looks good to me. Only some markup changes requested.

Please also increase/decrease headings by 1 per step. (not 3)

docs/specs/tsd-010-labels-and-selectors.md

srebhan

Thanks for the spec @neelayu and sorry for this taking so long! I do have some suggestions in the document...

docs/specs/tsd-010-labels-and-selectors.md

srebhan · 2025-05-28T16:45:41Z

docs/specs/tsd-010-labels-and-selectors.md

+## Previous Issues
+
+[Issue #9304](https://github.com/influxdata/telegraf/issues/9304)
+
+[Issue #1317](https://github.com/influxdata/telegraf/issues/1317)
+
+[Issue #10543](https://github.com/influxdata/telegraf/issues/10543)


Suggested change

## Previous Issues

[Issue #9304](https://github.com/influxdata/telegraf/issues/9304)

[Issue #1317](https://github.com/influxdata/telegraf/issues/1317)

[Issue #10543](https://github.com/influxdata/telegraf/issues/10543)

## Related Issues

- [issue #1317](https://github.com/influxdata/telegraf/issues/1317) for allowing to enable/disable plugin instances

- [issue #9304](https://github.com/influxdata/telegraf/issues/9304) for partially enable a config file

- [issue #10543](https://github.com/influxdata/telegraf/issues/10543) for allowing to enable/disable plugin instances

Either you didn't push the change or you didn't apply it... At least the current code is still the old one...

probably got overwritten. thanks

neelayu · 2025-05-30T11:26:32Z

Hi @srebhan
thanks for reviewing. I have addressed some of the comments- I think you got labels and selectors mixed up. Labels will be simply a list, and selectors will be following logical operations depending on the input.
Accordingly I have made the changes. Let me know.

srebhan

Thanks for the update @neelayu! I have some comments in the code...

Please wrap the text (not tables or code) at 80 columns as this is the convention.

Furthermore, I do have a question: With the current description how do you select
(app=web AND region=us-east) OR (app=backend AND region=eu-central) with the --label flags? I think you need to support lists also on the command-line flag to do this. Anyway, I'm OK to keep the spec as is and extend it later...

srebhan · 2025-06-06T08:43:05Z

docs/specs/tsd-010-labels-and-selectors.md

+
+## Keywords
+
+configuration Management, dynamic plugin selection


Suggested change

configuration Management, dynamic plugin selection

configuration, dynamic plugin selection

srebhan · 2025-06-06T08:44:50Z

docs/specs/tsd-010-labels-and-selectors.md

+Currently, managing plugin configurations across multiple Telegraf instances is cumbersome. Methods like commenting out plugins or renaming configuration files are not scalable. A label and selector system provides a more flexible and elegant solution.
+
+This feature aims to simplify plugin management in Telegraf by introducing a label and selector system inspired by [Kubernetes](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/). Labels are key-value pairs provided at runtime, and selectors are defined in plugin configurations to match against these labels. This approach allows to enable plugin dynamically at startup-time, making it easier to manage configurations in large-scale deployments where a single configuration is fetched from a centralized configuration-source.


Please wrap the text at 80 columns. Furthermore, use indirect links as that's more readable and we do it everywhere else (at least we should)...

Suggested change

Currently, managing plugin configurations across multiple Telegraf instances is cumbersome. Methods like commenting out plugins or renaming configuration files are not scalable. A label and selector system provides a more flexible and elegant solution.

This feature aims to simplify plugin management in Telegraf by introducing a label and selector system inspired by [Kubernetes](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/). Labels are key-value pairs provided at runtime, and selectors are defined in plugin configurations to match against these labels. This approach allows to enable plugin dynamically at startup-time, making it easier to manage configurations in large-scale deployments where a single configuration is fetched from a centralized configuration-source.

Currently, managing plugin configurations across multiple Telegraf instances is cumbersome. Methods like commenting out plugins or renaming configuration files are not scalable. A label and selector system provides a more flexible and elegant solution.

This feature aims to simplify plugin management in Telegraf by introducing a label and selector system inspired by [Kubernetes][k8s_labels]. Labels are key-value pairs provided at runtime, and selectors are defined in plugin configurations to match against these labels. This approach allows to enable plugin dynamically at startup-time, making it easier to manage configurations in large-scale deployments where a single configuration is fetched from a centralized configuration-source.

[k8s_labels]: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels

Yes. made the changes

srebhan · 2025-06-06T08:56:51Z

docs/specs/tsd-010-labels-and-selectors.md

+## Previous Issues
+
+[Issue #9304](https://github.com/influxdata/telegraf/issues/9304)
+
+[Issue #1317](https://github.com/influxdata/telegraf/issues/1317)
+
+[Issue #10543](https://github.com/influxdata/telegraf/issues/10543)


Either you didn't push the change or you didn't apply it... At least the current code is still the old one...

srebhan · 2025-06-06T08:57:32Z

docs/specs/tsd-010-labels-and-selectors.md

+## Previous Issues
+
+[Issue #9304](https://github.com/influxdata/telegraf/issues/9304)
+
+[Issue #1317](https://github.com/influxdata/telegraf/issues/1317)
+
+[Issue #10543](https://github.com/influxdata/telegraf/issues/10543)


Suggested change

## Previous Issues

[Issue #9304](https://github.com/influxdata/telegraf/issues/9304)

[Issue #1317](https://github.com/influxdata/telegraf/issues/1317)

[Issue #10543](https://github.com/influxdata/telegraf/issues/10543)

## Related Issues

- [issue #1317](https://github.com/influxdata/telegraf/issues/1317) for allowing to enable/disable plugin instances

- [issue #9304](https://github.com/influxdata/telegraf/issues/9304) for partially enable a config file

- [issue #10543](https://github.com/influxdata/telegraf/issues/10543) for allowing to enable/disable plugin instances

neelayu · 2025-06-06T09:56:20Z

@srebhan

Furthermore, I do have a question: With the current description how do you select
(app=web AND region=us-east) OR (app=backend AND region=eu-central) with the --label flags? I think you need to support lists also on the command-line flag to do this.

This would mean we pass

selectors = ["app=web,region=us-east", "app=backend,region=eu-central"]

To match it against the labels, we require a list of labels and it is documented in this spec. We would pass one or more --label flags

--label="app=web" --label="region=us-east" --label="another=value"

This would match for the first selector. This case is present in the 5th example of the table.

telegraf-tiger · 2025-06-06T10:21:28Z

Download PR build artifacts for linux_amd64.tar.gz, darwin_arm64.tar.gz, and windows_amd64.zip.
Downloads for additional architectures and packages are available below.

👍 This pull request doesn't change the Telegraf binary size

📦 Click here to get additional PR build artifacts

Artifact URLs

DEB	RPM	TAR GZ	ZIP
amd64.deb	aarch64.rpm	darwin_amd64.tar.gz	windows_amd64.zip
arm64.deb	armel.rpm	darwin_arm64.tar.gz	windows_arm64.zip
armel.deb	armv6hl.rpm	freebsd_amd64.tar.gz	windows_i386.zip
armhf.deb	i386.rpm	freebsd_armv7.tar.gz
i386.deb	ppc64le.rpm	freebsd_i386.tar.gz
mips.deb	riscv64.rpm	linux_amd64.tar.gz
mipsel.deb	s390x.rpm	linux_arm64.tar.gz
ppc64el.deb	x86_64.rpm	linux_armel.tar.gz
riscv64.deb		linux_armhf.tar.gz
s390x.deb		linux_i386.tar.gz
		linux_mips.tar.gz
		linux_mipsel.tar.gz
		linux_ppc64le.tar.gz
		linux_riscv64.tar.gz
		linux_s390x.tar.gz

telegraf-tiger bot added the docs Issues related to Telegraf documentation and configuration descriptions label Apr 26, 2025

neelayu mentioned this pull request Apr 26, 2025

Enable / Disable plugin instances #16704

Open

Hipska suggested changes May 21, 2025

View reviewed changes

neelayu requested a review from Hipska May 22, 2025 08:11

Hipska suggested changes May 22, 2025

View reviewed changes

docs/specs/tsd-010-labels-and-selectors.md Outdated Show resolved Hide resolved

Hipska approved these changes May 22, 2025

View reviewed changes

srebhan reviewed May 28, 2025

View reviewed changes

srebhan self-assigned this May 28, 2025

neelayu added 4 commits May 30, 2025 15:58

docs(specs): Labels and Selectors for Plugin Enablement

56e96ff

fix: address comments, making linter happy

84032ec

fix: formatting of table

be13701

fix: address review comments

4012095

neelayu force-pushed the labels-selector-spec branch from d3c6bcf to 4012095 Compare May 30, 2025 11:24

srebhan reviewed Jun 6, 2025

View reviewed changes

fix: put limit on columns and address comments

d400d0b


		## Keywords

		configuration Management, dynamic plugin selection

	configuration Management, dynamic plugin selection
	configuration, dynamic plugin selection

		Currently, managing plugin configurations across multiple Telegraf instances is cumbersome. Methods like commenting out plugins or renaming configuration files are not scalable. A label and selector system provides a more flexible and elegant solution.

		This feature aims to simplify plugin management in Telegraf by introducing a label and selector system inspired by [Kubernetes](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/). Labels are key-value pairs provided at runtime, and selectors are defined in plugin configurations to match against these labels. This approach allows to enable plugin dynamically at startup-time, making it easier to manage configurations in large-scale deployments where a single configuration is fetched from a centralized configuration-source.

docs(specs): Labels and Selectors for Plugin Enablement #16884

Are you sure you want to change the base?

docs(specs): Labels and Selectors for Plugin Enablement #16884

Uh oh!

Conversation

neelayu commented Apr 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Related issues

Uh oh!

Hipska left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

srebhan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

neelayu commented May 30, 2025

Uh oh!

srebhan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

neelayu commented Jun 6, 2025

Uh oh!

telegraf-tiger bot commented Jun 6, 2025

Artifact URLs

Uh oh!

Uh oh!

neelayu commented Apr 26, 2025 •

edited

Loading