* docs(influxdb3): document how to disable Processing Engine
Add documentation for disabling the Processing Engine in Docker and
systemd deployments. Key points:
- Processing Engine is enabled by default in Docker images and DEB/RPM
- Empty string does not disable — must unset or remove config
- Enterprise: use INFLUXDB3_UNSET_VARS feature
- Core Docker: requires custom entrypoint workaround
- systemd: comment out or remove plugin-dir from TOML config
closesinfluxdata/DAR#590
* docs(influxdb3): add cross-references for Processing Engine defaults
Add notes and cross-references explaining that the Processing Engine
is enabled by default in Docker and DEB/RPM installations:
- plugins/_index.md: Add deployment behavior table and link to disable docs
- get-started/processing-engine.md: Add note with cross-reference
* docs(influxdb3): clarify Processing Engine vs process mode distinction
Add notes explaining that --plugin-dir (Processing Engine activation) and
--mode=process (cluster node specialization) are independent configurations.
* docs(influxdb3): document --plugin-dir auto-enables process mode
- Update clustering, get-started, plugins, and reference pages
- Add example for enabling Processing Engine without --mode=process
- Clarify --mode=process is only needed for dedicated process-only nodes
- Synthesize notes into inline content for better flow in guides
* Update content/shared/influxdb3-reference/influxdb3-processing-engine.md
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* Update content/shared/influxdb3-cli/config-options.md
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
---------
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* fix(influxdb3): Mark disabled field as required in processing engine trigger API specs
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
* Add HTTP API examples to Processing Engine plugin documentation (#6789)
- Add disabled field and api-ref to API examples per review feedback
- Add api-ref to upload plugin endpoint and remove duplicate link sentence
- Convert {{% code-placeholders %}} shortcode to placeholders code block
attribute for cleaner syntax
- Add second argument to token-link shortcodes for admin tokens to
ensure consistent linking to /admin/tokens/admin/ path
- Follows PR 6789 review feedback for processing engine documentation
fix(influxdb3): update placeholder and token-link syntax in get-started
- Convert code-placeholders wrapper shortcodes to code block attributes
* fix(influxdb3): Fix broken trigger anchor links in plugin documentation
Rename "Set up a trigger" heading to "Create a trigger" and update
all internal anchor references to match.
---------
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): document trigger logging behavior
Add processing_engine_logs table documentation to system data reference,
explaining that logs are stored in both the trigger's database (primary)
and _internal. Update plugins error handling to specify trigger's database.
* Update content/shared/influxdb3-plugins/_index.md
* fix(influxdb3): source comments
* docs(influxdb3): fix plugin path handling and improve Get Started clarity
Fixes issues with plugin filename resolution and improves progressive
disclosure in the processing engine Get Started guide.
- Update `--plugin` flag to `--path` (current CLI syntax)
- Clarify plugin filename must be provided without relative/absolute paths
- Add note explaining path resolution relative to `--plugin-dir`
- Document single-file vs multi-file plugin path requirements
- Link to detailed multi-file plugin structure documentation
- Add "Before you begin" section listing required setup steps
- Add prerequisites to table of contents
- Improve progressive disclosure by front-loading essentials
- Update trigger type from "Data write" to "WAL rows" (consistent with `influxdb3 create trigger --help`) with WAL link
- Replace `--plugin` with `--path` in trigger creation example
- Fix syntax error in enable trigger example (missing backslash)
- Clarify plugin example as "data write (WAL) plugin"
- Update code comments for clarity and remove outdated notes
- Specify "wal_rows trigger specification" terminology
- Specify testing "process_writes (WAL) plugin" for clarity
- Reference multiple test commands, not just wal_plugin
- Add link to schedule_plugin test command
- Clarify that PLUGIN_FILENAME should be filename only
- Prevents path resolution errors users encountered
- Aligns documentation with current CLI behavior
- Improves Get Started guide readability and flow
- Reduces confusion about plugin file handling
Closes#588
* docs(influxdb3): Docker Compose optional plugin directory
- Added inline comments to Docker Compose examples: `# Optional: only
needed for processing engine plugins`
- Appears for both `--plugin-dir` flag and volume mount
- Helps users understand they can skip this if not using plugins
- Better progressive disclosure - users see it's optional without
needing separate explanation
* docs(influxdb3): Replace --plugin-filename with --path
- Uses `--path` for plugins, replacing deprecated `--plugin-filename`
- Replaces "Data write" with "WAL rows" to be consistent with CLI help
docs
* Update content/shared/influxdb3-get-started/processing-engine.md
* fix(deps): add missing yarn.lock updates for puppeteer
The puppeteer dependency was added to package.json in commit 784956a31
but yarn.lock was not updated, causing CI failures with --frozen-lockfile.
* chore(deps): upgrade puppeteer to 24.35.0
- Upgrade puppeteer from 23.11.1 to 24.35.0
- Fix deprecated page.waitForTimeout() - replaced with Promise/setTimeout
- Fix deprecated headless: 'new' - now just uses headless boolean
The 'new' headless mode is now the default in Puppeteer 24.
Add guidance for AI tools about generated documentation:
- content/shared/influxdb3-plugins/plugins-library/official/CLAUDE.md
- content/telegraf/CLAUDE.md
These files document the sync workflows and prevent AI tools from
editing generated content directly.
- Add TOML configuration section to plugins-library index explaining usage
- Add TOML config tables to all official plugin documentation files
- Standardize TOML section format across plugins with config_file_path parameter
- Update system-metrics plugin moved from examples to official
- Remove redundant config_file_path from individual parameter tables
- Ensure consistent placement before Installation/Requirements sections
- Fix linting: replace 'e.g.' with 'for example' in system-metrics.md
This completes the TOML configuration documentation updates from PR 6244
- Add plugin library structure for Core and
Enterprise products
- Create shared content directory for plugin
documentation
- Port 12 plugin documentation files from
influxdb3_plugins repository
- Add GitHub repository links in related frontmatter
for all plugins
- Remove emoji metadata tags and clean up content
structure
- Implement standardized support sections with
product-specific links
- Reorganize plugins navigation with dedicated
library section
- Include 2 example plugins and 10 official
InfluxData plugins
Jason Stirnaman
Copilot
github-actions[bot]
epgif
meelahme
Jameelah Mercer
peterbarnett03
Jason Stirnaman