* 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>
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
* 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>
* feat(askai): add Kapa.ai source group filtering for InfluxDB v3
- Add ai_source_group_ids field to all InfluxDB v3 products in data/products.yml
- Add getProductSourceGroupIds() function to retrieve source group IDs from product data
- Enables filtered AI responses using Kapa source groups for documentation pages
- Follows existing pattern for dynamic product configuration
- Implement version-specific config support (__v1, __v2 suffixes)
- Append version hints to example questions for InfluxDB database products only
- Make example questions generic (remove product-specific names)
- Tools (Telegraf, Chronograf, Kapacitor, Flux, Explorer) display questions without version hints
- Pre-fills chat input with [version: /path/] for InfluxDB database products
- Users can easily edit or remove the pre-filled text
- Works for manual opens (Cmd+K) and programmatic opens
- Converts module to TypeScript
* refactor(ask-ai): change version format to 'My version: <product name>'
Use human-readable product names instead of URL paths for better UX.
Example: 'My version: InfluxDB 3 Core' instead of '[version: /influxdb3/core/]'
* fix(ask-ai): restore working Kapa.open() pre-fill implementation
- Replace textarea detection with direct Kapa.open() call
- Add Kapa preinitialization code
- Use click handler on .ask-ai-open button with capture phase
- Handle conversation reset event to re-fill version context
- Remove console logging for cleaner production code
* fix(ask-ai): remove parentheses from example questions for consistency
Make example question format match the pre-fill format:
- Before: 'question (My version: product)'
- After: 'question My version: product'
This ensures users don't think there's a difference between the two formats.
* fix(askai): add Explorer product mapping for Ask AI widget
- Add influxdb3_explorer mapping to getCurrentProductData()
- Add explorer context to getContext() function
- Ensures Explorer pages use correct ai_sample_questions from products.yml
- Reorder Explorer questions with 'install and run' first
This fixes the issue where Explorer Ask AI widget was showing wrong
example questions by properly loading the influxdb3_explorer config.
* test(page-context): add comprehensive e2e tests for product mappings
Add Cypress tests to validate page-context.js correctly identifies:
- Product context values for all InfluxDB products
- Product data from products.yml configuration
- Version information
- AI sample questions and source group IDs
- Placeholder host values
Tests cover:
- InfluxDB 3 (Core, Enterprise, Explorer, Cloud variants, Clustered)
- InfluxDB v2 and v1
- InfluxDB Cloud (TSM)
- Tools (Telegraf, Chronograf, Kapacitor, Flux)
Validates the fix for Explorer Ask AI showing correct example questions.
Related to #jts-askai-group-filters branch work.
* feat(test): add --no-mapping flag to e2e test runner
Allow running functionality tests without requiring content file paths.
The --no-mapping flag skips content-to-URL mapping, making it easier
to run tests that don't depend on specific content files.
Usage:
# With content mapping (for content-specific tests)
node run-e2e-specs.js content/influxdb3/core/_index.md
# Without content mapping (for functionality tests)
node run-e2e-specs.js --spec cypress/e2e/page-context.cy.js --no-mapping
Benefits:
- Simplifies running functionality tests like page-context.cy.js
- Reduces test startup time by skipping unnecessary file mapping
- Makes test commands clearer about their purpose
The page-context test was updated to work correctly with this flag.
* deps: update caniuse and related hook files
* test: Add a `--no-mapping` flag to run tests without specific content files (i.e., test contains all the URLs it needs)
* chore(ask-ai): Format example questions
* test(page-context): add comprehensive e2e tests for all products in products.yml
- Expanded test suite from 6 to 27 tests covering all products
- Added tests for InfluxDB 3 products (Explorer, Core, Enterprise, Cloud Serverless, Cloud Dedicated, Clustered)
- Added tests for InfluxDB v2 and Cloud (TSM)
- Added tests for InfluxDB v1 and Enterprise v1
- Added tests for other products (Telegraf, Chronograf, Kapacitor, Flux)
- Validates page mappings in page-context.js
- Validates AI sample questions configuration in products.yml
- All 27 tests passing
* fix(page-context): correct enterprise_influxdb URL pattern matching
- Changed pattern from /enterprise_v1/ to /enterprise_influxdb/
- Fixes Ask AI example questions not showing correctly for Enterprise v1
- Pattern now matches actual URL structure /enterprise_influxdb/v1/
- All 27 e2e tests passing
* test(page-context): add UI validation for Ask AI widget configuration
- Added 4 tests checking Kapa widget script data attributes
- Tests verify data-modal-example-questions contains correct product-specific questions
- Validates Explorer, Core, Enterprise, and Enterprise v1 configurations
- All 31 tests passing (27 existing + 4 new UI tests)
* feat(ask-ai): add help in Ask AI widget placeholder
- InfluxDB placeholder recommends specifying product and version
- Fix page-context.js to use products.influxdb_cloud instead of products.cloud
- Add UI tests verifying version-specific naming in Kapa widget script tags
* feat(ask-ai): Tailors placeholder for each version/product. Disables "Viewing <product>" in disclaimer note.
- Migrate comprehensive ODBC driver installation instructions to Power BI guide
- Add Windows (PowerShell and Manual) installation steps with verification
- Add macOS and Linux installation steps with configuration details
- Include platform-specific verification procedures
- Enhance Power BI troubleshooting section with ODBC-specific guidance
- Add driver not found troubleshooting for all platforms
- Expand connection, authentication, and query error troubleshooting
- Add query performance optimization recommendations
- Restructure Power BI documentation for clarity
- Elevate ODBC driver installation to top-level section
- Add explicit sequencing: install driver before connector
- Improve section flow and subheading descriptiveness
- Remove standalone ODBC documentation pages
- Delete shared ODBC guide and product-specific ODBC pages
- Add aliases in Power BI frontmatter to redirect old ODBC URLs
- Apply changes across all InfluxDB 3 products:
core, enterprise, cloud-dedicated, cloud-serverless, clustered
* fix(influxdb3): document exec-mem-pool-bytes usage for data persistence
Updates documentation to reflect that exec-mem-pool-bytes is used for both
query processing and parquet persistence operations, not just queries.
Based on source code analysis showing the memory pool is used by:
- Query executor for processing queries
- Persister for converting WAL data to Parquet format
Changes:
- Updated config description to include "data operations"
- Added memory usage info to durability docs for Parquet storage
- Added troubleshooting section for memory-related write performance
- Fixed capitalization of "object store" throughout
Addresses DAR #499
Source analysis: influxdb3/src/commands/serve.rs:772-798
Shows separate executors for queries and write path operations,
both using memory pools for data processing.
* fix(influxdb3): broken links to no-sync
* Closes#6509
New Ent 3 CLI Commands
1. influxdb3 stop - Parent command for node lifecycle management
2. influxdb3 stop node - Stop a node in the Enterprise cluster and free up licensed cores
3. influxdb3 show nodes - Display information about nodes in the cluster
Files Created
Shared Content Files (only used by Ent3 for now):
- content/shared/influxdb3-cli/stop/_index.md - Stop command overview
- content/shared/influxdb3-cli/stop/node.md - Stop node command details with examples
- content/shared/influxdb3-cli/show/nodes.md - Show nodes command details with examples
Enterprise-Specific Frontmatter Files:
- content/influxdb3/enterprise/reference/cli/influxdb3/stop/_index.md
- content/influxdb3/enterprise/reference/cli/influxdb3/stop/node.md
- content/influxdb3/enterprise/reference/cli/influxdb3/show/nodes.md
Updated Files:
- Added stop command to the main influxdb3 CLI reference
- Added nodes subcommand to the show command reference
* Apply suggestion from @jstirnaman
* Apply suggestion from @jstirnaman
* fix(influxdb3): override PLUGIN_DIR env var in compose services to match --plugin-dir
- Set INFLUXDB3_PLUGIN_DIR=/var/lib/influxdb3/plugins in both influxdb3-core and influxdb3-enterprise services
- Overrides Docker image default (/plugins) to match --plugin-dir command argument
- Ensures package installation works correctly with bind-mounted plugin directory
- Update influxdb3 install package CLI documentation with complete options reference
* docs(influxdb3): add Docker disk space troubleshooting for package installation
Add troubleshooting section for 'No space left on device' errors when installing packages in Docker environments. Includes commands to check Docker disk usage and clean up unused images and build cache.
Also fix Vale linting errors by changing 'URL' to 'url'.
* Apply suggestion from @jstirnaman
* fix(ci): Vale rules for URL/-url-/WAL/-wal-/Parquet/-parquet-:
1. Simplified the Parquet vocabulary entry from the regex to just Parquet
2. Added separate regex patterns for hyphenated identifiers
* feat(influxdb3): describe use cases and effects of --package-manager disabled
* feat(influxdb3): Core/Enterprise: Upgrade instance or cluster:- Addresses recent internal requests for upgrade steps- Provide examples for Core or Enterprise single node (instance)- Provide steps recommended by Engineering and examples- Link from related pages
* Apply suggestion from @sanderson
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Apply suggestion from @sanderson
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Apply suggestion from @sanderson
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Apply suggestion from @sanderson
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Apply suggestion from @sanderson
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* docs(enterprise): clarify catalog version constraints for v3.3.x to v3.4.x upgrade
- Specify that catalog modification constraint applies when upgrading from v3.3.x (or earlier) to v3.4.x
- Add troubleshooting section noting that different version transitions may have different constraints
- Direct users to check release notes for version-specific upgrade requirements
Resolves review comment from hiltontj about catalog version boundaries.
---------
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* docs(influxdb3): update write endpoint recommendations and add Telegraf guidance
- Update write endpoint recommendations for Core/Enterprise
- Add Telegraf output plugin guidance (v1.x and v2.x)
- Improve introductory content and formatting
- Change Note to Tip for write endpoint recommendations
- Add italics to v1/v2 for clarity
* docs(influxdb3): add precision parameter comparison and format details
- Add precision comparison table across v1, v2, v3 write APIs
- Document auto precision detection with exponential notation (5e9, 5e12, 5e15)
- Add tabbed code examples for different precision values
- Update OpenAPI specs with long-form precision values only (auto, nanosecond, microsecond, millisecond, second)
- Add timestamp conversion details for internal storage
- Use long-form precision values in all examples
Note: Currently /api/v3/write_lp only supports long forms despite source code indicating short form support.
Related to #6472 - precision parameter behavior may have bugs
* feat(influxdb3): Core and Ent performance tuning guide:Add an admin/performance-tuning/ page with specific workload and capacity configurations.Part of #6403.
* fix(influxdb3): product-specific link fragments for flags
* fix(influxdb3): enterprise-specific link fragments
* Apply suggestion from @jstirnaman
* fix(influxdb3): duplicate licensing and resource limits sections- Rem… (#6470)
* fix(influxdb3): duplicate licensing and resource limits sections- Remove duplicate licensing section- Resolve resource limits duplicates, merging details into the Resource limits section.
* fix(influxdb3): fix broken links and enterprise-only flags in config options
- Comment out TOC links to undocumented datafusion-runtime-* dev flags
- Wrap enterprise-only section references (#licensing, #resource-limits) in conditionals
- Fix num-datafusion-threads incorrectly marked as enterprise-only
- Move Resource Limits section heading outside enterprise wrapper
Resolves broken fragment links for both Core and Enterprise builds.
* feat(enterprise): add cluster management documentation (#6431)
Add comprehensive guide for managing InfluxDB 3 Enterprise clusters including:
- Node configuration and deployment
- Cluster initialization and scaling
- Node removal and replacement procedures
- Best practices for production deployments
* Fixes multiple influxdb3 config option issues:
- Fixed option placement (global vs serve options) in performance-tuning.md
- Fixed --datafusion-num-threads option name (was --num-datafusion-threads)
- Fixed --parquet-mem-cache-size option name and defaults for Core
- Commented out unreleased --compaction-row-limit option
- Added v3.0.0 breaking changes to release notes
- Updated config-options.md with correct defaults and value formats
All changes verified against InfluxDB v3.5.0 release binaries and git history.
* fix(influxdb3): config options in clustering.md
- Correctly place server options
- Comment out unreleased options
* docs(cli): fix global vs serve-specific flag documentation
- Remove --verbose from global flags (it's serve-specific)
- Document --num-io-threads as global-only flag
- Add clear examples showing correct flag positioning
- Update serve.md files with global flag usage notes
- Fix config-options.md to separate Core/Enterprise examples
Resolves incorrect CLI usage patterns that would cause errors.
Global flags must go before 'serve', serve-specific flags go after.
* docs(cli): remove Tokio runtime options from CLI index pages
- Remove detailed Tokio runtime options tables from CLI index pages
- Replace with simplified global options and link to config-options
- Add examples showing correct global flag positioning
- Fix --verbose usage to be serve-specific (after serve command)
- Add --num-io-threads example as global flag (before serve command)
These detailed options are now documented in config-options.md with
proper global vs serve-specific categorization.
- Adds /reference/internals/data-retention/ for data retention behavior and retention period details
- admin/databases and admin/tables:
- Adds examples for API and retention period
- Adds cautions and behavior notes for Core retention
- reference/cli/influxdb3: Adds usage examples and details
- Closes /influxdata/DAR/issues/548
peterbarnett03
Jason Stirnaman
Dustin Eaton
Copilot
Scott Anderson
caterryan
Adam S
epgif
meelahme
Jameelah Mercer
Scott Anderson