diff --git a/assets/js/code-placeholders.js b/assets/js/code-placeholders.js
index 3912df97d..596364819 100644
--- a/assets/js/code-placeholders.js
+++ b/assets/js/code-placeholders.js
@@ -1,30 +1,52 @@
-const placeholderWrapper = '.code-placeholder-wrapper';
+import $ from 'jquery';
+
const placeholderElement = 'var.code-placeholder';
const editIcon = " ";
// When clicking a placeholder, append the edit input
-function handleClick(element) {
- $(element).on('click', function() {
+function handleClick($element) {
+ const $placeholder = $($element).find(placeholderElement);
+ $placeholder.on('click', function() {
var placeholderData = $(this)[0].dataset;
- var placeholderID = placeholderData.codeVar;
+ var placeholderID = placeholderData.codeVarEscaped;
var placeholderValue = placeholderData.codeVarValue;
- var placeholderInputWrapper = $('
');
- var placeholderInput = ` `;
- $(this).before(placeholderInputWrapper)
- $(this).siblings('.code-input-wrapper').append(placeholderInput);
- $(`input#${placeholderID}`).width(`${placeholderValue.length}ch`);
- $(`input#${placeholderID}`).focus().select();
- $(this).css('opacity', 0);
+ const placeholderInput = document.createElement('input');
+ placeholderInput.setAttribute('class', 'placeholder-edit');
+ placeholderInput.setAttribute('data-id', placeholderID);
+ placeholderInput.setAttribute('data-code-var-escaped', placeholderID);
+ placeholderInput.setAttribute('value', placeholderValue);
+ placeholderInput.setAttribute('spellcheck', 'false');
+
+ placeholderInput.addEventListener('blur', function() {
+ submitPlaceholder($(this));
+ }
+ );
+ placeholderInput.addEventListener('input', function() {
+ updateInputWidth($(this));
+ }
+ );
+ placeholderInput.addEventListener('keydown', function(event) {
+ closeOnEnter($(this)[0], event);
+ }
+ );
+
+ const placeholderInputWrapper = $('
');
+ $placeholder.before(placeholderInputWrapper)
+ $placeholder.siblings('.code-input-wrapper').append(placeholderInput);
+ $(`input[data-code-var-escaped="${placeholderID}"]`).width(`${placeholderValue.length}ch`);
+ document.querySelector(`input[data-code-var-escaped="${placeholderID}"]`).focus();
+ document.querySelector(`input[data-code-var-escaped="${placeholderID}"]`).select();
+ $placeholder.css('opacity', 0);
});
}
function submitPlaceholder(placeholderInput) {
- var placeholderID = placeholderInput.attr('id');
+ var placeholderID = placeholderInput.attr('data-code-var-escaped');
var placeholderValue = placeholderInput[0].value;
- var placeholderInput = $(`input.placeholder-edit#${placeholderID}`);
+ placeholderInput = $(`input.placeholder-edit[data-id="${placeholderID}"]`);
- $(`*[data-code-var='${placeholderID}']`).each(function() {
+ $(`*[data-code-var="${placeholderID}"]`).each(function() {
$(this).attr('data-code-var-value', placeholderValue);
$(this).html(placeholderValue + editIcon);
$(this).css('opacity', 1);
@@ -44,13 +66,7 @@ function closeOnEnter(input, event) {
}
}
-function CodePlaceholder({element}) {
- handleClick(element);
-}
-
-$(function() {
- const codePlaceholders = $(placeholderElement);
- codePlaceholders.each(function() {
- CodePlaceholder({element: this});
- });
-});
\ No newline at end of file
+export default function CodePlaceholder({ component }) {
+ const $component = $(component);
+ handleClick($component);
+}
\ No newline at end of file
diff --git a/assets/js/main.js b/assets/js/main.js
index c1b95d1bc..57b92a837 100644
--- a/assets/js/main.js
+++ b/assets/js/main.js
@@ -39,6 +39,7 @@ import * as v3Wayfinding from './v3-wayfinding.js';
* The JavaScript is ideally a single-purpose module that exports a single default function to initialize the component and handle any component interactions.
*/
import AskAITrigger from './ask-ai-trigger.js';
+import CodePlaceholder from './code-placeholders.js';
import { CustomTimeTrigger } from './custom-timestamps.js';
import { SearchButton } from './search-button.js';
import { SidebarToggle } from './sidebar-toggle.js';
@@ -97,6 +98,10 @@ document.addEventListener('DOMContentLoaded', function () {
AskAITrigger({ component });
window.influxdatadocs[componentName] = AskAITrigger;
break;
+ case 'code-placeholder':
+ CodePlaceholder({ component });
+ window.influxdatadocs[componentName] = CodePlaceholder;
+ break;
case 'custom-time-trigger':
CustomTimeTrigger({ component });
window.influxdatadocs[componentName] = CustomTimeTrigger;
diff --git a/content/enterprise_influxdb/v1/about-the-project/release-notes.md b/content/enterprise_influxdb/v1/about-the-project/release-notes.md
index fe2f32ba1..6edaa9e4d 100644
--- a/content/enterprise_influxdb/v1/about-the-project/release-notes.md
+++ b/content/enterprise_influxdb/v1/about-the-project/release-notes.md
@@ -9,60 +9,6 @@ menu:
parent: About the project
---
-## v1.12.0 {date="2025-04-15"}
-
-## Features
-
-- Add additional log output when using
- [`influx_inspect buildtsi`](/enterprise_influxdb/v1/tools/influx_inspect/#buildtsi) to
- rebuild the TSI index.
-- Use [`influx_inspect export`](/enterprise_influxdb/v1/tools/influx_inspect/#export) with
- [`-tsmfile` option](/enterprise_influxdb/v1/tools/influx_inspect/#--tsmfile-tsm_file-) to
- export a single TSM file.
-- Add `-m` flag to the [`influxd-ctl show-shards` command](/enterprise_influxdb/v1/tools/influxd-ctl/show-shards/)
- to output inconsistent shards.
-- Allow the specification of a write window for retention policies.
-- Add `fluxQueryRespBytes` metric to the `/debug/vars` metrics endpoint.
-- Log whenever meta gossip times exceed expiration.
-- Add [`query-log-path` configuration option](/enterprise_influxdb/v1/administration/configure/config-data-nodes/#query-log-path)
- to data nodes.
-- Add [`aggressive-points-per-block` configuration option](/influxdb/v1/administration/config/#aggressive-points-per-block)
- to prevent TSM files from not getting fully compacted.
-- Log TLS configuration settings on startup.
-- Check for TLS certificate and private key permissions.
-- Add a warning if the TLS certificate is expired.
-- Add authentication to the Raft portal and add the following related _data_
- node configuration options:
- - [`[meta].raft-portal-auth-required`](/enterprise_influxdb/v1/administration/configure/config-data-nodes/#raft-portal-auth-required)
- - [`[meta].raft-dialer-auth-required`](/enterprise_influxdb/v1/administration/configure/config-data-nodes/#raft-dialer-auth-required)
-- Improve error handling.
-- InfluxQL updates:
- - Delete series by retention policy.
- - Allow retention policies to discard writes that fall within their range, but
- outside of [`FUTURE LIMIT`](/enterprise_influxdb/v1/query_language/manage-database/#future-limit)
- and [`PAST LIMIT`](/enterprise_influxdb/v1/query_language/manage-database/#past-limit).
-
-## Bug fixes
-
-- Log rejected writes to subscriptions.
-- Update `xxhash` and avoid `stringtoslicebyte` in the cache.
-- Prevent a panic when a shard group has no shards.
-- Fix file handle leaks in `Compactor.write`.
-- Ensure fields in memory match the fields on disk.
-- Ensure temporary files are removed after failed compactions.
-- Do not panic on invalid multiple subqueries.
-- Update the `/shard-status` API to return the correct result and use a
- consistent "idleness" definition for shards.
-
-## Other
-
-- Update Go to 1.23.5.
-- Upgrade Flux to v0.196.1.
-- Upgrade InfluxQL to v1.4.1.
-- Various other dependency updates.
-
----
-
{{% note %}}
#### InfluxDB Enterprise and FIPS-compliance
@@ -75,10 +21,6 @@ InfluxDB Enterprise builds are available. For more information, see
## v1.11.8 {date="2024-11-15"}
-### Features
-
-- Add a startup logger to InfluxDB Enterprise data nodes.
-
### Bug Fixes
- Strip double quotes from measurement names in the [`/api/v2/delete` compatibility
@@ -86,8 +28,6 @@ InfluxDB Enterprise builds are available. For more information, see
string comparisons (e.g. to allow special characters in measurement names).
- Enable SHA256 for FIPS RPMs.
----
-
## v1.11.7 {date="2024-09-19"}
### Bug Fixes
@@ -641,7 +581,7 @@ in that there is no corresponding InfluxDB OSS release.
### Features
- Upgrade to Go 1.15.10.
-- Support user-defined _node labels_.
+- Support user-defined *node labels*.
Node labels let you assign arbitrary key-value pairs to meta and data nodes in a cluster.
For instance, an operator might want to label nodes with the availability zone in which they're located.
- Improve performance of `SHOW SERIES CARDINALITY` and `SHOW SERIES CARDINALITY from ` InfluxQL queries.
@@ -816,15 +756,11 @@ For details on changes incorporated from the InfluxDB OSS release, see
### Features
-#### Back up meta data only
+#### **Back up meta data only**
-- Add option to back up **meta data only** (users, roles, databases, continuous
- queries, and retention policies) using the new `-strategy` flag and `only meta`
- option: `influx ctl backup -strategy only meta `.
+- Add option to back up **meta data only** (users, roles, databases, continuous queries, and retention policies) using the new `-strategy` flag and `only meta` option: `influx ctl backup -strategy only meta `.
- > [!Note]
- > To restore a meta data backup, use the `restore -full` command and specify
- > your backup manifest: `influxd-ctl restore -full `.
+ > **Note:** To restore a meta data backup, use the `restore -full` command and specify your backup manifest: `influxd-ctl restore -full `.
For more information, see [Perform a metastore only backup](/enterprise_influxdb/v1/administration/backup-and-restore/#perform-a-metastore-only-backup).
@@ -1071,10 +1007,7 @@ The following summarizes the expected settings for proper configuration of JWT a
`""`.
- A long pass phrase is recommended for better security.
-> [!Note]
-> To provide encrypted internode communication, you must enable HTTPS. Although
-> the JWT signature is encrypted, the the payload of a JWT token is encoded, but
-> is not encrypted.
+>**Note:** To provide encrypted internode communication, you must enable HTTPS. Although the JWT signature is encrypted, the the payload of a JWT token is encoded, but is not encrypted.
### Bug fixes
@@ -1149,10 +1082,8 @@ Please see the [InfluxDB OSS release notes](/influxdb/v1/about_the_project/relea
## v1.5.0 {date="2018-03-06"}
-> [!Note]
-> This release builds off of the 1.5 release of InfluxDB OSS.
-> Please see the [InfluxDB OSS release notes](/influxdb/v1/about_the_project/release-notes/)
-> for more information about the InfluxDB OSS release.
+> ***Note:*** This release builds off of the 1.5 release of InfluxDB OSS. Please see the [InfluxDB OSS release
+> notes](/influxdb/v1/about_the_project/release-notes/) for more information about the InfluxDB OSS release.
For highlights of the InfluxDB 1.5 release, see [What's new in InfluxDB 1.5](/influxdb/v1/about_the_project/whats_new/).
diff --git a/content/enterprise_influxdb/v1/administration/configure/config-data-nodes.md b/content/enterprise_influxdb/v1/administration/configure/config-data-nodes.md
index ecddbd49c..c45d343f7 100644
--- a/content/enterprise_influxdb/v1/administration/configure/config-data-nodes.md
+++ b/content/enterprise_influxdb/v1/administration/configure/config-data-nodes.md
@@ -259,29 +259,6 @@ For detailed configuration information, see [`meta.ensure-fips`](/enterprise_inf
Environment variable: `INFLUXDB_META_ENSURE_FIPS`
-#### raft-portal-auth-required {metadata="v1.12.0+"}
-
-Default is `false`.
-
-Require Raft clients to authenticate with server using the
-[`meta-internal-shared-secret`](#meta-internal-shared-secret).
-This requires that all meta nodes are running InfluxDB Enterprise v1.12.0+ and
-are configured with the correct `meta-internal-shared-secret`.
-
-Environment variable: `INFLUXDB_META_RAFT_PORTAL_AUTH_REQUIRED`
-
-#### raft-dialer-auth-required {metadata="v1.12.0+"}
-
-Default is `false`.
-
-Require Raft servers to authenticate Raft clients using the
-[`meta-internal-shared-secret`](#meta-internal-shared-secret).
-This requires that all meta nodes are running InfluxDB Enterprise v1.12.0+, have
-`raft-portal-auth-required=true`, and are configured with the correct
-`meta-internal-shared-secret`.
-
-Environment variable: `INFLUXDB_META_RAFT_DIALER_AUTH_REQUIRED`
-
-----
## Data settings
@@ -328,8 +305,6 @@ Environment variable: `INFLUXDB_DATA_QUERY_LOG_ENABLED`
#### query-log-path
-Default is `""`.
-
An absolute path to the query log file.
The default is `""` (queries aren't logged to a file).
@@ -351,8 +326,6 @@ The following is an example of a `logrotate` configuration:
}
```
-Environment variable: `INFLUXDB_DATA_QUERY_LOG_PATH`
-
#### wal-fsync-delay
Default is `"0s"`.
@@ -449,16 +422,6 @@ The duration at which to compact all TSM and TSI files in a shard if it has not
Environment variable: `INFLUXDB_DATA_COMPACT_FULL_WRITE_COLD_DURATION`
-#### aggressive-points-per-block {metadata="v1.12.0+"}
-
-Default is `10000`.
-
-The number of points per block to use during aggressive compaction. There are
-certain cases where TSM files do not get fully compacted. This adjusts an
-internal parameter to help ensure these files do get fully compacted.
-
-Environment variable: `INFLUXDB_DATA_AGGRESSIVE_POINTS_PER_BLOCK`
-
#### index-version
Default is `"inmem"`.
diff --git a/content/enterprise_influxdb/v1/query_language/manage-database.md b/content/enterprise_influxdb/v1/query_language/manage-database.md
index f6161716b..73d5ce7fc 100644
--- a/content/enterprise_influxdb/v1/query_language/manage-database.md
+++ b/content/enterprise_influxdb/v1/query_language/manage-database.md
@@ -62,22 +62,17 @@ Creates a new database.
#### Syntax
```sql
-CREATE DATABASE [WITH [DURATION ] [REPLICATION ] [SHARD DURATION ] [PAST LIMIT ] [FUTURE LIMIT ] [NAME ]]
+CREATE DATABASE [WITH [DURATION ] [REPLICATION ] [SHARD DURATION ] [NAME ]]
```
#### Description of syntax
`CREATE DATABASE` requires a database [name](/enterprise_influxdb/v1/troubleshooting/frequently-asked-questions/#what-words-and-characters-should-i-avoid-when-writing-data-to-influxdb).
-The `WITH`, `DURATION`, `REPLICATION`, `SHARD DURATION`, `PAST LIMIT`,
-`FUTURE LIMIT, and `NAME` clauses are optional and create a single
-[retention policy](/enterprise_influxdb/v1/concepts/glossary/#retention-policy-rp)
-associated with the created database.
-If you do not specify one of the clauses after `WITH`, the relevant behavior
-defaults to the `autogen` retention policy settings.
+The `WITH`, `DURATION`, `REPLICATION`, `SHARD DURATION`, and `NAME` clauses are optional and create a single [retention policy](/enterprise_influxdb/v1/concepts/glossary/#retention-policy-rp) associated with the created database.
+If you do not specify one of the clauses after `WITH`, the relevant behavior defaults to the `autogen` retention policy settings.
The created retention policy automatically serves as the database's default retention policy.
-For more information about those clauses, see
-[Retention Policy Management](/enterprise_influxdb/v1/query_language/manage-database/#retention-policy-management).
+For more information about those clauses, see [Retention Policy Management](/enterprise_influxdb/v1/query_language/manage-database/#retention-policy-management).
A successful `CREATE DATABASE` query returns an empty result.
If you attempt to create a database that already exists, InfluxDB does nothing and does not return an error.
@@ -127,25 +122,21 @@ The `DROP SERIES` query deletes all points from a [series](/enterprise_influxdb/
and it drops the series from the index.
The query takes the following form, where you must specify either the `FROM` clause or the `WHERE` clause:
-
```sql
DROP SERIES FROM WHERE =''
```
Drop all series from a single measurement:
-
```sql
> DROP SERIES FROM "h2o_feet"
```
Drop series with a specific tag pair from a single measurement:
-
```sql
> DROP SERIES FROM "h2o_feet" WHERE "location" = 'santa_monica'
```
Drop all points in the series that have a specific tag pair from all measurements in the database:
-
```sql
> DROP SERIES WHERE "location" = 'santa_monica'
```
@@ -161,32 +152,23 @@ Unlike
You must include either the `FROM` clause, the `WHERE` clause, or both:
-```sql
+```
DELETE FROM WHERE [=''] | []
```
Delete all data associated with the measurement `h2o_feet`:
-
-```sql
+```
> DELETE FROM "h2o_feet"
```
Delete all data associated with the measurement `h2o_quality` and where the tag `randtag` equals `3`:
-
-```sql
+```
> DELETE FROM "h2o_quality" WHERE "randtag" = '3'
```
Delete all data in the database that occur before January 01, 2020:
-
-```sql
-> DELETE WHERE time < '2020-01-01'
```
-
-Delete all data associated with the measurement `h2o_feet` in retention policy `one_day`:
-
-```sql
-> DELETE FROM "one_day"."h2o_feet"
+> DELETE WHERE time < '2020-01-01'
```
A successful `DELETE` query returns an empty result.
@@ -194,16 +176,11 @@ A successful `DELETE` query returns an empty result.
Things to note about `DELETE`:
* `DELETE` supports
- [regular expressions](/enterprise_influxdb/v1/query_language/explore-data/#regular-expressions)
- in the `FROM` clause when specifying measurement names and in the `WHERE` clause
- when specifying tag values. It *does not* support regular expressions for the
- retention policy in the `FROM` clause.
- If deleting a series in a retention policy, `DELETE` requires that you define
- *only one* retention policy in the `FROM` clause.
-* `DELETE` does not support [fields](/enterprise_influxdb/v1/concepts/glossary/#field)
- in the `WHERE` clause.
-* If you need to delete points in the future, you must specify that time period
- as `DELETE SERIES` runs for `time < now()` by default.
+[regular expressions](/enterprise_influxdb/v1/query_language/explore-data/#regular-expressions)
+in the `FROM` clause when specifying measurement names and in the `WHERE` clause
+when specifying tag values.
+* `DELETE` does not support [fields](/enterprise_influxdb/v1/concepts/glossary/#field) in the `WHERE` clause.
+* If you need to delete points in the future, you must specify that time period as `DELETE SERIES` runs for `time < now()` by default. [Syntax](https://github.com/influxdata/influxdb/issues/8007)
### Delete measurements with DROP MEASUREMENT
@@ -257,9 +234,8 @@ You may disable its auto-creation in the [configuration file](/enterprise_influx
### Create retention policies with CREATE RETENTION POLICY
#### Syntax
-
-```sql
-CREATE RETENTION POLICY ON DURATION REPLICATION [SHARD DURATION ] [PAST LIMIT ] [FUTURE LIMIT ] [DEFAULT]
+```
+CREATE RETENTION POLICY ON DURATION REPLICATION [SHARD DURATION ] [DEFAULT]
```
#### Description of syntax
@@ -307,28 +283,6 @@ See
[Shard group duration management](/enterprise_influxdb/v1/concepts/schema_and_data_layout/#shard-group-duration-management)
for recommended configurations.
-##### `PAST LIMIT`
-
-The `PAST LIMIT` clause defines a time boundary before and relative to _now_
-in which points written to the retention policy are accepted. If a point has a
-timestamp before the specified boundary, the point is rejected and the write
-request returns a partial write error.
-
-For example, if a write request tries to write data to a retention policy with a
-`PAST LIMIT 6h` and there are points in the request with timestamps older than
-6 hours, those points are rejected.
-
-##### `FUTURE LIMIT`
-
-The `FUTURE LIMIT` clause defines a time boundary after and relative to _now_
-in which points written to the retention policy are accepted. If a point has a
-timestamp after the specified boundary, the point is rejected and the write
-request returns a partial write error.
-
-For example, if a write request tries to write data to a retention policy with a
-`FUTURE LIMIT 6h` and there are points in the request with future timestamps
-greater than 6 hours from now, those points are rejected.
-
##### `DEFAULT`
Sets the new retention policy as the default retention policy for the database.
diff --git a/content/enterprise_influxdb/v1/query_language/spec.md b/content/enterprise_influxdb/v1/query_language/spec.md
index 54163bc85..9951f2888 100644
--- a/content/enterprise_influxdb/v1/query_language/spec.md
+++ b/content/enterprise_influxdb/v1/query_language/spec.md
@@ -122,15 +122,15 @@ ALL ALTER ANY AS ASC BEGIN
BY CREATE CONTINUOUS DATABASE DATABASES DEFAULT
DELETE DESC DESTINATIONS DIAGNOSTICS DISTINCT DROP
DURATION END EVERY EXPLAIN FIELD FOR
-FROM FUTURE GRANT GRANTS GROUP GROUPS
-IN INF INSERT INTO KEY KEYS
-KILL LIMIT SHOW MEASUREMENT MEASUREMENTS NAME
-OFFSET ON ORDER PASSWORD PAST POLICY
-POLICIES PRIVILEGES QUERIES QUERY READ REPLICATION
-RESAMPLE RETENTION REVOKE SELECT SERIES SET
-SHARD SHARDS SLIMIT SOFFSET STATS SUBSCRIPTION
-SUBSCRIPTIONS TAG TO USER USERS VALUES
-WHERE WITH WRITE
+FROM GRANT GRANTS GROUP GROUPS IN
+INF INSERT INTO KEY KEYS KILL
+LIMIT SHOW MEASUREMENT MEASUREMENTS NAME OFFSET
+ON ORDER PASSWORD POLICY POLICIES PRIVILEGES
+QUERIES QUERY READ REPLICATION RESAMPLE RETENTION
+REVOKE SELECT SERIES SET SHARD SHARDS
+SLIMIT SOFFSET STATS SUBSCRIPTION SUBSCRIPTIONS TAG
+TO USER USERS VALUES WHERE WITH
+WRITE
```
If you use an InfluxQL keywords as an
@@ -380,14 +380,12 @@ create_database_stmt = "CREATE DATABASE" db_name
[ retention_policy_duration ]
[ retention_policy_replication ]
[ retention_policy_shard_group_duration ]
- [ retention_past_limit ]
- [ retention_future_limit ]
[ retention_policy_name ]
] .
```
-> [!Warning]
-> Replication factors do not serve a purpose with single node instances.
+{{% warn %}} Replication factors do not serve a purpose with single node instances.
+{{% /warn %}}
#### Examples
@@ -395,17 +393,11 @@ create_database_stmt = "CREATE DATABASE" db_name
-- Create a database called foo
CREATE DATABASE "foo"
--- Create a database called bar with a new DEFAULT retention policy and specify
--- the duration, replication, shard group duration, and name of that retention policy
+-- Create a database called bar with a new DEFAULT retention policy and specify the duration, replication, shard group duration, and name of that retention policy
CREATE DATABASE "bar" WITH DURATION 1d REPLICATION 1 SHARD DURATION 30m NAME "myrp"
--- Create a database called mydb with a new DEFAULT retention policy and specify
--- the name of that retention policy
+-- Create a database called mydb with a new DEFAULT retention policy and specify the name of that retention policy
CREATE DATABASE "mydb" WITH NAME "myrp"
-
--- Create a database called bar with a new retention policy named "myrp", and
--- specify the duration, past and future limits, and name of that retention policy
-CREATE DATABASE "bar" WITH DURATION 1d PAST LIMIT 6h FUTURE LIMIT 6h NAME "myrp"
```
### CREATE RETENTION POLICY
@@ -415,13 +407,11 @@ create_retention_policy_stmt = "CREATE RETENTION POLICY" policy_name on_clause
retention_policy_duration
retention_policy_replication
[ retention_policy_shard_group_duration ]
- [ retention_past_limit ]
- [ retention_future_limit ]
[ "DEFAULT" ] .
```
-> [!Warning]
-> Replication factors do not serve a purpose with single node instances.
+{{% warn %}} Replication factors do not serve a purpose with single node instances.
+{{% /warn %}}
#### Examples
@@ -434,9 +424,6 @@ CREATE RETENTION POLICY "10m.events" ON "somedb" DURATION 60m REPLICATION 2 DEFA
-- Create a retention policy and specify the shard group duration.
CREATE RETENTION POLICY "10m.events" ON "somedb" DURATION 60m REPLICATION 2 SHARD DURATION 30m
-
--- Create a retention policy and specify past and future limits.
-CREATE RETENTION POLICY "10m.events" ON "somedb" DURATION 12h PAST LIMIT 6h FUTURE LIMIT 6h
```
### CREATE SUBSCRIPTION
diff --git a/content/enterprise_influxdb/v1/tools/influx_inspect.md b/content/enterprise_influxdb/v1/tools/influx_inspect.md
index 37e68ae0a..b2589ed2c 100644
--- a/content/enterprise_influxdb/v1/tools/influx_inspect.md
+++ b/content/enterprise_influxdb/v1/tools/influx_inspect.md
@@ -10,10 +10,9 @@ menu:
Influx Inspect is an InfluxDB disk utility that can be used to:
-- View detailed information about disk shards.
-- Export data from a shard to [InfluxDB line protocol](/enterprise_influxdb/v1/concepts/glossary/#influxdb-line-protocol)
- that can be inserted back into the database.
-- Convert TSM index shards to TSI index shards.
+* View detailed information about disk shards.
+* Export data from a shard to [InfluxDB line protocol](/enterprise_influxdb/v1/concepts/glossary/#influxdb-line-protocol) that can be inserted back into the database.
+* Convert TSM index shards to TSI index shards.
## `influx_inspect` utility
@@ -39,8 +38,8 @@ The `influx_inspect` commands are summarized here, with links to detailed inform
- [`merge-schema`](#merge-schema): Merges a set of schema files from the `check-schema` command.
- [`report`](#report): Displays a shard level report.
- [`report-db`](#report-db): Estimates InfluxDB Cloud (TSM) cardinality for a database.
-- [`report-disk`](#report-disk): Reports disk usage by shards and measurements.
-- [`reporttsi`](#reporttsi): Reports on cardinality for shards and measurements.
+- [`report-disk`](#report-disk): Reports disk usage by shard and measurement.
+- [`reporttsi`](#reporttsi): Reports on cardinality for measurements and shards.
- [`verify`](#verify): Verifies the integrity of TSM files.
- [`verify-seriesfile`](#verify-seriesfile): Verifies the integrity of series files.
- [`verify-tombstone`](#verify-tombstone): Verifies the integrity of tombstones.
@@ -51,9 +50,7 @@ Builds TSI (Time Series Index) disk-based shard index files and associated serie
The index is written to a temporary location until complete and then moved to a permanent location.
If an error occurs, then this operation will fall back to the original in-memory index.
-> [!Note]
-> #### For offline conversion only
->
+> ***Note:*** **For offline conversion only.**
> When TSI is enabled, new shards use the TSI indexes.
> Existing shards continue as TSM-based shards until
> converted offline.
@@ -63,9 +60,7 @@ If an error occurs, then this operation will fall back to the original in-memory
```
influx_inspect buildtsi -datadir -waldir [ options ]
```
-
-> [!Note]
-> Use the `buildtsi` command with the user account that you are going to run the database as,
+> **Note:** Use the `buildtsi` command with the user account that you are going to run the database as,
> or ensure that the permissions match after running the command.
#### Options
@@ -76,8 +71,9 @@ Optional arguments are in brackets.
The size of the batches written to the index. Default value is `10000`.
-> [!Warning]
-> Setting this value can have adverse effects on performance and heap size.
+{{% warn %}}
+**Warning:** Setting this value can have adverse effects on performance and heap size.
+{{% /warn %}}
##### `[ -compact-series-file ]`
@@ -94,11 +90,10 @@ The name of the database.
##### `-datadir `
-The path to the [`data` directory](/enterprise_influxdb/v1/concepts/file-system-layout/#data-directory).
+The path to the `data` directory.
Default value is `$HOME/.influxdb/data`.
-See the [file system layout](/enterprise_influxdb/v1/concepts/file-system-layout/#file-system-layout)
-for InfluxDB on your system.
+See the [file system layout](/enterprise_influxdb/v1/concepts/file-system-layout/) for InfluxDB on your system.
##### `[ -max-cache-size ]`
@@ -125,32 +120,31 @@ Flag to enable output in verbose mode.
##### `-waldir `
-The directory for the [WAL (Write Ahead Log)](/enterprise_influxdb/v1/concepts/file-system-layout/#wal-directory) files.
+The directory for the WAL (Write Ahead Log) files.
Default value is `$HOME/.influxdb/wal`.
-See the [file system layout](/enterprise_influxdb/v1/concepts/file-system-layout/#file-system-layout)
-for InfluxDB on your system.
+See the [file system layout](/enterprise_influxdb/v1/concepts/file-system-layout/) for InfluxDB on your system.
#### Examples
##### Converting all shards on a node
```
-influx_inspect buildtsi -datadir ~/.influxdb/data -waldir ~/.influxdb/wal
+$ influx_inspect buildtsi -datadir /var/lib/influxdb/data -waldir /var/lib/influxdb/wal
```
##### Converting all shards for a database
```
-influx_inspect buildtsi -database mydb -datadir ~/.influxdb/data -waldir ~/.influxdb/wal
+$ influx_inspect buildtsi -database mydb datadir /var/lib/influxdb/data -waldir /var/lib/influxdb/wal
```
##### Converting a specific shard
```
-influx_inspect buildtsi -database stress -shard 1 -datadir ~/.influxdb/data -waldir ~/.influxdb/wal
+$ influx_inspect buildtsi -database stress -shard 1 datadir /var/lib/influxdb/data -waldir /var/lib/influxdb/wal
```
### `check-schema`
@@ -167,7 +161,7 @@ influx_inspect check-schema [ options ]
##### [ `-conflicts-file ` ]
-The filename where conflicts data should be written. Default is `conflicts.json`.
+Filename conflicts data should be written to. Default is `conflicts.json`.
##### [ `-path ` ]
@@ -176,16 +170,17 @@ working directory `.`.
##### [ `-schema-file ` ]
-The filename where schema data should be written. Default is `schema.json`.
+Filename schema data should be written to. Default is `schema.json`.
### `deletetsm`
Use `deletetsm -measurement` to delete a measurement in a raw TSM file (from specified shards).
Use `deletetsm -sanitize` to remove all tag and field keys containing non-printable Unicode characters in a raw TSM file (from specified shards).
-> [!Warning]
-> Use the `deletetsm` command only when your InfluxDB instance is
-> offline (`influxd` service is not running).
+{{% warn %}}
+**Warning:** Use the `deletetsm` command only when your InfluxDB instance is
+offline (`influxd` service is not running).
+{{% /warn %}}
#### Syntax
@@ -249,7 +244,7 @@ Optional arguments are in brackets.
##### `-series-file `
-The path to the `_series` directory under the database `data` directory. Required.
+Path to the `_series` directory under the database `data` directory. Required.
##### [ `-series` ]
@@ -288,18 +283,18 @@ Filter data by tag value regular expression.
##### Specifying paths to the `_series` and `index` directories
```
-influx_inspect dumptsi -series-file /path/to/db/_series /path/to/index
+$ influx_inspect dumptsi -series-file /path/to/db/_series /path/to/index
```
##### Specifying paths to the `_series` directory and an `index` file
```
-influx_inspect dumptsi -series-file /path/to/db/_series /path/to/index/file0
+$ influx_inspect dumptsi -series-file /path/to/db/_series /path/to/index/file0
```
##### Specifying paths to the `_series` directory and multiple `index` files
```
-influx_inspect dumptsi -series-file /path/to/db/_series /path/to/index/file0 /path/to/index/file1 ...
+$ influx_inspect dumptsi -series-file /path/to/db/_series /path/to/index/file0 /path/to/index/file1 ...
```
### `dumptsm`
@@ -314,7 +309,7 @@ influx_inspect dumptsm [ options ]
##### ``
-The path to the `.tsm` file, located by default in the `data` directory.
+Path to the `.tsm` file, located by default in the `data` directory.
#### Options
@@ -322,17 +317,17 @@ Optional arguments are in brackets.
##### [ `-index` ]
-The flag to dump raw index data.
+Flag to dump raw index data.
Default value is `false`.
##### [ `-blocks` ]
-The flag to dump raw block data.
+Flag to dump raw block data.
Default value is `false`.
##### [ `-all` ]
-The flag to dump all data. Caution: This may print a lot of information.
+Flag to dump all data. Caution: This may print a lot of information.
Default value is `false`.
##### [ `-filter-key ` ]
@@ -356,14 +351,14 @@ Optional arguments are in brackets.
##### [ `-show-duplicates` ]
-The flag to show keys which have duplicate or out-of-order timestamps.
+Flag to show keys which have duplicate or out-of-order timestamps.
If a user writes points with timestamps set by the client, then multiple points with the same timestamp (or with time-descending timestamps) can be written.
### `export`
-Exports all TSM files or a single TSM file in InfluxDB line protocol data format.
-The output file can be imported using the
-[influx](http://localhost:1313/enterprise_influxdb/v1/tools/influx-cli/use-influx-cli) command.
+Exports all TSM files in InfluxDB line protocol data format.
+This output file can be imported using the
+[influx](/enterprise_influxdb/v1/tools/influx-cli/use-influx/#import-data-from-a-file-with-import) command.
#### Syntax
@@ -387,11 +382,10 @@ Default value is `""`.
##### `-datadir `
-The path to the [`data` directory](/enterprise_influxdb/v1/concepts/file-system-layout/#data-directory).
+The path to the `data` directory.
Default value is `$HOME/.influxdb/data`.
-See the [file system layout](/enterprise_influxdb/v1/concepts/file-system-layout/#file-system-layout)
-for InfluxDB on your system.
+See the [file system layout](/enterprise_influxdb/v1/concepts/file-system-layout/) for InfluxDB on your system.
##### [ `-end ` ]
@@ -414,20 +408,15 @@ YYYY-MM-DDTHH:MM:SS-08:00
YYYY-MM-DDTHH:MM:SS+07:00
```
-> [!Note]
-> With offsets, avoid replacing the + or - sign with a Z. It may cause an error
-> or print Z (ISO 8601 behavior) instead of the time zone offset.
+> **Note:** With offsets, avoid replacing the + or - sign with a Z. It may cause an error or print Z (ISO 8601 behavior) instead of the time zone offset.
##### [ `-lponly` ]
-
Output data in line protocol format only.
-Does not output data definition language (DDL) statements (such as `CREATE DATABASE`)
-or DML context metadata (such as `# CONTEXT-DATABASE`).
+Does not output data definition language (DDL) statements (such as `CREATE DATABASE`) or DML context metadata (such as `# CONTEXT-DATABASE`).
-##### [ `-out ` or `-out -`]
-
-Location to export shard data. Specify an export directory to export a file, or add a hyphen after out (`-out -`) to export shard data to standard out (`stdout`) and send status messages to standard error (`stderr`).
+##### [ `-out ` ]
+The location for the export file.
Default value is `$HOME/.influxdb/export`.
##### [ `-retention ` ]
@@ -444,13 +433,7 @@ The timestamp string must be in [RFC3339 format](https://tools.ietf.org/html/rfc
Path to the [WAL](/enterprise_influxdb/v1/concepts/glossary/#wal-write-ahead-log) directory.
Default value is `$HOME/.influxdb/wal`.
-See the [file system layout](/enterprise_influxdb/v1/concepts/file-system-layout/#file-system-layout)
-for InfluxDB on your system.
-
-##### [ `-tsmfile ` ]
-
-Path to a single tsm file to export. This requires both `-database` and
-`-retention` to be specified.
+See the [file system layout](/enterprise_influxdb/v1/concepts/file-system-layout/) for InfluxDB on your system.
#### Examples
@@ -466,15 +449,6 @@ influx_inspect export -compress
influx_inspect export -database DATABASE_NAME -retention RETENTION_POLICY
```
-##### Export data from a single TSM file
-
-```bash
-influx_inspect export \
- -database DATABASE_NAME \
- -retention RETENTION_POLICY \
- -tsmfile TSM_FILE_NAME
-```
-
##### Output file
```bash
@@ -548,7 +522,7 @@ Note: This can use a lot of memory.
Use the `report-db` command to estimate the series cardinality of data in a
database when migrated to InfluxDB Cloud (TSM). InfluxDB Cloud (TSM) includes
-fields keys in the series key so unique field keys affect the total cardinality.
+field keys in the series key so unique field keys affect the total cardinality.
The total series cardinality of data in a InfluxDB 1.x database may differ from
from the series cardinality of that same data when migrated to InfluxDB Cloud (TSM).
@@ -588,87 +562,33 @@ Specify the cardinality "rollup" level--the granularity of the cardinality repor
### `report-disk`
-Use the `report-disk` command to review disk usage by shards and measurements for TSM files in a specified directory. Useful for determining disk usage for capacity planning and identifying which measurements or shards are using the most space.
+Use the `report-disk` command to review TSM file disk usage per shard and measurement in a specified directory. Useful for capacity planning and identifying which measurement or shard is using the most disk space. The default directory path `~/.influxdb/data/`.
-Calculates the total disk size (`total_tsm_size`) in bytes, the number of shards (`shards`), and the number of tsm files (`tsm_files`) for the specified directory. Also calculates the disk size (`size`) and number of tsm files (`tsm_files`) for each shard. Use the `-detailed` flag to report disk usage (`size`) by database (`db`), retention policy (`rp`), and measurement (`measurement`).
+Calculates the total disk size by database (`db`), retention policy (`rp`), shard (`shard`), tsm file (`tsm_file`), and measurement (`measurement`).
#### Syntax
```
-influx_inspect report-disk [ options ]
+influx_inspect report-disk [ options ]
```
-##### ``
-
-Path to the directory with `.tsm` file(s) to report disk usage for. Default location is `$HOME/.influxdb/data`.
-
-When specifying the path, wildcards (`*`) can replace one or more characters.
-
#### Options
Optional arguments are in brackets.
##### [ `-detailed` ]
-Include this flag to report disk usage by measurement.
-
-#### Examples
-
-##### Report on disk size by shard
-
-```bash
-influx_inspect report-disk ~/.influxdb/data/
-```
-
-##### Output
-
-```bash
-{
- "Summary": {"shards": 2, "tsm_files": 8, "total_tsm_size": 149834637 },
- "Shard": [
- {"db": "stress", "rp": "autogen", "shard": "3", "tsm_files": 7, "size": 147022321},
- {"db": "telegraf", "rp": "autogen", "shard": "2", "tsm_files": 1, "size": 2812316}
- ]
-}
-```
-
-##### Report on disk size by measurement
-
-```bash
-influx_inspect report-disk -detailed ~/.influxdb/data/
-```
-
-##### Output
-
-```bash
-{
- "Summary": {"shards": 2, "tsm_files": 8, "total_tsm_size": 149834637 },
- "Shard": [
- {"db": "stress", "rp": "autogen", "shard": "3", "tsm_files": 7, "size": 147022321},
- {"db": "telegraf", "rp": "autogen", "shard": "2", "tsm_files": 1, "size": 2812316}
- ],
- "Measurement": [
- {"db": "stress", "rp": "autogen", "measurement": "ctr", "size": 107900000},
- {"db": "telegraf", "rp": "autogen", "measurement": "cpu", "size": 1784211},
- {"db": "telegraf", "rp": "autogen", "measurement": "disk", "size": 374121},
- {"db": "telegraf", "rp": "autogen", "measurement": "diskio", "size": 254453},
- {"db": "telegraf", "rp": "autogen", "measurement": "mem", "size": 171120},
- {"db": "telegraf", "rp": "autogen", "measurement": "processes", "size": 59691},
- {"db": "telegraf", "rp": "autogen", "measurement": "swap", "size": 42310},
- {"db": "telegraf", "rp": "autogen", "measurement": "system", "size": 59561}
- ]
-}
-```
+Report disk usage by measurement.
### `reporttsi`
The report does the following:
-- Calculates the total exact series cardinality in the database.
-- Segments that cardinality by measurement, and emits those cardinality values.
-- Emits total exact cardinality for each shard in the database.
-- Segments for each shard the exact cardinality for each measurement in the shard.
-- Optionally limits the results in each shard to the "top n".
+* Calculates the total exact series cardinality in the database.
+* Segments that cardinality by measurement, and emits those cardinality values.
+* Emits total exact cardinality for each shard in the database.
+* Segments for each shard the exact cardinality for each measurement in the shard.
+* Optionally limits the results in each shard to the "top n".
The `reporttsi` command is primarily useful when there has been a change in cardinality
and it's not clear which measurement is responsible for this change, and further, _when_
@@ -783,8 +703,7 @@ Enables very verbose logging. Displays progress for every series key and time ra
Enables very very verbose logging. Displays progress for every series key and time range in the tombstone files. Timestamps are displayed in [RFC3339 format](https://tools.ietf.org/html/rfc3339) with nanosecond precision.
-> [!Note]
-> Higher verbosity levels override lower levels.
+> **Note on verbose logging:** Higher verbosity levels override lower levels.
## Caveats
diff --git a/content/enterprise_influxdb/v1/tools/influxd-ctl/show-shards.md b/content/enterprise_influxdb/v1/tools/influxd-ctl/show-shards.md
index b5bed0bb0..789077420 100644
--- a/content/enterprise_influxdb/v1/tools/influxd-ctl/show-shards.md
+++ b/content/enterprise_influxdb/v1/tools/influxd-ctl/show-shards.md
@@ -44,16 +44,14 @@ ID Database Retention Policy Desired Replicas Shard Group Start
{{% /expand %}}
{{< /expand-wrapper >}}
-You can also use the `-m` flag to output "inconsistent" shards which are shards
-that are either in metadata but not on disk or on disk but not in metadata.
-
## Flags
| Flag | Description |
| :--- | :-------------------------------- |
| `-v` | Return detailed shard information |
-| `-m` | Return inconsistent shards |
{{% caption %}}
_Also see [`influxd-ctl` global flags](/enterprise_influxdb/v1/tools/influxd-ctl/#influxd-ctl-global-flags)._
{{% /caption %}}
+
+## Examples
diff --git a/content/influxdb/v1/about_the_project/release-notes.md b/content/influxdb/v1/about_the_project/release-notes.md
index 1b5949666..aa82116c8 100644
--- a/content/influxdb/v1/about_the_project/release-notes.md
+++ b/content/influxdb/v1/about_the_project/release-notes.md
@@ -12,45 +12,6 @@ alt_links:
v2: /influxdb/v2/reference/release-notes/influxdb/
---
-## v1.12.0 {date="2025-04-15"}
-
-## Features
-
-- Add additional log output when using
- [`influx_inspect buildtsi`](/influxdb/v1/tools/influx_inspect/#buildtsi) to
- rebuild the TSI index.
-- Use [`influx_inspect export`](/influxdb/v1/tools/influx_inspect/#export) with
- [`-tsmfile` option](/influxdb/v1/tools/influx_inspect/#--tsmfile-tsm_file-) to
- export a single TSM file.
-- Add `fluxQueryRespBytes` metric to the `/debug/vars` metrics endpoint.
-- Add [`aggressive-points-per-block` configuration option](/influxdb/v1/administration/config/#aggressive-points-per-block)
- to prevent TSM files from not getting fully compacted.
-- Improve error handling.
-- InfluxQL updates:
- - Delete series by retention policy.
- - Allow retention policies to discard writes that fall within their range, but
- outside of [`FUTURE LIMIT`](/influxdb/v1/query_language/manage-database/#future-limit)
- and [`PAST LIMIT`](/influxdb/v1/query_language/manage-database/#past-limit).
-
-## Bug fixes
-
-- Log rejected writes to subscriptions.
-- Update `xxhash` and avoid `stringtoslicebyte` in the cache.
-- Prevent a panic when a shard group has no shards.
-- Fix file handle leaks in `Compactor.write`.
-- Ensure fields in memory match the fields on disk.
-- Ensure temporary files are removed after failed compactions.
-- Do not panic on invalid multiple subqueries.
-
-## Other
-
-- Update Go to 1.23.5.
-- Upgrade Flux to v0.196.1.
-- Upgrade InfluxQL to v1.4.1.
-- Various other dependency updates.
-
----
-
## v1.11.8 {date="2024-11-15"}
### Bug Fixes
@@ -59,8 +20,6 @@ alt_links:
compatibility API](/influxdb/v1/tools/api/#apiv2delete-http-endpoint) before
string comparisons (e.g. to allow special characters in measurement names).
----
-
## v1.11.7 {date="2024-10-10"}
This release represents the first public release of InfluxDB OSS v1 since 2021
@@ -113,17 +72,17 @@ All official build packages are for 64-bit architectures.
and [`influx_inspect merge-schema`](/influxdb/v1/tools/influx_inspect/#merge-schema)
commands to check for type conflicts between shards.
- **New configuration options:**
- - Add [`total-buffer-bytes`](/influxdb/v1/administration/config/#total-buffer-bytes)
+ - Add [`total-buffer-bytes`](/influxdb/v1/administration/config/#total-buffer-bytes--0)
configuration option to set the total number of bytes to allocate to
subscription buffers.
- - Add [`termination-query-log`](/influxdb/v1/administration/config/#termination-query-log)
+ - Add [`termination-query-log`](/influxdb/v1/administration/config/#termination-query-log--false)
configuration option to enable dumping running queries to log on `SIGTERM`.
- - Add [`max-concurrent-deletes`](/influxdb/v1/administration/config/#max-concurrent-deletes)
+ - Add [`max-concurrent-deletes`](/influxdb/v1/administration/config/#max-concurrent-deletes--1)
configuration option to set delete concurrency.
- Add [Flux query configuration settings](/influxdb/v1/administration/config/#flux-query-management-settings).
- - Add [`compact-series-file`](/influxdb/v1/administration/config/#compact-series-file)
+ - Add [`compact-series-file`](/influxdb/v1/administration/config/#compact-series-file--false)
configuration option to enable or disable series file compaction on startup.
- - Add [`prom-read-auth-enabled` configuration option](/influxdb/v1/administration/config/#prom-read-auth-enabled)
+ - Add [`prom-read-auth-enabled` configuration option](/influxdb/v1/administration/config/#prom-read-auth-enabled--false)
to authenticate Prometheus remote read.
- **Flux improvements:**
- Upgrade Flux to v0.194.5.
@@ -284,7 +243,7 @@ This release is for InfluxDB Enterprise 1.8.6 customers only. No OSS-specific ch
### Bug fixes
-- Update meta queries (for example, SHOW TAG VALUES, SHOW TAG KEYS, SHOW SERIES CARDINALITY, SHOW MEASUREMENT CARDINALITY, and SHOW MEASUREMENTS) to check the query context when possible to respect timeout values set in the [`query-timeout` configuration parameter](/influxdb/v1/administration/config/#query-timeout). Note, meta queries will check the context less frequently than regular queries, which use iterators, because meta queries return data in batches.
+- Update meta queries (for example, SHOW TAG VALUES, SHOW TAG KEYS, SHOW SERIES CARDINALITY, SHOW MEASUREMENT CARDINALITY, and SHOW MEASUREMENTS) to check the query context when possible to respect timeout values set in the [`query-timeout` configuration parameter](/influxdb/v1/administration/config/#query-timeout--0s). Note, meta queries will check the context less frequently than regular queries, which use iterators, because meta queries return data in batches.
- Previously, successful writes were incorrectly incrementing the `WriteErr` statistics. Now, successful writes correctly increment the `writeOK` statistics.
- Correct JSON marshalling error format.
- Previously, a GROUP BY query with an offset that caused an interval to cross a daylight savings change inserted an extra output row off by one hour. Now, the correct GROUP BY interval start time is set before the time zone offset is calculated.
@@ -367,19 +326,19 @@ features, performance improvements, and bug fixes below.
This release updates support for the Flux language and queries. To learn about Flux design principles and see how to get started with Flux, see [Introduction to Flux](/influxdb/v1/flux/).
-- Use the new [`influx -type=flux`](/influxdb/v1/tools/influx-cli/#flags) option to enable the Flux REPL shell for creating Flux queries.
+* Use the new [`influx -type=flux`](/influxdb/v1/tools/influx-cli/#flags) option to enable the Flux REPL shell for creating Flux queries.
-- Flux v0.65 includes the following capabilities:
- - Join data residing in multiple measurements, buckets, or data sources
- - Perform mathematical operations using data gathered across measurements/buckets
- - Manipulate Strings through an extensive library of string related functions
- - Shape data through `pivot()` and other functions
- - Group based on any data column: tags, fields, etc.
- - Window and aggregate based on calendar months, years
- - Join data across Influx and non-Influx sources
- - Cast booleans to integers
- - Query geo-temporal data (experimental)
- - Many additional functions for working with data
+* Flux v0.65 includes the following capabilities:
+ - Join data residing in multiple measurements, buckets, or data sources
+ - Perform mathematical operations using data gathered across measurements/buckets
+ - Manipulate Strings through an extensive library of string related functions
+ - Shape data through `pivot()` and other functions
+ - Group based on any data column: tags, fields, etc.
+ - Window and aggregate based on calendar months, years
+ - Join data across Influx and non-Influx sources
+ - Cast booleans to integers
+ - Query geo-temporal data (experimental)
+ - Many additional functions for working with data
> We're evaluating the need for Flux query management controls equivalent to existing InfluxQL [query management controls](/influxdb/v1/troubleshooting/query_management/#configuration-settings-for-query-management) based on your feedback. Please join the discussion on [InfluxCommunity](https://community.influxdata.com/), [Slack](https://influxcommunity.slack.com/), or [GitHub](https://github.com/influxdata/flux). InfluxDB Enterprise customers, please contact .
@@ -605,7 +564,7 @@ Chunked query was added into the Go client v2 interface. If you compiled against
Support for the Flux language and queries has been added in this release. To begin exploring Flux 0.7 (technical preview):
-* Enable Flux using the new configuration setting [`[http] flux-enabled = true`](/influxdb/v1/administration/config/#flux-enabled).
+* Enable Flux using the new configuration setting [`[http] flux-enabled = true`](/influxdb/v1/administration/config/#flux-enabled-false).
* Use the new [`influx -type=flux`](/influxdb/v1/tools/shell/#type) option to enable the Flux REPL shell for creating Flux queries.
* Read about Flux and the Flux language, enabling Flux, or jump into the getting started and other guides.
@@ -1142,7 +1101,7 @@ With TSI, the number of series should be unbounded by the memory on the server h
See Paul Dix's blogpost [Path to 1 Billion Time Series: InfluxDB High Cardinality Indexing Ready for Testing](https://www.influxdata.com/path-1-billion-time-series-influxdb-high-cardinality-indexing-ready-testing/) for additional information.
TSI is disabled by default in version 1.3.
-To enable TSI, uncomment the [`index-version` setting](/influxdb/v1/administration/config#index-version) and set it to `tsi1`.
+To enable TSI, uncomment the [`index-version` setting](/influxdb/v1/administration/config#index-version-inmem) and set it to `tsi1`.
The `index-version` setting is in the `[data]` section of the configuration file.
Next, restart your InfluxDB instance.
@@ -1291,14 +1250,14 @@ The following new configuration options are available.
#### `[http]` Section
-* [`max-row-limit`](/influxdb/v1/administration/config#max-row-limit) now defaults to `0`.
+* [`max-row-limit`](/influxdb/v1/administration/config#max-row-limit-0) now defaults to `0`.
In versions 1.0 and 1.1, the default setting was `10000`, but due to a bug, the value in use in versions 1.0 and 1.1 was effectively `0`.
In versions 1.2.0 through 1.2.1, we fixed that bug, but the fix caused a breaking change for Grafana and Kapacitor users; users who had not set `max-row-limit` to `0` experienced truncated/partial data due to the `10000` row limit.
In version 1.2.2, we've changed the default `max-row-limit` setting to `0` to match the behavior in versions 1.0 and 1.1.
### Bug fixes
-- Change the default [`max-row-limit`](/influxdb/v1/administration/config#max-row-limit) setting from `10000` to `0` to prevent the absence of data in Grafana or Kapacitor.
+- Change the default [`max-row-limit`](/influxdb/v1/administration/config#max-row-limit-0) setting from `10000` to `0` to prevent the absence of data in Grafana or Kapacitor.
## v1.2.1 {date="2017-03-08"}
diff --git a/content/influxdb/v1/administration/backup_and_restore.md b/content/influxdb/v1/administration/backup_and_restore.md
index 6a8823b63..f24694bb5 100644
--- a/content/influxdb/v1/administration/backup_and_restore.md
+++ b/content/influxdb/v1/administration/backup_and_restore.md
@@ -666,7 +666,7 @@ from(bucket: "example-tmp-db/autogen")
For more information, see
[How does InfluxDB handle duplicate points?](/influxdb/v1/troubleshooting/frequently-asked-questions/#how-does-influxdb-handle-duplicate-points)
-3. Use InfluxQL to delete the temporary database.
+3. Use InfluxQL to delete the temporary database.
```sql
DROP DATABASE "example-tmp-db"
@@ -683,7 +683,7 @@ are `127.0.0.1:8088`.
**To customize the TCP IP and port the backup and restore services use**,
uncomment and update the
-[`bind-address` configuration setting](/influxdb/v1/administration/config#bind-address)
+[`bind-address` configuration setting](/influxdb/v1/administration/config#bind-address-127-0-0-1-8088)
at the root level of your InfluxDB configuration file (`influxdb.conf`).
```toml
diff --git a/content/influxdb/v1/administration/config.md b/content/influxdb/v1/administration/config.md
index 22ebdb3e0..5b0bef2a3 100644
--- a/content/influxdb/v1/administration/config.md
+++ b/content/influxdb/v1/administration/config.md
@@ -15,28 +15,28 @@ The InfluxDB open source (OSS) configuration file contains configuration setting
#### Content
-- [Configuration overview](#configuration-overview)
-- [Environment variables](#environment-variables)
- - [InfluxDB environment variables (`INFLUXDB_*`)](#influxdb-environment-variables-influxdb)
- - [`GOMAXPROCS` environment variable](#gomaxprocs-environment-variable)
-- [Using the configuration file](#using-the-configuration-file)
-- [Configuration settings](#configuration-settings)
- - [Global settings](#global-settings)
- - [Metastore `[meta]`](#metastore-settings)
- - [Data `[data]`](#data-settings)
- - [Query management `[coordinator]`](#query-management-settings)
- - [Flux query management `[flux-controller]`](#flux-query-management-settings)
- - [Retention policies `[retention]`](#retention-policy-settings)
- - [Shard precreation `[shard-precreation]`](#shard-precreation-settings)
- - [Monitoring `[monitor]`](#monitoring-settings)
- - [HTTP endpoints `[http]`](#http-endpoints-settings)
- - [Subscriptions `[subscriber]`](#subscription-settings)
- - [Graphite `[[graphite]]`](#graphite-settings)
- - [CollectD `[[collectd]]`](#collectd-settings)
- - [OpenTSB `[[opentsdb]]`](#opentsdb-settings)
- - [UDP `[[udp]]`](#udp-settings)
- - [Continuous queries `[continuous_queries]`](#continuous-queries-settings)
- - [TLS `[tls]`](#transport-layer-security-tls-settings)
+* [Configuration overview](#configuration-overview)
+* [Environment variables](#environment-variables)
+ * [InfluxDB environment variables (`INFLUXDB_*`)](#influxdb-environment-variables-influxdb)
+ * [`GOMAXPROCS` environment variable](#gomaxprocs-environment-variable)
+* [Using the configuration file](#using-the-configuration-file)
+* [Configuration settings](#configuration-settings)
+ * [Global settings](#global-settings)
+ * [Metastore `[meta]`](#metastore-settings)
+ * [Data `[data]`](#data-settings)
+ * [Query management `[coordinator]`](#query-management-settings)
+ * [Flux query management `[flux-controller]`](#flux-query-management-settings)
+ * [Retention policies `[retention]`](#retention-policy-settings)
+ * [Shard precreation `[shard-precreation]`](#shard-precreation-settings)
+ * [Monitoring `[monitor]`](#monitoring-settings)
+ * [HTTP endpoints `[http]`](#http-endpoints-settings)
+ * [Subscriptions `[subscriber]`](#subscription-settings)
+ * [Graphite `[[graphite]]`](#graphite-settings)
+ * [CollectD `[[collectd]]`](#collectd-settings)
+ * [OpenTSB `[[opentsdb]]`](#opentsdb-settings)
+ * [UDP `[[udp]]`](#udp-settings)
+ * [Continuous queries `[continuous_queries]`](#continuous-queries-settings)
+ * [TLS `[tls]`](#transport-layer-security-tls-settings)
## Configuration overview
@@ -55,54 +55,40 @@ Configuration settings that specify a duration support the following duration un
- `d` _(days)_
- `w` _(weeks)_
-> [!Note]
-> Configuration file settings are documented here for the latest official release.
-> The [sample configuration file on GitHub](https://github.com/influxdb/influxdb/blob/1.8/etc/config.sample.toml)
-> might be slightly newer.
+>**Note:** Configuration file settings are documented here for the latest official release - the [sample configuration file on GitHub](https://github.com/influxdb/influxdb/blob/1.8/etc/config.sample.toml) might be slightly newer.
## Environment variables
-All of the configuration settings in the configuration file can be specified
-either in the configuration file or in an environment variable.
+All of the configuration settings in the configuration file can be specified either in the configuration file or in an environment variable.
The environment variable overrides the equivalent option in the configuration
-file. If a configuration option is not specified in either the configuration
-file or in an environment variable, InfluxDB uses its internal default configuration.
+file.
+If a configuration option is not specified in either the configuration file or in an environment variable, InfluxDB uses its internal default configuration.
-> [!Note]
-> If an environment variable has already been set, the equivalent configuration
-> setting in the configuration file is ignored.
+> ***Note:*** If an environment variable has already been set, the equivalent configuration setting in the configuration file is ignored.
### InfluxDB environment variables (`INFLUXDB_*`)
-The InfluxDB environment variables are documented below with the corresponding
-configuration file settings. All of the InfluxDB-specific environment variables
-are prefixed with `INFLUXDB_`.
+The InfluxDB environment variables are documented below with the corresponding configuration file settings. All of the InfluxDB-specific environment variables are prefixed with `INFLUXDB_`.
+
### `GOMAXPROCS` environment variable
-> [!Note]
-> The GOMAXPROCS environment variable cannot be set using the InfluxDB
-> configuration file settings, like other environment variables.
+> ***Note:*** The GOMAXPROCS environment variable cannot be set using the InfluxDB configuration file settings, like other environment variables.
-The `GOMAXPROCS` [Go language environment variable](https://golang.org/pkg/runtime/#hdr-Environment_Variables)
-can be used to set the maximum number of CPUs that can execute simultaneously.
-The default value of `GOMAXPROCS` is the number of CPUs (whatever your operating
-system considers to be a CPU) that are visible to the program _on startup_.
-For a 32-core machine, the `GOMAXPROCS` value would be `32`.
-You can override this value to be less than the maximum value, which can be
-useful in cases where you are running the InfluxDB along with other processes on
-the same machine and want to ensure that the database doesn't completely starve
-those processes.
+The `GOMAXPROCS` [Go language environment variable](https://golang.org/pkg/runtime/#hdr-Environment_Variables) can be used to set the maximum number of CPUs that can execute simultaneously.
-> [!Note]
+
+The default value of `GOMAXPROCS` is the number of CPUs (whatever your operating system considers to be a CPU) that are visible to the program *on startup.* For a 32-core machine, the `GOMAXPROCS` value would be `32`.
+You can override this value to be less than the maximum value, which can be useful in cases where you are running the InfluxDB along with other processes on the same machine and want to ensure that the database doesn't completely starve those processes.
+
+> ***Note:***
> Setting `GOMAXPROCS=1` will eliminate all parallelization.
+
## Using the configuration file
-The InfluxDB system has internal defaults for all of the settings in the
-configuration file. To view the default configuration settings, use the
-`influxd config` command.
+The InfluxDB system has internal defaults for all of the settings in the configuration file. To view the default configuration settings, use the `influxd config` command.
The local InfluxDB configuration file is located here:
@@ -110,30 +96,27 @@ The local InfluxDB configuration file is located here:
- **macOS**: `/usr/local/etc/influxdb.conf`
- **Windows**: _Same directory as `influxd.exe`_
-Settings that are commented out are set to the internal system defaults.
-Uncommented settings override the internal defaults.
-Note that the local configuration file does not need to include every
-configuration setting.
+Settings that are commented out are set to the internal system defaults. Uncommented settings override the internal defaults.
+Note that the local configuration file does not need to include every configuration setting.
There are two ways to launch InfluxDB with your configuration file:
-- Point the process to the configuration file by using the `-config`
+* Point the process to the configuration file by using the `-config`
option. For example:
- ```bash
- influxd -config /etc/influxdb/influxdb.conf
- ```
-
-- Set the environment variable `INFLUXDB_CONFIG_PATH` to the path of your
+ ```bash
+ influxd -config /etc/influxdb/influxdb.conf
+ ```
+* Set the environment variable `INFLUXDB_CONFIG_PATH` to the path of your
configuration file and start the process.
For example:
- ```bash
- echo $INFLUXDB_CONFIG_PATH
- /etc/influxdb/influxdb.conf
+ ```
+ echo $INFLUXDB_CONFIG_PATH
+ /etc/influxdb/influxdb.conf
- influxd
- ```
+ influxd
+ ```
InfluxDB first checks for the `-config` option and then for the environment
variable.
@@ -141,7 +124,7 @@ variable.
## Configuration settings
-> [!Note]
+> **Note:**
> To set or override settings in a config section that allows multiple
> configurations (any section with `[[double_brackets]]` in the header supports
> multiple configurations), the desired configuration must be specified by ordinal
@@ -150,791 +133,657 @@ variable.
> prefix the configuration setting name in the environment variable with the
> relevant position number (in this case: `0`):
>
-> ```txt
-> INFLUXDB_GRAPHITE_0_BATCH_PENDING
-> INFLUXDB_GRAPHITE_0_BATCH_SIZE
-> INFLUXDB_GRAPHITE_0_BATCH_TIMEOUT
-> INFLUXDB_GRAPHITE_0_BIND_ADDRESS
-> INFLUXDB_GRAPHITE_0_CONSISTENCY_LEVEL
-> INFLUXDB_GRAPHITE_0_DATABASE
-> INFLUXDB_GRAPHITE_0_ENABLED
-> INFLUXDB_GRAPHITE_0_PROTOCOL
-> INFLUXDB_GRAPHITE_0_RETENTION_POLICY
-> INFLUXDB_GRAPHITE_0_SEPARATOR
-> INFLUXDB_GRAPHITE_0_TAGS
-> INFLUXDB_GRAPHITE_0_TEMPLATES
-> INFLUXDB_GRAPHITE_0_UDP_READ_BUFFER
-> ```
+ INFLUXDB_GRAPHITE_0_BATCH_PENDING
+ INFLUXDB_GRAPHITE_0_BATCH_SIZE
+ INFLUXDB_GRAPHITE_0_BATCH_TIMEOUT
+ INFLUXDB_GRAPHITE_0_BIND_ADDRESS
+ INFLUXDB_GRAPHITE_0_CONSISTENCY_LEVEL
+ INFLUXDB_GRAPHITE_0_DATABASE
+ INFLUXDB_GRAPHITE_0_ENABLED
+ INFLUXDB_GRAPHITE_0_PROTOCOL
+ INFLUXDB_GRAPHITE_0_RETENTION_POLICY
+ INFLUXDB_GRAPHITE_0_SEPARATOR
+ INFLUXDB_GRAPHITE_0_TAGS
+ INFLUXDB_GRAPHITE_0_TEMPLATES
+ INFLUXDB_GRAPHITE_0_UDP_READ_BUFFER
>
-> For the Nth Graphite configuration in the configuration file, the relevant
-> environment variables would be of the form `INFLUXDB_GRAPHITE_(N-1)_BATCH_PENDING`.
-> For each section of the configuration file the numbering restarts at zero.
+>For the Nth Graphite configuration in the configuration file, the relevant
+>environment variables would be of the form `INFLUXDB_GRAPHITE_(N-1)_BATCH_PENDING`.
+>For each section of the configuration file the numbering restarts at zero.
+
## Global settings
-### reporting-disabled
+### `reporting-disabled = false`
-InfluxData uses voluntarily reported data from running InfluxDB nodes
-primarily to track the adoption rates of different InfluxDB versions. This
-data helps InfluxData support the continuing development of InfluxDB.
+InfluxData uses voluntarily reported data from running InfluxDB nodes
+primarily to track the adoption rates of different InfluxDB versions.
+This data helps InfluxData support the continuing development of
+InfluxDB.
-The `reporting-disabled` option toggles the reporting of data every 24 hours
-to `usage.influxdata.com`. Each report includes a randomly-generated
-identifier, OS, architecture, InfluxDB version, and the number of
-[databases](/influxdb/v1/concepts/glossary/#database),
-[measurements](/influxdb/v1/concepts/glossary/#measurement), and unique
-[series](/influxdb/v1/concepts/glossary/#series). Setting this option to
-`true` will disable reporting.
+The `reporting-disabled` option toggles
+the reporting of data every 24 hours to `usage.influxdata.com`.
+Each report includes a randomly-generated identifier, OS, architecture,
+InfluxDB version, and the
+number of [databases](/influxdb/v1/concepts/glossary/#database),
+[measurements](/influxdb/v1/concepts/glossary/#measurement), and
+unique [series](/influxdb/v1/concepts/glossary/#series). Setting
+this option to `true` will disable reporting.
-> [!Note]
-> **Note:** No data from user databases is ever transmitted.
+>**Note:** No data from user databases is ever transmitted.
-**Default**: `false`
-**Environment variable**: `INFLUXDB_REPORTING_DISABLED`
+Environment variable: `INFLUXDB_REPORTING_DISABLED`
-### bind-address {#rpc-bind-address}
+### `bind-address = "127.0.0.1:8088"`
-The `bind-address` option specifies the address and port to bind the RPC
-service for [backup and restore](/influxdb/v1/administration/backup_and_restore/).
+The bind address to use for the RPC service for [backup and restore](/influxdb/v1/administration/backup_and_restore/).
-**Default**: `127.0.0.1:8088`
-**Environment variable**: `INFLUXDB_BIND_ADDRESS`
+Environment variable: `INFLUXDB_BIND_ADDRESS`
-### compact-series-file {metadata="v1.11.4+"}
+### `compact-series-file = false` {metadata="v1.11.4+"}
-The `compact-series-file` options determines if series files should be compacted
-on startup. If `true`, InfluxDB runs
-[`influxd_inspect -compact-series-file`](/influxdb/v1/tools/influx_inspect/#--compact-series-file-)
-before starting the `influxd` server.
-
-Default: `false`
-Environment variable: `INFLUXDB_COMPACT_SERIES_FILE`
+Determines if series files should be compacted on startup. If `true`, InfluxDB
+runs [`influxd_inspect -compact-series-file`](/influxdb/v1/tools/influx_inspect/#--compact-series-file-)
+before starting the `influxd` server. Default is `false`.
## Metastore settings
-### [meta]
+### `[meta]`
This section controls parameters for the InfluxDB metastore,
which stores information on users, databases, retention policies, shards, and continuous queries.
-### dir
+### `dir = "/var/lib/influxdb/meta"`
-The directory where the metadata/raft database is stored. Files in the `meta`
-directory include `meta.db`, the InfluxDB metastore file.
+The directory where the metadata/raft database is stored.
+Files in the `meta` directory include `meta.db`, the InfluxDB metastore file.
-> [!Note]
-> The default directory for macOS installations is `/Users//.influxdb/meta`.
+>**Note:** The default directory for macOS installations is `/Users//.influxdb/meta`
-**Default**: `/var/lib/influxdb/meta`
-**Environment variable**: `INFLUXDB_META_DIR`
+Environment variable: `INFLUXDB_META_DIR`
-### retention-autocreate
+### `retention-autocreate = true`
-Enables the automatic creation of the
-[`DEFAULT` retention policy](/influxdb/v1/concepts/glossary/#retention-policy-rp)
-`autogen` when a database is created. The retention policy `autogen` has an
-infinite duration and is also set as the database's `DEFAULT` retention policy,
-which is used when a write or query does not specify a retention policy. Disable
-this setting to prevent the creation of this retention policy when creating
-databases.
+Enables the automatic creation of the [`DEFAULT` retention policy](/influxdb/v1/concepts/glossary/#retention-policy-rp) `autogen` when a database is created.
+The retention policy `autogen` has an infinite duration and is also set as the
+database's `DEFAULT` retention policy, which is used when a write or query does
+not specify a retention policy.
+Disable this setting to prevent the creation of this retention policy when creating databases.
-**Default**: `true`
-**Environment variable**: `INFLUXDB_META_RETENTION_AUTOCREATE`
+Environment variable: `INFLUXDB_META_RETENTION_AUTOCREATE`
-### logging-enabled
+### `logging-enabled = true`
Enables the logging of messages from the meta service.
-**Default**: `true`
-**Environment variable**: `INFLUXDB_META_LOGGING_ENABLED`
+Environment variable: `INFLUXDB_META_LOGGING_ENABLED`
## Data settings
-### [data]
+### `[data]`
-The `[data]` settings control where the actual shard data for InfluxDB lives and
-how it is flushed from the Write-Ahead Log (WAL).
-`dir` may need to be changed to a suitable place for your system, but the WAL
-settings are an advanced configuration.
+The `[data]` settings control where the actual shard data for InfluxDB lives and how it is flushed from the Write-Ahead Log (WAL).
+`dir` may need to be changed to a suitable place for your system, but the WAL settings are an advanced configuration.
The defaults should work for most systems.
-#### dir
+#### `dir = "/var/lib/influxdb/data"`
-The InfluxDB directory where the TSM engine stores TSM files. This directory
-may be changed.
+The InfluxDB directory where the TSM engine stores TSM files.
+This directory may be changed.
-> [!Note]
-> The default directory for macOS installations is `/Users//.influxdb/data`.
+>**Note:** The default directory for macOS installations is `/Users//.influxdb/data`.
-**Default**: `/var/lib/influxdb/data`
-**Environment variable**: `INFLUXDB_DATA_DIR`
+Environment variable: `INFLUXDB_DATA_DIR`
-#### wal-dir
+#### `wal-dir = "/var/lib/influxdb/wal"`
-The location of the directory for
-[write ahead log (WAL)](/influxdb/v1/concepts/glossary/#wal-write-ahead-log)
-files.
+The location of the directory for [write ahead log (WAL)](/influxdb/v1/concepts/glossary/#wal-write-ahead-log) files.
-> [!Note]
-> For macOS installations, the default WAL directory is
-> `/Users//.influxdb/wal`.
+>**Note:** For macOS installations, the default WAL directory is `/Users//.influxdb/wal`.
-**Default**: `/var/lib/influxdb/wal`
-**Environment variable**: `INFLUXDB_DATA_WAL_DIR`
+Environment variable: `INFLUXDB_DATA_WAL_DIR`
-#### wal-fsync-delay
+#### `wal-fsync-delay = "0s"`
-The amount of time that a write waits before fsyncing. Use a duration greater
-than `0` to batch up multiple fsync calls. This is useful for slower disks or
-when experiencing [WAL](/influxdb/v1/concepts/glossary/#wal-write-ahead-log)
-write contention.
+The amount of time that a write waits before fsyncing. Use a duration greater than `0` to batch up multiple fsync calls.
+This is useful for slower disks or when experiencing [WAL](/influxdb/v1/concepts/glossary/#wal-write-ahead-log) write contention.
+The default value of `0s` fsyncs every write to the WAL.
-> [!Note]
-> For non-SSD disks, InfluxData recommends values in the range of `0ms`-`100ms`.
+>**Note:** For non-SSD disks, InfluxData recommends values in the range of `0ms`-`100ms`.
-**Default**: `0s`
-**Environment variable**: `INFLUXDB_DATA_WAL_FSYNC_DELAY`
+Environment variable: `INFLUXDB_DATA_WAL_FSYNC_DELAY`
-#### index-version
+#### `index-version = "inmem"`
-The type of shard index to use for new shards. The default (`inmem`) index is
-an in-memory index that is recreated at startup. To enable the Time Series
-Index (TSI) disk-based index, set the value to `tsi1`.
+The type of shard index to use for new shards.
+The default (`inmem`) index is an in-memory index that is recreated at startup.
+To enable the Time Series Index (TSI) disk-based index, set the value to `tsi1`.
-**Default**: `inmem`
-**Environment variable**: `INFLUXDB_DATA_INDEX_VERSION`
+Environment variable: `INFLUXDB_DATA_INDEX_VERSION`
-#### trace-logging-enabled
+#### `trace-logging-enabled = false`
-Enables verbose logging of additional debug information within the TSM engine
-and WAL. The trace logging provides more useful output for debugging TSM
-engine issues.
+Enables verbose logging of additional debug information within the TSM engine and WAL.
+The trace logging provide more useful output for debugging TSM engine issues.
-**Default**: `false`
-**Environment variable**: `INFLUXDB_DATA_TRACE_LOGGING_ENABLED`
+Environment variable: `INFLUXDB_DATA_TRACE_LOGGING_ENABLED`
-#### query-log-enabled
+#### `query-log-enabled = true`
-Enables the logging of parsed queries before execution. The query log can be
-useful for troubleshooting, but logs any sensitive data contained within a
-query.
+Enables the logging of parsed queries before execution.
+The query log can be useful for troubleshooting, but logs any sensitive data contained within a query.
-**Default**: `true`
-**Environment variable**: `INFLUXDB_DATA_QUERY_LOG_ENABLED`
+Environment variable: `INFLUXDB_DATA_QUERY_LOG_ENABLED`
-#### strict-error-handling
+
-Validates incoming writes to ensure measurement keys and tag keys only have
-valid Unicode characters. This setting will incur a small overhead because
-every key must be checked. This will not validate field keys.
+#### `validate-keys = false`
+
+Validates incoming writes to ensure measurement keys and tag keys only have valid Unicode characters.
+This setting will incur a small overhead because every key must be checked. This will not validate field keys.
-**Default**: `false`
-**Environment variable**: `INFLUXDB_VALIDATE_KEYS`
### Settings for the TSM engine
-#### cache-max-memory-size
+#### `cache-max-memory-size = "1g"`
The maximum size that a shard cache can reach before it starts rejecting writes.
-Valid memory size suffixes are: `k`, `m`, or `g` (case-insensitive, 1024 = 1k).
+Valid memory size suffixes are: `k`, `m`, or `g` (case-insensitive, 1024 = 1k).
Values without a size suffix are in bytes.
-> [!Note]
-> Consider increasing this value if encountering
-> `cache maximum memory size exceeded` errors.
+Consider increasing this value if encountering `cache maximum memory size exceeded` errors.
-**Default**: `"1g"`
-**Environment variable**: `INFLUXDB_DATA_CACHE_MAX_MEMORY_SIZE`
+Environment variable: `INFLUXDB_DATA_CACHE_MAX_MEMORY_SIZE`
-#### cache-snapshot-memory-size
+#### `cache-snapshot-memory-size = "25m"`
-The size at which the engine will snapshot the cache and write it to a TSM file,
-freeing up memory.
+The size at which the engine will snapshot the cache and write it to a TSM file, freeing up memory.
-Valid memory size suffixes are: `k`, `m`, or `g` (case-insensitive, 1024 = 1k).
+Valid memory size suffixes are: `k`, `m`, or `g` (case-insensitive, 1024 = 1k).
Values without a size suffix are in bytes.
-**Default**: `"25m"`
-**Environment variable**: `INFLUXDB_DATA_CACHE_SNAPSHOT_MEMORY_SIZE`
+Environment variable: `INFLUXDB_DATA_CACHE_SNAPSHOT_MEMORY_SIZE`
-#### cache-snapshot-write-cold-duration
+#### `cache-snapshot-write-cold-duration = "10m"`
-The time interval at which the engine will snapshot the cache and write it to
-a new TSM file if the shard hasn't received writes or deletes.
+The time interval at which the engine will snapshot the cache and write it to a new TSM file if the shard hasn't received writes or deletes.
-**Default**: `"10m"`
-**Environment variable**: `INFLUXDB_DATA_CACHE_SNAPSHOT_WRITE_COLD_DURATION`
+Environment variable: `INFLUXDB_DATA_CACHE_SNAPSHOT_WRITE_COLD_DURATION`
-#### compact-full-write-cold-duration
+#### `compact-full-write-cold-duration = "4h"`
-The time interval at which the TSM engine will compact all TSM files in a shard
-if it hasn't received a write or delete.
+The time interval at which the TSM engine will compact all TSM files in a shard if it hasn't received a write or delete.
-**Default**: `"4h"`
-**Environment variable**: `INFLUXDB_DATA_COMPACT_FULL_WRITE_COLD_DURATION`
+Environment variable: `INFLUXDB_DATA_COMPACT_FULL_WRITE_COLD_DURATION`
-#### max-concurrent-compactions
+#### `max-concurrent-compactions = 0`
-The maximum number of concurrent full and level
-[compactions](/influxdb/v1/concepts/storage_engine/#compactions) that can run
-at one time. The default value of `0` results in 50% of the CPU cores being
-used at runtime for compactions. If explicitly set, the number of cores used
-for compaction is limited to the specified value. This setting does not apply
-to cache snapshotting.
+The maximum number of concurrent full and level [compactions](/influxdb/v1/concepts/storage_engine/#compactions) that can run at one time.
+The default value of `0` results in 50% of the CPU cores being used at runtime for compactions.
+If explicitly set, the number of cores used for compaction is limited to the specified value.
+This setting does not apply to cache snapshotting.
+For more information on `GOMAXPROCS` environment variable, see [`GOMAXPROCS` environment variable](#gomaxprocs-environment-variable) on this page.
-For more information on the `GOMAXPROCS` environment variable, see
-[`GOMAXPROCS` environment variable](#gomaxprocs-environment-variable) on this
-page.
+Environment variable: `INFLUXDB_DATA_MAX_CONCURRENT_COMPACTIONS`
-**Default**: `0`
-**Environment variable**: `INFLUXDB_DATA_MAX_CONCURRENT_COMPACTIONS`
+#### `max-concurrent-deletes = 1` {metadata="v1.11.7+"}
-#### max-concurrent-deletes {metadata="v1.11.7+"}
-
-The maximum number of simultaneous `DELETE` calls on a shard. Default is `1`
+The maximum number of simultaneous `DELETE` calls on a shard. Default is `1`
and should be left unchanged for most use cases.
-**Default**: `1`
-**Environment variable**: `INFLUXDB_DATA_MAX_CONCURRENT_DELETES`
+Environment variable: `INFLUXDB_DATA_MAX_CONCURRENT_DELETES`
-#### compact-throughput
+#### `compact-throughput = "48m"`
-The maximum number of bytes per second TSM compactions write to disk. Short
-bursts are allowed to exceed this value, as determined by
-`compact-throughput-burst`.
+The maximum number of bytes per second TSM compactions write to disk. Default is `"48m"` (48 million).
+Note that short bursts are allowed to happen at a possibly larger value, set by `compact-throughput-burst`.
-**Default**: `"48m"` (48 million)
-**Environment variable**: `INFLUXDB_DATA_COMPACT_THROUGHPUT`
+Environment variable: `INFLUXDB_DATA_COMPACT_THROUGHPUT`
-#### compact-throughput-burst
+#### `compact-throughput-burst = "48m"`
-The maximum number of bytes per second TSM compactions write to disk during
-brief bursts.
+The maximum number of bytes per seconds TSM compactions write to disk during brief bursts. Default is `"48m"` (48 million).
-**Default**: `"48m"` (48 million)
-**Environment variable**: `INFLUXDB_DATA_COMPACT_THROUGHPUT_BURST`
+Environment variable: `INFLUXDB_DATA_COMPACT_THROUGHPUT_BURST`
-#### aggressive-points-per-block {metadata="v1.12.0+"}
+#### `tsm-use-madv-willneed = false`
-The number of points per block to use during aggressive compaction. There are
-certain cases where TSM files do not get fully compacted. This adjusts an
-internal parameter to help ensure these files do get fully compacted.
+If `true`, then the MMap Advise value `MADV_WILLNEED` advises the kernel about how to handle the mapped
+memory region in terms of input/output paging and to expect access to the mapped memory region in the near future, with respect to TSM files.
+Because this setting has been problematic on some kernels (including CentOS and RHEL ), the default is `false`.
+Changing the value to `true` might help users who have slow disks in some cases.
-**Default**: `10000`
-**Environment variable**: `INFLUXDB_AGGRESSIVE_POINTS_PER_BLOCK`
-
-#### tsm-use-madv-willneed
-
-If `true`, the MMap Advise value `MADV_WILLNEED` advises the kernel about how
-to handle the mapped memory region in terms of input/output paging and to
-expect access to the mapped memory region in the near future, with respect to
-TSM files.
-
-> [!Note]
-> Because this setting has been problematic on some kernels (including CentOS
-> and RHEL), the default is `false`. Changing the value to `true` might help
-> users who have slow disks in some cases.
-
-**Default**: `false`
-**Environment variable**: `INFLUXDB_DATA_TSM_USE_MADV_WILLNEED`
+Environment variable: `INFLUXDB_DATA_TSM_USE_MADV_WILLNEED`
### In-memory (`inmem`) index settings
-#### max-series-per-database
+#### `max-series-per-database = 1000000`
-The maximum number of [series](/influxdb/v1/concepts/glossary/#series) allowed
-per database before writes are dropped. The default setting is `1000000` (one
-million). Change the setting to `0` to allow an unlimited number of series per
-database.
+The maximum number of [series](/influxdb/v1/concepts/glossary/#series) allowed per database before writes are dropped.
+The default setting is `1000000` (one million).
+Change the setting to `0` to allow an unlimited number of series per database.
-If a point causes the number of series in a database to exceed
-`max-series-per-database`, InfluxDB will not write the point, and it returns a
+If a point causes the number of series in a database to exceed
+`max-series-per-database`, InfluxDB will not write the point, and it returns a
`500` with the following error:
```
{"error":"max series per database exceeded: "}
```
+> **Note:** Any existing databases with a series count that exceeds `max-series-per-database`
+> will continue to accept writes to existing series, but writes that create a
+> new series will fail.
-> [!Note]
-> Any existing databases with a series count that exceeds
-> `max-series-per-database` will continue to accept writes to existing series,
-> but writes that create a new series will fail.
+Environment variable: `INFLUXDB_DATA_MAX_SERIES_PER_DATABASE`
-**Default**: `1000000`
-**Environment variable**: `INFLUXDB_DATA_MAX_SERIES_PER_DATABASE`
+#### `max-values-per-tag = 100000`
-#### max-values-per-tag
+The maximum number of [tag values](/influxdb/v1/concepts/glossary/#tag-value) allowed per [tag key](/influxdb/v1/concepts/glossary/#tag-key).
+The default value is `100000` (one hundred thousand).
+Change the setting to `0` to allow an unlimited number of tag values per tag
+key.
+If a tag value causes the number of tag values of a tag key to exceed
+`max-values-per-tag`, then InfluxDB will not write the point, and it returns
+a `partial write` error.
-The maximum number of
-[tag values](/influxdb/v1/concepts/glossary/#tag-value) allowed per
-[tag key](/influxdb/v1/concepts/glossary/#tag-key). The default value is
-`100000` (one hundred thousand). Change the setting to `0` to allow an
-unlimited number of tag values per tag key. If a tag value causes the number
-of tag values of a tag key to exceed `max-values-per-tag`, then InfluxDB will
-not write the point, and it returns a `partial write` error.
+Any existing tag keys with tag values that exceed `max-values-per-tag`
+will continue to accept writes, but writes that create a new tag value
+will fail.
-> [!Note]
-> Any existing tag keys with tag values that exceed `max-values-per-tag` will
-> continue to accept writes, but writes that create a new tag value will fail.
-
-**Default**: `100000`
-**Environment variable**: `INFLUXDB_DATA_MAX_VALUES_PER_TAG`
+Environment variable: `INFLUXDB_DATA_MAX_VALUES_PER_TAG`
### TSI (`tsi1`) index settings
-#### max-index-log-file-size
+#### `max-index-log-file-size = "1m"`
The threshold, in bytes, when an index write-ahead log (WAL) file will compact
into an index file. Lower sizes will cause log files to be compacted more
quickly and result in lower heap usage at the expense of write throughput.
-Higher sizes will be compacted less frequently, store more series in memory,
-and provide higher write throughput. Valid size suffixes are `k`, `m`, or `g`
-(case-insensitive, 1024 = 1k). Values without a size suffix are in bytes.
+Higher sizes will be compacted less frequently, store more series in-memory,
+and provide higher write throughput.
+Valid size suffixes are `k`, `m`, or `g` (case-insensitive, 1024 = 1k).
+Values without a size suffix are in bytes.
-**Default**: `"1m"`
-**Environment variable**: `INFLUXDB_DATA_MAX_INDEX_LOG_FILE_SIZE`
+Environment variable: `INFLUXDB_DATA_MAX_INDEX_LOG_FILE_SIZE`
-#### series-id-set-cache-size
+#### `series-id-set-cache-size = 100`
The size of the internal cache used in the TSI index to store previously
-calculated series results. Cached results will be returned quickly from the
-cache rather than needing to be recalculated when a subsequent query with a
-matching tag key-value predicate is executed. Setting this value to `0` will
-disable the cache, which may lead to query performance issues. This value
-should only be increased if it is known that the set of regularly used tag
-key-value predicates across all measurements for a database is larger than 100.
-An increase in cache size may lead to an increase in heap usage.
+calculated series results. Cached results will be returned quickly from the cache rather
+than needing to be recalculated when a subsequent query with a matching tag key-value
+predicate is executed.
+Setting this value to `0` will disable the cache, which may lead to query performance issues.
+This value should only be increased if it is known that the set of regularly used
+tag key-value predicates across all measurements for a database is larger than 100. An
+increase in cache size may lead to an increase in heap usage.
-**Default**: `100`
-**Environment variable**: `INFLUXDB_DATA_SERIES_ID_SET_CACHE_SIZE`
+Environment variable: `INFLUXDB_DATA_SERIES_ID_SET_CACHE_SIZE`
## Query management settings
-### [coordinator]
+### `[coordinator]`
This section contains configuration settings for query management.
-For more on managing queries, see
-[Query Management](/influxdb/v1/troubleshooting/query_management/).
+For more on managing queries, see [Query Management](/influxdb/v1/troubleshooting/query_management/).
-#### write-timeout
+#### `write-timeout = "10s"`
-The duration a write request waits until a "timeout" error is returned to the
-caller.
+The duration a write request waits until a "timeout" error is returned to the caller. The default value is 10 seconds.
-**Default**: `"10s"`
-**Environment variable**: `INFLUXDB_COORDINATOR_WRITE_TIMEOUT`
+Environment variable: `INFLUXDB_COORDINATOR_WRITE_TIMEOUT`
-#### max-concurrent-queries
+#### `max-concurrent-queries = 0`
The maximum number of running queries allowed on your instance.
+The default setting (`0`) allows for an unlimited number of queries.
-**Default**: `0` (unlimited)
-**Environment variable**: `INFLUXDB_COORDINATOR_MAX_CONCURRENT_QUERIES`
+Environment variable: `INFLUXDB_COORDINATOR_MAX_CONCURRENT_QUERIES`
-#### query-timeout
+#### `query-timeout = "0s"`
-The maximum duration that a query is allowed to execute before InfluxDB kills
-the query. This setting is a [duration](#configuration-overview).
+The maximum duration that a query is allowed to execute before InfluxDB
+kills the query.
+The default setting (`0`) allows queries to run with no time restrictions.
+This setting is a [duration](#configuration-overview).
-**Default**: `"0s"` (no time restrictions)
-**Environment variable**: `INFLUXDB_COORDINATOR_QUERY_TIMEOUT`
+Environment variable: `INFLUXDB_COORDINATOR_QUERY_TIMEOUT`
-#### log-queries-after
+#### `log-queries-after = "0s"`
-The maximum duration that a query can run until InfluxDB logs the query with a
-`Detected slow query` message. This setting is a [duration](#configuration-overview).
+The maximum duration that a query can until InfluxDB logs the query with a
+`Detected slow query` message.
+The default setting (`"0"`) will never tell InfluxDB to log the query.
+This setting is a [duration](#configuration-overview).
-**Default**: `"0s"` (never logs slow queries)
-**Environment variable**: `INFLUXDB_COORDINATOR_LOG_QUERIES_AFTER`
+Environment variable: `INFLUXDB_COORDINATOR_LOG_QUERIES_AFTER`
-#### max-select-point
+#### `max-select-point = 0`
The maximum number of [points](/influxdb/v1/concepts/glossary/#point) that a
`SELECT` statement can process.
+The default setting (`0`) allows the `SELECT` statement to process an unlimited
+number of points.
-**Default**: `0` (unlimited)
-**Environment variable**: `INFLUXDB_COORDINATOR_MAX_SELECT_POINT`
+Environment variable: `INFLUXDB_COORDINATOR_MAX_SELECT_POINT`
-#### max-select-series
+#### `max-select-series = 0`
-The maximum number of
-[series](/influxdb/v1/concepts/glossary/#series) that a `SELECT` statement
-can process.
+The maximum number of [series](/influxdb/v1/concepts/glossary/#series) that a
+`SELECT` statement can process.
+The default setting (`0`) allows the `SELECT` statement to process an unlimited
+number of series.
-> [!Note]
-> The default setting (`0`) allows the `SELECT` statement to process an
-> unlimited number of series.
+Environment variable: `INFLUXDB_COORDINATOR_MAX_SELECT_SERIES`
-**Default**: `0`
-**Environment variable**: `INFLUXDB_COORDINATOR_MAX_SELECT_SERIES`
-
-#### max-select-buckets
+#### `max-select-buckets = 0`
The maximum number of `GROUP BY time()` buckets that a query can process.
+The default setting (`0`) allows a query to process an unlimited number of
+buckets.
-> [!Note]
-> The default setting (`0`) allows a query to process an unlimited number
-> of buckets.
+Environment variable: `INFLUXDB_COORDINATOR_MAX_SELECT_BUCKETS`
-**Default**: `0`
-**Environment variable**: `INFLUXDB_COORDINATOR_MAX_SELECT_BUCKETS`
+#### `termination-query-log = false`
-#### termination-query-log
+Print a list of running queries when InfluxDB receives a `SIGTERM`
+(sent when a process exceeds a container memory limit or by the `kill` command).
-Prints a list of running queries when InfluxDB receives a `SIGTERM`
-(sent when a process exceeds a container memory limit or by the `kill`
-command).
-
-**Default**: `false`
-**Environment variable**: `INFLUXDB_COORDINATOR_TERMINATE_QUERY_LOG`
+Environment variable: `INFLUXDB_COORDINATOR_TERMINATE_QUERY_LOG`
-----
## Flux query management settings
-### [flux-controller] {metadata="v1.11.7+"}
+### `[flux-controller]` {metadata="v1.11.7+"}
The `flux-controller` settings control the behavior of Flux queries.
-#### query-concurrency {metadata="v1.11.7+"}
+#### `query-concurrency = 0` {metadata="v1.11.7+"}
-The number of Flux queries that are allowed to execute concurrently. `0` means
-unlimited.
+The number of Flux queries that are allowed to execute concurrently.
+`0` means unlimited. Default is `0`.
-**Default**: `0`
-**Environment variable**: `INFLUXDB_FLUX_CONTROLLER_QUERY_CONCURRENCY`
+Environment variable: `INFLUXDB_FLUX_CONTROLLER_QUERY_CONCURRENCY`
-#### query-initial-memory-bytes {metadata="v1.11.7+"}
+#### `query-initial-memory-bytes = 0` {metadata="v1.11.7+"}
-The initial number of bytes allocated for a Flux query when it is started. If
-this is unset, then the `query-max-memory-bytes` is used. `0` means unlimited.
+The initial number of bytes allocated for a Flux query when it is started.
+If this is unset, then the `query-max-memory-bytes` is used.
+`0` means unlimited. Default is `0`.
-**Default**: `0`
-**Environment variable**: `INFLUXDB_FLUX_CONTROLLER_QUERY_INITIAL_MEMORY_BYTES`
+Environment variable: `INFLUXDB_FLUX_CONTROLLER_QUERY_INITIAL_MEMORY_BYTES`
-#### query-max-memory-bytes {metadata="v1.11.7+"}
+#### `query-max-memory-bytes = 0` {metadata="v1.11.7+"}
The maximum number of bytes (in table memory) a Flux query is allowed to use at
-any given time. `0` means unlimited.
+any given time. `0` means unlimited. Default is `0`.
A query may not be able to use its entire quota of memory if requesting more
memory would conflict with the maximum amount of memory that the controller can
request.
-**Default**: `0`
-**Environment variable**: `INFLUXDB_FLUX_CONTROLLER_QUERY_MAX_MEMORY_BYTES`
+Environment variable: `INFLUXDB_FLUX_CONTROLLER_QUERY_MAX_MEMORY_BYTES`
-#### total-max-memory-bytes {metadata="v1.11.7+"}
+#### `total-max-memory-bytes = 0` {metadata="v1.11.7+"}
-The maximum amount of memory the Flux query controller is allowed to allocate
-to Flux queries. `0` means unlimited.
+The maximum amount of memory the Flux query controller is allowed to allocate to
+Flux queries. `0` means unlimited. Default is `0`.
If this is unset, then this number is `query-concurrency * query-max-memory-bytes`.
This number must be greater than or equal to
`query-concurrency * query-initial-memory-bytes` and may be less than
`query-concurrency * query-max-memory-bytes`.
-**Default**: `0`
-**Environment variable**: `INFLUXDB_FLUX_CONTROLLER_TOTAL_MAX_MEMORY_BYTES`
+Environment variable: `INFLUXDB_FLUX_CONTROLLER_TOTAL_MAX_MEMORY_BYTES`
-#### query-queue-size {metadata="v1.11.7+"}
+#### `query-queue-size = 0` {metadata="v1.11.7+"}
-The number of Flux queries that are allowed to be queued for execution before
-new queries are rejected. `0` means unlimited.
+The number of Flux queries that are allowed to be queued for execution before
+new queries are rejected. `0` means unlimited. Default is `0`.
-> [!Note]
-> The default value of `0` allows an unlimited number of queries to be queued.
-
-**Default**: `0`
-**Environment variable**: `INFLUXDB_FLUX_CONTROLLER_QUERY_QUEUE_SIZE`
+Environment variable: `INFLUXDB_FLUX_CONTROLLER_QUERY_QUEUE_SIZE`
-----
## Retention policy settings
-### [retention]
+### `[retention]`
The `[retention]` settings control the enforcement of retention policies for evicting old data.
-#### enabled
+#### `enabled = true`
Set to `false` to prevent InfluxDB from enforcing retention policies.
-**Default**: `true`
-**Environment variable**: `INFLUXDB_RETENTION_ENABLED`
+Environment variable: `INFLUXDB_RETENTION_ENABLED`
-#### check-interval
+#### `check-interval = "30m0s"`
The time interval at which InfluxDB checks to enforce a retention policy.
-**Default**: `"30m0s"`
-**Environment variable**: `INFLUXDB_RETENTION_CHECK_INTERVAL`
+Environment variable: `INFLUXDB_RETENTION_CHECK_INTERVAL`
-----
## Shard precreation settings
-### [shard-precreation]
+### `[shard-precreation]`
-The `[shard-precreation]` settings control the precreation of shards so that
-shards are available before data arrive. Only shards that, after creation, will
-have both a start- and end-time in the future are ever created.
+The `[shard-precreation]` settings control the precreation of shards so that shards are available before data arrive.
+Only shards that, after creation, will have both a start- and end-time in the future are ever created.
Shards that would be wholly or partially in the past are never precreated.
-#### enabled
+#### `enabled = true`
Determines whether the shard precreation service is enabled.
-**Default**: `true`
-**Environment variable**: `INFLUXDB_SHARD_PRECREATION_ENABLED`
+Environment variable: `INFLUXDB_SHARD_PRECREATION_ENABLED`
-#### check-interval
+#### `check-interval = "10m"`
The time interval when the check to precreate new shards runs.
-**Default**: `"10m"`
-**Environment variable**: `INFLUXDB_SHARD_PRECREATION_CHECK_INTERVAL`
+Environment variable: `INFLUXDB_SHARD_PRECREATION_CHECK_INTERVAL`
-#### advance-period
+#### `advance-period = "30m"`
-The maximum period in the future for which InfluxDB precreates shards. The
-`30m` default should work for most systems. Increasing this setting too far
-in the future can cause inefficiencies.
+The maximum period in the future for which InfluxDB precreates shards.
+The `30m` default should work for most systems.
+Increasing this setting too far in the future can cause inefficiencies.
-**Default**: `"30m"`
-**Environment variable**: `INFLUXDB_SHARD_PRECREATION_ADVANCE_PERIOD`
+Environment variable: `INFLUXDB_SHARD_PRECREATION_ADVANCE_PERIOD`
## Monitoring settings
-### [monitor]
+### `[monitor]`
-The `[monitor]` section settings control the InfluxDB
-[system self-monitoring](https://github.com/influxdata/influxdb/blob/1.8/monitor/README.md).
+The `[monitor]` section settings control the InfluxDB [system self-monitoring](https://github.com/influxdata/influxdb/blob/1.8/monitor/README.md).
By default, InfluxDB writes the data to the `_internal` database.
If that database does not exist, InfluxDB creates it automatically.
The `DEFAULT` retention policy on the `_internal` database is seven days.
-If you want to use a retention policy other than the seven-day retention policy,
-you must [create](/influxdb/v1/query_language/manage-database/#retention-policy-management) it.
+If you want to use a retention policy other than the seven-day retention policy, you must [create](/influxdb/v1/query_language/manage-database/#retention-policy-management) it.
-#### store-enabled
+#### `store-enabled = true`
-Set to `false` to disable recording statistics internally. If set to `false`,
-it will make it substantially more difficult to diagnose issues with your
-installation.
+Set to `false` to disable recording statistics internally.
+If set to `false` it will make it substantially more difficult to diagnose issues with your installation.
-**Default**: `true`
-**Environment variable**: `INFLUXDB_MONITOR_STORE_ENABLED`
+Environment variable: `INFLUXDB_MONITOR_STORE_ENABLED`
-#### store-database
+#### `store-database = "_internal"`
The destination database for recorded statistics.
-**Default**: `_internal`
-**Environment variable**: `INFLUXDB_MONITOR_STORE_DATABASE`
+Environment variable: `INFLUXDB_MONITOR_STORE_DATABASE`
-#### store-interval
+#### `store-interval = "10s"`
-The time interval at which InfluxDB records statistics. The default value is
-every ten seconds (`10s`).
+The time interval at which InfluxDB records statistics.
+The default value is every ten seconds (`10s`).
-**Default**: `10s`
-**Environment variable**: `INFLUXDB_MONITOR_STORE_INTERVAL`
+Environment variable: `INFLUXDB_MONITOR_STORE_INTERVAL`
## HTTP endpoints settings
-### [http]
+### `[http]`
The `[http]` section settings control how InfluxDB configures the HTTP endpoints.
These are the primary mechanisms for getting data into and out of InfluxDB.
Edit the settings in this section to enable HTTPS and authentication.
-For details on enabling HTTPS and authentication, see
-[Authentication and Authorization](/influxdb/v1/administration/authentication_and_authorization/).
+For details on enabling HTTPS and authentication, see [Authentication and Authorization](/influxdb/v1/administration/authentication_and_authorization/).
-#### enabled
+#### `enabled = true`
-Determines whether the HTTP endpoints are enabled. To disable access to the
-HTTP endpoints, set the value to `false`. Note that the InfluxDB
-[command line interface (CLI)](/influxdb/v1/tools/shell/) connects to the
-database using the InfluxDB API.
+Determines whether the HTTP endpoints are enabled.
+To disable access to the HTTP endpoints, set the value to `false`.
+Note that the InfluxDB [command line interface (CLI)](/influxdb/v1/tools/shell/) connects to the database using the InfluxDB API.
-**Default**: `true`
-**Environment variable**: `INFLUXDB_HTTP_ENABLED`
+Environment variable: `INFLUXDB_HTTP_ENABLED`
-#### flux-enabled
+#### `flux-enabled = false`
-Determines whether the Flux query endpoint is enabled. To enable the use of
-Flux queries, set the value to `true`.
+Determines whether the Flux query endpoint is enabled. To enable the use of Flux queries, set the value to `true`.
-**Default**: `false`
-**Environment variable**: `INFLUXDB_HTTP_FLUX_ENABLED`
+Environment variable: `INFLUXDB_HTTP_FLUX_ENABLED`
-#### bind-address {#http-bind-address}
+#### `bind-address = ":8086"`
The bind address (port) used by the HTTP service.
-**Default**: `":8086"`
-**Environment variable**: `INFLUXDB_HTTP_BIND_ADDRESS`
+Environment variable: `INFLUXDB_HTTP_BIND_ADDRESS`
-#### auth-enabled
+#### `auth-enabled = false`
-Determines whether user authentication is enabled over HTTP and HTTPS. To
-require authentication, set the value to `true`.
+Determines whether user authentication is enabled over HTTP and HTTPS.
+To require authentication, set the value to `true`.
-**Default**: `false`
-**Environment variable**: `INFLUXDB_HTTP_AUTH_ENABLED`
+Environment variable: `INFLUXDB_HTTP_AUTH_ENABLED`
-#### realm
+#### `realm = "InfluxDB"`
-The default realm sent back when issuing a basic authentication challenge.
+The default realm sent back when issuing a basic authentication challenge.
The realm is the JWT realm used by the HTTP endpoints.
-**Default**: `"InfluxDB"`
-**Environment variable**: `INFLUXDB_HTTP_REALM`
+Environment variable: `INFLUXDB_HTTP_REALM`
-#### log-enabled
+#### `log-enabled = true`
-Determines whether HTTP request logging is enabled. To disable logging, set
-the value to `false`.
+Determines whether HTTP request logging is enabled.
+To disable logging, set the value to `false`.
-**Default**: `true`
-**Environment variable**: `INFLUXDB_HTTP_LOG_ENABLED`
+Environment variable: `INFLUXDB_HTTP_LOG_ENABLED`
-#### suppress-write-log
+#### `suppress-write-log = false`
-Determines whether the HTTP write request logs should be suppressed when the
-log is enabled.
+Determines whether the HTTP write request logs should be suppressed when the log is enabled.
-**Default**: `false`
-**Environment variable**: `INFLUXDB_HTTP_SUPPRESS_WRITE_LOG`
+#### `access-log-path = ""`
-#### access-log-path
+The path to the access log, which determines whether detailed write logging is enabled using `log-enabled = true`.
+Specifies whether HTTP request logging is written to the specified path when enabled.
+If `influxd` is unable to access the specified path, it will log an error and fall back to `stderr`.
+When HTTP request logging is enabled, this option specifies the path where log entries should be written.
+If unspecified, the default is to write to stderr, which intermingles HTTP logs with internal InfluxDB logging.
+If `influxd` is unable to access the specified path, it will log an error and fall back to writing the request log to `stderr`.
-The path to the access log, which determines whether detailed write logging
-is enabled using `log-enabled = true`. Specifies whether HTTP request logging
-is written to the specified path when enabled. If `influxd` is unable to
-access the specified path, it will log an error and fall back to `stderr`.
-When HTTP request logging is enabled, this option specifies the path where
-log entries should be written. If unspecified, the default is to write to
-stderr, which intermingles HTTP logs with internal InfluxDB logging. If
-`influxd` is unable to access the specified path, it will log an error and
-fall back to writing the request log to `stderr`.
+Environment variable: `INFLUXDB_HTTP_ACCESS_LOG_PATH`
-**Default**: `""`
-**Environment variable**: `INFLUXDB_HTTP_ACCESS_LOG_PATH`
+#### `access-log-status-filters = []`
-#### access-log-status-filters
+Filters which requests should be logged. Each filter is of the pattern `nnn`, `nnx`, or `nxx` where `n` is
+a number and `x` is the wildcard for any number.
+To filter all `5xx` responses, use the string `5xx`.
+If multiple filters are used, then only one has to match.
+The default value is no filters, with every request being printed.
-Filters which requests should be logged. Each filter is of the pattern `nnn`,
-`nnx`, or `nxx` where `n` is a number and `x` is the wildcard for any number.
-To filter all `5xx` responses, use the string `5xx`. If multiple filters are
-used, then only one has to match. The default value is no filters, with every
-request being printed.
-
-**Default**: `[]`
-**Environment variable**: `INFLUXDB_HTTP_ACCESS_LOG_STATUS_FILTERS_x`
+Environment variable: `INFLUXDB_HTTP_ACCESS_LOG_STATUS_FILTERS_x`
##### Examples
-###### Set access log status filters using configuration settings
+###### Setting access log status filters using configuration settings
-```txt
-access-log-status-filters = ["4xx", "5xx"]
-```
+`access-log-status-filters = ["4xx", "5xx"]`
`"4xx"` is in array position `0`
`"5xx"` is in array position `1`
-###### Set access log status filters using environment variables
+###### Setting access log status filters using environment variables
The input values for the `access-log-status-filters` is an array.
When using environment variables, the values can be supplied as follows.
-```
-INFLUXDB_HTTP_ACCESS_LOG_STATUS_FILTERS_0=4xx
-INFLUXDB_HTTP_ACCESS_LOG_STATUS_FILTERS_1=5xx
-```
+`INFLUXDB_HTTP_ACCESS_LOG_STATUS_FILTERS_0=4xx`
+
+`INFLUXDB_HTTP_ACCESS_LOG_STATUS_FILTERS_1=5xx`
The `_n` at the end of the environment variable represents the array position of the entry.
-#### write-tracing
-Determines whether detailed write logging is enabled. Set to `true` to enable
-logging for the write payload. If set to `true`, this will duplicate every
-write statement in the logs and is thus not recommended for general use.
+#### `write-tracing = false`
-**Default**: `false`
-**Environment variable**: `INFLUXDB_HTTP_WRITE_TRACING`
+Determines whether detailed write logging is enabled.
+Set to `true` to enable logging for the write payload.
+If set to `true`, this will duplicate every write statement in the logs and is thus not recommended for general use.
-#### pprof-enabled
+Environment variable: `INFLUXDB_HTTP_WRITE_TRACING`
-Determines whether the `/net/http/pprof` HTTP endpoint is enabled. Useful for
-troubleshooting and monitoring.
+#### `pprof-enabled = true`
-**Default**: `true`
-**Environment variable**: `INFLUXDB_HTTP_PPROF_ENABLED`
+Determines whether the `/net/http/pprof` HTTP endpoint is enabled.
+Useful for troubleshooting and monitoring.
-#### pprof-auth-enabled
+Environment variable: `INFLUXDB_HTTP_PPROF_ENABLED`
-Enables authentication on `/debug` endpoints. If enabled, users need admin
-permissions to access the following endpoints:
+#### `pprof-auth-enabled = false`
+
+Enables authentication on `/debug` endpoints.
+If enabled, users need admin permissions to access the following endpoints:
- `/debug/pprof`
- `/debug/requests`
- `/debug/vars`
-This setting has no effect if either
-[`auth-enabled`](#auth-enabled-false) or
+This setting has no effect if either [`auth-enabled`](#auth-enabled-false) or
[`pprof-enabled`](#pprof-enabled-true) are set to `false`.
-**Default**: `false`
-**Environment variable**: `INFLUXDB_HTTP_PPROF_AUTH_ENABLED`
+Environment variable: `INFLUXDB_HTTP_PPROF_AUTH_ENABLED`
-#### debug-pprof-enabled
+#### `debug-pprof-enabled = false`
-Enables the default `/pprof` endpoint and binds against `localhost:6060`.
+Enable the default `/pprof` endpoint and bind against `localhost:6060`.
Useful for debugging startup performance issues.
-**Default**: `false`
-**Environment variable**: `INFLUXDB_HTTP_DEBUG_PPROF_ENABLED`
+Environment variable: `INFLUXDB_HTTP_DEBUG_PPROF_ENABLED`
-#### ping-auth-enabled
+#### `ping-auth-enabled = false`
-Enables authentication on the `/ping`, `/metrics`, and deprecated `/status`
-endpoints. This setting has no effect if
-[`auth-enabled`](#auth-enabled-false) is set to `false`.
+Enables authentication on the `/ping`, `/metrics`, and deprecated `/status` endpoints.
+This setting has no effect if [`auth-enabled`](#auth-enabled-false) is set to `false`.
-**Default**: `false`
-**Environment variable**: `INFLUXDB_HTTP_PING_AUTH_ENABLED`
+Environment variable: `INFLUXDB_HTTP_PING_AUTH_ENABLED`
-#### prom-read-auth-enabled
+#### `prom-read-auth-enabled = false`
-Enables authentication on the Prometheus remote read API. This setting has no
-effect if [`auth-enabled`](#auth-enabled-false) is set to `false`.
+Enables authentication on the Prometheus remote read API. Default is `false`.
+This setting has no effect if [`auth-enabled`](#auth-enabled-false) is set to `false`.
-**Default**: `false`
-**Environment variable**: `INFLUXDB_HTTP_PROM_READ_AUTH_ENABLED`
+Environment variable: `INFLUXDB_HTTP_PROM_READ_AUTH_ENABLED`
-#### http-headers
+#### `http-headers`
-User-supplied [HTTP response headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers).
-Configure this section to return
-[security headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers#Security)
+User-supplied [HTTP response headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers).
+Configure this section to return [security headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers#Security)
such as `X-Frame-Options` or `Content Security Policy` where needed.
Example:
@@ -944,700 +793,599 @@ Example:
X-Frame-Options = "DENY"
```
-#### https-enabled
+#### `https-enabled = false`
-Determines whether HTTPS is enabled. To enable HTTPS, set the value to `true`.
+Determines whether HTTPS is enabled.
+To enable HTTPS, set the value to `true`.
-**Default**: `false`
-**Environment variable**: `INFLUXDB_HTTP_HTTPS_ENABLED`
+Environment variable: `INFLUXDB_HTTP_HTTPS_ENABLED`
-#### https-certificate
+#### `https-certificate = "/etc/ssl/influxdb.pem"`
The path of the SSL certificate file to use when HTTPS is enabled.
-**Default**: `"/etc/ssl/influxdb.pem"`
-**Environment variable**: `INFLUXDB_HTTP_HTTPS_CERTIFICATE`
+Environment variable: `INFLUXDB_HTTP_HTTPS_CERTIFICATE`
-#### https-private-key
+#### `https-private-key = ""`
-Use a separate private key location. If only the `https-certificate` is
-specified, the `httpd` service will try to load the private key from the
-`https-certificate` file. If a separate `https-private-key` file is specified,
-the `httpd` service will load the private key from the `https-private-key` file.
+Use a separate private key location.
+If only the `https-certificate` is specified, the `httpd` service will try to load the private key from the `https-certificate` file.
+If a separate `https-private-key` file is specified, the `httpd` service will load the private key from the `https-private-key` file.
-**Default**: `""`
-**Environment variable**: `INFLUXDB_HTTP_HTTPS_PRIVATE_KEY`
+Environment variable: `INFLUXDB_HTTP_HTTPS_PRIVATE_KEY`
-#### shared-secret
+#### `shared-secret = ""`
The shared secret used to validate public API requests using JWT tokens.
-**Default**: `""`
-**Environment variable**: `INFLUXDB_HTTP_SHARED_SECRET`
+Environment variable: `INFLUXDB_HTTP_SHARED_SECRET`
-#### max-row-limit
+#### `max-row-limit = 0`
-The maximum number of rows that the system can return in a
-[non-chunked](/influxdb/v1/tools/api#query-string-parameters) query. The
-default setting (`0`) allows for an unlimited number of rows. If the query
-results exceed a specified value, then InfluxDB includes a `"partial":true`
-tag in the response body.
+The maximum number of rows that the system can return in a [non-chunked](/influxdb/v1/tools/api#query-string-parameters) query.
+The default setting (`0`) allows for an unlimited number of rows.
+If the query results exceed a specified value, then InfluxDB includes a `"partial":true` tag in the response body.
-**Default**: `0`
-**Environment variable**: `INFLUXDB_HTTP_MAX_ROW_LIMIT`
+Environment variable: `INFLUXDB_HTTP_MAX_ROW_LIMIT`
-#### max-connection-limit
+#### `max-connection-limit = 0`
-The maximum number of connections that may be open at once. New connections
-that would exceed the limit are dropped. The default value of `0` disables
-the limit.
+The maximum number of connections that may be open at once.
+New connections that would exceed the limit are dropped.
+The default value of `0` disables the limit.
-**Default**: `0`
-**Environment variable**: `INFLUXDB_HTTP_MAX_CONNECTION_LIMIT`
+Environment variable: `INFLUXDB_HTTP_MAX_CONNECTION_LIMIT`
-#### unix-socket-enabled
+#### `unix-socket-enabled = false`
-Enable HTTP service over the UNIX domain socket. To enable HTTP service over
-the UNIX domain socket, set the value to `true`.
+Enable HTTP service over the UNIX domain socket.
+To enable HTTP service over the UNIX domain socket, set the value to `true`.
-**Default**: `false`
-**Environment variable**: `INFLUXDB_HTTP_UNIX_SOCKET_ENABLED`
+Environment variable: `INFLUXDB_HTTP_UNIX_SOCKET_ENABLED`
-#### bind-socket
+#### `bind-socket = "/var/run/influxdb.sock"`
The path of the UNIX domain socket.
-**Default**: `"/var/run/influxdb.sock"`
-**Environment variable**: `INFLUXDB_HTTP_UNIX_BIND_SOCKET`
+Environment variable: `INFLUXDB_HTTP_UNIX_BIND_SOCKET`
-#### max-body-size
+#### `max-body-size = 25000000`
-The maximum size, in bytes, of a client request body. When an HTTP client
-sends data that exceeds the configured maximum size, a `413 Request Entity
-Too Large` HTTP response is returned. To disable the limit, set the value
-to `0`.
+The maximum size, in bytes, of a client request body.
+When a HTTP client sends data that exceeds the configured maximum size, a `413 Request Entity Too Large` HTTP response is returned.
+To disable the limit, set the value to `0`.
-**Default**: `25000000`
-**Environment variable**: `INFLUXDB_HTTP_MAX_BODY_SIZE`
+Environment variable: `INFLUXDB_HTTP_MAX_BODY_SIZE`
-#### max-concurrent-write-limit
+#### `max-concurrent-write-limit = 0`
-The maximum number of writes that can be processed concurrently. To disable
-the limit, set the value to `0`.
+The maximum number of writes that can be processed concurrently.
+To disable the limit, set the value to `0`.
-**Default**: `0`
-**Environment variable**: `INFLUXDB_HTTP_MAX_CONCURRENT_WRITE_LIMIT`
+Environment variable: `INFLUXDB_HTTP_MAX_CONCURRENT_WRITE_LIMIT`
-#### max-enqueued-write-limit
+#### `max-enqueued-write-limit = 0`
-The maximum number of writes queued for processing. To disable the limit, set
-the value to `0`.
+The maximum number of writes queued for processing.
+To disable the limit, set the value to `0`.
-**Default**: `0`
-**Environment variable**: `INFLUXDB_HTTP_MAX_ENQUEUED_WRITE_LIMIT`
+Environment variable: `INFLUXDB_HTTP_MAX_ENQUEUED_WRITE_LIMIT`
-#### enqueued-write-timeout
+#### `enqueued-write-timeout = 0`
+The maximum duration for a write to wait in the queue to be processed.
+To disable the limit, set this to `0` or set the `max-concurrent-write-limit` value to `0`.
-The maximum duration for a write to wait in the queue to be processed. To
-disable the limit, set this to `0` or set the `max-concurrent-write-limit`
-value to `0`.
+Environment variable: `INFLUXDB_HTTP_ENQUEUED_WRITE_TIMEOUT`
-**Default**: `0`
-**Environment variable**: `INFLUXDB_HTTP_ENQUEUED_WRITE_TIMEOUT`
+#### `[http.headers]`
+
+Use the `[http.headers]` section to configure user-supplied HTTP response headers.
+
+```
+# [http.headers]
+# X-Header-1 = "Header Value 1"
+# X-Header-2 = "Header Value 2"
+```
-----
## Logging settings
-### [logging]
+### `[logging]`
Controls how the logger emits logs to the output.
-#### format
+#### `format = "auto"`
-Determines which log encoder to use for logs. Valid values are `auto` (default),
-`logfmt`, and `json`. With the default `auto` option, if the output is to a TTY
-device (e.g., a terminal), a more user-friendly console encoding is used. If the
-output is to files, the auto option uses the `logfmt` encoding. The `logfmt` and
-`json` options are useful for integration with external tools.
+Determines which log encoder to use for logs.
+Valid values are `auto`(default), `logfmt`, and `json`.
+With the default `auto` option, if the output is to a TTY device (e.g., a terminal), a more user-friendly console encoding is used.
+If the output is to files, the auto option uses the `logfmt` encoding.
+The `logfmt` and `json` options are useful for integration with external tools.
-**Default**: `auto`
-**Environment variable**: `INFLUXDB_LOGGING_FORMAT`
+Environment variable: `INFLUXDB_LOGGING_FORMAT`
-#### level
+#### `level = "info"`
-The log level to be emitted. Valid values are `error`, `warn`, `info` (default),
-and `debug`. Logs that are equal to, or above, the specified level will be
-emitted.
+The log level to be emitted.
+Valid values are `error`, `warn`, `info`(default), and `debug`.
+Logs that are equal to, or above, the specified level will be emitted.
-**Default**: `info`
-**Environment variable**: `INFLUXDB_LOGGING_LEVEL`
+Environment variable: `INFLUXDB_LOGGING_LEVEL`
-#### suppress-logo
+#### `suppress-logo = false`
-Suppresses the logo output that is printed when the program is started. The logo
-is always suppressed if `STDOUT` is not a TTY.
+Suppresses the logo output that is printed when the program is started.
+The logo is always suppressed if `STDOUT` is not a TTY.
-**Default**: `false`
-**Environment variable**: `INFLUXDB_LOGGING_SUPPRESS_LOGO`
+Environment variable: `INFLUXDB_LOGGING_SUPPRESS_LOGO`
-----
## Subscription settings
-### [subscriber]
+### `[subscriber]`
The `[subscriber]` section controls how [Kapacitor](/kapacitor/v1/) will receive data.
-#### enabled
+#### `enabled = true`
-Determines whether the subscriber service is enabled. To disable the subscriber
-service, set the value to `false`.
+Determines whether the subscriber service is enabled.
+To disable the subscriber service, set the value to `false`.
-**Default**: `true`
-**Environment variable**: `INFLUXDB_SUBSCRIBER_ENABLED`
+Environment variable: `INFLUXDB_SUBSCRIBER_ENABLED`
-#### http-timeout
+#### `http-timeout = "30s"`
The duration that an HTTP write to a subscriber runs until it times out.
-**Default**: `"30s"`
-**Environment variable**: `INFLUXDB_SUBSCRIBER_HTTP_TIMEOUT`
+Environment variable: `INFLUXDB_SUBSCRIBER_HTTP_TIMEOUT`
-#### insecure-skip-verify
+#### `insecure-skip-verify = false`
-Determines whether to allow insecure HTTPS connections to subscribers. This is
-useful when testing with self-signed certificates.
+Determines whether to allow insecure HTTPS connections to subscribers.
+This is useful when testing with self-signed certificates.
-**Default**: `false`
-**Environment variable**: `INFLUXDB_SUBSCRIBER_INSECURE_SKIP_VERIFY`
+Environment variable: `INFLUXDB_SUBSCRIBER_INSECURE_SKIP_VERIFY`
-#### ca-certs
+#### `ca-certs = ""`
-The path to the PEM-encoded CA certs file. If the value is an empty string
-(`""`), the default system certs will be used.
+The path to the PEM-encoded CA certs file.
+If the value is an empty string (`""`), the default system certs will be used.
-**Default**: `""`
-**Environment variable**: `INFLUXDB_SUBSCRIBER_CA_CERTS`
+Environment variable: `INFLUXDB_SUBSCRIBER_CA_CERTS`
-#### write-concurrency
+#### `write-concurrency = 40`
The number of writer goroutines processing the write channel.
-**Default**: `40`
-**Environment variable**: `INFLUXDB_SUBSCRIBER_WRITE_CONCURRENCY`
+Environment variable: `INFLUXDB_SUBSCRIBER_WRITE_CONCURRENCY`
-#### write-buffer-size
+#### `write-buffer-size = 1000`
The number of in-flight writes buffered in the write channel.
-**Default**: `1000`
-**Environment variable**: `INFLUXDB_SUBSCRIBER_WRITE_BUFFER_SIZE`
+Environment variable: `INFLUXDB_SUBSCRIBER_WRITE_BUFFER_SIZE`
-#### total-buffer-bytes {metadata="v1.11.7+"}
+#### `total-buffer-bytes = 0` {metadata="v1.11.7"}
-The total size in bytes allocated to buffering across all subscriptions. Each
-named subscription receives an even division of the total.
+The total size in bytes allocated to buffering across all subscriptions.
+Each named subscription receives an even division of the total.
+Default is `0`.
-**Default**: `0`
-**Environment variable**: `INFLUXDB_SUBSCRIBER_TOTAL_BUFFER_BYTES`
+Environment variable: `INFLUXDB_SUBSCRIBER_TOTAL_BUFFER_BYTES`
-----
## Graphite settings
-### [[graphite]]
+### `[[graphite]]`
This section controls one or many listeners for Graphite data.
For more information, see [Graphite protocol support in InfluxDB](/influxdb/v1/supported_protocols/graphite/).
-#### enabled
+#### `enabled = false`
Set to `true` to enable Graphite input.
-**Default**: `false`
-**Environment variable**: `INFLUXDB_GRAPHITE_0_ENABLED`
+Environment variable: `INFLUXDB_GRAPHITE_0_ENABLED`
-#### database
+#### `database = "graphite"`
The name of the database that you want to write to.
-**Default**: `"graphite"`
-**Environment variable**: `INFLUXDB_GRAPHITE_0_DATABASE`
+Environment variable: `INFLUXDB_GRAPHITE_0_DATABASE`
-#### retention-policy
+#### `retention-policy = ""`
-The relevant retention policy. An empty string is equivalent to the database's
-`DEFAULT` retention policy.
+The relevant retention policy.
+An empty string is equivalent to the database's `DEFAULT` retention policy.
-**Default**: `""`
-**Environment variable**: `INFLUXDB_GRAPHITE_0_RETENTION_POLICY`
+Environment variable: `INFLUXDB_GRAPHITE_0_RETENTION_POLICY`
-#### bind-address {#graphite-bind-address}
+#### `bind-address = ":2003"`
The default port.
-**Default**: `":2003"`
-**Environment variable**: `INFLUXDB_GRAPHITE_0_BIND_ADDRESS`
+Environment variable: `INFLUXDB_GRAPHITE_0_BIND_ADDRESS`
-#### protocol
+#### `protocol = "tcp"`
Set to `tcp` or `udp`.
-**Default**: `"tcp"`
-**Environment variable**: `INFLUXDB_GRAPHITE_PROTOCOL`
+Environment variable: `INFLUXDB_GRAPHITE_PROTOCOL`
-#### consistency-level
+#### `consistency-level = "one"`
-The number of nodes that must confirm the write. If the requirement is not met,
-the return value will be either `partial write` if some points in the batch fail
-or `write failure` if all points in the batch fail. For more information, see
-the Query String Parameters for Writes section in the
-[InfluxDB line protocol syntax reference](/influxdb/v1/write_protocols/write_syntax/).
+The number of nodes that must confirm the write.
+If the requirement is not met the return value will be either `partial write` if some points in the batch fail or `write failure` if all points in the batch fail.
+For more information, see the Query String Parameters for Writes section in the [InfluxDB line protocol syntax reference](/influxdb/v1/write_protocols/write_syntax/).
-**Default**: `"one"`
-**Environment variable**: `INFLUXDB_GRAPHITE_CONSISTENCY_LEVEL`
+Environment variable: `INFLUXDB_GRAPHITE_CONSISTENCY_LEVEL`
-> [!Important]
-> The next three settings control how batching works.
-> You should have this enabled otherwise you could get dropped metrics or poor performance.
-> Batching will buffer points in memory if you have many coming in.
+*The next three settings control how batching works.
+You should have this enabled otherwise you could get dropped metrics or poor performance.
+Batching will buffer points in memory if you have many coming in.*
-#### batch-size
+#### `batch-size = 5000`
The input will flush if this many points get buffered.
-**Default**: `5000`
-**Environment variable**: `INFLUXDB_GRAPHITE_BATCH_SIZE`
+Environment variable: `INFLUXDB_GRAPHITE_BATCH_SIZE`
-#### batch-pending
+#### `batch-pending = 10`
The number of batches that may be pending in memory.
-**Default**: `10`
-**Environment variable**: `INFLUXDB_GRAPHITE_BATCH_PENDING`
+Environment variable: `INFLUXDB_GRAPHITE_BATCH_PENDING`
-#### batch-timeout
+#### `batch-timeout = "1s"`
-The input will flush at least this often even if it hasn't reached the
-configured batch-size.
+The input will flush at least this often even if it hasn't reached the configured batch-size.
-**Default**: `"1s"`
-**Environment variable**: `INFLUXDB_GRAPHITE_BATCH_TIMEOUT`
+Environment variable: `INFLUXDB_GRAPHITE_BATCH_TIMEOUT`
-#### udp-read-buffer
+#### `udp-read-buffer = 0`
-UDP read buffer size, `0` means OS default. The UDP listener will fail if set
-above the OS maximum.
+UDP Read buffer size, `0` means OS default.
+UDP listener will fail if set above OS max.
-**Default**: `0`
-**Environment variable**: `INFLUXDB_GRAPHITE_UDP_READ_BUFFER`
+Environment variable: `INFLUXDB_GRAPHITE_UDP_READ_BUFFER`
-#### separator
+#### `separator = "."`
-This string joins multiple matching 'measurement' values, providing more
-control over the final measurement name.
+This string joins multiple matching 'measurement' values providing more control over the final measurement name.
-**Default**: `"."`
-**Environment variable**: `INFLUXDB_GRAPHITE_SEPARATOR`
+Environment variable: `INFLUXDB_GRAPHITE_SEPARATOR`
-----
## CollectD settings
-### [[collectd]]
+### `[[collectd]]`
The `[[collectd]]` settings control the listener for `collectd` data.
For more information, see [CollectD protocol support in InfluxDB](/influxdb/v1/supported_protocols/collectd/).
-#### enabled
+#### `enabled = false`
Set to `true` to enable `collectd` writes.
-**Default**: `false`
-**Environment variable**: `INFLUXDB_COLLECTD_ENABLED`
+Environment variable: `INFLUXDB_COLLECTD_ENABLED`
-#### bind-address {#collectd-bind-address}
+#### `bind-address = ":25826"`
The port.
-**Default**: `":25826"`
-**Environment variable**: `INFLUXDB_COLLECTD_BIND_ADDRESS`
+Environment variable: `INFLUXDB_COLLECTD_BIND_ADDRESS`
-#### database
+#### `database = "collectd"`
-The name of the database that you want to write to. This defaults to `collectd`.
+The name of the database that you want to write to.
+This defaults to `collectd`.
-**Default**: `"collectd"`
-**Environment variable**: `INFLUXDB_COLLECTD_DATABASE`
+Environment variable: `INFLUXDB_COLLECTD_DATABASE`
-#### retention-policy
+#### `retention-policy = ""`
-The relevant retention policy. An empty string is equivalent to the database's
-`DEFAULT` retention policy.
+The relevant retention policy.
+An empty string is equivalent to the database's `DEFAULT` retention policy.
-**Default**: `""`
-**Environment variable**: `INFLUXDB_COLLECTD_RETENTION_POLICY`
+Environment variable: `INFLUXDB_COLLECTD_RETENTION_POLICY`
-#### typesdb
+#### `typesdb = "/usr/local/share/collectd"`
The collectd service supports either scanning a directory for multiple types
-db files, or specifying a single db file. A sample `types.db` file can be found
+db files, or specifying a single db file.
+A sample `types.db` file
+can be found
[here](https://github.com/collectd/collectd/blob/master/src/types.db).
-**Default**: `"/usr/local/share/collectd"`
-**Environment variable**: `INFLUXDB_COLLECTD_TYPESDB`
+Environment variable: `INFLUXDB_COLLECTD_TYPESDB`
-#### security-level
+#### `security-level = "none"`
-**Default**: `"none"`
-**Environment variable**: `INFLUXDB_COLLECTD_SECURITY_LEVEL`
+Environment variable: `INFLUXDB_COLLECTD_SECURITY_LEVEL`
-#### auth-file
+#### `auth-file = "/etc/collectd/auth_file"`
-**Default**: `"/etc/collectd/auth_file"`
-**Environment variable**: `INFLUXDB_COLLECTD_AUTH_FILE`
+Environment variable: `INFLUXDB_COLLECTD_AUTH_FILE`
-> [!Important]
-> The next three settings control how batching works.
-> You should have this enabled otherwise you could get dropped metrics or poor performance.
-> Batching will buffer points in memory if you have many coming in.*
+*The next three settings control how batching works.
+You should have this enabled otherwise you could get dropped metrics or poor performance.
+Batching will buffer points in memory if you have many coming in.*
-#### batch-size
+#### `batch-size = 5000`
The input will flush if this many points get buffered.
-**Default**: `5000`
-**Environment variable**: `INFLUXDB_COLLECTD_BATCH_SIZE`
+Environment variable: `INFLUXDB_COLLECTD_BATCH_SIZE`
-#### batch-pending
+#### `batch-pending = 10`
The number of batches that may be pending in memory.
-**Default**: `10`
-**Environment variable**: `INFLUXDB_COLLECTD_BATCH_PENDING`
+Environment variable: `INFLUXDB_COLLECTD_BATCH_PENDING`
-#### batch-timeout
+#### `batch-timeout = "10s"`
-The input will flush at least this often even if it hasn't reached the
-configured batch-size.
+The input will flush at least this often even if it hasn't reached the configured batch-size.
-**Default**: `"10s"`
-**Environment variable**: `INFLUXDB_COLLECTD_BATCH_TIMEOUT`
+Environment variable: `INFLUXDB_COLLECTD_BATCH_TIMEOUT`
-#### read-buffer
+#### `read-buffer = 0`
-UDP read buffer size, `0` means OS default. The UDP listener will fail if set
-above the OS maximum.
+UDP Read buffer size, 0 means OS default.
+UDP listener will fail if set above OS max.
-**Default**: `0`
-**Environment variable**: `INFLUXDB_COLLECTD_READ_BUFFER`
+Environment variable: `INFLUXDB_COLLECTD_READ_BUFFER`
-#### parse-multivalue-plugin
+#### `parse-multivalue-plugin = "split"`
-When set to `split`, multi-value plugin data (e.g., `df free:5000,used:1000`)
-will be split into separate measurements (e.g., `(df_free, value=5000)`
-`(df_used, value=1000)`). When set to `join`, multi-value plugin data will be
-stored as a single multi-value measurement (e.g., `(df, free=5000,used=1000)`).
-
-**Default**: `"split"`
-**Environment variable**: `INFLUXDB_COLLECTD_PARSE_MULTIVALUE_PLUGIN`
+When set to `split`, multi-value plugin data (e.g. df free:5000,used:1000) will be split into separate measurements (e.g., (df_free, value=5000) (df_used, value=1000)). When set to `join`, multi-value plugin will be stored as a single multi-value measurement (e.g., (df, free=5000,used=1000)). Defaults to `split`.
-----
## OpenTSDB settings
-### [[opentsdb]]
+### `[[opentsdb]]`
Controls the listener for OpenTSDB data.
For more information, see [OpenTSDB protocol support in InfluxDB](/influxdb/v1/supported_protocols/opentsdb/).
-#### enabled
+#### `enabled = false`
Set to `true` to enable openTSDB writes.
-**Default**: `false`
-**Environment variable**: `INFLUXDB_OPENTSDB_0_ENABLED`
+Environment variable: `INFLUXDB_OPENTSDB_0_ENABLED`
-#### bind-address {#opentsdb-bind-address}
+#### `bind-address = ":4242"`
The default port.
-**Default**: `":4242"`
-**Environment variable**: `INFLUXDB_OPENTSDB_BIND_ADDRESS`
+Environment variable: `INFLUXDB_OPENTSDB_BIND_ADDRESS`
-#### database
+#### `database = "opentsdb"`
-The name of the database that you want to write to. If the database does not
-exist, it will be created automatically when the input is initialized.
+The name of the database that you want to write to.
+If the database does not exist, it will be created automatically when the input is initialized.
-**Default**: `"opentsdb"`
-**Environment variable**: `INFLUXDB_OPENTSDB_DATABASE`
+Environment variable: `INFLUXDB_OPENTSDB_DATABASE`
-#### retention-policy
+#### `retention-policy = ""`
-The relevant retention policy. An empty string is equivalent to the
-database's `DEFAULT` retention policy.
+The relevant retention policy.
+An empty string is equivalent to the database's `DEFAULT` retention policy.
-**Default**: `""`
-**Environment variable**: `INFLUXDB_OPENTSDB_RETENTION_POLICY`
+Environment variable: `INFLUXDB_OPENTSDB_RETENTION_POLICY`
-#### consistency-level
+#### `consistency-level = "one"`
Sets the write consistency level: `any`, `one`, `quorum`, or `all` for writes.
-**Default**: `"one"`
-**Environment variable**: `INFLUXDB_OPENTSDB_CONSISTENCY_LEVEL`
+Environment variable: `INFLUXDB_OPENTSDB_CONSISTENCY_LEVEL`
-#### tls-enabled
+#### `tls-enabled = false`
-Enable TLS for openTSDB writes.
+Environment variable: `INFLUXDB_OPENTSDB_TLS_ENABLED`
-**Default**: `false`
-**Environment variable**: `INFLUXDB_OPENTSDB_TLS_ENABLED`
+#### `certificate = "/etc/ssl/influxdb.pem"`
-#### certificate
+Environment variable: `INFLUXDB_OPENTSDB_CERTIFICATE`
-The path to the SSL certificate file to use when TLS is enabled.
-
-**Default**: `"/etc/ssl/influxdb.pem"`
-**Environment variable**: `INFLUXDB_OPENTSDB_CERTIFICATE`
-
-#### log-point-errors
+#### `log-point-errors = true`
Log an error for every malformed point.
-**Default**: `true`
-**Environment variable**: `INFLUXDB_OPENTSDB_0_LOG_POINT_ERRORS`
+Environment variable: `INFLUXDB_OPENTSDB_0_LOG_POINT_ERRORS`
-> [!Important]
-> The next three settings control how batching works.
-> You should have this enabled otherwise you could get dropped metrics or poor performance.
-> Only points metrics received over the telnet protocol undergo batching.*
+*The next three settings control how batching works.
+You should have this enabled otherwise you could get dropped metrics or poor performance.
+Only points metrics received over the telnet protocol undergo batching.*
-#### batch-size
+#### `batch-size = 1000`
The input will flush if this many points get buffered.
-**Default**: `1000`
-**Environment variable**: `INFLUXDB_OPENTSDB_BATCH_SIZE`
+Environment variable: `INFLUXDB_OPENTSDB_BATCH_SIZE`
-#### batch-pending
+#### `batch-pending = 5`
The number of batches that may be pending in memory.
-**Default**: `5`
-**Environment variable**: `INFLUXDB_OPENTSDB_BATCH_PENDING`
+Environment variable: `INFLUXDB_OPENTSDB_BATCH_PENDING`
-#### batch-timeout
+#### `batch-timeout = "1s"`
-The input will flush at least this often even if it hasn't reached the
-configured batch-size.
+The input will flush at least this often even if it hasn't reached the configured batch-size.
+
+Environment variable: `INFLUXDB_OPENTSDB_BATCH_TIMEOUT`
-**Default**: `"1s"`
-**Environment variable**: `INFLUXDB_OPENTSDB_BATCH_TIMEOUT`
-----
## UDP settings
-### [[udp]]
+### `[[udp]]`
The `[[udp]]` settings control the listeners for InfluxDB line protocol data using UDP.
For more information, see [UDP protocol support in InfluxDB](/influxdb/v1/supported_protocols/udp/).
-#### enabled
+#### `enabled = false`
-Determines whether UDP listeners are enabled. To enable writes over UDP, set
-the value to `true`.
+Determines whether UDP listeners are enabled.
+To enable writes over UDP, set the value to `true`.
-**Default**: `false`
-**Environment variable**: `INFLUXDB_UDP_ENABLED`
+Environment variable: `INFLUXDB_UDP_ENABLED`
-#### bind-address {#udp-bind-address}
+#### `bind-address = ":8089"`
An empty string is equivalent to `0.0.0.0`.
-**Default**: `":8089"`
-**Environment variable**: `INFLUXDB_UDP_BIND_ADDRESS`
+Environment variable: `INFLUXDB_UDP_BIND_ADDRESS`
-#### database
+#### `database = "udp"`
The name of the database that you want to write to.
-**Default**: `"udp"`
-**Environment variable**: `INFLUXDB_UDP_DATABASE`
+Environment variable: `INFLUXDB_UDP_DATABASE`
-#### retention-policy
+#### `retention-policy = ""`
-The relevant retention policy for your data. An empty string is equivalent to
-the database's `DEFAULT` retention policy.
+The relevant retention policy for your data.
+An empty string is equivalent to the database's `DEFAULT` retention policy.
-**Default**: `""`
-**Environment variable**: `INFLUXDB_UDP_RETENTION_POLICY`
+Environment variable: `INFLUXDB_UDP_RETENTION_POLICY`
-> [!Important]
-> The next three settings control how batching works.
-> You should have this enabled otherwise you could get dropped metrics or poor performance.
-> Batching will buffer points in memory if you have many coming in.*
+*The next three settings control how batching works.
+You should have this enabled otherwise you could get dropped metrics or poor performance.
+Batching will buffer points in memory if you have many coming in.*
-#### batch-size
+#### `batch-size = 5000`
The input will flush if this many points get buffered.
-**Default**: `5000`
-**Environment variable**: `INFLUXDB_UDP_0_BATCH_SIZE`
+Environment variable: `INFLUXDB_UDP_0_BATCH_SIZE`
-#### batch-pending
+#### `batch-pending = 10`
The number of batches that may be pending in memory.
-**Default**: `10`
-**Environment variable**: `INFLUXDB_UDP_0_BATCH_PENDING`
+Environment variable: `INFLUXDB_UDP_0_BATCH_PENDING`
-#### batch-timeout
+#### `batch-timeout = "1s"`
-The input will flush at least this often even if it hasn't reached the
-configured batch-size.
+The input will flush at least this often even if it hasn't reached the configured batch-size.
-**Default**: `"1s"`
-**Environment variable**: `INFLUXDB_UDP_BATCH_TIMEOUT`
+Environment variable: `INFLUXDB_UDP_BATCH_TIMEOUT`
-#### read-buffer
+#### `read-buffer = 0`
-UDP read buffer size, `0` means OS default. The UDP listener will fail if set
-above the OS maximum.
+UDP read buffer size, 0 means OS default.
+UDP listener will fail if set above OS max.
-**Default**: `0`
-**Environment variable**: `INFLUXDB_UDP_BATCH_SIZE`
+Environment variable: `INFLUXDB_UDP_BATCH_SIZE`
-#### precision
+#### `precision = ""`
-[Time precision](/influxdb/v1/query_language/spec/#durations) used when
-decoding time values. Defaults to `nanoseconds`, which is the default of the
-database.
+[Time precision](/influxdb/v1/query_language/spec/#durations) used when decoding time values. Defaults to `nanoseconds` which is the default of the database.
-**Default**: `""`
-**Environment variable**: `INFLUXDB_UDP_PRECISION`
+Environment variable: `INFLUXDB_UDP_PRECISION`
-----
## Continuous queries settings
-### [continuous_queries]
+### `[continuous_queries]`
-The `[continuous_queries]` settings control how
-[continuous queries (CQs)](/influxdb/v1/concepts/glossary/#continuous-query-cq)
-run within InfluxDB. Continuous queries are automated batches of queries that
-execute over recent time intervals. InfluxDB executes one auto-generated query
-per `GROUP BY time()` interval.
+The `[continuous_queries]` settings control how [continuous queries (CQs)](/influxdb/v1/concepts/glossary/#continuous-query-cq) run within InfluxDB.
+Continuous queries are automated batches of queries that execute over recent time intervals.
+InfluxDB executes one auto-generated query per `GROUP BY time()` interval.
-#### enabled
+#### `enabled = true`
Set to `false` to disable CQs.
-**Default**: `true`
-**Environment variable**: `INFLUXDB_CONTINUOUS_QUERIES_ENABLED`
+Environment variable: `INFLUXDB_CONTINUOUS_QUERIES_ENABLED`
-#### log-enabled
+#### `log-enabled = true`
Set to `false` to disable logging for CQ events.
-**Default**: `true`
-**Environment variable**: `INFLUXDB_CONTINUOUS_QUERIES_LOG_ENABLED`
+Environment variable: `INFLUXDB_CONTINUOUS_QUERIES_LOG_ENABLED`
-#### query-stats-enabled
+#### `query-stats-enabled = false`
-When set to `true`, continuous query execution statistics are written to the
-default monitor store.
+When set to true, continuous query execution statistics are written to the default monitor store.
-**Default**: `false`
-**Environment variable**: `INFLUXDB_CONTINUOUS_QUERIES_QUERY_STATS_ENABLED`
+Environment variable: `INFLUXDB_CONTINUOUS_QUERIES_QUERY_STATS_ENABLED`
-#### run-interval
+#### `run-interval = "1s"`
-The interval at which InfluxDB checks to see if a CQ needs to run. Set this
-option to the lowest interval at which your CQs run. For example, if your most
-frequent CQ runs every minute, set `run-interval` to `1m`.
+The interval at which InfluxDB checks to see if a CQ needs to run. Set this option to the lowest interval at which your CQs run. For example, if your most frequent CQ runs every minute, set `run-interval` to `1m`.
-**Default**: `"1s"`
-**Environment variable**: `INFLUXDB_CONTINUOUS_QUERIES_RUN_INTERVAL`
+Environment variable: `INFLUXDB_CONTINUOUS_QUERIES_RUN_INTERVAL`
-----
## Transport Layer Security (TLS) settings
-### [tls]
+### `[tls]`
Global configuration settings for Transport Layer Security (TLS) in InfluxDB.
For more information, see [Enabling HTTPS](/influxdb/v1/administration/https_setup/).
If the TLS configuration settings is not specified,
-InfluxDB supports all of the cipher suite IDs listed and all TLS versions
-implemented in the [Constants section of the Go `crypto/tls` package documentation](https://golang.org/pkg/crypto/tls/#pkg-constants),
+InfluxDB supports all of the cipher suite IDs listed and all TLS versions implemented in the [Constants section of the Go `crypto/tls` package documentation](https://golang.org/pkg/crypto/tls/#pkg-constants),
depending on the version of Go used to build InfluxDB.
Use the `SHOW DIAGNOSTICS` command to see the version of Go used to build InfluxDB.
### Recommended server configuration for "modern compatibility"
-InfluxData recommends configuring your InfluxDB server's TLS settings for
-"modern compatibility." This provides a higher level of security and assumes
-that backward compatibility is not required. Our recommended TLS configuration
-settings for `ciphers`, `min-version`, and `max-version` are based on Mozilla's
-"modern compatibility" TLS server configuration described in
-[Security/Server Side TLS](https://wiki.mozilla.org/Security/Server_Side_TLS#Modern_compatibility).
+InfluxData recommends configuring your InfluxDB server's TLS settings for "modern compatibility."
+This provides a higher level of security and assumes that backward compatibility is not required.
+Our recommended TLS configuration settings for `ciphers`, `min-version`, and `max-version` are based on Mozilla's "modern compatibility" TLS server configuration
+described in [Security/Server Side TLS](https://wiki.mozilla.org/Security/Server_Side_TLS#Modern_compatibility).
-InfluxData's recommended TLS settings for "modern compatibility" are specified
-in the following configuration settings example:
+InfluxData's recommended TLS settings for "modern compatibility" are specified in the following configuration settings example:
-```toml
-[tls]
-ciphers = [
- "TLS_AES_128_GCM_SHA256",
- "TLS_AES_256_GCM_SHA384",
- "TLS_CHACHA20_POLY1305_SHA256"
+```
+ciphers = [ "TLS_AES_128_GCM_SHA256",
+ "TLS_AES_256_GCM_SHA384",
+ "TLS_CHACHA20_POLY1305_SHA256"
]
+
min-version = "tls1.3"
+
max-version = "tls1.3"
```
+> **Important:** The order of the cipher suite IDs in the `ciphers` setting determines which algorithms are selected by priority.
+> The TLS `min-version` and the `max-version` settings restrict support to TLS 1.3.
-> [!Important]
-> The order of the cipher suite IDs in the `ciphers` setting determines which
-> algorithms are selected by priority. The TLS `min-version` and the
-> `max-version` settings restrict support to TLS 1.3.
+#### `ciphers = [ "TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305", "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", ]`
-#### ciphers
+Specifies the set of cipher suite IDs to negotiate.
+If not specified, `ciphers` supports all existing cipher suite IDs listed in the Go `crypto/tls` package.
+This is consistent with the behavior within previous releases.
+In this example, only the two specified cipher suite IDs would be supported.
-Specifies the set of cipher suite IDs to negotiate. If not specified, `ciphers`
-supports all existing cipher suite IDs listed in the Go `crypto/tls` package.
-This is consistent with the behavior within previous releases. In this example,
-only the two specified cipher suite IDs would be supported.
+Environment variable: `INFLUXDB_TLS_CIPHERS`
-**Default**: `["TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305", "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256"]`
-**Environment variable**: `INFLUXDB_TLS_CIPHERS`
+#### `min-version = "tls1.0"`
-#### min-version
+Minimum version of the TLS protocol that will be negotiated. Valid values include: `tls1.0`, `tls1.1`, `tls1.2`, and `tls1.3`.
+If not specified, `min-version` is the minimum TLS version specified in the [Go `crypto/tls` package](https://golang.org/pkg/crypto/tls/#pkg-constants).
+In this example, `tls1.0` specifies the minimum version as TLS 1.0, which is consistent with the behavior of previous InfluxDB releases.
-Minimum version of the TLS protocol that will be negotiated. Valid values
-include: `tls1.0`, `tls1.1`, `tls1.2`, and `tls1.3`. If not specified,
-`min-version` is the minimum TLS version specified in the
-[Go `crypto/tls` package](https://golang.org/pkg/crypto/tls/#pkg-constants).
-In this example, `tls1.0` specifies the minimum version as TLS 1.0, which is
-consistent with the behavior of previous InfluxDB releases.
+Environment variable: `INFLUXDB_TLS_MIN_VERSION`
-**Default**: `"tls1.0"`
-**Environment variable**: `INFLUXDB_TLS_MIN_VERSION`
+#### `max-version = "tls1.3"`
-#### max-version
+The maximum version of the TLS protocol that will be negotiated.
+Valid values include: `tls1.0`, `tls1.1`, `tls1.2`, and `tls1.3`.
+If not specified, `max-version` is the maximum TLS version specified in the [Go `crypto/tls` package](https://golang.org/pkg/crypto/tls/#pkg-constants).
+In this example, `tls1.3` specifies the maximum version as TLS 1.3, which is consistent with the behavior of previous InfluxDB releases.
-The maximum version of the TLS protocol that will be negotiated. Valid values
-include: `tls1.0`, `tls1.1`, `tls1.2`, and `tls1.3`. If not specified,
-`max-version` is the maximum TLS version specified in the
-[Go `crypto/tls` package](https://golang.org/pkg/crypto/tls/#pkg-constants).
-In this example, `tls1.3` specifies the maximum version as TLS 1.3, which is
-consistent with the behavior of previous InfluxDB releases.
-
-**Default**: `tls1.3`
-**Environment variable**: `INFLUXDB_TLS_MAX_VERSION`
+Environment variable: `INFLUXDB_TLS_MAX_VERSION`
diff --git a/content/influxdb/v1/administration/ports.md b/content/influxdb/v1/administration/ports.md
index 5252e4ccf..c6884a4ad 100644
--- a/content/influxdb/v1/administration/ports.md
+++ b/content/influxdb/v1/administration/ports.md
@@ -12,14 +12,14 @@ menu:
### `8086`
The default port that runs the InfluxDB HTTP service.
-[Configure this port](/influxdb/v1/administration/config#http-bind-address)
+[Configure this port](/influxdb/v1/administration/config#bind-address-8086)
in the configuration file.
**Resources** [API Reference](/influxdb/v1/tools/api/)
### 8088
The default port used by the RPC service for RPC calls made by the CLI for backup and restore operations (`influxdb backup` and `influxd restore`).
-[Configure this port](/influxdb/v1/administration/config#rpc-bind-address)
+[Configure this port](/influxdb/v1/administration/config#bind-address-127-0-0-1-8088)
in the configuration file.
**Resources** [Backup and Restore](/influxdb/v1/administration/backup_and_restore/)
@@ -29,7 +29,7 @@ in the configuration file.
### 2003
The default port that runs the Graphite service.
-[Enable and configure this port](/influxdb/v1/administration/config#graphite-bind-address)
+[Enable and configure this port](/influxdb/v1/administration/config#bind-address-2003)
in the configuration file.
**Resources** [Graphite README](https://github.com/influxdata/influxdb/tree/1.8/services/graphite/README.md)
@@ -37,7 +37,7 @@ in the configuration file.
### 4242
The default port that runs the OpenTSDB service.
-[Enable and configure this port](/influxdb/v1/administration/config#opentsdb-bind-address)
+[Enable and configure this port](/influxdb/v1/administration/config#bind-address-4242)
in the configuration file.
**Resources** [OpenTSDB README](https://github.com/influxdata/influxdb/tree/1.8/services/opentsdb/README.md)
@@ -45,7 +45,7 @@ in the configuration file.
### 8089
The default port that runs the UDP service.
-[Enable and configure this port](/influxdb/v1/administration/config#udp-bind-address)
+[Enable and configure this port](/influxdb/v1/administration/config#bind-address-8089)
in the configuration file.
**Resources** [UDP README](https://github.com/influxdata/influxdb/tree/1.8/services/udp/README.md)
@@ -53,7 +53,7 @@ in the configuration file.
### 25826
The default port that runs the Collectd service.
-[Enable and configure this port](/influxdb/v1/administration/config#collectd-bind-address)
+[Enable and configure this port](/influxdb/v1/administration/config#bind-address-25826)
in the configuration file.
**Resources** [Collectd README](https://github.com/influxdata/influxdb/tree/1.8/services/collectd/README.md)
diff --git a/content/influxdb/v1/administration/subscription-management.md b/content/influxdb/v1/administration/subscription-management.md
index fcc716854..20a67bbbb 100644
--- a/content/influxdb/v1/administration/subscription-management.md
+++ b/content/influxdb/v1/administration/subscription-management.md
@@ -21,7 +21,7 @@ HTTP, HTTPS, or UDP in [line protocol](/influxdb/v1/write_protocols/line_protoco
the InfluxDB subscriber service creates multiple "writers" ([goroutines](https://golangbot.com/goroutines/))
which send writes to the subscription endpoints.
-_The number of writer goroutines is defined by the [`write-concurrency`](/influxdb/v1/administration/config#write-concurrency) configuration._
+_The number of writer goroutines is defined by the [`write-concurrency`](/influxdb/v1/administration/config#write-concurrency-40) configuration._
As writes occur in InfluxDB, each subscription writer sends the written data to the
specified subscription endpoints.
diff --git a/content/influxdb/v1/concepts/file-system-layout.md b/content/influxdb/v1/concepts/file-system-layout.md
index 676b6c2e9..cacad80be 100644
--- a/content/influxdb/v1/concepts/file-system-layout.md
+++ b/content/influxdb/v1/concepts/file-system-layout.md
@@ -21,18 +21,18 @@ The InfluxDB file structure includes of the following:
### Data directory
Directory path where InfluxDB stores time series data (TSM files).
-To customize this path, use the [`[data].dir`](/influxdb/v1/administration/config/#dir-1)
+To customize this path, use the [`[data].dir`](/influxdb/v1/administration/config/#dir--varlibinfluxdbdata)
configuration option.
### WAL directory
Directory path where InfluxDB stores Write Ahead Log (WAL) files.
-To customize this path, use the [`[data].wal-dir`](/influxdb/v1/administration/config/#wal-dir)
+To customize this path, use the [`[data].wal-dir`](/influxdb/v1/administration/config/#wal-dir--varlibinfluxdbwal)
configuration option.
### Metastore directory
Directory path of the InfluxDB metastore, which stores information about users,
databases, retention policies, shards, and continuous queries.
-To customize this path, use the [`[meta].dir`](/influxdb/v1/administration/config/#dir)
+To customize this path, use the [`[meta].dir`](/influxdb/v1/administration/config/#dir--varlibinfluxdbmeta)
configuration option.
## InfluxDB configuration files
diff --git a/content/influxdb/v1/concepts/storage_engine.md b/content/influxdb/v1/concepts/storage_engine.md
index 92504a13a..257cb64f6 100644
--- a/content/influxdb/v1/concepts/storage_engine.md
+++ b/content/influxdb/v1/concepts/storage_engine.md
@@ -66,13 +66,13 @@ Deletes sent to the Cache will clear out the given key or the specific time rang
The Cache exposes a few controls for snapshotting behavior.
The two most important controls are the memory limits.
-There is a lower bound, [`cache-snapshot-memory-size`](/influxdb/v1/administration/config#cache-snapshot-memory-size), which when exceeded will trigger a snapshot to TSM files and remove the corresponding WAL segments.
-There is also an upper bound, [`cache-max-memory-size`](/influxdb/v1/administration/config#cache-max-memory-size), which when exceeded will cause the Cache to reject new writes.
+There is a lower bound, [`cache-snapshot-memory-size`](/influxdb/v1/administration/config#cache-snapshot-memory-size-25m), which when exceeded will trigger a snapshot to TSM files and remove the corresponding WAL segments.
+There is also an upper bound, [`cache-max-memory-size`](/influxdb/v1/administration/config#cache-max-memory-size-1g), which when exceeded will cause the Cache to reject new writes.
These configurations are useful to prevent out of memory situations and to apply back pressure to clients writing data faster than the instance can persist it.
The checks for memory thresholds occur on every write.
The other snapshot controls are time based.
-The idle threshold, [`cache-snapshot-write-cold-duration`](/influxdb/v1/administration/config#cache-snapshot-write-cold-duration), forces the Cache to snapshot to TSM files if it hasn't received a write within the specified interval.
+The idle threshold, [`cache-snapshot-write-cold-duration`](/influxdb/v1/administration/config#cache-snapshot-write-cold-duration-10m), forces the Cache to snapshot to TSM files if it hasn't received a write within the specified interval.
The in-memory Cache is recreated on restart by re-reading the WAL files on disk.
diff --git a/content/influxdb/v1/guides/downsample_and_retain.md b/content/influxdb/v1/guides/downsample_and_retain.md
index 1e50599c5..ed610d652 100644
--- a/content/influxdb/v1/guides/downsample_and_retain.md
+++ b/content/influxdb/v1/guides/downsample_and_retain.md
@@ -215,7 +215,7 @@ data that reside in an RP other than the `DEFAULT` RP.
Between checks, `orders` may have data that are older than two hours.
The rate at which InfluxDB checks to enforce an RP is a configurable setting,
see
-[Database Configuration](/influxdb/v1/administration/config#check-interval).
+[Database Configuration](/influxdb/v1/administration/config#check-interval-30m0s).
Using a combination of RPs and CQs, we've successfully set up our database to
automatically keep the high precision raw data for a limited time, create lower
diff --git a/content/influxdb/v1/query_language/manage-database.md b/content/influxdb/v1/query_language/manage-database.md
index 48b01229d..719075247 100644
--- a/content/influxdb/v1/query_language/manage-database.md
+++ b/content/influxdb/v1/query_language/manage-database.md
@@ -62,22 +62,17 @@ Creates a new database.
#### Syntax
```sql
-CREATE DATABASE [WITH [DURATION ] [REPLICATION ] [SHARD DURATION ] [PAST LIMIT ] [FUTURE LIMIT ] [NAME ]]
+CREATE DATABASE [WITH [DURATION ] [REPLICATION ] [SHARD DURATION ] [NAME ]]
```
#### Description of syntax
`CREATE DATABASE` requires a database [name](/influxdb/v1/troubleshooting/frequently-asked-questions/#what-words-and-characters-should-i-avoid-when-writing-data-to-influxdb).
-The `WITH`, `DURATION`, `REPLICATION`, `SHARD DURATION`, `PAST LIMIT`,
-`FUTURE LIMIT, and `NAME` clauses are optional and create a single
-[retention policy](/influxdb/v1/concepts/glossary/#retention-policy-rp)
-associated with the created database.
-If you do not specify one of the clauses after `WITH`, the relevant behavior
-defaults to the `autogen` retention policy settings.
+The `WITH`, `DURATION`, `REPLICATION`, `SHARD DURATION`, and `NAME` clauses are optional and create a single [retention policy](/influxdb/v1/concepts/glossary/#retention-policy-rp) associated with the created database.
+If you do not specify one of the clauses after `WITH`, the relevant behavior defaults to the `autogen` retention policy settings.
The created retention policy automatically serves as the database's default retention policy.
-For more information about those clauses, see
-[Retention Policy Management](/influxdb/v1/query_language/manage-database/#retention-policy-management).
+For more information about those clauses, see [Retention Policy Management](/influxdb/v1/query_language/manage-database/#retention-policy-management).
A successful `CREATE DATABASE` query returns an empty result.
If you attempt to create a database that already exists, InfluxDB does nothing and does not return an error.
@@ -92,7 +87,7 @@ If you attempt to create a database that already exists, InfluxDB does nothing a
```
The query creates a database called `NOAA_water_database`.
-[By default](/influxdb/v1/administration/config/#retention-autocreate), InfluxDB also creates the `autogen` retention policy and associates it with the `NOAA_water_database`.
+[By default](/influxdb/v1/administration/config/#retention-autocreate-true), InfluxDB also creates the `autogen` retention policy and associates it with the `NOAA_water_database`.
##### Create a database with a specific retention policy
@@ -127,25 +122,21 @@ The `DROP SERIES` query deletes all points from a [series](/influxdb/v1/concepts
and it drops the series from the index.
The query takes the following form, where you must specify either the `FROM` clause or the `WHERE` clause:
-
```sql
DROP SERIES FROM WHERE =''
```
Drop all series from a single measurement:
-
```sql
> DROP SERIES FROM "h2o_feet"
```
Drop series with a specific tag pair from a single measurement:
-
```sql
> DROP SERIES FROM "h2o_feet" WHERE "location" = 'santa_monica'
```
Drop all points in the series that have a specific tag pair from all measurements in the database:
-
```sql
> DROP SERIES WHERE "location" = 'santa_monica'
```
@@ -161,31 +152,27 @@ Unlike
You must include either the `FROM` clause, the `WHERE` clause, or both:
-```sql
+```
DELETE FROM WHERE [=''] | []
```
Delete all data associated with the measurement `h2o_feet`:
-
-```sql
+```
> DELETE FROM "h2o_feet"
```
Delete all data associated with the measurement `h2o_quality` and where the tag `randtag` equals `3`:
-
-```sql
+```
> DELETE FROM "h2o_quality" WHERE "randtag" = '3'
```
Delete all data in the database that occur before January 01, 2020:
-
-```sql
+```
> DELETE WHERE time < '2020-01-01'
```
Delete all data associated with the measurement `h2o_feet` in retention policy `one_day`:
-
-```sql
+```
> DELETE FROM "one_day"."h2o_feet"
```
@@ -194,16 +181,12 @@ A successful `DELETE` query returns an empty result.
Things to note about `DELETE`:
* `DELETE` supports
- [regular expressions](/enterprise_influxdb/v1/query_language/explore-data/#regular-expressions)
- in the `FROM` clause when specifying measurement names and in the `WHERE` clause
- when specifying tag values. It *does not* support regular expressions for the
- retention policy in the `FROM` clause.
- If deleting a series in a retention policy, `DELETE` requires that you define
- *only one* retention policy in the `FROM` clause.
-* `DELETE` does not support [fields](/influxdb/v1/concepts/glossary/#field) in
- the `WHERE` clause.
-* If you need to delete points in the future, you must specify that time period
- as `DELETE SERIES` runs for `time < now()` by default.
+[regular expressions](/influxdb/v1/query_language/explore-data/#regular-expressions)
+in the `FROM` clause when specifying measurement names and in the `WHERE` clause
+when specifying tag values. It *does not* support regular expressions for the retention policy in the `FROM` clause.
+`DELETE` requires that you define *one* retention policy in the `FROM` clause.
+* `DELETE` does not support [fields](/influxdb/v1/concepts/glossary/#field) in the `WHERE` clause.
+* If you need to delete points in the future, you must specify that time period as `DELETE SERIES` runs for `time < now()` by default. [Syntax](https://github.com/influxdata/influxdb/issues/8007)
### Delete measurements with DROP MEASUREMENT
@@ -257,9 +240,8 @@ You may disable its auto-creation in the [configuration file](/influxdb/v1/admin
### Create retention policies with CREATE RETENTION POLICY
#### Syntax
-
-```sql
-CREATE RETENTION POLICY ON DURATION REPLICATION [SHARD DURATION ] [PAST LIMIT ] [FUTURE LIMIT ] [DEFAULT]
+```
+CREATE RETENTION POLICY ON DURATION REPLICATION [SHARD DURATION ] [DEFAULT]
```
#### Description of syntax
@@ -307,28 +289,6 @@ See
[Shard group duration management](/influxdb/v1/concepts/schema_and_data_layout/#shard-group-duration-management)
for recommended configurations.
-##### `PAST LIMIT`
-
-The `PAST LIMIT` clause defines a time boundary before and relative to _now_
-in which points written to the retention policy are accepted. If a point has a
-timestamp before the specified boundary, the point is rejected and the write
-request returns a partial write error.
-
-For example, if a write request tries to write data to a retention policy with a
-`PAST LIMIT 6h` and there are points in the request with timestamps older than
-6 hours, those points are rejected.
-
-##### `FUTURE LIMIT`
-
-The `FUTURE LIMIT` clause defines a time boundary after and relative to _now_
-in which points written to the retention policy are accepted. If a point has a
-timestamp after the specified boundary, the point is rejected and the write
-request returns a partial write error.
-
-For example, if a write request tries to write data to a retention policy with a
-`FUTURE LIMIT 6h` and there are points in the request with future timestamps
-greater than 6 hours from now, those points are rejected.
-
##### `DEFAULT`
Sets the new retention policy as the default retention policy for the database.
diff --git a/content/influxdb/v1/query_language/spec.md b/content/influxdb/v1/query_language/spec.md
index b2639838c..f8563c516 100644
--- a/content/influxdb/v1/query_language/spec.md
+++ b/content/influxdb/v1/query_language/spec.md
@@ -8,6 +8,11 @@ menu:
parent: InfluxQL
aliases:
- /influxdb/v2/query_language/spec/
+ - /influxdb/v2/query_language/spec/
+ - /influxdb/v2/query_language/spec/
+ - /influxdb/v2/query_language/spec/
+ - /influxdb/v2/query_language/spec/
+ - /influxdb/v2/query_language/spec/
---
## Introduction
@@ -118,15 +123,15 @@ ALL ALTER ANY AS ASC BEGIN
BY CREATE CONTINUOUS DATABASE DATABASES DEFAULT
DELETE DESC DESTINATIONS DIAGNOSTICS DISTINCT DROP
DURATION END EVERY EXPLAIN FIELD FOR
-FROM FUTURE GRANT GRANTS GROUP GROUPS
-IN INF INSERT INTO KEY KEYS
-KILL LIMIT SHOW MEASUREMENT MEASUREMENTS NAME
-OFFSET ON ORDER PASSWORD PAST POLICY
-POLICIES PRIVILEGES QUERIES QUERY READ REPLICATION
-RESAMPLE RETENTION REVOKE SELECT SERIES SET
-SHARD SHARDS SLIMIT SOFFSET STATS SUBSCRIPTION
-SUBSCRIPTIONS TAG TO USER USERS VALUES
-WHERE WITH WRITE
+FROM GRANT GRANTS GROUP GROUPS IN
+INF INSERT INTO KEY KEYS KILL
+LIMIT SHOW MEASUREMENT MEASUREMENTS NAME OFFSET
+ON ORDER PASSWORD POLICY POLICIES PRIVILEGES
+QUERIES QUERY READ REPLICATION RESAMPLE RETENTION
+REVOKE SELECT SERIES SET SHARD SHARDS
+SLIMIT SOFFSET STATS SUBSCRIPTION SUBSCRIPTIONS TAG
+TO USER USERS VALUES WHERE WITH
+WRITE
```
If you use an InfluxQL keywords as an
@@ -378,14 +383,12 @@ create_database_stmt = "CREATE DATABASE" db_name
[ retention_policy_duration ]
[ retention_policy_replication ]
[ retention_policy_shard_group_duration ]
- [ retention_past_limit ]
- [ retention_future_limit ]
[ retention_policy_name ]
] .
```
-> [!Warning]
-> Replication factors do not serve a purpose with single node instances.
+{{% warn %}} Replication factors do not serve a purpose with single node instances.
+{{% /warn %}}
#### Examples
@@ -393,17 +396,11 @@ create_database_stmt = "CREATE DATABASE" db_name
-- Create a database called foo
CREATE DATABASE "foo"
--- Create a database called bar with a new DEFAULT retention policy and specify
--- the duration, replication, shard group duration, and name of that retention policy
+-- Create a database called bar with a new DEFAULT retention policy and specify the duration, replication, shard group duration, and name of that retention policy
CREATE DATABASE "bar" WITH DURATION 1d REPLICATION 1 SHARD DURATION 30m NAME "myrp"
--- Create a database called mydb with a new DEFAULT retention policy and specify
--- the name of that retention policy
+-- Create a database called mydb with a new DEFAULT retention policy and specify the name of that retention policy
CREATE DATABASE "mydb" WITH NAME "myrp"
-
--- Create a database called bar with a new retention policy named "myrp", and
--- specify the duration, past and future limits, and name of that retention policy
-CREATE DATABASE "bar" WITH DURATION 1d PAST LIMIT 6h FUTURE LIMIT 6h NAME "myrp"
```
### CREATE RETENTION POLICY
@@ -413,13 +410,11 @@ create_retention_policy_stmt = "CREATE RETENTION POLICY" policy_name on_clause
retention_policy_duration
retention_policy_replication
[ retention_policy_shard_group_duration ]
- [ retention_past_limit ]
- [ retention_future_limit ]
[ "DEFAULT" ] .
```
-> [!Warning]
-> Replication factors do not serve a purpose with single node instances.
+{{% warn %}} Replication factors do not serve a purpose with single node instances.
+{{% /warn %}}
#### Examples
@@ -432,9 +427,6 @@ CREATE RETENTION POLICY "10m.events" ON "somedb" DURATION 60m REPLICATION 2 DEFA
-- Create a retention policy and specify the shard group duration.
CREATE RETENTION POLICY "10m.events" ON "somedb" DURATION 60m REPLICATION 2 SHARD DURATION 30m
-
--- Create a retention policy and specify past and future limits.
-CREATE RETENTION POLICY "10m.events" ON "somedb" DURATION 12h PAST LIMIT 6h FUTURE LIMIT 6h
```
### CREATE SUBSCRIPTION
diff --git a/content/influxdb/v1/supported_protocols/prometheus.md b/content/influxdb/v1/supported_protocols/prometheus.md
index 518167c5d..f24b99361 100644
--- a/content/influxdb/v1/supported_protocols/prometheus.md
+++ b/content/influxdb/v1/supported_protocols/prometheus.md
@@ -89,7 +89,7 @@ made to match the InfluxDB data structure:
* Prometheus labels become InfluxDB tags.
* All `# HELP` and `# TYPE` lines are ignored.
* [v1.8.6 and later] Prometheus remote write endpoint drops unsupported Prometheus values (`NaN`,`-Inf`, and `+Inf`) rather than reject the entire batch.
- * If [write trace logging is enabled (`[http] write-tracing = true`)](/influxdb/v1/administration/config/#write-tracing), then summaries of dropped values are logged.
+ * If [write trace logging is enabled (`[http] write-tracing = true`)](/influxdb/v1/administration/config/#write-tracing-false), then summaries of dropped values are logged.
* If a batch of values contains values that are subsequently dropped, HTTP status code `204` is returned.
### Example: Parse Prometheus to InfluxDB
diff --git a/content/influxdb/v1/tools/api.md b/content/influxdb/v1/tools/api.md
index eb5d1fa24..6dc56de32 100644
--- a/content/influxdb/v1/tools/api.md
+++ b/content/influxdb/v1/tools/api.md
@@ -554,7 +554,7 @@ A successful [`CREATE DATABASE` query](/influxdb/v1/query_language/manage-databa
| u=\ | Optional if you haven't [enabled authentication](/influxdb/v1/administration/authentication_and_authorization/#set-up-authentication). Required if you've enabled authentication.* | Sets the username for authentication if you've enabled authentication. The user must have read access to the database. Use with the query string parameter `p`. |
\* InfluxDB does not truncate the number of rows returned for requests without the `chunked` parameter.
-That behavior is configurable; see the [`max-row-limit`](/influxdb/v1/administration/config/#max-row-limit) configuration option for more information.
+That behavior is configurable; see the [`max-row-limit`](/influxdb/v1/administration/config/#max-row-limit-0) configuration option for more information.
\** The InfluxDB API also supports basic authentication.
Use basic authentication if you've [enabled authentication](/influxdb/v1/administration/authentication_and_authorization/#set-up-authentication)
@@ -1077,7 +1077,7 @@ Errors are returned in JSON.
| 400 Bad Request | Unacceptable request. Can occur with an InfluxDB line protocol syntax error or if a user attempts to write values to a field that previously accepted a different value type. The returned JSON offers further information. |
| 401 Unauthorized | Unacceptable request. Can occur with invalid authentication credentials. |
| 404 Not Found | Unacceptable request. Can occur if a user attempts to write to a database that does not exist. The returned JSON offers further information. |
-| 413 Request Entity Too Large | Unacceptable request. It will occur if the payload of the POST request is bigger than the maximum size allowed. See [`max-body-size`](/influxdb/v1/administration/config/#max-body-size) parameter for more details.
+| 413 Request Entity Too Large | Unaccetable request. It will occur if the payload of the POST request is bigger than the maximum size allowed. See [`max-body-size`](/influxdb/v1/administration/config/#max-body-size-25000000) parameter for more details.
| 500 Internal Server Error | The system is overloaded or significantly impaired. Can occur if a user attempts to write to a retention policy that does not exist. The returned JSON offers further information. |
#### Examples
diff --git a/content/influxdb/v1/tools/influx_inspect.md b/content/influxdb/v1/tools/influx_inspect.md
index 5a217dc8f..a1edf5c03 100644
--- a/content/influxdb/v1/tools/influx_inspect.md
+++ b/content/influxdb/v1/tools/influx_inspect.md
@@ -12,10 +12,9 @@ alt_links:
Influx Inspect is an InfluxDB disk utility that can be used to:
-- View detailed information about disk shards.
-- Export data from a shard to [InfluxDB line protocol](/influxdb/v1/concepts/glossary/#influxdb-line-protocol)
- that can be inserted back into the database.
-- Convert TSM index shards to TSI index shards.
+* View detailed information about disk shards.
+* Export data from a shard to [InfluxDB line protocol](/influxdb/v1/concepts/glossary/#influxdb-line-protocol) that can be inserted back into the database.
+* Convert TSM index shards to TSI index shards.
## `influx_inspect` utility
@@ -53,9 +52,7 @@ Builds TSI (Time Series Index) disk-based shard index files and associated serie
The index is written to a temporary location until complete and then moved to a permanent location.
If an error occurs, then this operation will fall back to the original in-memory index.
-> [!Note]
-> #### For offline conversion only
->
+> ***Note:*** **For offline conversion only.**
> When TSI is enabled, new shards use the TSI indexes.
> Existing shards continue as TSM-based shards until
> converted offline.
@@ -65,9 +62,7 @@ If an error occurs, then this operation will fall back to the original in-memory
```
influx_inspect buildtsi -datadir -waldir [ options ]
```
-
-> [!Note]
-> Use the `buildtsi` command with the user account that you are going to run the database as,
+> **Note:** Use the `buildtsi` command with the user account that you are going to run the database as,
> or ensure that the permissions match after running the command.
#### Options
@@ -78,8 +73,9 @@ Optional arguments are in brackets.
The size of the batches written to the index. Default value is `10000`.
-> [!Warning]
-> Setting this value can have adverse effects on performance and heap size.
+{{% warn %}}
+**Warning:** Setting this value can have adverse effects on performance and heap size.
+{{% /warn %}}
##### `[ -compact-series-file ]`
@@ -127,7 +123,7 @@ Flag to enable output in verbose mode.
##### `-waldir `
-The directory for the [WAL (Write Ahead Log)](/influxdb/v1/concepts/file-system-layout/#wal-directory) files.
+The directory for the (WAL (Write Ahead Log)](/influxdb/v1/concepts/file-system-layout/#wal-directory) files.
Default value is `$HOME/.influxdb/wal`.
See the [file system layout](/influxdb/v1/concepts/file-system-layout/#file-system-layout)
@@ -185,9 +181,10 @@ The filename where schema data should be written. Default is `schema.json`.
Use `deletetsm -measurement` to delete a measurement in a raw TSM file (from specified shards).
Use `deletetsm -sanitize` to remove all tag and field keys containing non-printable Unicode characters in a raw TSM file (from specified shards).
-> [!Warning]
-> Use the `deletetsm` command only when your InfluxDB instance is
-> offline (`influxd` service is not running).
+{{% warn %}}
+**Warning:** Use the `deletetsm` command only when your InfluxDB instance is
+offline (`influxd` service is not running).
+{{% /warn %}}
#### Syntax
@@ -290,18 +287,18 @@ Filter data by tag value regular expression.
##### Specifying paths to the `_series` and `index` directories
```
-influx_inspect dumptsi -series-file /path/to/db/_series /path/to/index
+$ influx_inspect dumptsi -series-file /path/to/db/_series /path/to/index
```
##### Specifying paths to the `_series` directory and an `index` file
```
-influx_inspect dumptsi -series-file /path/to/db/_series /path/to/index/file0
+$ influx_inspect dumptsi -series-file /path/to/db/_series /path/to/index/file0
```
##### Specifying paths to the `_series` directory and multiple `index` files
```
-influx_inspect dumptsi -series-file /path/to/db/_series /path/to/index/file0 /path/to/index/file1 ...
+$ influx_inspect dumptsi -series-file /path/to/db/_series /path/to/index/file0 /path/to/index/file1 ...
```
### `dumptsm`
@@ -363,8 +360,8 @@ If a user writes points with timestamps set by the client, then multiple points
### `export`
-Exports all TSM files or a single TSM file in InfluxDB line protocol data format.
-The output file can be imported using the
+Exports all TSM files in InfluxDB line protocol data format.
+This output file can be imported using the
[influx](/influxdb/v1/tools/shell/#import-data-from-a-file-with-import) command.
#### Syntax
@@ -416,12 +413,9 @@ YYYY-MM-DDTHH:MM:SS-08:00
YYYY-MM-DDTHH:MM:SS+07:00
```
-> [!Note]
-> With offsets, avoid replacing the + or - sign with a Z. It may cause an error
-> or print Z (ISO 8601 behavior) instead of the time zone offset.
+> **Note:** With offsets, avoid replacing the + or - sign with a Z. It may cause an error or print Z (ISO 8601 behavior) instead of the time zone offset.
##### [ `-lponly` ]
-
Output data in line protocol format only.
Does not output data definition language (DDL) statements (such as `CREATE DATABASE`)
or DML context metadata (such as `# CONTEXT-DATABASE`).
@@ -449,11 +443,6 @@ Default value is `$HOME/.influxdb/wal`.
See the [file system layout](/influxdb/v1/concepts/file-system-layout/#file-system-layout)
for InfluxDB on your system.
-##### [ `-tsmfile ` ]
-
-Path to a single tsm file to export. This requires both `-database` and
-`-retention` to be specified.
-
#### Examples
##### Export all databases and compress the output
@@ -468,15 +457,6 @@ influx_inspect export -compress
influx_inspect export -database DATABASE_NAME -retention RETENTION_POLICY
```
-##### Export data from a single TSM file
-
-```bash
-influx_inspect export \
- -database DATABASE_NAME \
- -retention RETENTION_POLICY \
- -tsmfile TSM_FILE_NAME
-```
-
##### Output file
```bash
@@ -670,11 +650,11 @@ influx_inspect report-disk -detailed ~/.influxdb/data/
The report does the following:
-- Calculates the total exact series cardinality in the database.
-- Segments that cardinality by measurement, and emits those cardinality values.
-- Emits total exact cardinality for each shard in the database.
-- Segments for each shard the exact cardinality for each measurement in the shard.
-- Optionally limits the results in each shard to the "top n".
+* Calculates the total exact series cardinality in the database.
+* Segments that cardinality by measurement, and emits those cardinality values.
+* Emits total exact cardinality for each shard in the database.
+* Segments for each shard the exact cardinality for each measurement in the shard.
+* Optionally limits the results in each shard to the "top n".
The `reporttsi` command is primarily useful when there has been a change in cardinality
and it's not clear which measurement is responsible for this change, and further, _when_
@@ -789,8 +769,7 @@ Enables very verbose logging. Displays progress for every series key and time ra
Enables very very verbose logging. Displays progress for every series key and time range in the tombstone files. Timestamps are displayed in [RFC3339 format](https://tools.ietf.org/html/rfc3339) with nanosecond precision.
-> [!Note]
-> Higher verbosity levels override lower levels.
+> **Note on verbose logging:** Higher verbosity levels override lower levels.
## Caveats
diff --git a/content/influxdb/v1/troubleshooting/errors.md b/content/influxdb/v1/troubleshooting/errors.md
index 7ecec7a69..52b76cfe3 100644
--- a/content/influxdb/v1/troubleshooting/errors.md
+++ b/content/influxdb/v1/troubleshooting/errors.md
@@ -47,7 +47,7 @@ By default `max-series-per-database` is set to one million.
Changing the setting to `0` allows an unlimited number of series per database.
**Resources:**
-[Database Configuration](/influxdb/v1/administration/config/#max-series-per-database)
+[Database Configuration](/influxdb/v1/administration/config/#max-series-per-database-1000000)
## `error parsing query: found < >, expected identifier at line < >, char < >`
@@ -326,7 +326,7 @@ The maximum valid timestamp is `9223372036854775806` or `2262-04-11T23:47:16.854
The `cache maximum memory size exceeded` error occurs when the cached
memory size increases beyond the
-[`cache-max-memory-size` setting](/influxdb/v1/administration/config/#cache-max-memory-size)
+[`cache-max-memory-size` setting](/influxdb/v1/administration/config/#cache-max-memory-size-1g)
in the configuration file.
By default, `cache-max-memory-size` is set to 512mb.
@@ -398,15 +398,11 @@ This error occurs when the Docker container cannot read files on the host machin
#### Make host machine files readable to Docker
-1. Create a directory, and then copy files to import into InfluxDB to this directory.
-2. When you launch the Docker container, mount the new directory on the InfluxDB container by running the following command:
+ 1. Create a directory, and then copy files to import into InfluxDB to this directory.
+ 2. When you launch the Docker container, mount the new directory on the InfluxDB container by running the following command:
- ```bash
- docker run -v /dir/path/on/host:/dir/path/in/container
- ```
+ docker run -v /dir/path/on/host:/dir/path/in/container
-3. Verify the Docker container can read host machine files by running the following command:
+ 3. Verify the Docker container can read host machine files by running the following command:
- ```bash
- influx -import -path=/path/in/container
- ```
+ influx -import -path=/path/in/container
diff --git a/content/influxdb/v1/troubleshooting/frequently-asked-questions.md b/content/influxdb/v1/troubleshooting/frequently-asked-questions.md
index 936386f0f..fc67c1639 100644
--- a/content/influxdb/v1/troubleshooting/frequently-asked-questions.md
+++ b/content/influxdb/v1/troubleshooting/frequently-asked-questions.md
@@ -164,7 +164,7 @@ an RP every 30 minutes.
You may need to wait for the next RP check for InfluxDB to drop data that are
outside the RP's new `DURATION` setting.
The 30 minute interval is
-[configurable](/influxdb/v1/administration/config/#check-interval).
+[configurable](/influxdb/v1/administration/config/#check-interval-30m0s).
Second, altering both the `DURATION` and `SHARD DURATION` of an RP can result in
unexpected data retention.
@@ -623,9 +623,9 @@ Avoid using the same name for a tag and field key. If you inadvertently add the
#### Example
-1. [Launch `influx`](/influxdb/v1/tools/shell/#launch-influx).
+1. [Launch `influx`](/influxdb/v1/tools/shell/#launch-influx).
-2. Write the following points to create both a field and tag key with the same name `leaves`:
+2. Write the following points to create both a field and tag key with the same name `leaves`:
```bash
# create the `leaves` tag key
@@ -635,7 +635,7 @@ Avoid using the same name for a tag and field key. If you inadvertently add the
INSERT grape leaves=5
```
-3. If you view both keys, you'll notice that neither key includes `_1`:
+3. If you view both keys, you'll notice that neither key includes `_1`:
```bash
# show the `leaves` tag key
@@ -655,7 +655,7 @@ Avoid using the same name for a tag and field key. If you inadvertently add the
leaves float
```
-4. If you query the `grape` measurement, you'll see the `leaves` tag key has an appended `_1`:
+4. If you query the `grape` measurement, you'll see the `leaves` tag key has an appended `_1`:
```bash
# query the `grape` measurement
@@ -668,7 +668,7 @@ Avoid using the same name for a tag and field key. If you inadvertently add the
1574128238044155000 5.00
```
-5. To query a duplicate key name, you **must drop** `_1` **and include** `::tag` or `::field` after the key:
+5. To query a duplicate key name, you **must drop** `_1` **and include** `::tag` or `::field` after the key:
```bash
# query duplicate keys using the correct syntax
@@ -693,9 +693,9 @@ the allotted memory.
#### Remove a duplicate key
-1. [Launch `influx`](/influxdb/v1/tools/shell/#launch-influx).
+1. [Launch `influx`](/influxdb/v1/tools/shell/#launch-influx).
-2. Use the following queries to remove a duplicate key.
+2. Use the following queries to remove a duplicate key.
```sql
@@ -1093,39 +1093,39 @@ time az hostname val_1 val_2
To store both points:
-- Introduce an arbitrary new tag to enforce uniqueness.
+* Introduce an arbitrary new tag to enforce uniqueness.
- Old point: `cpu_load,hostname=server02,az=us_west,uniq=1 val_1=24.5,val_2=7 1234567890000000`
+ Old point: `cpu_load,hostname=server02,az=us_west,uniq=1 val_1=24.5,val_2=7 1234567890000000`
- New point: `cpu_load,hostname=server02,az=us_west,uniq=2 val_1=5.24 1234567890000000`
+ New point: `cpu_load,hostname=server02,az=us_west,uniq=2 val_1=5.24 1234567890000000`
- After writing the new point to InfluxDB:
+ After writing the new point to InfluxDB:
- ```sql
- > SELECT * FROM "cpu_load" WHERE time = 1234567890000000
- name: cpu_load
- --------------
- time az hostname uniq val_1 val_2
- 1970-01-15T06:56:07.89Z us_west server02 1 24.5 7
- 1970-01-15T06:56:07.89Z us_west server02 2 5.24
- ```
+```sql
+> SELECT * FROM "cpu_load" WHERE time = 1234567890000000
+name: cpu_load
+--------------
+time az hostname uniq val_1 val_2
+1970-01-15T06:56:07.89Z us_west server02 1 24.5 7
+1970-01-15T06:56:07.89Z us_west server02 2 5.24
+```
-- Increment the timestamp by a nanosecond.
+* Increment the timestamp by a nanosecond.
- Old point: `cpu_load,hostname=server02,az=us_west val_1=24.5,val_2=7 1234567890000000`
+ Old point: `cpu_load,hostname=server02,az=us_west val_1=24.5,val_2=7 1234567890000000`
- New point: `cpu_load,hostname=server02,az=us_west val_1=5.24 1234567890000001`
+ New point: `cpu_load,hostname=server02,az=us_west val_1=5.24 1234567890000001`
- After writing the new point to InfluxDB:
+ After writing the new point to InfluxDB:
- ```sql
- > SELECT * FROM "cpu_load" WHERE time >= 1234567890000000 and time <= 1234567890000001
- name: cpu_load
- --------------
- time az hostname val_1 val_2
- 1970-01-15T06:56:07.89Z us_west server02 24.5 7
- 1970-01-15T06:56:07.890000001Z us_west server02 5.24
- ```
+```sql
+> SELECT * FROM "cpu_load" WHERE time >= 1234567890000000 and time <= 1234567890000001
+name: cpu_load
+--------------
+time az hostname val_1 val_2
+1970-01-15T06:56:07.89Z us_west server02 24.5 7
+1970-01-15T06:56:07.890000001Z us_west server02 5.24
+```
## What newline character does the InfluxDB API require?
@@ -1207,29 +1207,27 @@ To keep regular expressions and quoting simple, avoid using the following charac
## When should I single quote and when should I double quote when writing data?
-- Avoid single quoting and double quoting identifiers when writing data via the
- line protocol; see the examples below for how writing identifiers with quotes
- can complicate queries. Identifiers are database names, retention policy
- names, user names, measurement names, tag keys, and field keys.
+* Avoid single quoting and double quoting identifiers when writing data via the line protocol; see the examples below for how writing identifiers with quotes can complicate queries.
+Identifiers are database names, retention policy names, user names, measurement names, tag keys, and field keys.
- Write with a double-quoted measurement: `INSERT "bikes" bikes_available=3`
- Applicable query: `SELECT * FROM "\"bikes\""`
+ Write with a double-quoted measurement: `INSERT "bikes" bikes_available=3`
+ Applicable query: `SELECT * FROM "\"bikes\""`
- Write with a single-quoted measurement: `INSERT 'bikes' bikes_available=3`
- Applicable query: `SELECT * FROM "\'bikes\'"`
+ Write with a single-quoted measurement: `INSERT 'bikes' bikes_available=3`
+ Applicable query: `SELECT * FROM "\'bikes\'"`
- Write with an unquoted measurement: `INSERT bikes bikes_available=3`
- Applicable query: `SELECT * FROM "bikes"`
+ Write with an unquoted measurement: `INSERT bikes bikes_available=3`
+ Applicable query: `SELECT * FROM "bikes"`
-- Double quote field values that are strings.
+* Double quote field values that are strings.
- Write: `INSERT bikes happiness="level 2"`
- Applicable query: `SELECT * FROM "bikes" WHERE "happiness"='level 2'`
+ Write: `INSERT bikes happiness="level 2"`
+ Applicable query: `SELECT * FROM "bikes" WHERE "happiness"='level 2'`
-- Special characters should be escaped with a backslash and not placed in quotes.
+* Special characters should be escaped with a backslash and not placed in quotes.
- Write: `INSERT wacky va\"ue=4`
- Applicable query: `SELECT "va\"ue" FROM "wacky"`
+ Write: `INSERT wacky va\"ue=4`
+ Applicable query: `SELECT "va\"ue" FROM "wacky"`
For more information , see [Line protocol](/influxdb/v1/write_protocols/).
@@ -1257,6 +1255,6 @@ The default shard group duration is one week and if your data cover several hund
Having an extremely high number of shards is inefficient for InfluxDB.
Increase the shard group duration for your data’s retention policy with the [`ALTER RETENTION POLICY` query](/influxdb/v1/query_language/manage-database/#modify-retention-policies-with-alter-retention-policy).
-Second, temporarily lowering the [`cache-snapshot-write-cold-duration` configuration setting](/influxdb/v1/administration/config/#cache-snapshot-write-cold-duration).
+Second, temporarily lowering the [`cache-snapshot-write-cold-duration` configuration setting](/influxdb/v1/administration/config/#cache-snapshot-write-cold-duration-10m).
If you’re writing a lot of historical data, the default setting (`10m`) can cause the system to hold all of your data in cache for every shard.
Temporarily lowering the `cache-snapshot-write-cold-duration` setting to `10s` while you write the historical data makes the process more efficient.
diff --git a/content/platform/monitoring/influxdata-platform/tools/measurements-internal.md b/content/platform/monitoring/influxdata-platform/tools/measurements-internal.md
index 8a027b218..67cc9a7b0 100644
--- a/content/platform/monitoring/influxdata-platform/tools/measurements-internal.md
+++ b/content/platform/monitoring/influxdata-platform/tools/measurements-internal.md
@@ -541,9 +541,6 @@ The number of Flux query requests served.
#### fluxQueryReqDurationNs
The duration (wall-time), in nanoseconds, spent executing Flux query requests.
-#### fluxQueryRespBytes
-The sum of all bytes returned in Flux query responses.
-
#### pingReq
The number of times InfluxDB HTTP server served the `/ping` HTTP endpoint.
diff --git a/data/products.yml b/data/products.yml
index a18134816..831b4b70f 100644
--- a/data/products.yml
+++ b/data/products.yml
@@ -85,7 +85,7 @@ influxdb:
latest: v2.7
latest_patches:
v2: 2.7.11
- v1: 1.12.0
+ v1: 1.11.8
latest_cli:
v2: 2.7.5
ai_sample_questions:
@@ -155,9 +155,9 @@ enterprise_influxdb:
menu_category: self-managed
list_order: 5
versions: [v1]
- latest: v1.12
+ latest: v1.11
latest_patches:
- v1: 1.12.0
+ v1: 1.11.8
ai_sample_questions:
- How can I configure my InfluxDB v1 Enterprise server?
- How do I replicate data between InfluxDB v1 Enterprise and OSS?
diff --git a/layouts/partials/footer/javascript.html b/layouts/partials/footer/javascript.html
index 52ab25e10..eb64ae5ad 100644
--- a/layouts/partials/footer/javascript.html
+++ b/layouts/partials/footer/javascript.html
@@ -7,12 +7,10 @@
{{ $fluxGroupKeys := resources.Get "js/flux-group-keys.js" }}
{{ $dateTime := resources.Get "js/datetime.js" }}
{{ $homepageInteractions := resources.Get "js/home-interactions.js" }}
-{{ $codePlaceholders := resources.Get "/js/code-placeholders.js" }}
{{ $releaseTOC := resources.Get "/js/release-toc.js" }}
{{ $footerjs := slice $versionSelector $searchInteractions $listFilters $featureCallouts $keybindings $homepageInteractions | resources.Concat "js/footer.bundle.js" | resources.Fingerprint }}
{{ $fluxGroupKeyjs := $fluxGroupKeys | resources.Fingerprint }}
{{ $dateTimejs := $dateTime | resources.Fingerprint }}
-{{ $codePlaceholdersjs := $codePlaceholders | resources.Fingerprint }}
{{ $releaseTOCjs := $releaseTOC | resources.Fingerprint }}
@@ -50,11 +48,6 @@
{{ end }}
-
-{{ if .Page.HasShortcode "code-placeholders" }}
-
-{{ end }}
-
{{ if .Page.HasShortcode "release-toc" }}
diff --git a/layouts/shortcodes/code-placeholders.html b/layouts/shortcodes/code-placeholders.html
index 85920b3b9..b7e0b1801 100644
--- a/layouts/shortcodes/code-placeholders.html
+++ b/layouts/shortcodes/code-placeholders.html
@@ -1,6 +1,6 @@
{{- $regex := .Get 0 -}}
{{- $color := .Get 1 | default "magenta" -}}
-{{- $elReplace := print "$0
" -}}
+{{- $elReplace := print "$0
" -}}
{{- $code := .Inner | markdownify -}}
{{- $codePlaceholders := replaceRE $regex $elReplace $code -}}
{{ $codePlaceholders | safeHTML }}
\ No newline at end of file