From 05e74088bf7f575276092e05fb0df58a4f17d3f2 Mon Sep 17 00:00:00 2001 From: Gary Fowler <97983559+garylfowler@users.noreply.github.com> Date: Wed, 30 Jul 2025 14:41:45 -1000 Subject: [PATCH 1/6] Update get-started.md Since we now allow other types of keys than Open AI, removing the word Open from this page. --- content/influxdb3/explorer/get-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/influxdb3/explorer/get-started.md b/content/influxdb3/explorer/get-started.md index 244191130..863ecbfec 100644 --- a/content/influxdb3/explorer/get-started.md +++ b/content/influxdb3/explorer/get-started.md @@ -86,7 +86,7 @@ To use {{% product-name %}} to query data from InfluxDB 3, navigate to The _Data Explorer_ lets you explore the schema of your database and automatically builds SQL queries by either selecting columns in the _Schema Browser_ or by using _Natural Language_ with -the {{% product-name %}} OpenAI integration. +the {{% product-name %}} AI integration. For this getting started guide, use the Schema Browser to build a SQL query that returns data from the newly written sample data set. From 963d0a8d218cd2cb7a5cd90f89b87fb5d327df09 Mon Sep 17 00:00:00 2001 From: Peter Barnett Date: Thu, 14 Aug 2025 11:29:44 -0400 Subject: [PATCH 2/6] docs: add usage telemetry documentation --- content/influxdb3/core/reference/telemetry.md | 18 ++++ .../enterprise/reference/telemetry.md | 18 ++++ content/shared/influxdb3-admin/telemetry.md | 97 +++++++++++++++++++ 3 files changed, 133 insertions(+) create mode 100644 content/influxdb3/core/reference/telemetry.md create mode 100644 content/influxdb3/enterprise/reference/telemetry.md create mode 100644 content/shared/influxdb3-admin/telemetry.md diff --git a/content/influxdb3/core/reference/telemetry.md b/content/influxdb3/core/reference/telemetry.md new file mode 100644 index 000000000..fae9427e3 --- /dev/null +++ b/content/influxdb3/core/reference/telemetry.md @@ -0,0 +1,18 @@ +--- +title: Usage telemetry +seotitle: InfluxDB Core usage telemetry +description: > + InfluxDB Core can collect and send usage telemetry data to help improve the + product. +menu: + influxdb3_core: + parent: Reference +weight: 108 +influxdb3/core/tags: [telemetry, monitoring, metrics, observability] +source: /shared/influxdb3-admin/telemetry.md +--- + + \ No newline at end of file diff --git a/content/influxdb3/enterprise/reference/telemetry.md b/content/influxdb3/enterprise/reference/telemetry.md new file mode 100644 index 000000000..779896464 --- /dev/null +++ b/content/influxdb3/enterprise/reference/telemetry.md @@ -0,0 +1,18 @@ +--- +title: Usage telemetry +seotitle: InfluxDB Enterprise usage telemetry +description: > + InfluxDB Enterprise can collect and send usage telemetry data to help improve the + product. +menu: + influxdb3_enterprise: + parent: Reference +weight: 108 +influxdb3/enterprise/tags: [telemetry, monitoring, metrics, observability] +source: /shared/influxdb3-admin/telemetry.md +--- + + \ No newline at end of file diff --git a/content/shared/influxdb3-admin/telemetry.md b/content/shared/influxdb3-admin/telemetry.md new file mode 100644 index 000000000..90639f993 --- /dev/null +++ b/content/shared/influxdb3-admin/telemetry.md @@ -0,0 +1,97 @@ +InfluxDB 3 can collect and send usage telemetry data to help improve the product. This page describes what telemetry data is collected, when it's collected, how it's transmitted, and how to disable it. + +## What data is collected + +{{< product-name >}} collects the following telemetry data: + +### System metrics + +- **CPU utilization**: Process-specific CPU usage (min, max, average) +- **Memory usage**: Process memory consumption in MB (min, max, average) +- **Cores**: Number of CPU cores in use +- **OS**: Operating system information +- **Version**: {{< product-name >}} version +- **Uptime**: Server uptime in seconds + +### Write metrics + +- **Write requests**: Number of write operations (min, max, average, hourly sum) +- **Write lines**: Number of lines written (min, max, average, hourly sum) +- **Write bytes**: Amount of data written in MB (min, max, average, hourly sum) + +### Query metrics + +- **Query requests**: Number of query operations (min, max, average, hourly sum) + +### Storage metrics + +- **Parquet file count**: Number of Parquet files (when available) +- **Parquet file size**: Total size of Parquet files in MB (when available) +- **Parquet row count**: Total number of rows in Parquet files (when available) + +### Processing engine metrics + +- **WAL triggers**: Write-Ahead Log trigger counts (when available) +- **Schedule triggers**: Scheduled processing trigger counts (when available) +- **Request triggers**: Request-based processing trigger counts (when available) + +### Instance information + +- **Instance ID**: Unique identifier for the server instance +- **Cluster UUID**: Unique identifier for the cluster (same as catalog UUID) +- **Storage type**: Type of object storage being used +{{% show-in "core" %}} +- **Product type**: "Core" +{{% /show-in %}} +{{% show-in "enterprise" %}} +- **Product type**: "Enterprise" +{{% /show-in %}} + +## Collection frequency + +- **System metrics** (CPU, memory): Collected every 60 seconds +- **Write and query metrics**: Collected per operation, rolled up every 60 seconds +- **Storage and processing engine metrics**: Collected at snapshot time (when available) +- **Instance information**: Static data collected once + +Telemetry data is transmitted once per hour. + +## Disable telemetry + +Disables sending telemetry data to InfluxData. + +**Default:** `false` + +| influxdb3 flag | Environment variable | +| :------------- | :------------------- | +| `--disable-telemetry-upload` | `INFLUXDB3_TELEMETRY_DISABLE_UPLOAD` | + +#### Command line flag +```sh +influxdb3 serve --disable-telemetry-upload +``` + +#### Environment variable +```sh +export INFLUXDB3_TELEMETRY_DISABLE_UPLOAD=true +``` + +When telemetry is disabled, no usage data is collected or transmitted. + +## Data handling + +The telemetry data is used by InfluxData to: + +- Understand product usage patterns +- Improve product performance and reliability +- Prioritize feature development +- Identify and resolve issues + +No personally identifiable information (PII) is collected. + +## Privacy and security + +- All telemetry data is transmitted securely via HTTPS +- No database contents, queries, or user data is collected +- Only operational metrics and system information is transmitted +- Data collection follows InfluxData's privacy policy \ No newline at end of file From 32cdfb533c85b6ea9575f2f140e23ed2ac4f74fe Mon Sep 17 00:00:00 2001 From: Peter Barnett Date: Thu, 14 Aug 2025 11:44:25 -0400 Subject: [PATCH 3/6] fix: small clarity changes and easier reading --- content/shared/influxdb3-admin/telemetry.md | 42 +++++++++------------ 1 file changed, 17 insertions(+), 25 deletions(-) diff --git a/content/shared/influxdb3-admin/telemetry.md b/content/shared/influxdb3-admin/telemetry.md index 90639f993..09a4bd10a 100644 --- a/content/shared/influxdb3-admin/telemetry.md +++ b/content/shared/influxdb3-admin/telemetry.md @@ -6,8 +6,8 @@ InfluxDB 3 can collect and send usage telemetry data to help improve the product ### System metrics -- **CPU utilization**: Process-specific CPU usage (min, max, average) -- **Memory usage**: Process memory consumption in MB (min, max, average) +- **CPU utilization**: Process-specific CPU usage +- **Memory usage**: Process memory consumption in MB - **Cores**: Number of CPU cores in use - **OS**: Operating system information - **Version**: {{< product-name >}} version @@ -15,30 +15,30 @@ InfluxDB 3 can collect and send usage telemetry data to help improve the product ### Write metrics -- **Write requests**: Number of write operations (min, max, average, hourly sum) -- **Write lines**: Number of lines written (min, max, average, hourly sum) -- **Write bytes**: Amount of data written in MB (min, max, average, hourly sum) +- **Write requests**: Number of write operations +- **Write lines**: Number of lines written +- **Write bytes**: Amount of data written in MB ### Query metrics -- **Query requests**: Number of query operations (min, max, average, hourly sum) +- **Query requests**: Number of query operations ### Storage metrics -- **Parquet file count**: Number of Parquet files (when available) -- **Parquet file size**: Total size of Parquet files in MB (when available) -- **Parquet row count**: Total number of rows in Parquet files (when available) +- **Parquet file count**: Number of Parquet files +- **Parquet file size**: Total size of Parquet files in MB +- **Parquet row count**: Total number of rows in Parquet files ### Processing engine metrics -- **WAL triggers**: Write-Ahead Log trigger counts (when available) -- **Schedule triggers**: Scheduled processing trigger counts (when available) -- **Request triggers**: Request-based processing trigger counts (when available) +- **WAL triggers**: Write-Ahead Log trigger counts +- **Schedule triggers**: Scheduled processing trigger counts +- **Request triggers**: Request-based processing trigger counts ### Instance information - **Instance ID**: Unique identifier for the server instance -- **Cluster UUID**: Unique identifier for the cluster (same as catalog UUID) +- **Cluster UUID**: Unique identifier for the cluster - **Storage type**: Type of object storage being used {{% show-in "core" %}} - **Product type**: "Core" @@ -80,18 +80,10 @@ When telemetry is disabled, no usage data is collected or transmitted. ## Data handling -The telemetry data is used by InfluxData to: - -- Understand product usage patterns -- Improve product performance and reliability -- Prioritize feature development -- Identify and resolve issues - -No personally identifiable information (PII) is collected. +The telemetry data is used by InfluxData to understand product usage patterns, improve product performance and reliability, prioritize feature development, and identify/resolve issues. No personally identifiable information (PII) is collected. ## Privacy and security -- All telemetry data is transmitted securely via HTTPS -- No database contents, queries, or user data is collected -- Only operational metrics and system information is transmitted -- Data collection follows InfluxData's privacy policy \ No newline at end of file +All telemetry data is transmitted securely via HTTPS. No database contents, queries, or user data is collected; only operational metrics and system information is transmitted. + +All data collection follows InfluxData's privacy policy. \ No newline at end of file From 4d5d5092347b1cbaf59dd1e70bf12b4491e874d8 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Wed, 23 Jul 2025 15:17:43 -0600 Subject: [PATCH 4/6] fix(monolith): add configurable db, table, and column limits to enterprise --- .../enterprise/reference/config-options.md | 2 +- .../influxdb3-admin/databases/_index.md | 29 +++++++---- .../influxdb3-admin/databases/create.md | 5 ++ .../shared/influxdb3-cli/config-options.md | 50 ++++++++++++++++--- 4 files changed, 69 insertions(+), 17 deletions(-) diff --git a/content/influxdb3/enterprise/reference/config-options.md b/content/influxdb3/enterprise/reference/config-options.md index cab8a5a77..313ceb3f4 100644 --- a/content/influxdb3/enterprise/reference/config-options.md +++ b/content/influxdb3/enterprise/reference/config-options.md @@ -13,4 +13,4 @@ source: /shared/influxdb3-cli/config-options.md \ No newline at end of file +--> diff --git a/content/shared/influxdb3-admin/databases/_index.md b/content/shared/influxdb3-admin/databases/_index.md index 73d148aae..f3f59aef7 100644 --- a/content/shared/influxdb3-admin/databases/_index.md +++ b/content/shared/influxdb3-admin/databases/_index.md @@ -13,7 +13,7 @@ stored. Each database can contain multiple tables. > **If coming from InfluxDB v2, InfluxDB Cloud (TSM), or InfluxDB Cloud Serverless**, > _database_ and _bucket_ are synonymous. - +The _maximum_ retention period is infinite (`none`) meaning data does not expire +and will never be removed by the retention enforcement service. +{{% /show-in %}} ## Database, table, and column limits @@ -40,9 +39,11 @@ never be removed by the retention enforcement service. **Maximum number of tables across all databases**: {{% influxdb3/limit "table" %}} {{< product-name >}} limits the number of tables you can have across _all_ -databases to {{% influxdb3/limit "table" %}}. There is no specific limit on how -many tables you can have in an individual database, as long as the total across -all databases is below the limit. +databases to {{% influxdb3/limit "table" %}}{{% show-in "enterprise" %}} by default{{% /show-in %}}. +{{% show-in "enterprise" %}}You can configure the table limit using the +[`--num-table-limit` configuration option](/influxdb3/enterprise/reference/config-options/#num-table-limit).{{% /show-in %}} +InfluxDB doesn't limit how many tables you can have in an individual database, +as long as the total across all databases is below the limit. Having more tables affects your {{% product-name %}} installation in the following ways: @@ -64,7 +65,8 @@ persists data to Parquet files. Each `PUT` request incurs a monetary cost and increases the operating cost of {{< product-name >}}. {{% /expand %}} -{{% expand "**More work for the compactor** _(Enterprise only)_ View more info" %}} +{{% show-in "enterprise" %}} +{{% expand "**More work for the compactor** View more info" %}} To optimize storage over time, InfluxDB 3 Enterprise has a compactor that routinely compacts Parquet files. @@ -72,6 +74,7 @@ With more tables and Parquet files to compact, the compactor may need to be scal to keep up with demand, adding to the operating cost of InfluxDB 3 Enterprise. {{% /expand %}} +{{% /show-in %}} {{< /expand-wrapper >}} ### Column limit @@ -80,11 +83,17 @@ to keep up with demand, adding to the operating cost of InfluxDB 3 Enterprise. Each row must include a time column, with the remaining columns representing tags and fields. -As a result, a table can have one time column and up to {{% influxdb3/limit "column" -1 %}} +As a result,{{% show-in "enterprise" %}} by default,{{% /show-in %}} a table can +have one time column and up to {{% influxdb3/limit "column" -1 %}} _combined_ field and tag columns. If you attempt to write to a table and exceed the column limit, the write request fails and InfluxDB returns an error. +{{% show-in "enterprise" %}} +You can configure the maximum number of columns per +table using the [`num-total-columns-per-table-limit` configuration option](/influxdb3/enterprise/reference/config-options/#num-total-columns-per-table-limit). +{{% /show-in %}} + Higher numbers of columns has the following side-effects: {{< expand-wrapper >}} diff --git a/content/shared/influxdb3-admin/databases/create.md b/content/shared/influxdb3-admin/databases/create.md index bbac8fa26..fd9546174 100644 --- a/content/shared/influxdb3-admin/databases/create.md +++ b/content/shared/influxdb3-admin/databases/create.md @@ -130,7 +130,12 @@ database_name/retention_policy_name ## Database limit +{{% show-in "enterprise" %}} +**Default maximum number of databases**: {{% influxdb3/limit "database" %}} +{{% /show-in %}} +{{% show-in "core" %}} **Maximum number of databases**: {{% influxdb3/limit "database" %}} +{{% /show-in %}} _For more information about {{< product-name >}} database, table, and column limits, see [Database, table, and column limits](/influxdb3/version/admin/databases/#database-table-and-column-limits)._ diff --git a/content/shared/influxdb3-cli/config-options.md b/content/shared/influxdb3-cli/config-options.md index 268b3ac93..13d98106c 100644 --- a/content/shared/influxdb3-cli/config-options.md +++ b/content/shared/influxdb3-cli/config-options.md @@ -53,6 +53,10 @@ influxdb3 serve - [tls-minimum-versions](#tls-minimum-version) - [without-auth](#without-auth) - [disable-authz](#disable-authz) +{{% show-in "enterprise" %}} + - [num-database-limit](#num-database-limit) + - [num-table-limit](#num-table-limit) + - [num-total-columns-per-table-limit](#num-total-columns-per-table-limit){{% /show-in %}} - [AWS](#aws) - [aws-access-key-id](#aws-access-key-id) - [aws-secret-access-key](#aws-secret-access-key) @@ -204,7 +208,7 @@ This value must be different than the [`--node-id`](#node-id) value. #### data-dir -For the `file` object store, defines the location InfluxDB 3 uses to store files locally. +For the `file` object store, defines the location {{< product-name >}} uses to store files locally. Required when using the `file` [object store](#object-store). | influxdb3 serve option | Environment variable | @@ -216,7 +220,7 @@ Required when using the `file` [object store](#object-store). {{% show-in "enterprise" %}} #### license-email -Specifies the email address to associate with your InfluxDB 3 Enterprise license +Specifies the email address to associate with your {{< product-name >}} license and automatically responds to the interactive email prompt when the server starts. This option is mutually exclusive with [license-file](#license-file). @@ -228,7 +232,7 @@ This option is mutually exclusive with [license-file](#license-file). #### license-file -Specifies the path to a license file for InfluxDB 3 Enterprise. When provided, the license +Specifies the path to a license file for {{< product-name >}}. When provided, the license file's contents are used instead of requesting a new license. This option is mutually exclusive with [license-email](#license-email). @@ -361,10 +365,44 @@ The server processes all requests without requiring tokens or authentication. Optionally disable authz by passing in a comma separated list of resources. Valid values are `health`, `ping`, and `metrics`. -| influxdb3 serve option | Environment variable | -| :--------------------- | :----------------------- | -| `--disable-authz` | `INFLUXDB3_DISABLE_AUTHZ`| +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------------ | +| `--disable-authz` | `INFLUXDB3_DISABLE_AUTHZ` | +{{% show-in "enterprise" %}} +--- + +#### num-database-limit + +Limits the total number of active databases. +Default is {{% influxdb3/limit "database" %}}. + +| influxdb3 serve option | Environment variable | +| :---------------------- | :---------------------------------------- | +| `--num-database-limit` | `INFLUXDB3_ENTERPRISE_NUM_DATABASE_LIMIT` | + +--- + +#### num-table-limit + +Limits the total number of active tables across all databases. +Default is {{% influxdb3/limit "table" %}}. + +| influxdb3 serve option | Environment variable | +| :--------------------- | :------------------------------------- | +| `--num-table-limit` | `INFLUXDB3_ENTERPRISE_NUM_TABLE_LIMIT` | + +--- + +#### num-total-columns-per-table-limit + +Limits the total number of columns per table. +Default is {{% influxdb3/limit "column" %}}. + +| influxdb3 serve option | Environment variable | +| :------------------------------------ | :------------------------------------------------------- | +| `--num-total-columns-per-table-limit` | `INFLUXDB3_ENTERPRISE_NUM_TOTAL_COLUMNS_PER_TABLE_LIMIT` | +{{% /show-in %}} --- ### AWS From 5492ba9eef7eef1bbee0912acbcbcc49d872bfa6 Mon Sep 17 00:00:00 2001 From: Peter Barnett Date: Thu, 14 Aug 2025 11:52:59 -0400 Subject: [PATCH 5/6] fix: remember the 3 --- content/influxdb3/core/reference/telemetry.md | 4 ++-- content/influxdb3/enterprise/reference/telemetry.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/content/influxdb3/core/reference/telemetry.md b/content/influxdb3/core/reference/telemetry.md index fae9427e3..14eb0692e 100644 --- a/content/influxdb3/core/reference/telemetry.md +++ b/content/influxdb3/core/reference/telemetry.md @@ -1,8 +1,8 @@ --- title: Usage telemetry -seotitle: InfluxDB Core usage telemetry +seotitle: InfluxDB 3 Core usage telemetry description: > - InfluxDB Core can collect and send usage telemetry data to help improve the + InfluxDB 3 Core can collect and send usage telemetry data to help improve the product. menu: influxdb3_core: diff --git a/content/influxdb3/enterprise/reference/telemetry.md b/content/influxdb3/enterprise/reference/telemetry.md index 779896464..3b3fef879 100644 --- a/content/influxdb3/enterprise/reference/telemetry.md +++ b/content/influxdb3/enterprise/reference/telemetry.md @@ -1,8 +1,8 @@ --- title: Usage telemetry -seotitle: InfluxDB Enterprise usage telemetry +seotitle: InfluxDB 3 Enterprise usage telemetry description: > - InfluxDB Enterprise can collect and send usage telemetry data to help improve the + InfluxDB 3 Enterprise can collect and send usage telemetry data to help improve the product. menu: influxdb3_enterprise: From f23026982b681658d658f8a50719a2a7f98e591d Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Thu, 14 Aug 2025 14:41:05 -0500 Subject: [PATCH 6/6] chore(monolith): Move telemetry reference to shared/influxdb3-reference. Revise description, disable, and product names. --- content/influxdb3/core/reference/telemetry.md | 9 +++++---- content/influxdb3/enterprise/reference/telemetry.md | 9 +++++---- .../telemetry.md | 8 ++++++-- 3 files changed, 16 insertions(+), 10 deletions(-) rename content/shared/{influxdb3-admin => influxdb3-reference}/telemetry.md (83%) diff --git a/content/influxdb3/core/reference/telemetry.md b/content/influxdb3/core/reference/telemetry.md index 14eb0692e..91002fb2c 100644 --- a/content/influxdb3/core/reference/telemetry.md +++ b/content/influxdb3/core/reference/telemetry.md @@ -2,17 +2,18 @@ title: Usage telemetry seotitle: InfluxDB 3 Core usage telemetry description: > - InfluxDB 3 Core can collect and send usage telemetry data to help improve the - product. + InfluxData collects telemetry data to help improve the {{< product-name >}}. + Learn what data {{< product-name >}} collects and sends to InfluxData, how it's used, and + how you can opt out. menu: influxdb3_core: parent: Reference weight: 108 influxdb3/core/tags: [telemetry, monitoring, metrics, observability] -source: /shared/influxdb3-admin/telemetry.md +source: /shared/influxdb3-reference/telemetry.md --- \ No newline at end of file diff --git a/content/influxdb3/enterprise/reference/telemetry.md b/content/influxdb3/enterprise/reference/telemetry.md index 3b3fef879..6ebb4ac6b 100644 --- a/content/influxdb3/enterprise/reference/telemetry.md +++ b/content/influxdb3/enterprise/reference/telemetry.md @@ -2,17 +2,18 @@ title: Usage telemetry seotitle: InfluxDB 3 Enterprise usage telemetry description: > - InfluxDB 3 Enterprise can collect and send usage telemetry data to help improve the - product. + InfluxData collects telemetry data to help improve the {{< product-name >}}. + Learn what data {{< product-name >}} collects and sends to InfluxData, how it's used, and + how you can opt out. menu: influxdb3_enterprise: parent: Reference weight: 108 influxdb3/enterprise/tags: [telemetry, monitoring, metrics, observability] -source: /shared/influxdb3-admin/telemetry.md +source: /shared/influxdb3-reference/telemetry.md --- \ No newline at end of file diff --git a/content/shared/influxdb3-admin/telemetry.md b/content/shared/influxdb3-reference/telemetry.md similarity index 83% rename from content/shared/influxdb3-admin/telemetry.md rename to content/shared/influxdb3-reference/telemetry.md index 09a4bd10a..4f8a5589f 100644 --- a/content/shared/influxdb3-admin/telemetry.md +++ b/content/shared/influxdb3-reference/telemetry.md @@ -1,4 +1,6 @@ -InfluxDB 3 can collect and send usage telemetry data to help improve the product. This page describes what telemetry data is collected, when it's collected, how it's transmitted, and how to disable it. +InfluxData collects information, or _telemetry data_, about the usage of {{% product-name %}} to help improve the product. +Learn what data {{% product-name %}} collects and sends to InfluxData, how it's used, and +how you can opt out. ## What data is collected @@ -58,7 +60,9 @@ Telemetry data is transmitted once per hour. ## Disable telemetry -Disables sending telemetry data to InfluxData. +To "opt-out" of collecting and sending {{% product-name %}} telemetry data, +include the `--disable-telemetry-upload` flag or set the `INFLUXDB3_TELEMETRY_DISABLE_UPLOAD` environment variable +when starting {{% product-name %}}. **Default:** `false`