diff --git a/content/influxdb3/core/reference/telemetry.md b/content/influxdb3/core/reference/telemetry.md new file mode 100644 index 000000000..91002fb2c --- /dev/null +++ b/content/influxdb3/core/reference/telemetry.md @@ -0,0 +1,19 @@ +--- +title: Usage telemetry +seotitle: InfluxDB 3 Core usage telemetry +description: > + 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-reference/telemetry.md +--- + + \ No newline at end of file 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/influxdb3/enterprise/reference/telemetry.md b/content/influxdb3/enterprise/reference/telemetry.md new file mode 100644 index 000000000..6ebb4ac6b --- /dev/null +++ b/content/influxdb3/enterprise/reference/telemetry.md @@ -0,0 +1,19 @@ +--- +title: Usage telemetry +seotitle: InfluxDB 3 Enterprise usage telemetry +description: > + 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-reference/telemetry.md +--- + + \ No newline at end of file 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. 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 diff --git a/content/shared/influxdb3-reference/telemetry.md b/content/shared/influxdb3-reference/telemetry.md new file mode 100644 index 000000000..4f8a5589f --- /dev/null +++ b/content/shared/influxdb3-reference/telemetry.md @@ -0,0 +1,93 @@ +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 + +{{< product-name >}} collects the following telemetry data: + +### System metrics + +- **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 +- **Uptime**: Server uptime in seconds + +### Write metrics + +- **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 + +### Storage metrics + +- **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 +- **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 +- **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 + +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` + +| 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, 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. + +All data collection follows InfluxData's privacy policy. \ No newline at end of file