[WIP] Document recommendation for Telegraf with InfluxDB 3 - use the v2 plugin and concurrent writes#6589
[WIP] Document recommendation for Telegraf with InfluxDB 3 - use the v2 plugin and concurrent writes#6589
Conversation
… Enterprise Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
…nterprise only Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
|
PR Preview
Pages included in this preview
Preview auto-deploys on push. Will be cleaned up when PR closes. |
| - [bucket](#bucket) | ||
| - [concurrent_writes](#concurrent_writes) |
There was a problem hiding this comment.
The TOC entry for concurrent_writes should be conditionally rendered to match the content visibility. Since the concurrent_writes section (lines 115-137) is wrapped in show-in "enterprise,core", this TOC entry should also be wrapped to avoid showing a link to non-existent content on other product pages. Consider wrapping this line with the same show-in directive.
| - [bucket](#bucket) | |
| - [concurrent_writes](#concurrent_writes) | |
| - [bucket](#bucket) | |
| {{% show-in "enterprise,core" %}} | |
| - [concurrent_writes](#concurrent_writes) | |
| {{% /show-in %}} |
| ```toml | ||
| [[outputs.influxdb_v2]] | ||
| urls = ["http://{{< influxdb/host >}}"] | ||
| token = "${INFLUX_TOKEN}" | ||
| organization = "" | ||
| bucket = "DATABASE_NAME" | ||
| concurrent_writes = 5 | ||
| ``` |
There was a problem hiding this comment.
The code example uses DATABASE_NAME as a placeholder but doesn't wrap it with the code-placeholders shortcode like the main example does (lines 54-63). For consistency, either wrap this code block with the code-placeholders shortcode or add a note indicating that DATABASE_NAME should be replaced with the actual database name. This ensures users understand which values need to be customized.
/content/shared/influxdb3-write-guides/use-telegraf/influxdb_v2output plugin with concurrent_writes configurationSummary
Successfully documented the recommendation for using Telegraf with multiple concurrent writers for InfluxDB v3 Core and Enterprise. The documentation:
Added
concurrent_writesparameter documentation with:min(number of CPU cores / 2, 10)Updated configuration examples to include
concurrent_writes = 5(conditionally displayed only for Core and Enterprise versions using{{% show-in "enterprise,core" %}})Added note about plugin choice: Emphasizes using
influxdb_v2output plugin instead of v1 plugin for InfluxDB v3Updated table of contents to include the new concurrent_writes section
All changes are in the shared content file
/content/shared/influxdb3-write-guides/use-telegraf/configure.md, which is automatically included in both Core and Enterprise documentation pages.Changes in latest commit
Fixed the conditional rendering by properly wrapping the entire
concurrent_writessection with{{% show-in "enterprise,core" %}}...{{% /show-in %}}directive as requested in review feedback. This ensures the content only appears on Core and Enterprise documentation, not on Cloud Serverless or Cloud Dedicated.Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.