* 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>
* docs(influxdb3): add Helm chart deployment guide for Enterprise
Add documentation for deploying InfluxDB 3 Enterprise on Kubernetes
using the official Helm chart (currently in beta). The guide covers:
- Prerequisites and licensing information
- Installation steps using Helm
- Configuration options for object storage (S3, Azure, GCS, MinIO)
- Cluster and ingress configuration
- Upgrade and uninstall procedures
- Troubleshooting commands
- Support and issue reporting links
* chore(influxdb3): Cleanup install
* chore(influxdb3): add version metadata for systemd
Move documentation on Raft authentication from data nodes page to meta
node page. Also add note with recommended staging for enabling Raft
authentication in an existing cluster.
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
* Initial plan
* docs: move perf-debug example output to query command reference
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
* docs: update placeholder syntax and add link to query command
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
* docs: add disclaimer for example performance statistics output
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
* fix(influxdb3): update --perf-debug example output to match documented query
Regenerate example performance statistics output using the documented
query (SELECT SUM(temp) FROM home). Tested influxctl query --perf-debug
command to verify output format and values.
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
* fix: add a few missing DEB/RPM instructions for license activation
* fix: sourcing shell config only needed with quick installs
* chore: address review feedback from Jason
* fix: remove a couple of mis-merges and clarify DEB/RPM is non-Docker
* chore: update install and license info for DEB/RPM
* chore: incorporate formatting and style feedback from Jason
* fix(influxdb3): Install: ToC and merge cleanup
---------
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
* 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
Add missing documentation for the template output data format
(serializer) that allows formatting metrics using custom Go templates.
Includes configuration examples, template method reference,
batch mode usage, and Sprig function support.
closesinfluxdata/docs-v2#5522
* Initial plan
* Change token type headings from h4 to h3 to fix fragment detection
Changed heading levels for Operator token, All Access token, and Read/Write token from level 4 to level 3. This ensures better compatibility with link checkers that may have issues detecting fragments in h4 headings.
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
* fix(v2): Clarify operator token auto- vs manual- generation
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
* Initial plan
* Add v1.12.2 FUTURE LIMIT and PAST LIMIT callouts
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
* fix(v1): Remove patch from Enterprise v1 name
* fix(ent1): Remove version from `PAST LIMIT` and `FUTURE LIMIT` callout
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
* Apply suggestions from code review
Apply to cloud-serverless
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* fix(influxdb3): broken links and aliases:
The link in the cloud-serverless schema-design page was pointing to /influxdb3/cloud-serverless/reference/line-protocol/#duplicate-points, but the actual file is located at /influxdb3/cloud-serverless/reference/syntax/line-protocol/
Core/Ent3 aliases were missing trailing slash, preventing navigating directly from other product line protocol docs
* chore: cleanup
* fix(ci): skip fragment validation for local file URLs in link-checker
Workaround for link-checker Hugo pretty URL bug where /path/to/page#fragment
is converted to file:///path/to/page#fragment instead of
file:///path/to/page/index.html#fragment.
All 60 'broken' fragments reported by CI actually exist in the HTML files.
---------
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* docs(influxdb3): document duplicate point write ordering and workarounds
Expand duplicate points documentation for Cloud Dedicated and Clustered
to address non-deterministic write ordering when duplicate points are
flushed together.
Changes:
- Add warning callout explaining duplicate point overwrites are non-deterministic
- Add recommended patterns section with append-only approaches
- Add SQL and InfluxQL query examples for getting latest state
- Add anti-patterns section with common mistakes to avoid
- Add retention guidance for last-value tables (Cloud Dedicated only)
- Add performance considerations for append-only patterns
- Add cross-links from schema-design and optimize-writes pages
closesinfluxdata/DAR#560
* Apply suggestions from code review
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Apply suggestions from code review
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Apply suggestion from @jstirnaman
* fix(influxdb3): broken links and aliases:
The link in the cloud-serverless schema-design page was pointing to /influxdb3/cloud-serverless/reference/line-protocol/#duplicate-points, but the actual file is located at /influxdb3/cloud-serverless/reference/syntax/line-protocol/
Core/Ent3 aliases were missing trailing slash, preventing navigating directly from other product line protocol docs
* chore: cleanup
---------
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Document use-hashed-tokens configuration option
Added documentation for the use-hashed-tokens option, including its benefits, default value, and configuration methods.
* Update documentation for use-hashed-tokens option
Clarify default behavior for hashed API tokens in version 2.8 and future versions.
---------
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
* Initial plan
* feat: add Windows environment variable instructions for INFLUXDB3_AUTH_TOKEN
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
* refactor: update to new code-placeholders syntax
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
* Separate env var and CLI option into distinct sections instead of nested tabs
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
* Clarify that both auth methods are for CLI commands with parallel headings
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
* fix(3ent/core): Set token env var in Windows, clean up structure
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
* docs(influxdb3): Use the CLI (influxdb3 --version), /ping endpoint, or /health endpoint to get the actual InfluxDB product version—not the SQL version() function.
Summary of Changes
1. content/shared/sql-reference/functions/misc.md (SQL version() function)
- Enhanced the description to clarify it returns the DataFusion query engine version
- Added a Note callout explicitly stating this is NOT the InfluxDB product version
- Added a link to the identify-version page for users who want to find their InfluxDB version
- Added an expandable example with the actual query and output:
SELECT version()
- Output: Apache DataFusion 49.0.2, aarch64 on linux
2. content/shared/identify-version.md (Identify version page)
Added a Note callout in three locations:
- Core-specific section (show-in "core")
- Enterprise-specific section (show-in "enterprise")
- General InfluxDB 3 Core and Enterprise section (in the tabs)
Replaced hardcoded patch version with latest-version shortcode
* fix(clustered): use "database" instead of "namespace" in release notes
Replace user-facing "namespace" terminology with "database" in the
Clustered release notes for clarity. Add a note explaining that
"namespace" in environment variable names refers to a database.
closesinfluxdata/DAR#556
Summary of Changes
1. content/shared/sql-reference/functions/misc.md (SQL version() function)
- Enhanced the description to clarify it returns the DataFusion query engine version
- Added a Note callout explicitly stating this is NOT the InfluxDB product version
- Added a link to the identify-version page for users who want to find their InfluxDB version
- Added an expandable example with the actual query and output:
SELECT version()
- Output: Apache DataFusion 49.0.2, aarch64 on linux
2. content/shared/identify-version.md (Identify version page)
Added a Note callout in three locations:
- Core-specific section (show-in "core")
- Enterprise-specific section (show-in "enterprise")
- General InfluxDB 3 Core and Enterprise section (in the tabs)
Replaced hardcoded patch version with latest-version shortcode
* chore(sql): add LAG examples for time-based value comparisons
Enhance window function documentation with practical examples for
calculating differences between current and previous values (e.g., 1h ago).
- Add 3 LAG examples to window functions reference with tested queries
- Create new 'Compare values' query guide covering common time-based
comparison patterns (differences, percentage changes, exact intervals)
- Add guide frontmatter for all InfluxDB 3 products
All queries validated against InfluxDB 3 Core.
Refs: Kapa.ai conversation https://app.kapa.ai/720100f9-ce93-4305-88fd-5fcf71effad7/conversations/4536b79e-3930-4359-87f5-2ad9ccc1917d
Starting from: https://docs.influxdata.com/influxdb3/cloud-serverless/reference/sql/functions/window/
* chore(sql): add counter metrics examples to compare-values guide
Enhance time-based value comparisons with counter metrics patterns
using LAG and GREATEST to handle counter resets.
- Add counter metrics section with 3 examples (rate, cumulative, intervals)
- Include tested queries for non-negative differences and aggregation
- Document workarounds for Flux increase() and InfluxQL NON_NEGATIVE_DIFFERENCE()
All queries validated against InfluxDB 3 Core.
Refs: Kapa.ai conversation https://app.kapa.ai/720100f9-ce93-4305-88fd-5fcf71effad7/conversations/16b13679-0ced-4780-ab58-3d9cacb2d899
Starting from: https://docs.influxdata.com/influxdb3/enterprise/
* Update content/shared/influxdb3-query-guides/sql/compare-values.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
---------
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* chore: Standard exclude comment format to denote flags, options, etc. that shouldn't be promoted in docs
* chore: exclude internal flags
* chore: Add docs:exclude comments for internal CLI flags, fix linting
- Note internal options that should be ignored by `docs audit` and authors.
- Remove character escaping from GitHub callouts and placeholders
Lint config changes:
- Add explicit exclude for content/**/*.md in lint-markdown-instructions
- Exclude all markdown files from Prettier formatting
Fixes issue where remark-lint was auto-formatting content files and
escaping special characters like [!Note] callouts and underscores.
* fix: cleanup escaping
* Initial plan
* Fix Edit this page link duplication
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
* docs: fix dedicated admin ui doc adjustments
* merge identity version under one heading
* docs: fix links in one location shortcode does not work
* chore: remove extra space from editor in admin ui access layout shortcode
* chore: 3.7 update
* fix(influxdb3): influxdb3 3.7 release:
- Avoid use of "retention policy" except for the storage engine
- User guide: specific heading, active voice
- Use SOURCE
* feat(influxdb3): update API docs for 3.7 release
- Add cluster-uuid response header to all write endpoints
- Document multi-member gzip payload support in ContentEncoding
- Update API version to 3.7.0 for both Core and Enterprise
- Extract cluster-uuid header to reusable component
Changes for InfluxDB 3.7 release include:
- cluster-uuid header now included in all HTTP responses
- Multi-member gzip support per RFC 1952 for write endpoints
- Compatible with v1 and v2 write endpoints
* fix(influxdb3): remove precision bug note - fixed in 3.7
Removed outdated bug note about abbreviated precision values not working
with /api/v3/write_lp endpoint. Testing confirms all abbreviated values
(ns, ms, us, s) now work correctly in InfluxDB 3.7.
Tested precision values:
- ns (nanoseconds) ✅
- ms (milliseconds) ✅
- us (microseconds) ✅
- s (seconds) ✅
* docs(influxdb3): add precision bug fix to v3.6.0 release notes
Document that abbreviated precision values (ns, ms, us, s) were fixed
in v3.6.0 to work with /api/v3/write_lp endpoint.
The fix was implemented in commit 97dafa177c and included in v3.6.0 release.
---------
Co-authored-by: Peter Barnett <peter.barnett03@gmail.com>
* chore: 3.7 update
* fix(influxdb3): influxdb3 3.7 release:
- Avoid use of "retention policy" except for the storage engine
- User guide: specific heading, active voice
- Use SOURCE
---------
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Jason Stirnaman
Geoffrey Wossum
spike77453
Copilot
Jamie Strandboge
WeblWabl
Dustin Eaton
peterbarnett03
Sven Rebhan
Gary Fowler
Scott Anderson
Bill O'Connell
Bill OConnell