-
Notifications
You must be signed in to change notification settings - Fork 325
docs(influxdb3): Add performance upgrade preview documentation for Enterprise #6770
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
peterbarnett03
wants to merge
7
commits into
release/influxdb3.9
Choose a base branch
from
docs/influxdb3-enterprise-performance-upgrade-preview
base: release/influxdb3.9
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
0ea8a83
docs(influxdb3): Add performance upgrade preview documentation for En…
peterbarnett03 6797bbb
Merge branch 'master' into docs/influxdb3-enterprise-performance-upgr…
peterbarnett03 928913e
Update content/influxdb3/enterprise/admin/pachatree/_index.md
jstirnaman 8707a37
Update content/influxdb3/enterprise/admin/pachatree/_index.md
jstirnaman 3375d78
Update content/influxdb3/enterprise/admin/pachatree/configure.md
jstirnaman 7c96765
fix(influxdb3): PR suggestions (#6771)
jstirnaman 8db83ef
Update code blocks with placeholders and clarify AUTH_TOKEN usage (#6…
jstirnaman File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| --- | ||
| title: Performance upgrade preview | ||
| seotitle: Performance upgrade preview for InfluxDB 3 Enterprise | ||
| description: > | ||
| Preview performance upgrades in InfluxDB 3 Enterprise with improved | ||
| single-series query performance, consistent resource usage, wide-and-sparse | ||
| table support, and automatic distinct value caching. | ||
| menu: | ||
| influxdb3_enterprise: | ||
| name: Performance upgrade preview | ||
| parent: Administer InfluxDB | ||
| weight: 115 | ||
| influxdb3/enterprise/tags: [storage, performance, beta, preview] | ||
| related: | ||
| - /influxdb3/enterprise/get-started/setup/ | ||
| - /influxdb3/enterprise/admin/pachatree/configure/ | ||
| - /influxdb3/enterprise/admin/pachatree/monitor/ | ||
| - /influxdb3/enterprise/admin/performance-tuning/ | ||
| --- | ||
|
|
||
| > [!Warning] | ||
| > #### Private preview beta | ||
| > The performance upgrade preview is available to {{% product-name %}} Trial | ||
| > and Commercial users as a private beta. These features are subject to breaking changes | ||
| > and **should not be used for production workloads**. | ||
| > | ||
| > To share feedback on this preview, see [Support and feedback options](#bug-reports-and-feedback). | ||
| > Your feedback on stability | ||
| > and performance at scale helps shape the future of InfluxDB 3. | ||
|
|
||
| {{% product-name %}} includes a private preview of major performance and | ||
| feature updates. These updates represent the foundation for the upcoming 3.10 | ||
| and 3.11 releases. Available in beta now for InfluxDB 3 Enterprise, many of | ||
| these improvements will be coming to InfluxDB 3 Core in subsequent release cycles. | ||
|
|
||
| ## Key improvements | ||
|
|
||
| - **Faster single-series queries**: Optimized data path for fetching specific | ||
| trends over long time windows, with single-digit millisecond response times. | ||
| - **Consistent resource usage**: Reduced CPU and memory spikes during heavy | ||
| compaction or ingestion bursts through key-range partitioning. | ||
| - **Wide-and-sparse table support**: Handles schemas with up to hundreds of | ||
| thousands of columns and dynamic schema evolution without expensive rewrites. | ||
| - **Automatic distinct value caches**: Dramatically reduced latency for metadata | ||
| queries like `SHOW TAG VALUES` in InfluxQL. | ||
|
|
||
| ## Enable the preview | ||
|
|
||
| Add the `--use-pacha-tree` flag to your normal | ||
| [`influxdb3 serve` startup command](/influxdb3/enterprise/get-started/setup/): | ||
|
|
||
| ```bash | ||
| influxdb3 serve \ | ||
| --node-id host01 \ | ||
| --cluster-id cluster01 \ | ||
| --object-store file \ | ||
| --data-dir ~/.influxdb3 \ | ||
| --use-pacha-tree | ||
| ``` | ||
|
|
||
| The flag exposes additional configuration options prefixed with `--pt-`. | ||
| See [Configure the preview](/influxdb3/enterprise/admin/pachatree/configure/) | ||
| for tuning options, or [Monitor the preview](/influxdb3/enterprise/admin/pachatree/monitor/) | ||
| for system tables and telemetry. | ||
|
|
||
| ## Who should try the preview | ||
|
|
||
| Consider enabling the preview in your staging or development environment if | ||
| you have workloads with high cardinality, wide tables, frequent backfill, or | ||
| query-heavy access patterns. | ||
|
|
||
| Your feedback on stability and speed at scale helps inform the development of | ||
| features planned for general availability in the 3.10 and 3.11 releases. | ||
|
|
||
| > [!Important] | ||
| > #### Important: Upgraded file format | ||
| > | ||
| > These upgrades use a new file format (`.pt` files). | ||
| > When you enable the preview, | ||
| > your existing data is automatically upgraded to the new format in place. | ||
| > While downgrading is possible, any data written after the upgrade will not | ||
| > be included in the downgrade. | ||
| > | ||
| > Systems with large amounts of data may take longer to complete the | ||
| > conversion. For the beta, we recommend starting with a fresh setup for | ||
| > testing and evaluation rather than converting existing data. | ||
|
|
||
| {{< children hlevel="h2" readmore=true hr=true >}} | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@peterbarnett03 -- do you want to call it "pacha tree" in the beta? We can create a synonmous enable flag if you want to call it something more general like
--enable-performance-trial... "performance-trial" having the same initials as "pacha tree".