docs-v2/content/telegraf
Jason Stirnaman 6090142bb3
docs(telegraf): add missing serializer documentation (#6654)
* 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 <212227+jstirnaman@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* Update content/telegraf/v1/data_formats/output/binary.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* 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 <jstirnaman@influxdata.com>

---------

Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-12-23 11:09:07 -05:00
..
v1 docs(telegraf): add missing serializer documentation (#6654) 2025-12-23 11:09:07 -05:00