docs(telegraf): clarify prometheusremotewrite example shows logical representation #6661
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 tasks
…epresentation Co-authored-by: jstirnaman <[email protected]>
Copilot
AI
changed the title
[WIP] Update serializer documentation in Telegraf
docs(telegraf): clarify prometheusremotewrite example shows logical representation
Dec 21, 2025
jstirnaman
approved these changes
Dec 22, 2025
jstirnaman
added a commit
that referenced
this pull request
Dec 22, 2025
…epresentation (#6661) * Initial plan * docs(telegraf): clarify prometheusremotewrite example shows logical representation Co-authored-by: jstirnaman <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: jstirnaman <[email protected]>
jstirnaman
added a commit
that referenced
this pull request
Dec 23, 2025
* docs(telegraf): add missing serializer documentation Add documentation for missing output data formats (serializers): - binary: Binary protocol serialization with configurable entries - cloudevents: CloudEvents JSON format (v0.3 and v1.0) - csv: Comma-separated values with configurable columns - prometheus: Prometheus text exposition format - prometheusremotewrite: Prometheus protobuf for remote write - wavefront: Wavefront data format Also fixes: - Rename messagepack.md to msgpack.md to match Telegraf source This completes the serializer documentation coverage. * Apply suggestion from @jstirnaman * Apply suggestion from @jstirnaman * docs(telegraf): clarify prometheusremotewrite example shows logical representation (#6661) * Initial plan * docs(telegraf): clarify prometheusremotewrite example shows logical representation Co-authored-by: jstirnaman <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: jstirnaman <[email protected]> * Update content/telegraf/v1/data_formats/output/binary.md Co-authored-by: Copilot <[email protected]> * docs: improve prometheus serializer warnings and clarify configuration options (#6660) * hotfix(influxdb3): fix duplicate menu entry for Enterprise security page Change menu key from influxdb3_core to influxdb3_enterprise. * chore(influxdb3) Security: style and cleanup: intro, requirements, callouts * fix(influxdb3): restore clean install.md from jdstrand branch Remove duplicate content and fix malformed code blocks introduced during rebase conflict resolution. * docs(telegraf): add design plan for batch format documentation Defines documentation changes to clarify: - Output plugin vs serializer relationship - use_batch_format option location and purpose - Histogram/summary handling with prometheus_client - Choosing the right output approach * docs(telegraf): clarify output plugins, serializers, and batch format - Add "How output plugins use serializers" section explaining the relationship between output plugins and data formats - Add "Choosing an output approach" guidance by destination and metric type - Create prometheus serializer doc with histogram/summary guidance - Add "Use this plugin for..." sections to prometheus_client - Add Data formats subsection to configuration.md - Expand output plugins index with serializer relationship Addresses confusion about use_batch_format being an output plugin option rather than a serializer option, and provides clear guidance on when to use prometheus_client vs the prometheus serializer. --------- Co-authored-by: Jason Stirnaman <[email protected]> --------- Co-authored-by: Copilot <[email protected]> Co-authored-by: Copilot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The prometheusremotewrite serializer outputs binary protobuf format, but the documentation example showed Prometheus text exposition format without clarifying this distinction.
Changes
Screenshot
The clarification prevents confusion about the serializer's actual output format while maintaining the example's usefulness for understanding the metric transformation.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.