From fb4d8722a8d9dbcee04887d26947c7900b9fed5d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20Bedn=C3=A1=C5=99?= Date: Tue, 3 Mar 2026 15:09:38 +0100 Subject: [PATCH 01/27] Release Kapacitor v1.8.3 (#6899) --- .../v1/reference/about_the_project/release-notes.md | 6 ++++++ data/products.yml | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/content/kapacitor/v1/reference/about_the_project/release-notes.md b/content/kapacitor/v1/reference/about_the_project/release-notes.md index d1d852996..82d0bb4c0 100644 --- a/content/kapacitor/v1/reference/about_the_project/release-notes.md +++ b/content/kapacitor/v1/reference/about_the_project/release-notes.md @@ -9,6 +9,12 @@ aliases: - /kapacitor/v1/about_the_project/releasenotes-changelog/ --- +## v1.8.3 {date="2026-03-03"} + +### Dependency updates + +- Upgrade Go to 1.25.7. + ## v1.8.2 {date="2025-09-29"} ### Features diff --git a/data/products.yml b/data/products.yml index e9522e81f..1a0cbdca5 100644 --- a/data/products.yml +++ b/data/products.yml @@ -306,7 +306,7 @@ kapacitor: versions: [v1] latest: v1.8 latest_patches: - v1: 1.8.2 + v1: 1.8.3 ai_sample_questions: - How do I configure Kapacitor for InfluxDB v1? - How do I write a custom task for Kapacitor? From 3f34f43627aa020ef175883d68bf77f475a93ec0 Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Wed, 4 Mar 2026 11:52:42 -0600 Subject: [PATCH 02/27] Fix line break between `influxdb3` and "CLI" in write-data intro (#6902) * Initial plan * Remove line separation between influxdb3 and CLI in write-data page Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> --- content/shared/influxdb3-write-guides/_index.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/content/shared/influxdb3-write-guides/_index.md b/content/shared/influxdb3-write-guides/_index.md index b44267edf..5d8f0724c 100644 --- a/content/shared/influxdb3-write-guides/_index.md +++ b/content/shared/influxdb3-write-guides/_index.md @@ -1,5 +1,4 @@ -Use tools like the {{% show-in "cloud-dedicated,clustered" %}}`influxctl`{{% /show-in %}}{{% show-in "cloud-serverless" %}}`influx`{{% /show-in %}}{{% show-in "core,enterprise" %}}`influxdb3`{{% /show-in %}} -CLI, Telegraf, and InfluxDB client libraries +Use tools like the {{% show-in "cloud-dedicated,clustered" %}}`influxctl`{{% /show-in %}}{{% show-in "cloud-serverless" %}}`influx`{{% /show-in %}}{{% show-in "core,enterprise" %}}`influxdb3`{{% /show-in %}} CLI, Telegraf, and InfluxDB client libraries to write time series data to {{< product-name >}}. [line protocol](#line-protocol) is the text-based format used to write data to InfluxDB. From 765f669d06923d0f4dc05a18466d27ce824cc015 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Fri, 6 Mar 2026 08:11:11 -0600 Subject: [PATCH 03/27] feat(influxdb3): document --checkpoint-interval serve option (#6896) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * feat(influxdb3): document --checkpoint-interval serve option Add documentation for the previously undocumented --checkpoint-interval flag, which aggregates WAL snapshot files into monthly checkpoint files to significantly reduce server startup time. Changes: - config-options.md: add checkpoint-interval entry in the WAL section, including description, default (disabled), env var, and usage example - performance-tuning.md: add "Startup optimization" section explaining the startup-time tradeoff and recommended intervals by scenario Closes #6884 https://claude.ai/code/session_01BArJYJTXBsUjNcdTJVyg6v * docs(influxdb3): add version metadata to checkpoint-interval heading (#6897) * Initial plan * feat(influxdb3): add version metadata to checkpoint-interval heading Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> * Apply suggestions from code review * fix(workflows): trigger pr-preview on ready_for_review event (#6898) * Initial plan * fix(workflows): trigger pr-preview on ready_for_review event Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> * Update content/shared/influxdb3-cli/config-options.md * fix(influxdb3): remove WAL snapshot conflation and add release note - Replace "WAL snapshot files" with "snapshots" shorthand, linking to backup-restore file structure on first use - Simplify "snapshot files"→"snapshots" and "checkpoint files"→"checkpoints" throughout checkpoint-interval and startup optimization sections - Add checkpoint-interval feature to v3.8.2 release notes Addresses review feedback from #6896. * Update content/shared/influxdb3-cli/config-options.md --------- Co-authored-by: Claude Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> --- .github/workflows/pr-preview.yml | 2 +- .../influxdb3-admin/performance-tuning.md | 48 +++++++++++++++++++ .../shared/influxdb3-cli/config-options.md | 41 ++++++++++++++++ .../_index.md | 1 + 4 files changed, 91 insertions(+), 1 deletion(-) diff --git a/.github/workflows/pr-preview.yml b/.github/workflows/pr-preview.yml index 0eb5d6b42..18c8ca378 100644 --- a/.github/workflows/pr-preview.yml +++ b/.github/workflows/pr-preview.yml @@ -2,7 +2,7 @@ name: PR Preview on: pull_request: - types: [opened, reopened, synchronize, closed] + types: [opened, reopened, synchronize, closed, ready_for_review] paths: - 'content/**' - 'layouts/**' diff --git a/content/shared/influxdb3-admin/performance-tuning.md b/content/shared/influxdb3-admin/performance-tuning.md index 3ed16c6e6..45201eb65 100644 --- a/content/shared/influxdb3-admin/performance-tuning.md +++ b/content/shared/influxdb3-admin/performance-tuning.md @@ -12,6 +12,7 @@ based on your workload characteristics. {{% /show-in %}} - [Memory tuning](#memory-tuning) - [Advanced tuning options](#advanced-tuning-options) +- [Startup optimization](#startup-optimization) - [Monitoring and validation](#monitoring-and-validation) - [Common performance issues](#common-performance-issues-1) @@ -577,6 +578,53 @@ For all available configuration options, see: - [CLI serve command reference](/influxdb3/version/reference/cli/influxdb3/serve/) - [Configuration options](/influxdb3/version/reference/config-options/) +## Startup optimization + +Server startup time scales with the number of +[snapshots](/influxdb3/version/admin/backup-restore/#file-structure) +stored in the object store. +Snapshots accumulate over time and are not automatically deleted. + +Without checkpointing, the server loads individual snapshots on startup. +The number of snapshots is determined by the lookback window +([`gen1-lookback-duration`](/influxdb3/version/reference/config-options/#gen1-lookback-duration), +default 1 month) divided by +[`gen1-duration`](/influxdb3/version/reference/config-options/#gen1-duration) +(default 10 minutes), with a minimum of 100. +With default settings, a long-running server can accumulate up to ~4,320 +snapshots, causing slow restarts. + +Two configuration options reduce startup time: + +- [`--checkpoint-interval`](/influxdb3/version/reference/config-options/#checkpoint-interval)-- + periodically consolidates snapshot metadata into monthly checkpoints. + On startup, the server loads one to two checkpoints per calendar month, + then loads only snapshots created since the last checkpoint. +- [`--gen1-lookback-duration`](/influxdb3/version/reference/config-options/#gen1-lookback-duration)-- + limits how far back the server loads gen1 file index metadata on startup. + Files outside this window still exist in object storage but are not indexed. + +> [!Note] +> Enabling checkpointing does not delete old snapshots. +> They remain in object storage but are no longer needed for startup. + +### Recommended checkpoint intervals + +| Scenario | Recommended interval | +| :------- | :------------------- | +| Production servers | `1h` | +| Development / testing | `10m` | + +### Enable checkpoint creation + + +```bash +influxdb3 serve --checkpoint-interval 1h +``` + +For all checkpoint configuration options, see +[checkpoint-interval](/influxdb3/version/reference/config-options/#checkpoint-interval). + ## Monitoring and validation ### Monitor thread utilization diff --git a/content/shared/influxdb3-cli/config-options.md b/content/shared/influxdb3-cli/config-options.md index 8cf4ebca4..d82eafaba 100644 --- a/content/shared/influxdb3-cli/config-options.md +++ b/content/shared/influxdb3-cli/config-options.md @@ -1227,6 +1227,7 @@ percentage (portion of available memory) or absolute value in MB--for example: ` ### Write-Ahead Log (WAL) +- [checkpoint-interval](#checkpoint-interval) - [wal-flush-interval](#wal-flush-interval) - [wal-snapshot-size](#wal-snapshot-size) - [wal-max-write-buffer-size](#wal-max-write-buffer-size) @@ -1234,6 +1235,46 @@ percentage (portion of available memory) or absolute value in MB--for example: ` - [wal-replay-fail-on-error](#wal-replay-fail-on-error) - [wal-replay-concurrency-limit](#wal-replay-concurrency-limit) +#### checkpoint-interval {#checkpoint-interval metadata="v3.8.2+"} + +Sets the interval for consolidating +[snapshots](/influxdb3/version/admin/backup-restore/#file-structure) into +monthly checkpoints for faster server startup. +Snapshots accumulate in object storage over time and are not automatically deleted. + +Without checkpointing, the server loads individual snapshots on startup. +The number of snapshots is determined by the lookback window +([`gen1-lookback-duration`](#gen1-lookback-duration), default 1 month) +divided by [`gen1-duration`](#gen1-duration) (default 10 minutes), +with a minimum of 100. +With default settings, that can be up to ~4,320 snapshots. + +With checkpointing enabled, the server periodically consolidates snapshot +metadata into checkpoints in object storage. +On startup, the server loads one to two checkpoints per calendar month, +then loads only snapshots created since the last checkpoint. +Enabling checkpointing does not delete old snapshots. + +Up to 10 checkpoints load concurrently during startup. +The server retains two checkpoints per calendar month and handles month rollovers automatically. + +Accepts a [duration](/influxdb3/version/reference/glossary/#duration) value--for example: `1h`, `30m`, `10m`. + +**Default:** _Not set (disabled)_ + +| influxdb3 serve option | Environment variable | +| :---------------------- | :------------------------------ | +| `--checkpoint-interval` | `INFLUXDB3_CHECKPOINT_INTERVAL` | + +##### Example + + +```bash +influxdb3 serve --checkpoint-interval 1h +``` + +*** + #### wal-flush-interval Specifies the interval to flush buffered data to a WAL file. Writes that wait diff --git a/content/shared/v3-core-enterprise-release-notes/_index.md b/content/shared/v3-core-enterprise-release-notes/_index.md index c8e747da3..07503f63c 100644 --- a/content/shared/v3-core-enterprise-release-notes/_index.md +++ b/content/shared/v3-core-enterprise-release-notes/_index.md @@ -40,6 +40,7 @@ - **`_internal` database default retention**: The `_internal` system database now defaults to a 7-day retention period (previously infinite). Only admin tokens can modify retention on the `_internal` database. +- **Snapshot checkpointing for faster startup**: Use the new [`--checkpoint-interval`](/influxdb3/version/reference/config-options/#checkpoint-interval) serve option to periodically consolidate snapshots into monthly checkpoints. On startup, the server loads one to two checkpoints per calendar month instead of thousands of individual snapshots, reducing startup time for long-running servers. #### Bug fixes From e1e7e222426fa586258821be1510ae4c781a7adf Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Sun, 8 Mar 2026 17:15:32 -0500 Subject: [PATCH 04/27] feat(influxdb3): rename API specs and add download links (#6906) Rename Core and Enterprise OpenAPI spec files from ref.yml to descriptive names (influxdb3-core-openapi.yaml, influxdb3-enterprise-openapi.yaml). Copy specs to static/openapi/ and add download links in the API description. --- api-docs/generate-api-docs.sh | 4 +- api-docs/influxdb3/core/.config.yml | 2 +- api-docs/influxdb3/core/v3/content/info.yml | 5 +- .../v3/influxdb3-core-openapi.yaml} | 3505 ++++++++------- api-docs/influxdb3/enterprise/.config.yml | 2 +- .../influxdb3/enterprise/v3/content/info.yml | 5 +- .../v3/influxdb3-enterprise-openapi.yaml | 3799 +++++++++++++++++ .../openapi/influxdb3-core-openapi.yaml | 3441 ++++++++------- .../openapi/influxdb3-enterprise-openapi.yaml | 3799 +++++++++++++++++ 9 files changed, 11448 insertions(+), 3114 deletions(-) rename api-docs/influxdb3/{enterprise/v3/ref.yml => core/v3/influxdb3-core-openapi.yaml} (77%) create mode 100644 api-docs/influxdb3/enterprise/v3/influxdb3-enterprise-openapi.yaml rename api-docs/influxdb3/core/v3/ref.yml => static/openapi/influxdb3-core-openapi.yaml (72%) create mode 100644 static/openapi/influxdb3-enterprise-openapi.yaml diff --git a/api-docs/generate-api-docs.sh b/api-docs/generate-api-docs.sh index 1e7820a7e..f603bb2af 100755 --- a/api-docs/generate-api-docs.sh +++ b/api-docs/generate-api-docs.sh @@ -70,7 +70,7 @@ function generateHtml { local specbundle=redoc-static_index.html # Define the temporary file for the Hugo template and Redoc HTML. local tmpfile="${productVersion}-${api}_index.tmp" - + echo "Bundling $specPath" # Use npx to install and run the specified version of redoc-cli. @@ -83,9 +83,9 @@ function generateHtml { --title="$title" \ --options.sortPropsAlphabetically \ --options.menuToggle \ - --options.hideDownloadButton \ --options.hideHostname \ --options.noAutoAuth \ + --options.hideDownloadButton \ --output=$specbundle \ --templateOptions.description="$shortDescription" \ --templateOptions.product="$productVersion" \ diff --git a/api-docs/influxdb3/core/.config.yml b/api-docs/influxdb3/core/.config.yml index 14792e219..d492b29ed 100644 --- a/api-docs/influxdb3/core/.config.yml +++ b/api-docs/influxdb3/core/.config.yml @@ -7,7 +7,7 @@ x-influxdata-product-name: InfluxDB 3 Core apis: v3@3: - root: v3/ref.yml + root: v3/influxdb3-core-openapi.yaml x-influxdata-docs-aliases: - /influxdb3/core/api/ - /influxdb3/core/api/v1/ diff --git a/api-docs/influxdb3/core/v3/content/info.yml b/api-docs/influxdb3/core/v3/content/info.yml index 34e55186e..107c08b13 100644 --- a/api-docs/influxdb3/core/v3/content/info.yml +++ b/api-docs/influxdb3/core/v3/content/info.yml @@ -21,10 +21,7 @@ description: | - `/`: Compatibility endpoints for InfluxDB v1 workloads and clients - `/api/v2/write`: Compatibility endpoint for InfluxDB v2 workloads and clients - + [Download the OpenAPI specification](/openapi/influxdb3-core-openapi.yaml) license: name: MIT url: 'https://opensource.org/licenses/MIT' diff --git a/api-docs/influxdb3/enterprise/v3/ref.yml b/api-docs/influxdb3/core/v3/influxdb3-core-openapi.yaml similarity index 77% rename from api-docs/influxdb3/enterprise/v3/ref.yml rename to api-docs/influxdb3/core/v3/influxdb3-core-openapi.yaml index 8a813ac3e..f41334147 100644 --- a/api-docs/influxdb3/enterprise/v3/ref.yml +++ b/api-docs/influxdb3/core/v3/influxdb3-core-openapi.yaml @@ -1,27 +1,24 @@ openapi: 3.0.3 info: - title: InfluxDB 3 Enterprise API Service + title: InfluxDB 3 Core API Service description: | - The InfluxDB HTTP API for InfluxDB 3 Enterprise provides a programmatic interface for - interacting with InfluxDB 3 Enterprise databases and resources. + The InfluxDB HTTP API for InfluxDB 3 Core provides a programmatic interface for + interacting with InfluxDB 3 Core databases and resources. Use this API to: - - Write data to InfluxDB 3 Enterprise databases + - Write data to InfluxDB 3 Core databases - Query data using SQL or InfluxQL - Process data using Processing engine plugins - Manage databases, tables, and Processing engine triggers - Perform administrative tasks and access system information The API includes endpoints under the following paths: - - `/api/v3`: InfluxDB 3 Enterprise native endpoints + - `/api/v3`: InfluxDB 3 Core native endpoints - `/`: Compatibility endpoints for InfluxDB v1 workloads and clients - `/api/v2/write`: Compatibility endpoint for InfluxDB v2 workloads and clients - - version: '3.7.0' + [Download the OpenAPI specification](/openapi/influxdb3-core-openapi.yaml) + version: v3.8.0 license: name: MIT url: https://opensource.org/licenses/MIT @@ -29,15 +26,16 @@ info: name: InfluxData url: https://www.influxdata.com email: support@influxdata.com + x-source-hash: sha256:1259b96096eab6c8dbf3f76c974924f124e9b3e08eedc6b0c9a66d3108857c52 servers: - url: https://{baseurl} - description: InfluxDB 3 Enterprise API URL + description: InfluxDB 3 Core API URL variables: baseurl: enum: - localhost:8181 default: localhost:8181 - description: InfluxDB 3 Enterprise URL + description: InfluxDB 3 Core URL security: - BearerAuthentication: [] - TokenAuthentication: [] @@ -56,8 +54,13 @@ tags: | [Querystring authentication](#section/Authentication/QuerystringAuthentication) | v1 endpoints | x-traitTag: true + x-related: + - title: Authenticate v1 API requests + href: /influxdb3/core/guides/api-compatibility/v1/ + - title: Manage tokens + href: /influxdb3/core/admin/tokens/ - name: Cache data - description: | + description: |- Manage the in-memory cache. #### Distinct Value Cache @@ -84,76 +87,126 @@ tags: what fields to cache, what tags to use to identify each series, and the number of values to cache for each unique series. An LVC is associated with a table, which can have multiple LVCs. - - #### Related guides - - - [Manage the Distinct Value Cache](/influxdb3/enterprise/admin/distinct-value-cache/) - - [Manage the Last Value Cache](/influxdb3/enterprise/admin/last-value-cache/) + x-related: + - title: Manage the Distinct Value Cache + href: /influxdb3/core/admin/distinct-value-cache/ + - title: Manage the Last Value Cache + href: /influxdb3/core/admin/last-value-cache/ - name: Compatibility endpoints - description: | + description: > InfluxDB 3 provides compatibility endpoints for InfluxDB 1.x and InfluxDB 2.x workloads and clients. + ### Write data using v1- or v2-compatible endpoints + - [`/api/v2/write` endpoint](#operation/PostV2Write) for InfluxDB v2 clients and when you bring existing InfluxDB v2 write workloads to InfluxDB 3. - - [`/write` endpoint](#operation/PostV1Write) for InfluxDB v1 clients and when you bring existing InfluxDB v1 write workloads to InfluxDB 3. + - [`/write` endpoint](#operation/PostV1Write) for InfluxDB v1 clients and when you bring existing InfluxDB v1 + write workloads to InfluxDB 3. + For new workloads, use the [`/api/v3/write_lp` endpoint](#operation/PostWriteLP). + All endpoints accept the same line protocol format. + ### Query data - Use the HTTP [`/query`](#operation/GetV1ExecuteQuery) endpoint for InfluxDB v1 clients and v1 query workloads using InfluxQL. + + Use the HTTP [`/query`](#operation/GetV1ExecuteQuery) endpoint for InfluxDB v1 clients and v1 query workloads + using InfluxQL. + For new workloads, use one of the following: + - HTTP [`/api/v3/query_sql` endpoint](#operation/GetExecuteQuerySQL) for new query workloads using SQL. - - HTTP [`/api/v3/query_influxql` endpoint](#operation/GetExecuteInfluxQLQuery) for new query workloads using InfluxQL. - - Flight SQL and InfluxDB 3 _Flight+gRPC_ APIs for querying with SQL or InfluxQL. For more information about using Flight APIs, see [InfluxDB 3 client libraries](https://github.com/InfluxCommunity?q=influxdb3&type=public&language=&sort=). + + - HTTP [`/api/v3/query_influxql` endpoint](#operation/GetExecuteInfluxQLQuery) for new query workloads using + InfluxQL. + + - Flight SQL and InfluxDB 3 _Flight+gRPC_ APIs for querying with SQL or InfluxQL. For more information about using + Flight APIs, see [InfluxDB 3 client + libraries](https://github.com/InfluxCommunity?q=influxdb3&type=public&language=&sort=). + ### Server information - Server information endpoints such as `/health` and `metrics` are compatible with InfluxDB 1.x and InfluxDB 2.x clients. + + Server information endpoints such as `/health` and `metrics` are compatible with InfluxDB 1.x and InfluxDB 2.x + clients. + x-related: + - title: Use compatibility APIs to write data + href: /influxdb3/core/write-data/http-api/compatibility-apis/ - name: Database description: Manage databases - - description: | + - description: > Most InfluxDB API endpoints require parameters in the request--for example, specifying the database to use. + ### Common parameters + The following table shows common parameters used by many InfluxDB API endpoints. + Many endpoints may require other parameters in the query string or in the + request body that perform functions specific to those endpoints. + | Query parameter | Value type | Description | + |:------------------------ |:--------------------- |:-------------------------------------------| + | `db` | string | The database name | + InfluxDB HTTP API endpoints use standard HTTP request and response headers. + The following table shows common headers used by many InfluxDB API endpoints. + Some endpoints may use other headers that perform functions more specific to those endpoints--for example, - the write endpoints accept the `Content-Encoding` header to indicate that line protocol is compressed in the request body. + + the write endpoints accept the `Content-Encoding` header to indicate that line protocol is compressed in the + request body. + | Header | Value type | Description | + |:------------------------ |:--------------------- |:-------------------------------------------| + | `Accept` | string | The content type that the client can understand. | + | `Authorization` | string | The authorization scheme and credential. | + | `Content-Length` | integer | The size of the entity-body, in bytes. | + | `Content-Type` | string | The format of the data in the request body. | name: Headers and parameters x-traitTag: true - name: Processing engine - description: | + description: > Manage Processing engine triggers, test plugins, and send requests to trigger On Request plugins. - InfluxDB 3 Enterprise provides the InfluxDB 3 processing engine, an embedded Python VM that can dynamically load and trigger Python plugins in response to events in your database. + + InfluxDB 3 Core provides the InfluxDB 3 processing engine, an embedded Python VM that can dynamically load and + trigger Python plugins in response to events in your database. + Use Processing engine plugins and triggers to run code and perform tasks for different database events. - To get started with the processing engine, see the [Processing engine and Python plugins](/influxdb3/enterprise/processing-engine/) guide. + + To get started with the processing engine, see the [Processing engine and Python + plugins](/influxdb3/core/processing-engine/) guide. + x-related: + - title: Processing engine and Python plugins + href: /influxdb3/core/plugins/ - name: Query data description: Query data using SQL or InfluxQL + x-related: + - title: Use the InfluxDB v1 HTTP query API and InfluxQL to query data + href: /influxdb3/core/query-data/execute-queries/influxdb-v1-api/ - name: Quick start description: | 1. [Create an admin token](#section/Authentication) to authorize API requests. @@ -195,7 +248,7 @@ tags: {"room":"Living room","temp":71.5,"time":"2025-02-25T20:19:34.984098"} ``` - For more information about using InfluxDB 3 Enterprise, see the [Get started](/influxdb3/enterprise/get-started/) guide. + For more information about using InfluxDB 3 Core, see the [Get started](/influxdb3/core/get-started/) guide. x-traitTag: true - name: Server information description: Retrieve server metrics, status, and version information @@ -219,157 +272,79 @@ tags: | **Milliseconds** | ✅ `ms` | ✅ `ms` | ✅ `millisecond` | | **Microseconds** | ✅ `u` or `µ` | ✅ `us` | ✅ `microsecond` | | **Nanoseconds** | ✅ `ns` | ✅ `ns` | ✅ `nanosecond` | - | **Minutes** | ✅ `m` | ❌ No | ❌ No | - | **Hours** | ✅ `h` | ❌ No | ❌ No | | **Default** | Nanosecond | Nanosecond | **Auto** (guessed) | All timestamps are stored internally as nanoseconds. paths: - /write: - post: - operationId: PostV1Write - summary: Write line protocol (v1-compatible) + /api/v1/health: + get: + operationId: GetHealthV1 + summary: Health check (v1) description: | - Writes line protocol to the specified database. + Checks the status of the service. - This endpoint provides backward compatibility for InfluxDB 1.x write workloads using tools such as InfluxDB 1.x client libraries, the Telegraf `outputs.influxdb` output plugin, or third-party tools. + Returns `OK` if the service is running. This endpoint does not return version information. + Use the [`/ping`](#operation/GetPing) endpoint to retrieve version details. - Use this endpoint to send data in [line protocol](https://docs.influxdata.com/influxdb3/enterprise/reference/syntax/line-protocol/) format to InfluxDB. - Use query parameters to specify options for writing data. - - #### Related - - - [Use compatibility APIs to write data](/influxdb3/enterprise/write-data/http-api/compatibility-apis/) - parameters: - - $ref: '#/components/parameters/dbWriteParam' - - $ref: '#/components/parameters/compatibilityPrecisionParam' - - $ref: '#/components/parameters/v1UsernameParam' - - $ref: '#/components/parameters/v1PasswordParam' - - name: rp - in: query - required: false - schema: - type: string - description: | - Retention policy name. Honored but discouraged. InfluxDB 3 doesn't use retention policies. - - name: consistency - in: query - required: false - schema: - type: string - description: | - Write consistency level. Ignored by InfluxDB 3. Provided for compatibility with InfluxDB 1.x clients. - - name: Authorization - in: header - required: false - schema: - type: string - description: | - Authorization header for token-based authentication. - Supported schemes: - - `Bearer AUTH_TOKEN` - OAuth bearer token scheme - - `Token AUTH_TOKEN` - InfluxDB v2 token scheme - - `Basic ` - Basic authentication (username is ignored) - - name: Content-Type - in: header - description: | - The content type of the request payload. - schema: - $ref: '#/components/schemas/LineProtocol' - required: false - - name: Accept - in: header - description: | - The content type that the client can understand. - Writes only return a response body if they fail (partially or completely)--for example, - due to a syntax problem or type mismatch. - schema: - type: string - default: application/json - enum: - - application/json - required: false - - $ref: '#/components/parameters/ContentEncoding' - - $ref: '#/components/parameters/ContentLength' - requestBody: - $ref: '#/components/requestBodies/lineProtocolRequestBody' + > **Note**: This endpoint requires authentication by default in InfluxDB 3 Core. responses: - '204': - description: Success ("No Content"). All data in the batch is written and queryable. - headers: - cluster-uuid: - $ref: '#/components/headers/ClusterUUID' - '400': - description: | - Bad request. Some (a _partial write_) or all of the data from the batch was rejected and not written. - If a partial write occurred, then some points from the batch are written and queryable. - - The response body: - - indicates if a partial write occurred or all data was rejected. - - contains details about the [rejected points](/influxdb3/enterprise/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. + "200": + description: Service is running. Returns `OK`. content: - application/json: - examples: - rejectedAllPoints: - summary: Rejected all points in the batch - value: | - { - "error": "write of line protocol failed", - "data": [ - { - "original_line": "dquote> home,room=Kitchen temp=hi", - "line_number": 2, - "error_message": "No fields were provided" - } - ] - } - partialWriteErrorWithRejectedPoints: - summary: Partial write rejected some points in the batch - value: | - { - "error": "partial write of line protocol occurred", - "data": [ - { - "original_line": "dquote> home,room=Kitchen temp=hi", - "line_number": 2, - "error_message": "No fields were provided" - } - ] - } - '401': - $ref: '#/components/responses/Unauthorized' - '403': - description: Access denied. - '413': - description: Request entity too large. + text/plain: + schema: + type: string + example: OK + "401": + description: Unauthorized. Authentication is required. + "500": + description: Service is unavailable. tags: + - Server information - Compatibility endpoints - - Write data - x-influxdata-guides: - - title: Use compatibility APIs to write data - href: /influxdb3/enterprise/write-data/http-api/compatibility-apis/ /api/v2/write: post: operationId: PostV2Write + responses: + "204": + description: Success ("No Content"). All data in the batch is written and queryable. + headers: + cluster-uuid: + $ref: "#/components/headers/ClusterUUID" + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "413": + description: Request entity too large. summary: Write line protocol (v2-compatible) - description: | + description: > Writes line protocol to the specified database. - This endpoint provides backward compatibility for InfluxDB 2.x write workloads using tools such as InfluxDB 2.x client libraries, the Telegraf `outputs.influxdb_v2` output plugin, or third-party tools. - Use this endpoint to send data in [line protocol](/influxdb3/enterprise/reference/syntax/line-protocol/) format to InfluxDB. + This endpoint provides backward compatibility for InfluxDB 2.x write workloads using tools such as InfluxDB 2.x + client libraries, the Telegraf `outputs.influxdb_v2` output plugin, or third-party tools. + + + Use this endpoint to send data in [line protocol](/influxdb3/core/reference/syntax/line-protocol/) format to + InfluxDB. + Use query parameters to specify options for writing data. + #### Related - - [Use compatibility APIs to write data](/influxdb3/enterprise/write-data/http-api/compatibility-apis/) + + - [Use compatibility APIs to write data](/influxdb3/core/write-data/http-api/compatibility-apis/) parameters: - name: Content-Type in: header description: | The content type of the request payload. schema: - $ref: '#/components/schemas/LineProtocol' + $ref: "#/components/schemas/LineProtocol" required: false - description: | The compression applied to the line protocol in the request payload. @@ -404,750 +379,33 @@ paths: enum: - application/json type: string - - name: db + - name: bucket in: query required: true schema: type: string - description: | + description: |- A database name. InfluxDB creates the database if it doesn't already exist, and then writes all points in the batch to the database. + + This parameter is named `bucket` for compatibility with InfluxDB v2 client libraries. - name: accept_partial in: query required: false schema: - $ref: '#/components/schemas/AcceptPartial' - - $ref: '#/components/parameters/compatibilityPrecisionParam' + $ref: "#/components/schemas/AcceptPartial" + - $ref: "#/components/parameters/compatibilityPrecisionParam" requestBody: - $ref: '#/components/requestBodies/lineProtocolRequestBody' - responses: - '204': - description: Success ("No Content"). All data in the batch is written and queryable. - headers: - cluster-uuid: - $ref: '#/components/headers/ClusterUUID' - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '403': - description: Access denied. - '413': - description: Request entity too large. + $ref: "#/components/requestBodies/lineProtocolRequestBody" tags: - Compatibility endpoints - Write data - x-influxdata-guides: - - title: Use compatibility APIs to write data - href: /influxdb3/enterprise/write-data/http-api/compatibility-apis/ - /api/v3/write_lp: - post: - operationId: PostWriteLP - summary: Write line protocol - description: | - Writes line protocol to the specified database. - - This is the native InfluxDB 3 Enterprise write endpoint that provides enhanced control - over write behavior with advanced parameters for high-performance and fault-tolerant operations. - - Use this endpoint to send data in [line protocol](/influxdb3/enterprise/reference/syntax/line-protocol/) format to InfluxDB. - Use query parameters to specify options for writing data. - - #### Features - - - **Partial writes**: Use `accept_partial=true` to allow partial success when some lines in a batch fail - - **Asynchronous writes**: Use `no_sync=true` to skip waiting for WAL synchronization, allowing faster response times but sacrificing durability guarantees - - **Flexible precision**: Automatic timestamp precision detection with `precision=auto` (default) - - #### Auto precision detection - - When you use `precision=auto` or omit the precision parameter, InfluxDB 3 automatically detects - the timestamp precision based on the magnitude of the timestamp value: - - - Timestamps < 5e9 → Second precision (multiplied by 1,000,000,000 to convert to nanoseconds) - - Timestamps < 5e12 → Millisecond precision (multiplied by 1,000,000) - - Timestamps < 5e15 → Microsecond precision (multiplied by 1,000) - - Larger timestamps → Nanosecond precision (no conversion needed) - - #### Related - - - [Use the InfluxDB v3 write_lp API to write data](/influxdb3/enterprise/write-data/http-api/v3-write-lp/) - parameters: - - $ref: '#/components/parameters/dbWriteParam' - - $ref: '#/components/parameters/accept_partial' - - $ref: '#/components/parameters/precisionParam' - - name: no_sync - in: query - schema: - $ref: '#/components/schemas/NoSync' - - name: Content-Type - in: header - description: | - The content type of the request payload. - schema: - $ref: '#/components/schemas/LineProtocol' - required: false - - name: Accept - in: header - description: | - The content type that the client can understand. - Writes only return a response body if they fail (partially or completely)--for example, - due to a syntax problem or type mismatch. - schema: - type: string - default: application/json - enum: - - application/json - required: false - - $ref: '#/components/parameters/ContentEncoding' - - $ref: '#/components/parameters/ContentLength' - requestBody: - $ref: '#/components/requestBodies/lineProtocolRequestBody' - responses: - '204': - description: Success ("No Content"). All data in the batch is written and queryable. - headers: - cluster-uuid: - $ref: '#/components/headers/ClusterUUID' - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '403': - description: Access denied. - '413': - description: Request entity too large. - '422': - description: Unprocessable entity. - x-codeSamples: - - label: cURL - Basic write - lang: Shell - source: | - curl --request POST "http://localhost:8181/api/v3/write_lp?db=sensors" \ - --header "Authorization: Bearer DATABASE_TOKEN" \ - --header "Content-Type: text/plain" \ - --data-raw "cpu,host=server01 usage=85.2 1638360000000000000" - - label: cURL - Write with millisecond precision - lang: Shell - source: | - curl --request POST "http://localhost:8181/api/v3/write_lp?db=sensors&precision=ms" \ - --header "Authorization: Bearer DATABASE_TOKEN" \ - --header "Content-Type: text/plain" \ - --data-raw "cpu,host=server01 usage=85.2 1638360000000" - - label: cURL - Asynchronous write with partial acceptance - lang: Shell - source: | - curl --request POST "http://localhost:8181/api/v3/write_lp?db=sensors&accept_partial=true&no_sync=true&precision=auto" \ - --header "Authorization: Bearer DATABASE_TOKEN" \ - --header "Content-Type: text/plain" \ - --data-raw "cpu,host=server01 usage=85.2 - memory,host=server01 used=4096" - - label: cURL - Multiple measurements with tags - lang: Shell - source: | - curl --request POST "http://localhost:8181/api/v3/write_lp?db=sensors&precision=ns" \ - --header "Authorization: Bearer DATABASE_TOKEN" \ - --header "Content-Type: text/plain" \ - --data-raw "cpu,host=server01,region=us-west usage=85.2,load=0.75 1638360000000000000 - memory,host=server01,region=us-west used=4096,free=12288 1638360000000000000 - disk,host=server01,region=us-west,device=/dev/sda1 used=50.5,free=49.5 1638360000000000000" - tags: - - Write data - /api/v3/query_sql: - get: - operationId: GetExecuteQuerySQL - summary: Execute SQL query - description: Executes an SQL query to retrieve data from the specified database. - parameters: - - $ref: '#/components/parameters/db' - - $ref: '#/components/parameters/querySqlParam' - - $ref: '#/components/parameters/format' - - $ref: '#/components/parameters/AcceptQueryHeader' - - $ref: '#/components/parameters/ContentType' - responses: - '200': - description: Success. The response body contains query results. - content: - application/json: - schema: - $ref: '#/components/schemas/QueryResponse' - example: - results: - - series: - - name: mytable - columns: - - time - - value - values: - - - '2024-02-02T12:00:00Z' - - 42 - text/csv: - schema: - type: string - application/vnd.apache.parquet: - schema: - type: string - application/jsonl: - schema: - type: string - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '403': - description: Access denied. - '404': - description: Database not found. - '405': - description: Method not allowed. - '422': - description: Unprocessable entity. - tags: - - Query data - post: - operationId: PostExecuteQuerySQL - summary: Execute SQL query - description: Executes an SQL query to retrieve data from the specified database. - parameters: - - $ref: '#/components/parameters/AcceptQueryHeader' - - $ref: '#/components/parameters/ContentType' - requestBody: - $ref: '#/components/requestBodies/queryRequestBody' - responses: - '200': - description: Success. The response body contains query results. - content: - application/json: - schema: - $ref: '#/components/schemas/QueryResponse' - text/csv: - schema: - type: string - application/vnd.apache.parquet: - schema: - type: string - application/jsonl: - schema: - type: string - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '403': - description: Access denied. - '404': - description: Database not found. - '405': - description: Method not allowed. - '422': - description: Unprocessable entity. - tags: - - Query data - /api/v3/query_influxql: - get: - operationId: GetExecuteInfluxQLQuery - summary: Execute InfluxQL query - description: Executes an InfluxQL query to retrieve data from the specified database. - parameters: - - $ref: '#/components/parameters/dbQueryParam' - - name: q - in: query - required: true - schema: - type: string - - name: format - in: query - required: false - schema: - type: string - - $ref: '#/components/parameters/AcceptQueryHeader' - responses: - '200': - description: Success. The response body contains query results. - content: - application/json: - schema: - $ref: '#/components/schemas/QueryResponse' - text/csv: - schema: - type: string - application/vnd.apache.parquet: - schema: - type: string - application/jsonl: - schema: - type: string - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '403': - description: Access denied. - '404': - description: Database not found. - '405': - description: Method not allowed. - '422': - description: Unprocessable entity. - tags: - - Query data - post: - operationId: PostExecuteQueryInfluxQL - summary: Execute InfluxQL query - description: Executes an InfluxQL query to retrieve data from the specified database. - parameters: - - $ref: '#/components/parameters/AcceptQueryHeader' - - $ref: '#/components/parameters/ContentType' - requestBody: - $ref: '#/components/requestBodies/queryRequestBody' - responses: - '200': - description: Success. The response body contains query results. - content: - application/json: - schema: - $ref: '#/components/schemas/QueryResponse' - text/csv: - schema: - type: string - application/vnd.apache.parquet: - schema: - type: string - application/jsonl: - schema: - type: string - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '403': - description: Access denied. - '404': - description: Database not found. - '405': - description: Method not allowed. - '422': - description: Unprocessable entity. - tags: - - Query data - /query: - get: - operationId: GetV1ExecuteQuery - summary: Execute InfluxQL query (v1-compatible) - description: | - Executes an InfluxQL query to retrieve data from the specified database. - - This endpoint is compatible with InfluxDB 1.x client libraries and third-party integrations such as Grafana. - Use query parameters to specify the database and the InfluxQL query. - - #### Related - - - [Use the InfluxDB v1 HTTP query API and InfluxQL to query data](/influxdb3/enterprise/query-data/execute-queries/influxdb-v1-api/) - parameters: - - name: Accept - in: header - schema: - type: string - default: application/json - enum: - - application/json - - application/csv - - text/csv - required: false - description: | - The content type that the client can understand. - - If `text/csv` is specified, the `Content-type` response header is `application/csv` and the response is formatted as CSV. - - Returns an error if the format is invalid or non-UTF8. - - in: query - name: chunked - description: | - If true, the response is divided into chunks of size `chunk_size`. - schema: - type: boolean - default: false - - in: query - name: chunk_size - description: | - The number of records that will go into a chunk. - This parameter is only used if `chunked=true`. - schema: - type: integer - default: 10000 - - in: query - name: db - description: The database to query. If not provided, the InfluxQL query string must specify the database. - schema: - type: string - format: InfluxQL - - in: query - name: pretty - description: | - If true, the JSON response is formatted in a human-readable format. - schema: - type: boolean - default: false - - in: query - name: q - description: The InfluxQL query string. - required: true - schema: - type: string - - name: epoch - description: | - Formats timestamps as [unix (epoch) timestamps](/influxdb3/enterprise/reference/glossary/#unix-timestamp) with the specified precision - instead of [RFC3339 timestamps](/influxdb3/enterprise/reference/glossary/#rfc3339-timestamp) with nanosecond precision. - in: query - schema: - $ref: '#/components/schemas/EpochCompatibility' - - $ref: '#/components/parameters/v1UsernameParam' - - $ref: '#/components/parameters/v1PasswordParam' - - name: rp - in: query - required: false - schema: - type: string - description: | - Retention policy name. Honored but discouraged. InfluxDB 3 doesn't use retention policies. - - name: Authorization - in: header - required: false - schema: - type: string - description: | - Authorization header for token-based authentication. - Supported schemes: - - `Bearer AUTH_TOKEN` - OAuth bearer token scheme - - `Token AUTH_TOKEN` - InfluxDB v2 token scheme - - `Basic ` - Basic authentication (username is ignored) - responses: - '200': - description: | - Success. The response body contains query results. - content: - application/json: - schema: - $ref: '#/components/schemas/QueryResponse' - application/csv: - schema: - type: string - headers: - Content-Type: - description: | - The content type of the response. - Default is `application/json`. - - If the `Accept` request header is `application/csv` or `text/csv`, the `Content-type` response header is `application/csv` - and the response is formatted as CSV. - schema: - type: string - default: application/json - enum: - - application/json - - application/csv - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '403': - description: Access denied. - '404': - description: Database not found. - '405': - description: Method not allowed. - '422': - description: Unprocessable entity. - tags: - - Query data - - Compatibility endpoints - x-influxdata-guides: - - title: Use the InfluxDB v1 HTTP query API and InfluxQL to query data - href: /influxdb3/enterprise/query-data/execute-queries/influxdb-v1-api/ - post: - operationId: PostExecuteV1Query - summary: Execute InfluxQL query (v1-compatible) - description: | - Executes an InfluxQL query to retrieve data from the specified database. - - #### Related - - - [Use the InfluxDB v1 HTTP query API and InfluxQL to query data](/influxdb3/enterprise/query-data/execute-queries/influxdb-v1-api/) - requestBody: - content: - application/json: - schema: - type: object - properties: - db: - type: string - description: The database to query. If not provided, the InfluxQL query string must specify the database. - q: - description: The InfluxQL query string. - type: string - chunked: - description: | - If true, the response is divided into chunks of size `chunk_size`. - type: boolean - chunk_size: - description: | - The number of records that will go into a chunk. - This parameter is only used if `chunked=true`. - type: integer - default: 10000 - epoch: - description: | - A unix timestamp precision. - - - `h` for hours - - `m` for minutes - - `s` for seconds - - `ms` for milliseconds - - `u` or `µ` for microseconds - - `ns` for nanoseconds - - Formats timestamps as [unix (epoch) timestamps](/influxdb3/enterprise/reference/glossary/#unix-timestamp) with the specified precision - instead of [RFC3339 timestamps](/influxdb3/enterprise/reference/glossary/#rfc3339-timestamp) with nanosecond precision. - enum: - - ns - - u - - µ - - ms - - s - - m - - h - type: string - pretty: - description: | - If true, the JSON response is formatted in a human-readable format. - type: boolean - required: - - q - parameters: - - name: Accept - in: header - schema: - type: string - default: application/json - enum: - - application/json - - application/csv - - text/csv - required: false - description: | - The content type that the client can understand. - - If `text/csv` is specified, the `Content-type` response header is `application/csv` and the response is formatted as CSV. - - Returns an error if the format is invalid or non-UTF8. - responses: - '200': - description: | - Success. The response body contains query results. - content: - application/json: - schema: - $ref: '#/components/schemas/QueryResponse' - application/csv: - schema: - type: string - headers: - Content-Type: - description: | - The content type of the response. - Default is `application/json`. - - If the `Accept` request header is `application/csv` or `text/csv`, the `Content-type` response header is `application/csv` - and the response is formatted as CSV. - schema: - type: string - default: application/json - enum: - - application/json - - application/csv - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '403': - description: Access denied. - '404': - description: Database not found. - '405': - description: Method not allowed. - '422': - description: Unprocessable entity. - tags: - - Query data - - Compatibility endpoints - x-influxdata-guides: - - title: Use the InfluxDB v1 HTTP query API and InfluxQL to query data - href: /influxdb3/enterprise/query-data/execute-queries/influxdb-v1-api/ - /health: - get: - operationId: GetHealth - summary: Health check - description: | - Checks the status of the service. - - Returns `OK` if the service is running. This endpoint does not return version information. - Use the [`/ping`](#operation/GetPing) endpoint to retrieve version details. - - > **Note**: This endpoint requires authentication by default in InfluxDB 3 Enterprise. - responses: - '200': - description: Service is running. Returns `OK`. - content: - text/plain: - schema: - type: string - example: OK - '401': - description: Unauthorized. Authentication is required. - '500': - description: Service is unavailable. - tags: - - Server information - /api/v1/health: - get: - operationId: GetHealthV1 - summary: Health check (v1) - description: Checks the status of the service. - responses: - '200': - description: Service is running. - '500': - description: Service is unavailable. - tags: - - Server information - - Compatibility endpoints - /ping: - get: - operationId: GetPing - tags: - - Server information - summary: Ping the server - description: | - Returns version information for the server. - - **Important**: Use a GET request. HEAD requests return `404 Not Found`. - - The response includes version information in both headers and the JSON body: - - - **Headers**: `x-influxdb-version` and `x-influxdb-build` - - **Body**: JSON object with `version`, `revision`, and `process_id` - - > **Note**: This endpoint requires authentication by default in InfluxDB 3 Enterprise. - responses: - '200': - description: Success. The response body contains server information. - headers: - x-influxdb-version: - description: The InfluxDB version number (for example, `3.8.0`). - schema: - type: string - example: '3.8.0' - x-influxdb-build: - description: The InfluxDB build type (`Core` or `Enterprise`). - schema: - type: string - example: Enterprise - content: - application/json: - schema: - type: object - properties: - version: - type: string - description: The InfluxDB version number. - example: '3.8.0' - revision: - type: string - description: The git revision hash for the build. - example: '83b589b883' - process_id: - type: string - description: A unique identifier for the server process. - example: 'b756d9e0-cecd-4f72-b6d0-19e2d4f8cbb7' - '401': - description: Unauthorized. Authentication is required. - '404': - description: | - Not Found. Returned for HEAD requests. - Use a GET request to retrieve version information. - /metrics: - get: - operationId: GetMetrics - summary: Metrics - description: Retrieves Prometheus-compatible server metrics. - responses: - '200': - description: Success. The response body contains Prometheus-compatible server metrics. - tags: - - Server information /api/v3/configure/database: - get: - operationId: GetConfigureDatabase - summary: List databases - description: Retrieves a list of databases. - parameters: - - $ref: '#/components/parameters/formatRequired' - - name: show_deleted - in: query - required: false - schema: - type: boolean - default: false - description: | - Include soft-deleted databases in the response. - By default, only active databases are returned. - responses: - '200': - description: Success. The response body contains the list of databases. - content: - application/json: - schema: - $ref: '#/components/schemas/ShowDatabasesResponse' - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '404': - description: Database not found. - tags: - - Database - post: - operationId: PostConfigureDatabase - summary: Create a database - description: Creates a new database in the system. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/CreateDatabaseRequest' - responses: - '201': - description: Success. Database created. - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '409': - description: Database already exists. - tags: - - Database delete: operationId: DeleteConfigureDatabase - summary: Delete a database - description: | - Soft deletes a database. - The database is scheduled for deletion and unavailable for querying. - Use the `hard_delete_at` parameter to schedule a hard deletion. - Use the `data_only` parameter to delete data while preserving the database schema and resources. parameters: - - $ref: '#/components/parameters/db' + - $ref: "#/components/parameters/db" - name: data_only in: query required: false @@ -1174,7 +432,7 @@ paths: schema: type: string format: date-time - description: | + description: |- Schedule the database for hard deletion at the specified time. If not provided, the database will be soft deleted. Use ISO 8601 date-time format (for example, "2025-12-31T23:59:59Z"). @@ -1183,13 +441,98 @@ paths: Deleting a database is a destructive action. Once a database is deleted, data stored in that database cannot be recovered. + + + Also accepts special string values: + - `now` — hard delete immediately + - `never` — soft delete only (default behavior) + - `default` — use the system default hard deletion time responses: - '200': + "200": description: Success. Database deleted. - '401': - $ref: '#/components/responses/Unauthorized' - '404': + "401": + $ref: "#/components/responses/Unauthorized" + "404": description: Database not found. + summary: Delete a database + description: | + Soft deletes a database. + The database is scheduled for deletion and unavailable for querying. + Use the `hard_delete_at` parameter to schedule a hard deletion. + Use the `data_only` parameter to delete data while preserving the database schema and resources. + tags: + - Database + get: + operationId: GetConfigureDatabase + responses: + "200": + description: Success. The response body contains the list of databases. + content: + application/json: + schema: + $ref: "#/components/schemas/ShowDatabasesResponse" + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Database not found. + summary: List databases + description: Retrieves a list of databases. + parameters: + - $ref: "#/components/parameters/formatRequired" + - name: show_deleted + in: query + required: false + schema: + type: boolean + default: false + description: | + Include soft-deleted databases in the response. + By default, only active databases are returned. + tags: + - Database + post: + operationId: PostConfigureDatabase + responses: + "200": + description: Success. Database created. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "409": + description: Database already exists. + summary: Create a database + description: Creates a new database in the system. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/CreateDatabaseRequest" + tags: + - Database + put: + operationId: update_database + responses: + "200": + description: Success. The database has been updated. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Database not found. + summary: Update a database + description: | + Updates database configuration, such as retention period. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateDatabaseRequest" tags: - Database /api/v3/configure/database/retention_period: @@ -1199,188 +542,32 @@ paths: description: | Removes the retention period from a database, setting it to infinite retention. parameters: - - $ref: '#/components/parameters/db' + - $ref: "#/components/parameters/db" responses: - '204': + "204": description: Success. The database retention period has been removed. - '401': - $ref: '#/components/responses/Unauthorized' - '404': + "401": + $ref: "#/components/responses/Unauthorized" + "404": description: Database not found. tags: - Database - /api/v3/configure/table: - post: - operationId: PostConfigureTable - summary: Create a table - description: Creates a new table within a database. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/CreateTableRequest' - responses: - '201': - description: Success. The table has been created. - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '404': - description: Database not found. - tags: - - Table - delete: - operationId: DeleteConfigureTable - summary: Delete a table - description: | - Soft deletes a table. - The table is scheduled for deletion and unavailable for querying. - Use the `hard_delete_at` parameter to schedule a hard deletion. - Use the `data_only` parameter to delete data while preserving the table schema and resources. - - #### Deleting a table cannot be undone - - Deleting a table is a destructive action. - Once a table is deleted, data stored in that table cannot be recovered. - parameters: - - $ref: '#/components/parameters/db' - - name: table - in: query - required: true - schema: - type: string - - name: data_only - in: query - required: false - schema: - type: boolean - default: false - description: | - Delete only data while preserving the table schema and all associated resources - (last value caches, distinct value caches). - When `false` (default), the entire table is deleted. - - name: hard_delete_at - in: query - required: false - schema: - type: string - format: date-time - description: | - Schedule the table for hard deletion at the specified time. - If not provided, the table will be soft deleted. - Use ISO 8601 format (for example, "2025-12-31T23:59:59Z"). - responses: - '200': - description: Success (no content). The table has been deleted. - '401': - $ref: '#/components/responses/Unauthorized' - '404': - description: Table not found. - tags: - - Table - patch: - operationId: PatchConfigureTable - summary: Update a table - description: | - Updates table configuration, such as retention period. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateTableRequest' - responses: - '200': - description: Success. The table has been updated. - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '404': - description: Table not found. - tags: - - Table - /api/v3/configure/database/{db}: - patch: - operationId: PatchConfigureDatabase - summary: Update a database - description: | - Updates database configuration, such as retention period. - parameters: - - name: db - in: path - required: true - schema: - type: string - description: The name of the database to update. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateDatabaseRequest' - responses: - '200': - description: Success. The database has been updated. - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '404': - description: Database not found. - tags: - - Database - /api/v3/show/license: - get: - operationId: GetShowLicense - summary: Show license information - description: | - Retrieves information about the current InfluxDB 3 Enterprise license. - responses: - '200': - description: Success. The response body contains license information. - content: - application/json: - schema: - $ref: '#/components/schemas/LicenseResponse' - '401': - $ref: '#/components/responses/Unauthorized' - '403': - description: Access denied. - tags: - - Server information /api/v3/configure/distinct_cache: - post: - operationId: PostConfigureDistinctCache - summary: Create distinct cache - description: Creates a distinct cache for a table. - tags: - - Cache data - - Table - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/DistinctCacheCreateRequest' - responses: - '201': - description: Success. The distinct cache has been created. - '204': - description: Not created. A distinct cache with this configuration already exists. - '400': - description: | - Bad request. - - The server responds with status `400` if the request would overwrite an existing cache with a different configuration. delete: operationId: DeleteConfigureDistinctCache + responses: + "200": + description: Success. The distinct cache has been deleted. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Cache not found. summary: Delete distinct cache description: Deletes a distinct cache. parameters: - - $ref: '#/components/parameters/db' + - $ref: "#/components/parameters/db" - name: table in: query required: true @@ -1393,49 +580,50 @@ paths: schema: type: string description: The name of the distinct cache to delete. - responses: - '200': - description: Success. The distinct cache has been deleted. - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '404': - description: Cache not found. tags: - Cache data - Table - /api/v3/configure/last_cache: post: - operationId: PostConfigureLastCache - summary: Create last cache - description: Creates a last cache for a table. + operationId: PostConfigureDistinctCache + responses: + "201": + description: Success. The distinct cache has been created. + "400": + description: > + Bad request. + + + The server responds with status `400` if the request would overwrite an existing cache with a different + configuration. + "409": + description: Conflict. A distinct cache with this configuration already exists. + summary: Create distinct cache + description: Creates a distinct cache for a table. requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/LastCacheCreateRequest' - responses: - '201': - description: Success. Last cache created. - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '404': - description: Cache not found. - '409': - description: Cache already exists. + $ref: "#/components/schemas/DistinctCacheCreateRequest" tags: - Cache data - Table + /api/v3/configure/last_cache: delete: operationId: DeleteConfigureLastCache + responses: + "200": + description: Success. The last cache has been deleted. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Cache not found. summary: Delete last cache description: Deletes a last cache. parameters: - - $ref: '#/components/parameters/db' + - $ref: "#/components/parameters/db" - name: table in: query required: true @@ -1448,40 +636,142 @@ paths: schema: type: string description: The name of the last cache to delete. - responses: - '200': - description: Success. The last cache has been deleted. - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '404': - description: Cache not found. tags: - Cache data - Table - /api/v3/configure/processing_engine_trigger: post: - operationId: PostConfigureProcessingEngineTrigger - summary: Create processing engine trigger - description: | - Creates a processing engine trigger with the specified plugin file and trigger specification. - - ### Related guides - - - [Processing engine and Python plugins](/influxdb3/enterprise/plugins/) + operationId: PostConfigureLastCache + responses: + "201": + description: Success. Last cache created. + "400": + description: Bad request. A cache with this name already exists or the request is malformed. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Cache not found. + summary: Create last cache + description: Creates a last cache for a table. requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/ProcessingEngineTriggerRequest' + $ref: "#/components/schemas/LastCacheCreateRequest" + tags: + - Cache data + - Table + /api/v3/configure/plugin_environment/install_packages: + post: + operationId: PostInstallPluginPackages + summary: Install plugin packages + description: |- + Installs the specified Python packages into the processing engine plugin environment. + + This endpoint is synchronous and blocks until the packages are installed. + parameters: + - $ref: "#/components/parameters/ContentType" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + packages: + type: array + items: + type: string + description: | + A list of Python package names to install. + Can include version specifiers (e.g., "scipy==1.9.0"). + example: + - influxdb3-python + - scipy + - pandas==1.5.0 + - requests + required: + - packages + example: + packages: + - influxdb3-python + - scipy + - pandas==1.5.0 + - requests + responses: + "200": + description: Success. The packages are installed. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + tags: + - Processing engine + /api/v3/configure/plugin_environment/install_requirements: + post: + operationId: PostInstallPluginRequirements + summary: Install plugin requirements + description: > + Installs requirements from a requirements file (also known as a "pip requirements file") into the processing + engine plugin environment. + + + This endpoint is synchronous and blocks until the requirements are installed. + + + ### Related + + + - [Processing engine and Python plugins](/influxdb3/core/plugins/) + + - [Python requirements file format](https://pip.pypa.io/en/stable/reference/requirements-file-format/) + parameters: + - $ref: "#/components/parameters/ContentType" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + requirements_location: + type: string + description: | + The path to the requirements file containing Python packages to install. + Can be a relative path (relative to the plugin directory) or an absolute path. + example: requirements.txt + required: + - requirements_location + example: + requirements_location: requirements.txt + responses: + "200": + description: Success. The requirements have been installed. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + tags: + - Processing engine + /api/v3/configure/processing_engine_trigger: + post: + operationId: PostConfigureProcessingEngineTrigger + summary: Create processing engine trigger + description: Creates a processing engine trigger with the specified plugin file and trigger specification. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/ProcessingEngineTriggerRequest" examples: schedule_cron: summary: Schedule trigger using cron - description: | + description: > In `"cron:CRON_EXPRESSION"`, `CRON_EXPRESSION` uses extended 6-field cron format. - The cron expression `0 0 6 * * 1-5` means the trigger will run at 6:00 AM every weekday (Monday to Friday). + + The cron expression `0 0 6 * * 1-5` means the trigger will run at 6:00 AM every weekday (Monday to + Friday). value: db: DATABASE_NAME plugin_filename: schedule.py @@ -1597,13 +887,13 @@ paths: run_async: false error_behavior: Log responses: - '200': + "200": description: Success. Processing engine trigger created. - '400': + "400": description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '404': + "401": + $ref: "#/components/responses/Unauthorized" + "404": description: Trigger not found. tags: - Processing engine @@ -1612,7 +902,7 @@ paths: summary: Delete processing engine trigger description: Deletes a processing engine trigger. parameters: - - $ref: '#/components/parameters/db' + - $ref: "#/components/parameters/db" - name: trigger_name in: query required: true @@ -1628,13 +918,13 @@ paths: Force deletion of the trigger even if it has active executions. By default, deletion fails if the trigger is currently executing. responses: - '200': + "200": description: Success. The processing engine trigger has been deleted. - '400': + "400": description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '404': + "401": + $ref: "#/components/responses/Unauthorized" + "404": description: Trigger not found. tags: - Processing engine @@ -1644,21 +934,26 @@ paths: summary: Disable processing engine trigger description: Disables a processing engine trigger. parameters: - - $ref: '#/components/parameters/ContentType' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/ProcessingEngineTriggerRequest' + - name: db + in: query + required: true + schema: + type: string + description: The database name. + - name: trigger_name + in: query + required: true + schema: + type: string + description: The name of the trigger. responses: - '200': + "200": description: Success. The processing engine trigger has been disabled. - '400': + "400": description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '404': + "401": + $ref: "#/components/responses/Unauthorized" + "404": description: Trigger not found. tags: - Processing engine @@ -1668,89 +963,192 @@ paths: summary: Enable processing engine trigger description: Enables a processing engine trigger. parameters: - - $ref: '#/components/parameters/ContentType' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/ProcessingEngineTriggerRequest' + - name: db + in: query + required: true + schema: + type: string + description: The database name. + - name: trigger_name + in: query + required: true + schema: + type: string + description: The name of the trigger. responses: - '200': + "200": description: Success. The processing engine trigger is enabled. - '400': + "400": description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '404': + "401": + $ref: "#/components/responses/Unauthorized" + "404": description: Trigger not found. tags: - Processing engine - /api/v3/configure/plugin_environment/install_packages: - post: - operationId: PostInstallPluginPackages - summary: Install plugin packages - description: | - Installs the specified Python packages into the processing engine plugin environment. - - This endpoint is synchronous and blocks until the packages are installed. - - ### Related guides - - - [Processing engine and Python plugins](/influxdb3/enterprise/plugins/) + /api/v3/configure/table: + delete: + operationId: DeleteConfigureTable parameters: - - $ref: '#/components/parameters/ContentType' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - packages: - type: array - items: - type: string - description: | - A list of Python package names to install. - Can include version specifiers (e.g., "scipy==1.9.0"). - example: - - influxdb3-python - - scipy - - pandas==1.5.0 - - requests - required: - - packages - example: - packages: - - influxdb3-python - - scipy - - pandas==1.5.0 - - requests + - $ref: "#/components/parameters/db" + - name: table + in: query + required: true + schema: + type: string + - name: data_only + in: query + required: false + schema: + type: boolean + default: false + description: | + Delete only data while preserving the table schema and all associated resources + (last value caches, distinct value caches). + When `false` (default), the entire table is deleted. + - name: hard_delete_at + in: query + required: false + schema: + type: string + format: date-time + description: |- + Schedule the table for hard deletion at the specified time. + If not provided, the table will be soft deleted. + Use ISO 8601 format (for example, "2025-12-31T23:59:59Z"). + + + Also accepts special string values: + - `now` — hard delete immediately + - `never` — soft delete only (default behavior) + - `default` — use the system default hard deletion time responses: - '200': - description: Success. The packages are installed. - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - tags: - - Processing engine - /api/v3/configure/plugin_environment/install_requirements: - post: - operationId: PostInstallPluginRequirements - summary: Install plugin requirements + "200": + description: Success (no content). The table has been deleted. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Table not found. + summary: Delete a table description: | - Installs requirements from a requirements file (also known as a "pip requirements file") into the processing engine plugin environment. + Soft deletes a table. + The table is scheduled for deletion and unavailable for querying. + Use the `hard_delete_at` parameter to schedule a hard deletion. + Use the `data_only` parameter to delete data while preserving the table schema and resources. - This endpoint is synchronous and blocks until the requirements are installed. + #### Deleting a table cannot be undone - ### Related - - - [Processing engine and Python plugins](/influxdb3/enterprise/plugins/) - - [Python requirements file format](https://pip.pypa.io/en/stable/reference/requirements-file-format/) + Deleting a table is a destructive action. + Once a table is deleted, data stored in that table cannot be recovered. + tags: + - Table + post: + operationId: PostConfigureTable + responses: + "200": + description: Success. The table has been created. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Database not found. + summary: Create a table + description: Creates a new table within a database. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/CreateTableRequest" + tags: + - Table + /api/v3/configure/token: + delete: + operationId: DeleteToken parameters: - - $ref: '#/components/parameters/ContentType' + - name: token_name + in: query + required: true + schema: + type: string + description: The name of the token to delete. + responses: + "200": + description: Success. The token has been deleted. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Token not found. + summary: Delete token + description: | + Deletes a token. + tags: + - Authentication + - Token + /api/v3/configure/token/admin: + post: + operationId: PostCreateAdminToken + responses: + "201": + description: | + Success. The admin token has been created. + The response body contains the token string and metadata. + content: + application/json: + schema: + $ref: "#/components/schemas/AdminTokenObject" + "401": + $ref: "#/components/responses/Unauthorized" + summary: Create admin token + description: | + Creates an admin token. + An admin token is a special type of token that has full access to all resources in the system. + tags: + - Authentication + - Token + /api/v3/configure/token/admin/regenerate: + post: + operationId: PostRegenerateAdminToken + summary: Regenerate admin token + description: | + Regenerates an admin token and revokes the previous token with the same name. + parameters: [] + responses: + "201": + description: Success. The admin token has been regenerated. + content: + application/json: + schema: + $ref: "#/components/schemas/AdminTokenObject" + "401": + $ref: "#/components/responses/Unauthorized" + tags: + - Authentication + - Token + /api/v3/configure/token/named_admin: + post: + operationId: PostCreateNamedAdminToken + responses: + "201": + description: | + Success. The named admin token has been created. + The response body contains the token string and metadata. + content: + application/json: + schema: + $ref: "#/components/schemas/AdminTokenObject" + "401": + $ref: "#/components/responses/Unauthorized" + "409": + description: A token with this name already exists. + summary: Create named admin token + description: | + Creates a named admin token. + A named admin token is a special type of admin token with a custom name for identification and management. + tags: + - Authentication + - Token requestBody: required: true content: @@ -1758,70 +1156,93 @@ paths: schema: type: object properties: - requirements_location: + token_name: type: string - description: | - The path to the requirements file containing Python packages to install. - Can be a relative path (relative to the plugin directory) or an absolute path. - example: requirements.txt + description: The name for the admin token. + expiry_secs: + type: integer + description: Optional expiration time in seconds. If not provided, the token does not expire. + nullable: true required: - - requirements_location - example: - requirements_location: requirements.txt - responses: - '200': - description: Success. The requirements have been installed. - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - tags: - - Processing engine - /api/v3/plugin_test/wal: - post: - operationId: PostTestWALPlugin - summary: Test WAL plugin - description: Executes a test of a write-ahead logging (WAL) plugin. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/WALPluginTestRequest' - responses: - '200': - description: Success. The plugin test has been executed. - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '404': - description: Plugin not enabled. - tags: - - Processing engine - /api/v3/plugin_test/schedule: - post: - operationId: PostTestSchedulingPlugin - summary: Test scheduling plugin - description: Executes a test of a scheduling plugin. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/SchedulePluginTestRequest' - responses: - '200': - description: Success. The plugin test has been executed. - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '404': - description: Plugin not enabled. - tags: - - Processing engine + - token_name /api/v3/engine/{request_path}: + get: + operationId: GetProcessingEnginePluginRequest + responses: + "200": + description: Success. The plugin request has been executed. + "400": + description: Malformed request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Plugin not found. + "500": + description: Processing failure. + summary: On Request processing engine plugin request + description: > + Executes the On Request processing engine plugin specified in the trigger's `plugin_filename`. + + The request can include request headers, query string parameters, and a request body, which InfluxDB passes to + the plugin. + + + An On Request plugin implements the following signature: + + + ```python + + def process_request(influxdb3_local, query_parameters, request_headers, request_body, args=None) + + ``` + + + The response depends on the plugin implementation. + tags: + - Processing engine + post: + operationId: PostProcessingEnginePluginRequest + responses: + "200": + description: Success. The plugin request has been executed. + "400": + description: Malformed request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Plugin not found. + "500": + description: Processing failure. + summary: On Request processing engine plugin request + description: > + Executes the On Request processing engine plugin specified in the trigger's `plugin_filename`. + + The request can include request headers, query string parameters, and a request body, which InfluxDB passes to + the plugin. + + + An On Request plugin implements the following signature: + + + ```python + + def process_request(influxdb3_local, query_parameters, request_headers, request_body, args=None) + + ``` + + + The response depends on the plugin implementation. + parameters: + - $ref: "#/components/parameters/ContentType" + requestBody: + required: false + content: + application/json: + schema: + type: object + additionalProperties: true + tags: + - Processing engine parameters: - name: request_path description: | @@ -1842,229 +1263,1064 @@ paths: required: true schema: type: string - get: - operationId: GetProcessingEnginePluginRequest - summary: On Request processing engine plugin request - description: | - Executes the On Request processing engine plugin specified in the trigger's `plugin_filename`. - The request can include request headers, query string parameters, and a request body, which InfluxDB passes to the plugin. - - An On Request plugin implements the following signature: - - ```python - def process_request(influxdb3_local, query_parameters, request_headers, request_body, args=None) - ``` - - The response depends on the plugin implementation. - responses: - '200': - description: Success. The plugin request has been executed. - '400': - description: Malformed request. - '401': - $ref: '#/components/responses/Unauthorized' - '404': - description: Plugin not found. - '500': - description: Processing failure. - tags: - - Processing engine + /api/v3/plugin_test/schedule: post: - operationId: PostProcessingEnginePluginRequest - summary: On Request processing engine plugin request - description: | - Executes the On Request processing engine plugin specified in the trigger's `plugin_filename`. - The request can include request headers, query string parameters, and a request body, which InfluxDB passes to the plugin. - - An On Request plugin implements the following signature: - - ```python - def process_request(influxdb3_local, query_parameters, request_headers, request_body, args=None) - ``` - - The response depends on the plugin implementation. - parameters: - - $ref: '#/components/parameters/ContentType' - requestBody: - required: false - content: - application/json: - schema: - type: object - additionalProperties: true + operationId: PostTestSchedulingPlugin responses: - '200': - description: Success. The plugin request has been executed. - '400': - description: Malformed request. - '401': - $ref: '#/components/responses/Unauthorized' - '404': - description: Plugin not found. - '500': - description: Processing failure. - tags: - - Processing engine - /api/v3/configure/enterprise/token: - post: - operationId: PostCreateResourceToken - summary: Create a resource token - description: | - Creates a resource (fine-grained permissions) token. - A resource token is a token that has access to specific resources in the system. - - This endpoint is only available in InfluxDB 3 Enterprise. - responses: - '201': - description: | - Success. The resource token has been created. - The response body contains the token string and metadata. - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceTokenObject' - '401': - $ref: '#/components/responses/Unauthorized' - tags: - - Authentication - - Token - /api/v3/configure/token/admin: - post: - operationId: PostCreateAdminToken - summary: Create admin token - description: | - Creates an admin token. - An admin token is a special type of token that has full access to all resources in the system. - responses: - '201': - description: | - Success. The admin token has been created. - The response body contains the token string and metadata. - content: - application/json: - schema: - $ref: '#/components/schemas/AdminTokenObject' - '401': - $ref: '#/components/responses/Unauthorized' - tags: - - Authentication - - Token - /api/v3/configure/token/admin/regenerate: - post: - operationId: PostRegenerateAdminToken - summary: Regenerate admin token - description: | - Regenerates an admin token and revokes the previous token with the same name. - parameters: [] - responses: - '201': - description: Success. The admin token has been regenerated. - content: - application/json: - schema: - $ref: '#/components/schemas/AdminTokenObject' - '401': - $ref: '#/components/responses/Unauthorized' - tags: - - Authentication - - Token - /api/v3/configure/token: - delete: - operationId: DeleteToken - summary: Delete token - description: | - Deletes a token. - parameters: - - name: id - in: query - required: true - schema: - type: string - description: The ID of the token to delete. - responses: - '204': - description: Success. The token has been deleted. - '401': - $ref: '#/components/responses/Unauthorized' - '404': - description: Token not found. - tags: - - Authentication - - Token - /api/v3/configure/token/named_admin: - post: - operationId: PostCreateNamedAdminToken - summary: Create named admin token - description: | - Creates a named admin token. - A named admin token is a special type of admin token with a custom name for identification and management. - parameters: - - name: name - in: query - required: true - schema: - type: string - description: The name for the admin token. - responses: - '201': - description: | - Success. The named admin token has been created. - The response body contains the token string and metadata. - content: - application/json: - schema: - $ref: '#/components/schemas/AdminTokenObject' - '401': - $ref: '#/components/responses/Unauthorized' - '409': - description: A token with this name already exists. - tags: - - Authentication - - Token - /api/v3/plugins/files: - put: - operationId: PutPluginFile - summary: Update plugin file - description: | - Updates a plugin file in the plugin directory. - x-security-note: Requires an admin token + "200": + description: Success. The plugin test has been executed. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Plugin not enabled. + summary: Test scheduling plugin + description: Executes a test of a scheduling plugin. requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/PluginFileRequest' + $ref: "#/components/schemas/SchedulePluginTestRequest" + tags: + - Processing engine + /api/v3/plugin_test/wal: + post: + operationId: PostTestWALPlugin responses: - '204': - description: Success. The plugin file has been updated. - '401': - $ref: '#/components/responses/Unauthorized' - '403': - description: Forbidden. Admin token required. + "200": + description: Success. The plugin test has been executed. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Plugin not enabled. + summary: Test WAL plugin + description: Executes a test of a write-ahead logging (WAL) plugin. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/WALPluginTestRequest" tags: - Processing engine /api/v3/plugins/directory: put: operationId: PutPluginDirectory - summary: Update plugin directory - description: | - Updates the plugin directory configuration. - x-security-note: Requires an admin token requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/PluginDirectoryRequest' + $ref: "#/components/schemas/PluginDirectoryRequest" responses: - '204': + "200": description: Success. The plugin directory has been updated. - '401': - $ref: '#/components/responses/Unauthorized' - '403': + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Forbidden. Admin token required. + "500": + description: Plugin not found. The `plugin_name` does not match any registered trigger. + summary: Update a multi-file plugin directory + description: | + Replaces all files in a multi-file plugin directory. The + `plugin_name` must match a registered trigger name. Each entry in + the `files` array specifies a `relative_path` and `content`—the + server writes them into the trigger's plugin directory. + + Use this endpoint to update multi-file plugins (directories with + `__init__.py` and supporting modules). For single-file plugins, + use `PUT /api/v3/plugins/files` instead. + tags: + - Processing engine + x-security-note: Requires an admin token + /api/v3/plugins/files: + post: + operationId: create_plugin_file + summary: Create a plugin file + description: | + Creates a single plugin file in the plugin directory. Writes the + `content` to a file named after `plugin_name`. Does not require an + existing trigger—use this to upload plugin files before creating + triggers that reference them. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/PluginFileRequest" + responses: + "200": + description: Success. The plugin file has been created. + "401": + $ref: "#/components/responses/Unauthorized" + "403": description: Forbidden. Admin token required. tags: - Processing engine + x-security-note: Requires an admin token + put: + operationId: PutPluginFile + summary: Update a plugin file + description: | + Updates a single plugin file for an existing trigger. The + `plugin_name` must match a registered trigger name—the server + resolves the trigger's `plugin_filename` and overwrites that file + with the provided `content`. + + To upload a new plugin file before creating a trigger, use + `POST /api/v3/plugins/files` instead. To update a multi-file + plugin directory, use `PUT /api/v3/plugins/directory`. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/PluginFileRequest" + responses: + "200": + description: Success. The plugin file has been updated. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Forbidden. Admin token required. + "500": + description: Plugin not found. The `plugin_name` does not match any registered trigger. + tags: + - Processing engine + x-security-note: Requires an admin token + /api/v3/query_influxql: + get: + operationId: GetExecuteInfluxQLQuery + responses: + "200": + description: Success. The response body contains query results. + content: + application/json: + schema: + $ref: "#/components/schemas/QueryResponse" + text/csv: + schema: + type: string + application/vnd.apache.parquet: + schema: + type: string + application/jsonl: + schema: + type: string + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "404": + description: Database not found. + "405": + description: Method not allowed. + "422": + description: Unprocessable entity. + summary: Execute InfluxQL query + description: Executes an InfluxQL query to retrieve data from the specified database. + parameters: + - $ref: "#/components/parameters/dbQueryParam" + - name: q + in: query + required: true + schema: + type: string + - name: format + in: query + required: false + schema: + type: string + - $ref: "#/components/parameters/AcceptQueryHeader" + - name: params + in: query + required: false + schema: + type: string + description: JSON-encoded query parameters. Use this to pass bind parameters to parameterized queries. + description: JSON-encoded query parameters for parameterized queries. + tags: + - Query data + post: + operationId: PostExecuteQueryInfluxQL + responses: + "200": + description: Success. The response body contains query results. + content: + application/json: + schema: + $ref: "#/components/schemas/QueryResponse" + text/csv: + schema: + type: string + application/vnd.apache.parquet: + schema: + type: string + application/jsonl: + schema: + type: string + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "404": + description: Database not found. + "405": + description: Method not allowed. + "422": + description: Unprocessable entity. + summary: Execute InfluxQL query + description: Executes an InfluxQL query to retrieve data from the specified database. + parameters: + - $ref: "#/components/parameters/AcceptQueryHeader" + - $ref: "#/components/parameters/ContentType" + requestBody: + $ref: "#/components/requestBodies/queryRequestBody" + tags: + - Query data + /api/v3/query_sql: + get: + operationId: GetExecuteQuerySQL + responses: + "200": + description: Success. The response body contains query results. + content: + application/json: + schema: + $ref: "#/components/schemas/QueryResponse" + example: + results: + - series: + - name: mytable + columns: + - time + - value + values: + - - "2024-02-02T12:00:00Z" + - 42 + text/csv: + schema: + type: string + application/vnd.apache.parquet: + schema: + type: string + application/jsonl: + schema: + type: string + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "404": + description: Database not found. + "405": + description: Method not allowed. + "422": + description: Unprocessable entity. + summary: Execute SQL query + description: Executes an SQL query to retrieve data from the specified database. + parameters: + - $ref: "#/components/parameters/db" + - $ref: "#/components/parameters/querySqlParam" + - $ref: "#/components/parameters/format" + - $ref: "#/components/parameters/AcceptQueryHeader" + - $ref: "#/components/parameters/ContentType" + - name: params + in: query + required: false + schema: + type: string + description: JSON-encoded query parameters. Use this to pass bind parameters to parameterized queries. + description: JSON-encoded query parameters for parameterized queries. + tags: + - Query data + post: + operationId: PostExecuteQuerySQL + responses: + "200": + description: Success. The response body contains query results. + content: + application/json: + schema: + $ref: "#/components/schemas/QueryResponse" + text/csv: + schema: + type: string + application/vnd.apache.parquet: + schema: + type: string + application/jsonl: + schema: + type: string + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "404": + description: Database not found. + "405": + description: Method not allowed. + "422": + description: Unprocessable entity. + summary: Execute SQL query + description: Executes an SQL query to retrieve data from the specified database. + parameters: + - $ref: "#/components/parameters/AcceptQueryHeader" + - $ref: "#/components/parameters/ContentType" + requestBody: + $ref: "#/components/requestBodies/queryRequestBody" + tags: + - Query data + /api/v3/write_lp: + post: + operationId: PostWriteLP + parameters: + - $ref: "#/components/parameters/dbWriteParam" + - $ref: "#/components/parameters/accept_partial" + - $ref: "#/components/parameters/precisionParam" + - name: no_sync + in: query + schema: + $ref: "#/components/schemas/NoSync" + - name: Content-Type + in: header + description: | + The content type of the request payload. + schema: + $ref: "#/components/schemas/LineProtocol" + required: false + - name: Accept + in: header + description: | + The content type that the client can understand. + Writes only return a response body if they fail (partially or completely)--for example, + due to a syntax problem or type mismatch. + schema: + type: string + default: application/json + enum: + - application/json + required: false + - $ref: "#/components/parameters/ContentEncoding" + - $ref: "#/components/parameters/ContentLength" + responses: + "204": + description: Success ("No Content"). All data in the batch is written and queryable. + headers: + cluster-uuid: + $ref: "#/components/headers/ClusterUUID" + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "413": + description: Request entity too large. + "422": + description: Unprocessable entity. + summary: Write line protocol + description: > + Writes line protocol to the specified database. + + + This is the native InfluxDB 3 Core write endpoint that provides enhanced control + + over write behavior with advanced parameters for high-performance and fault-tolerant operations. + + + Use this endpoint to send data in [line protocol](/influxdb3/core/reference/syntax/line-protocol/) format to + InfluxDB. + + Use query parameters to specify options for writing data. + + + #### Features + + + - **Partial writes**: Use `accept_partial=true` to allow partial success when some lines in a batch fail + + - **Asynchronous writes**: Use `no_sync=true` to skip waiting for WAL synchronization, allowing faster response + times but sacrificing durability guarantees + + - **Flexible precision**: Automatic timestamp precision detection with `precision=auto` (default) + + + #### Auto precision detection + + + When you use `precision=auto` or omit the precision parameter, InfluxDB 3 automatically detects + + the timestamp precision based on the magnitude of the timestamp value: + + + - Timestamps < 5e9 → Second precision (multiplied by 1,000,000,000 to convert to nanoseconds) + + - Timestamps < 5e12 → Millisecond precision (multiplied by 1,000,000) + + - Timestamps < 5e15 → Microsecond precision (multiplied by 1,000) + + - Larger timestamps → Nanosecond precision (no conversion needed) + + + #### Related + + + - [Use the InfluxDB v3 write_lp API to write data](/influxdb3/core/write-data/http-api/v3-write-lp/) + requestBody: + $ref: "#/components/requestBodies/lineProtocolRequestBody" + tags: + - Write data + x-codeSamples: + - label: cURL - Basic write + lang: Shell + source: | + curl --request POST "http://localhost:8181/api/v3/write_lp?db=sensors" \ + --header "Authorization: Bearer DATABASE_TOKEN" \ + --header "Content-Type: text/plain" \ + --data-raw "cpu,host=server01 usage=85.2 1638360000000000000" + - label: cURL - Write with millisecond precision + lang: Shell + source: | + curl --request POST "http://localhost:8181/api/v3/write_lp?db=sensors&precision=ms" \ + --header "Authorization: Bearer DATABASE_TOKEN" \ + --header "Content-Type: text/plain" \ + --data-raw "cpu,host=server01 usage=85.2 1638360000000" + - label: cURL - Asynchronous write with partial acceptance + lang: Shell + source: > + curl --request POST + "http://localhost:8181/api/v3/write_lp?db=sensors&accept_partial=true&no_sync=true&precision=auto" \ + --header "Authorization: Bearer DATABASE_TOKEN" \ + --header "Content-Type: text/plain" \ + --data-raw "cpu,host=server01 usage=85.2 + memory,host=server01 used=4096" + - label: cURL - Multiple measurements with tags + lang: Shell + source: | + curl --request POST "http://localhost:8181/api/v3/write_lp?db=sensors&precision=ns" \ + --header "Authorization: Bearer DATABASE_TOKEN" \ + --header "Content-Type: text/plain" \ + --data-raw "cpu,host=server01,region=us-west usage=85.2,load=0.75 1638360000000000000 + memory,host=server01,region=us-west used=4096,free=12288 1638360000000000000 + disk,host=server01,region=us-west,device=/dev/sda1 used=50.5,free=49.5 1638360000000000000" + /health: + get: + operationId: GetHealth + responses: + "200": + description: Service is running. Returns `OK`. + content: + text/plain: + schema: + type: string + example: OK + "401": + description: Unauthorized. Authentication is required. + "500": + description: Service is unavailable. + summary: Health check + description: | + Checks the status of the service. + + Returns `OK` if the service is running. This endpoint does not return version information. + Use the [`/ping`](#operation/GetPing) endpoint to retrieve version details. + + > **Note**: This endpoint requires authentication by default in InfluxDB 3 Core. + tags: + - Server information + /metrics: + get: + operationId: GetMetrics + responses: + "200": + description: Success + summary: Metrics + description: Retrieves Prometheus-compatible server metrics. + tags: + - Server information + /ping: + get: + operationId: GetPing + responses: + "200": + description: Success. The response body contains server information. + headers: + x-influxdb-version: + description: The InfluxDB version number (for example, `3.8.0`). + schema: + type: string + example: 3.8.0 + x-influxdb-build: + description: The InfluxDB build type (`Core` or `Enterprise`). + schema: + type: string + example: Core + content: + application/json: + schema: + type: object + properties: + version: + type: string + description: The InfluxDB version number. + example: 3.8.0 + revision: + type: string + description: The git revision hash for the build. + example: 83b589b883 + process_id: + type: string + description: A unique identifier for the server process. + example: b756d9e0-cecd-4f72-b6d0-19e2d4f8cbb7 + "401": + description: Unauthorized. Authentication is required. + "404": + description: | + Not Found. Returned for HEAD requests. + Use a GET request to retrieve version information. + x-client-method: ping + summary: Ping the server + description: | + Returns version information for the server. + + **Important**: Use a GET request. HEAD requests return `404 Not Found`. + + The response includes version information in both headers and the JSON body: + + - **Headers**: `x-influxdb-version` and `x-influxdb-build` + - **Body**: JSON object with `version`, `revision`, and `process_id` + + > **Note**: This endpoint requires authentication by default in InfluxDB 3 Core. + tags: + - Server information + post: + operationId: ping + responses: + "200": + description: Success. The response body contains server information. + headers: + x-influxdb-version: + description: The InfluxDB version number (for example, `3.8.0`). + schema: + type: string + example: 3.8.0 + x-influxdb-build: + description: The InfluxDB build type (`Core` or `Enterprise`). + schema: + type: string + example: Core + content: + application/json: + schema: + type: object + properties: + version: + type: string + description: The InfluxDB version number. + example: 3.8.0 + revision: + type: string + description: The git revision hash for the build. + example: 83b589b883 + process_id: + type: string + description: A unique identifier for the server process. + example: b756d9e0-cecd-4f72-b6d0-19e2d4f8cbb7 + "401": + description: Unauthorized. Authentication is required. + "404": + description: | + Not Found. Returned for HEAD requests. + Use a GET request to retrieve version information. + summary: Ping the server + description: Returns version information for the server. Accepts POST in addition to GET. + tags: + - Server information + /query: + get: + operationId: GetV1ExecuteQuery + responses: + "200": + description: | + Success. The response body contains query results. + content: + application/json: + schema: + $ref: "#/components/schemas/QueryResponse" + application/csv: + schema: + type: string + headers: + Content-Type: + description: > + The content type of the response. + + Default is `application/json`. + + + If the `Accept` request header is `application/csv` or `text/csv`, the `Content-type` response header is + `application/csv` + + and the response is formatted as CSV. + schema: + type: string + default: application/json + enum: + - application/json + - application/csv + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "404": + description: Database not found. + "405": + description: Method not allowed. + "422": + description: Unprocessable entity. + summary: Execute InfluxQL query (v1-compatible) + description: > + Executes an InfluxQL query to retrieve data from the specified database. + + + This endpoint is compatible with InfluxDB 1.x client libraries and third-party integrations such as Grafana. + + Use query parameters to specify the database and the InfluxQL query. + + + #### Related + + + - [Use the InfluxDB v1 HTTP query API and InfluxQL to query + data](/influxdb3/core/query-data/execute-queries/influxdb-v1-api/) + parameters: + - name: Accept + in: header + schema: + type: string + default: application/json + enum: + - application/json + - application/csv + - text/csv + required: false + description: > + The content type that the client can understand. + + + If `text/csv` is specified, the `Content-type` response header is `application/csv` and the response is + formatted as CSV. + + + Returns an error if the format is invalid or non-UTF8. + - in: query + name: chunked + description: | + If true, the response is divided into chunks of size `chunk_size`. + schema: + type: boolean + default: false + - in: query + name: chunk_size + description: | + The number of records that will go into a chunk. + This parameter is only used if `chunked=true`. + schema: + type: integer + default: 10000 + - in: query + name: db + description: The database to query. If not provided, the InfluxQL query string must specify the database. + schema: + type: string + format: InfluxQL + - in: query + name: pretty + description: | + If true, the JSON response is formatted in a human-readable format. + schema: + type: boolean + default: false + - in: query + name: q + description: The InfluxQL query string. + required: true + schema: + type: string + - name: epoch + description: > + Formats timestamps as [unix (epoch) timestamps](/influxdb3/core/reference/glossary/#unix-timestamp) with the + specified precision + + instead of [RFC3339 timestamps](/influxdb3/core/reference/glossary/#rfc3339-timestamp) with nanosecond + precision. + in: query + schema: + $ref: "#/components/schemas/EpochCompatibility" + - $ref: "#/components/parameters/v1UsernameParam" + - $ref: "#/components/parameters/v1PasswordParam" + - name: rp + in: query + required: false + schema: + type: string + description: | + Retention policy name. Honored but discouraged. InfluxDB 3 doesn't use retention policies. + - name: Authorization + in: header + required: false + schema: + type: string + description: | + Authorization header for token-based authentication. + Supported schemes: + - `Bearer AUTH_TOKEN` - OAuth bearer token scheme + - `Token AUTH_TOKEN` - InfluxDB v2 token scheme + - `Basic ` - Basic authentication (username is ignored) + tags: + - Query data + - Compatibility endpoints + post: + operationId: PostExecuteV1Query + responses: + "200": + description: | + Success. The response body contains query results. + content: + application/json: + schema: + $ref: "#/components/schemas/QueryResponse" + application/csv: + schema: + type: string + headers: + Content-Type: + description: > + The content type of the response. + + Default is `application/json`. + + + If the `Accept` request header is `application/csv` or `text/csv`, the `Content-type` response header is + `application/csv` + + and the response is formatted as CSV. + schema: + type: string + default: application/json + enum: + - application/json + - application/csv + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "404": + description: Database not found. + "405": + description: Method not allowed. + "422": + description: Unprocessable entity. + summary: Execute InfluxQL query (v1-compatible) + description: > + Executes an InfluxQL query to retrieve data from the specified database. + + + #### Related + + + - [Use the InfluxDB v1 HTTP query API and InfluxQL to query + data](/influxdb3/core/query-data/execute-queries/influxdb-v1-api/) + parameters: + - name: Accept + in: header + schema: + type: string + default: application/json + enum: + - application/json + - application/csv + - text/csv + required: false + description: > + The content type that the client can understand. + + + If `text/csv` is specified, the `Content-type` response header is `application/csv` and the response is + formatted as CSV. + + + Returns an error if the format is invalid or non-UTF8. + requestBody: + content: + application/json: + schema: + type: object + properties: + db: + type: string + description: The database to query. If not provided, the InfluxQL query string must specify the database. + q: + description: The InfluxQL query string. + type: string + chunked: + description: | + If true, the response is divided into chunks of size `chunk_size`. + type: boolean + chunk_size: + description: | + The number of records that will go into a chunk. + This parameter is only used if `chunked=true`. + type: integer + default: 10000 + epoch: + description: > + A unix timestamp precision. + + + - `h` for hours + + - `m` for minutes + + - `s` for seconds + + - `ms` for milliseconds + + - `u` or `µ` for microseconds + + - `ns` for nanoseconds + + + Formats timestamps as [unix (epoch) timestamps](/influxdb3/core/reference/glossary/#unix-timestamp) + with the specified precision + + instead of [RFC3339 timestamps](/influxdb3/core/reference/glossary/#rfc3339-timestamp) with + nanosecond precision. + enum: + - ns + - u + - µ + - ms + - s + - m + - h + type: string + pretty: + description: | + If true, the JSON response is formatted in a human-readable format. + type: boolean + required: + - q + application/x-www-form-urlencoded: + schema: + type: object + properties: + db: + type: string + description: The database to query. If not provided, the InfluxQL query string must specify the database. + q: + description: The InfluxQL query string. + type: string + chunked: + description: | + If true, the response is divided into chunks of size `chunk_size`. + type: boolean + chunk_size: + description: | + The number of records that will go into a chunk. + This parameter is only used if `chunked=true`. + type: integer + default: 10000 + epoch: + description: > + A unix timestamp precision. + + + - `h` for hours + + - `m` for minutes + + - `s` for seconds + + - `ms` for milliseconds + + - `u` or `µ` for microseconds + + - `ns` for nanoseconds + + + Formats timestamps as [unix (epoch) timestamps](/influxdb3/core/reference/glossary/#unix-timestamp) + with the specified precision + + instead of [RFC3339 timestamps](/influxdb3/core/reference/glossary/#rfc3339-timestamp) with + nanosecond precision. + enum: + - ns + - u + - µ + - ms + - s + - m + - h + type: string + pretty: + description: | + If true, the JSON response is formatted in a human-readable format. + type: boolean + required: + - q + application/vnd.influxql: + schema: + type: string + description: InfluxQL query string sent as the request body. + tags: + - Query data + - Compatibility endpoints + /write: + post: + operationId: PostV1Write + responses: + "204": + description: Success ("No Content"). All data in the batch is written and queryable. + headers: + cluster-uuid: + $ref: "#/components/headers/ClusterUUID" + "400": + description: | + Bad request. Some (a _partial write_) or all of the data from the batch was rejected and not written. + If a partial write occurred, then some points from the batch are written and queryable. + + The response body: + - indicates if a partial write occurred or all data was rejected. + - contains details about the [rejected points](/influxdb3/core/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. + content: + application/json: + examples: + rejectedAllPoints: + summary: Rejected all points in the batch + value: | + { + "error": "write of line protocol failed", + "data": [ + { + "original_line": "dquote> home,room=Kitchen temp=hi", + "line_number": 2, + "error_message": "No fields were provided" + } + ] + } + partialWriteErrorWithRejectedPoints: + summary: Partial write rejected some points in the batch + value: | + { + "error": "partial write of line protocol occurred", + "data": [ + { + "original_line": "dquote> home,room=Kitchen temp=hi", + "line_number": 2, + "error_message": "No fields were provided" + } + ] + } + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "413": + description: Request entity too large. + summary: Write line protocol (v1-compatible) + description: > + Writes line protocol to the specified database. + + + This endpoint provides backward compatibility for InfluxDB 1.x write workloads using tools such as InfluxDB 1.x + client libraries, the Telegraf `outputs.influxdb` output plugin, or third-party tools. + + + Use this endpoint to send data in [line + protocol](https://docs.influxdata.com/influxdb3/core/reference/syntax/line-protocol/) format to InfluxDB. + + Use query parameters to specify options for writing data. + + + #### Related + + + - [Use compatibility APIs to write data](/influxdb3/core/write-data/http-api/compatibility-apis/) + parameters: + - $ref: "#/components/parameters/dbWriteParam" + - $ref: "#/components/parameters/compatibilityPrecisionParam" + - $ref: "#/components/parameters/v1UsernameParam" + - $ref: "#/components/parameters/v1PasswordParam" + - name: rp + in: query + required: false + schema: + type: string + description: | + Retention policy name. Honored but discouraged. InfluxDB 3 doesn't use retention policies. + - name: consistency + in: query + required: false + schema: + type: string + description: | + Write consistency level. Ignored by InfluxDB 3. Provided for compatibility with InfluxDB 1.x clients. + - name: Authorization + in: header + required: false + schema: + type: string + description: | + Authorization header for token-based authentication. + Supported schemes: + - `Bearer AUTH_TOKEN` - OAuth bearer token scheme + - `Token AUTH_TOKEN` - InfluxDB v2 token scheme + - `Basic ` - Basic authentication (username is ignored) + - name: Content-Type + in: header + description: | + The content type of the request payload. + schema: + $ref: "#/components/schemas/LineProtocol" + required: false + - name: Accept + in: header + description: | + The content type that the client can understand. + Writes only return a response body if they fail (partially or completely)--for example, + due to a syntax problem or type mismatch. + schema: + type: string + default: application/json + enum: + - application/json + required: false + - $ref: "#/components/parameters/ContentEncoding" + - $ref: "#/components/parameters/ContentLength" + requestBody: + $ref: "#/components/requestBodies/lineProtocolRequestBody" + tags: + - Compatibility endpoints + - Write data components: parameters: AcceptQueryHeader: @@ -2088,7 +2344,7 @@ components: The compression applied to the line protocol in the request payload. To send a gzip payload, pass `Content-Encoding: gzip` header. schema: - $ref: '#/components/schemas/ContentEncoding' + $ref: "#/components/schemas/ContentEncoding" required: false ContentLength: name: Content-Length @@ -2096,7 +2352,7 @@ components: description: | The size of the entity-body, in bytes, sent to InfluxDB. schema: - $ref: '#/components/schemas/ContentLength' + $ref: "#/components/schemas/ContentLength" ContentType: name: Content-Type description: | @@ -2140,20 +2396,20 @@ components: in: query required: false schema: - $ref: '#/components/schemas/AcceptPartial' + $ref: "#/components/schemas/AcceptPartial" compatibilityPrecisionParam: name: precision in: query - required: true + required: false schema: - $ref: '#/components/schemas/PrecisionWriteCompatibility' + $ref: "#/components/schemas/PrecisionWriteCompatibility" description: The precision for unix timestamps in the line protocol batch. precisionParam: name: precision in: query - required: true + required: false schema: - $ref: '#/components/schemas/PrecisionWrite' + $ref: "#/components/schemas/PrecisionWrite" description: The precision for unix timestamps in the line protocol batch. querySqlParam: name: q @@ -2169,22 +2425,24 @@ components: in: query required: false schema: - $ref: '#/components/schemas/Format' + $ref: "#/components/schemas/Format" formatRequired: name: format in: query required: true schema: - $ref: '#/components/schemas/Format' + $ref: "#/components/schemas/Format" v1UsernameParam: name: u in: query required: false schema: type: string - description: | + description: > Username for v1 compatibility authentication. - When using Basic authentication or query string authentication, InfluxDB 3 ignores this parameter but allows any arbitrary string for compatibility with InfluxDB 1.x clients. + + When using Basic authentication or query string authentication, InfluxDB 3 ignores this parameter but allows any + arbitrary string for compatibility with InfluxDB 1.x clients. v1PasswordParam: name: p in: query @@ -2217,7 +2475,7 @@ components: content: application/json: schema: - $ref: '#/components/schemas/QueryRequestObject' + $ref: "#/components/schemas/QueryRequestObject" schemas: AdminTokenObject: type: object @@ -2240,61 +2498,31 @@ components: name: _admin token: apiv3_00xx0Xx0xx00XX0x0 hash: 00xx0Xx0xx00XX0x0 - created_at: '2025-04-18T14:02:45.331Z' + created_at: "2025-04-18T14:02:45.331Z" expiry: null - ResourceTokenObject: - type: object - properties: - token_name: - type: string - permissions: - type: array - items: - type: object - properties: - resource_type: - type: string - enum: - - system - - db - resource_identifier: - type: array - items: - type: string - actions: - type: array - items: - type: string - enum: - - read - - write - expiry_secs: - type: integer - description: The expiration time in seconds. - example: - token_name: All system information - permissions: - - resource_type: system - resource_identifier: - - '*' - actions: - - read - expiry_secs: 300000 ContentEncoding: type: string enum: - gzip - identity - description: | + description: > Content coding. + Use `gzip` for compressed data or `identity` for unmodified, uncompressed data. + #### Multi-member gzip support - InfluxDB 3 supports multi-member gzip payloads (concatenated gzip files per [RFC 1952](https://www.rfc-editor.org/rfc/rfc1952)). + + InfluxDB 3 supports multi-member gzip payloads (concatenated gzip files per [RFC + 1952](https://www.rfc-editor.org/rfc/rfc1952)). + This allows you to: + - Concatenate multiple gzip files and send them in a single request + - Maintain compatibility with InfluxDB v1 and v2 write endpoints + - Simplify batch operations using standard compression tools default: identity LineProtocol: @@ -2308,8 +2536,6 @@ components: ContentLength: type: integer description: The length in decimal number of octets. - Database: - type: string AcceptPartial: type: boolean default: true @@ -2320,9 +2546,12 @@ components: - json - csv - parquet + - json_lines - jsonl - description: | + - pretty + description: |- The format of data in the response body. + `json_lines` is the canonical name; `jsonl` is accepted as an alias. NoSync: type: boolean default: false @@ -2331,18 +2560,21 @@ components: #### Related - - [Use the HTTP API and client libraries to write data](/influxdb3/enterprise/write-data/api-client-libraries/) - - [Data durability](/influxdb3/enterprise/reference/internals/durability/) + - [Use the HTTP API and client libraries to write data](/influxdb3/core/write-data/api-client-libraries/) + - [Data durability](/influxdb3/core/reference/internals/durability/) PrecisionWriteCompatibility: enum: - ms - s - us + - u - ns + - "n" type: string - description: | + description: |- The precision for unix timestamps in the line protocol batch. - Use `ms` for milliseconds, `s` for seconds, `us` for microseconds, or `ns` for nanoseconds. + Use `ms` for milliseconds, `s` for seconds, `us` or `u` for microseconds, or `ns` or `n` for nanoseconds. + Optional — defaults to nanosecond precision if omitted. PrecisionWrite: enum: - auto @@ -2378,6 +2610,7 @@ components: - json - csv - parquet + - json_lines - jsonl - pretty params: @@ -2458,8 +2691,6 @@ components: type: string table: type: string - node_spec: - $ref: '#/components/schemas/ApiNodeSpec' name: type: string description: Optional cache name. @@ -2492,8 +2723,6 @@ components: type: string table: type: string - node_spec: - $ref: '#/components/schemas/ApiNodeSpec' name: type: string description: Optional cache name. @@ -2538,63 +2767,99 @@ components: The path can be absolute or relative to the `--plugins-dir` directory configured when starting InfluxDB 3. The plugin file must implement the trigger interface associated with the trigger's specification. - node_spec: - $ref: '#/components/schemas/ApiNodeSpec' trigger_name: type: string trigger_settings: description: | Configuration for trigger error handling and execution behavior. allOf: - - $ref: '#/components/schemas/TriggerSettings' + - $ref: "#/components/schemas/TriggerSettings" trigger_specification: - description: | + description: > Specifies when and how the processing engine trigger should be invoked. + ## Supported trigger specifications: + ### Cron-based scheduling + Format: `cron:CRON_EXPRESSION` + Uses extended (6-field) cron format (second minute hour day_of_month month day_of_week): + ``` + ┌───────────── second (0-59) + │ ┌───────────── minute (0-59) + │ │ ┌───────────── hour (0-23) + │ │ │ ┌───────────── day of month (1-31) + │ │ │ │ ┌───────────── month (1-12) + │ │ │ │ │ ┌───────────── day of week (0-6, Sunday=0) + │ │ │ │ │ │ + * * * * * * + ``` + Examples: + - `cron:0 0 6 * * 1-5` - Every weekday at 6:00 AM + - `cron:0 30 14 * * 5` - Every Friday at 2:30 PM + - `cron:0 0 0 1 * *` - First day of every month at midnight + ### Interval-based scheduling + Format: `every:DURATION` - Supported durations: `s` (seconds), `m` (minutes), `h` (hours), `d` (days), `w` (weeks), `M` (months), `y` (years): + + Supported durations: `s` (seconds), `m` (minutes), `h` (hours), `d` (days), `w` (weeks), `M` (months), `y` + (years): + - `every:30s` - Every 30 seconds + - `every:5m` - Every 5 minutes + - `every:1h` - Every hour + - `every:1d` - Every day + - `every:1w` - Every week + - `every:1M` - Every month + - `every:1y` - Every year + **Maximum interval**: 1 year + ### Table-based triggers + - `all_tables` - Triggers on write events to any table in the database + - `table:TABLE_NAME` - Triggers on write events to a specific table + ### On-demand triggers + Format: `request:REQUEST_PATH` + Creates an HTTP endpoint `/api/v3/engine/REQUEST_PATH` for manual invocation: + - `request:hello-world` - Creates endpoint `/api/v3/engine/hello-world` + - `request:data-export` - Creates endpoint `/api/v3/engine/data-export` pattern: ^(cron:[0-9 *,/-]+|every:[0-9]+[smhd]|all_tables|table:[a-zA-Z_][a-zA-Z0-9_]*|request:[a-zA-Z0-9_-]+)$ example: cron:0 0 6 * * 1-5 @@ -2640,22 +2905,6 @@ components: required: - run_async - error_behavior - ApiNodeSpec: - type: object - description: | - Optional specification for targeting specific nodes in a multi-node InfluxDB 3 Enterprise cluster. - Use this to control which node(s) should handle the cache or trigger. - properties: - node_id: - type: string - description: | - The ID of a specific node in the cluster. - If specified, the cache or trigger will only be created on this node. - node_group: - type: string - description: | - The name of a node group in the cluster. - If specified, the cache or trigger will be created on all nodes in this group. WALPluginTestRequest: type: object description: | @@ -2745,7 +2994,7 @@ components: files: type: array items: - $ref: '#/components/schemas/PluginFileEntry' + $ref: "#/components/schemas/PluginFileEntry" description: | List of plugin files to include in the directory. required: @@ -2756,16 +3005,15 @@ components: description: | Represents a single file in a plugin directory. properties: - filename: - type: string - description: | - The name of the file within the plugin directory. content: type: string description: | The content of the file. + relative_path: + type: string + description: The relative path of the file within the plugin directory. required: - - filename + - relative_path - content ShowDatabasesResponse: type: object @@ -2789,7 +3037,7 @@ components: - time - value values: - - - '2024-02-02T12:00:00Z' + - - "2024-02-02T12:00:00Z" - 42 ErrorMessage: type: object @@ -2799,38 +3047,6 @@ components: data: type: object nullable: true - LineProtocolError: - properties: - code: - description: Code is the machine-readable error code. - enum: - - internal error - - not found - - conflict - - invalid - - empty value - - unavailable - readOnly: true - type: string - err: - description: Stack of errors that occurred during processing of the request. Useful for debugging. - readOnly: true - type: string - line: - description: First line in the request body that contains malformed data. - format: int32 - readOnly: true - type: integer - message: - description: Human-readable message. - readOnly: true - type: string - op: - description: Describes the logical code operation when the error occurred. Useful for debugging. - readOnly: true - type: string - required: - - code EpochCompatibility: description: | A unix timestamp precision. @@ -2859,62 +3075,13 @@ components: Use duration format (for example, "1d", "1h", "30m", "7d"). example: 7d description: Request schema for updating database configuration. - UpdateTableRequest: - type: object - properties: - db: - type: string - description: The name of the database containing the table. - table: - type: string - description: The name of the table to update. - retention_period: - type: string - description: | - The retention period for the table. Specifies how long data in this table should be retained. - Use duration format (for example, "1d", "1h", "30m", "7d"). - example: 30d - required: - - db - - table - description: Request schema for updating table configuration. - LicenseResponse: - type: object - properties: - license_type: - type: string - description: The type of license (for example, "enterprise", "trial"). - example: enterprise - expires_at: - type: string - format: date-time - description: The expiration date of the license in ISO 8601 format. - example: '2025-12-31T23:59:59Z' - features: - type: array - items: - type: string - description: List of features enabled by the license. - example: - - clustering - - processing_engine - - advanced_auth - status: - type: string - enum: - - active - - expired - - invalid - description: The current status of the license. - example: active - description: Response schema for license information. responses: Unauthorized: description: Unauthorized access. content: application/json: schema: - $ref: '#/components/schemas/ErrorMessage' + $ref: "#/components/schemas/ErrorMessage" BadRequest: description: | Request failed. Possible reasons: @@ -2925,19 +3092,19 @@ components: content: application/json: schema: - $ref: '#/components/schemas/ErrorMessage' + $ref: "#/components/schemas/ErrorMessage" Forbidden: description: Access denied. content: application/json: schema: - $ref: '#/components/schemas/ErrorMessage' + $ref: "#/components/schemas/ErrorMessage" NotFound: description: Resource not found. content: application/json: schema: - $ref: '#/components/schemas/ErrorMessage' + $ref: "#/components/schemas/ErrorMessage" headers: ClusterUUID: description: | @@ -2954,94 +3121,126 @@ components: BasicAuthentication: type: http scheme: basic - description: | + description: >- Use the `Authorization` header with the `Basic` scheme to authenticate v1 API requests. - Works with v1 compatibility [`/write`](#operation/PostV1Write) and [`/query`](#operation/GetV1Query) endpoints in InfluxDB 3. - When authenticating requests, InfluxDB 3 checks that the `password` part of the decoded credential is an authorized token + Works with v1 compatibility [`/write`](#operation/PostV1Write) and [`/query`](#operation/GetV1Query) endpoints + in InfluxDB 3. + + + When authenticating requests, InfluxDB 3 checks that the `password` part of the decoded credential is an + authorized token + and ignores the `username` part of the decoded credential. + ### Syntax + ```http + Authorization: Basic + ``` + ### Example + ```bash + curl "http://localhost:8181/write?db=DATABASE_NAME&precision=s" \ --user "":"AUTH_TOKEN" \ --header "Content-type: text/plain; charset=utf-8" \ --data-binary 'home,room=kitchen temp=72 1641024000' ``` + Replace the following: - - **`DATABASE_NAME`**: your InfluxDB 3 Enterprise database + + - **`DATABASE_NAME`**: your InfluxDB 3 Core database + - **`AUTH_TOKEN`**: an admin token or database token authorized for the database - - #### Related guides - - - [Authenticate v1 API requests](/influxdb3/enterprise/guides/api-compatibility/v1/) - - [Manage tokens](/influxdb3/enterprise/admin/tokens/) QuerystringAuthentication: type: apiKey in: query name: u=&p= - description: | + description: >- Use InfluxDB 1.x API parameters to provide credentials through the query string for v1 API requests. - Querystring authentication works with v1-compatible [`/write`](#operation/PostV1Write) and [`/query`](#operation/GetV1Query) endpoints. + + Querystring authentication works with v1-compatible [`/write`](#operation/PostV1Write) and + [`/query`](#operation/GetV1Query) endpoints. + When authenticating requests, InfluxDB 3 checks that the `p` (_password_) query parameter is an authorized token + and ignores the `u` (_username_) query parameter. + ### Syntax + ```http + https://localhost:8181/query/?[u=any]&p=AUTH_TOKEN + https://localhost:8181/write/?[u=any]&p=AUTH_TOKEN + ``` + ### Examples + ```bash + curl "http://localhost:8181/write?db=DATABASE_NAME&precision=s&p=AUTH_TOKEN" \ --header "Content-type: text/plain; charset=utf-8" \ --data-binary 'home,room=kitchen temp=72 1641024000' ``` + Replace the following: - - **`DATABASE_NAME`**: your InfluxDB 3 Enterprise database + + - **`DATABASE_NAME`**: your InfluxDB 3 Core database + - **`AUTH_TOKEN`**: an admin token or database token authorized for the database + ```bash + ####################################### + # Use an InfluxDB 1.x compatible username and password + # to query the InfluxDB v1 HTTP API + ####################################### + # Use authentication query parameters: + # ?p=AUTH_TOKEN + ####################################### + curl --get "http://localhost:8181/query" \ --data-urlencode "p=AUTH_TOKEN" \ --data-urlencode "db=DATABASE_NAME" \ --data-urlencode "q=SELECT * FROM MEASUREMENT" ``` + Replace the following: + - **`DATABASE_NAME`**: the database to query + - **`AUTH_TOKEN`**: a database token with sufficient permissions to the database - - #### Related guides - - - [Authenticate v1 API requests](/influxdb3/enterprise/guides/api-compatibility/v1/) - - [Manage tokens](/influxdb3/enterprise/admin/tokens/) BearerAuthentication: type: http scheme: bearer @@ -3069,7 +3268,7 @@ components: --header "Authorization: Bearer AUTH_TOKEN" ``` TokenAuthentication: - description: | + description: |- Use InfluxDB v2 Token authentication to provide an authorization token to InfluxDB 3. The v2 Token scheme works with v1 and v2 compatibility endpoints in InfluxDB 3. @@ -3096,10 +3295,6 @@ components: --header "Authorization: Token AUTH_TOKEN" \ --data-binary 'home,room=kitchen temp=72 1463683075' ``` - - ### Related guides - - - [Manage tokens](/influxdb3/enterprise/admin/tokens/) in: header name: Authorization type: apiKey diff --git a/api-docs/influxdb3/enterprise/.config.yml b/api-docs/influxdb3/enterprise/.config.yml index 4b8210b97..d39bc413c 100644 --- a/api-docs/influxdb3/enterprise/.config.yml +++ b/api-docs/influxdb3/enterprise/.config.yml @@ -7,7 +7,7 @@ x-influxdata-product-name: InfluxDB 3 Enterprise apis: v3@3: - root: v3/ref.yml + root: v3/influxdb3-enterprise-openapi.yaml x-influxdata-docs-aliases: - /influxdb3/enterprise/api/ - /influxdb3/enterprise/api/v1/ diff --git a/api-docs/influxdb3/enterprise/v3/content/info.yml b/api-docs/influxdb3/enterprise/v3/content/info.yml index e4ec8ef60..cd2e5acdf 100644 --- a/api-docs/influxdb3/enterprise/v3/content/info.yml +++ b/api-docs/influxdb3/enterprise/v3/content/info.yml @@ -21,10 +21,7 @@ description: | - `/`: Compatibility endpoints for InfluxDB v1 workloads and clients - `/api/v2/write`: Compatibility endpoint for InfluxDB v2 workloads and clients - + [Download the OpenAPI specification](/openapi/influxdb3-enterprise-openapi.yaml) license: name: MIT url: 'https://opensource.org/licenses/MIT' diff --git a/api-docs/influxdb3/enterprise/v3/influxdb3-enterprise-openapi.yaml b/api-docs/influxdb3/enterprise/v3/influxdb3-enterprise-openapi.yaml new file mode 100644 index 000000000..5ff481f9d --- /dev/null +++ b/api-docs/influxdb3/enterprise/v3/influxdb3-enterprise-openapi.yaml @@ -0,0 +1,3799 @@ +openapi: 3.0.3 +info: + title: InfluxDB 3 Enterprise API Service + description: | + The InfluxDB HTTP API for InfluxDB 3 Enterprise provides a programmatic interface for + interacting with InfluxDB 3 Enterprise databases and resources. + Use this API to: + + - Write data to InfluxDB 3 Enterprise databases + - Query data using SQL or InfluxQL + - Process data using Processing engine plugins + - Manage databases, tables, and Processing engine triggers + - Perform administrative tasks and access system information + + The API includes endpoints under the following paths: + - `/api/v3`: InfluxDB 3 Enterprise native endpoints + - `/`: Compatibility endpoints for InfluxDB v1 workloads and clients + - `/api/v2/write`: Compatibility endpoint for InfluxDB v2 workloads and clients + + [Download the OpenAPI specification](/openapi/influxdb3-enterprise-openapi.yaml) + version: v3.8.0 + license: + name: MIT + url: https://opensource.org/licenses/MIT + contact: + name: InfluxData + url: https://www.influxdata.com + email: support@influxdata.com + x-source-hash: sha256:1259b96096eab6c8dbf3f76c974924f124e9b3e08eedc6b0c9a66d3108857c52 +servers: + - url: https://{baseurl} + description: InfluxDB 3 Enterprise API URL + variables: + baseurl: + enum: + - localhost:8181 + default: localhost:8181 + description: InfluxDB 3 Enterprise URL +security: + - BearerAuthentication: [] + - TokenAuthentication: [] + - BasicAuthentication: [] + - QuerystringAuthentication: [] +tags: + - name: Authentication + description: | + Depending on your workflow, use one of the following schemes to authenticate to the InfluxDB 3 API: + + | Authentication scheme | Works with | + |:-------------------|:-----------| + | [Bearer authentication](#section/Authentication/BearerAuthentication) | All endpoints | + | [Token authentication](#section/Authentication/TokenAuthentication) | v1, v2 endpoints | + | [Basic authentication](#section/Authentication/BasicAuthentication) | v1 endpoints | + | [Querystring authentication](#section/Authentication/QuerystringAuthentication) | v1 endpoints | + + x-traitTag: true + x-related: + - title: Authenticate v1 API requests + href: /influxdb3/enterprise/guides/api-compatibility/v1/ + - title: Manage tokens + href: /influxdb3/enterprise/admin/tokens/ + - name: Cache data + description: |- + Manage the in-memory cache. + + #### Distinct Value Cache + + The Distinct Value Cache (DVC) lets you cache distinct + values of one or more columns in a table, improving the performance of + queries that return distinct tag and field values. + + The DVC is an in-memory cache that stores distinct values for specific columns + in a table. When you create an DVC, you can specify what columns' distinct + values to cache, the maximum number of distinct value combinations to cache, and + the maximum age of cached values. A DVC is associated with a table, which can + have multiple DVCs. + + #### Last value cache + + The Last Value Cache (LVC) lets you cache the most recent + values for specific fields in a table, improving the performance of queries that + return the most recent value of a field for specific series or the last N values + of a field. + + The LVC is an in-memory cache that stores the last N number of values for + specific fields of series in a table. When you create an LVC, you can specify + what fields to cache, what tags to use to identify each series, and the + number of values to cache for each unique series. + An LVC is associated with a table, which can have multiple LVCs. + x-related: + - title: Manage the Distinct Value Cache + href: /influxdb3/enterprise/admin/distinct-value-cache/ + - title: Manage the Last Value Cache + href: /influxdb3/enterprise/admin/last-value-cache/ + - name: Compatibility endpoints + description: > + InfluxDB 3 provides compatibility endpoints for InfluxDB 1.x and InfluxDB 2.x workloads and clients. + + + ### Write data using v1- or v2-compatible endpoints + + + - [`/api/v2/write` endpoint](#operation/PostV2Write) + for InfluxDB v2 clients and when you bring existing InfluxDB v2 write workloads to InfluxDB 3. + - [`/write` endpoint](#operation/PostV1Write) for InfluxDB v1 clients and when you bring existing InfluxDB v1 + write workloads to InfluxDB 3. + + + For new workloads, use the [`/api/v3/write_lp` endpoint](#operation/PostWriteLP). + + + All endpoints accept the same line protocol format. + + + ### Query data + + + Use the HTTP [`/query`](#operation/GetV1ExecuteQuery) endpoint for InfluxDB v1 clients and v1 query workloads + using InfluxQL. + + + For new workloads, use one of the following: + + + - HTTP [`/api/v3/query_sql` endpoint](#operation/GetExecuteQuerySQL) for new query workloads using SQL. + + - HTTP [`/api/v3/query_influxql` endpoint](#operation/GetExecuteInfluxQLQuery) for new query workloads using + InfluxQL. + + - Flight SQL and InfluxDB 3 _Flight+gRPC_ APIs for querying with SQL or InfluxQL. For more information about using + Flight APIs, see [InfluxDB 3 client + libraries](https://github.com/InfluxCommunity?q=influxdb3&type=public&language=&sort=). + + + ### Server information + + + Server information endpoints such as `/health` and `metrics` are compatible with InfluxDB 1.x and InfluxDB 2.x + clients. + x-related: + - title: Use compatibility APIs to write data + href: /influxdb3/enterprise/write-data/http-api/compatibility-apis/ + - name: Database + description: Manage databases + - description: > + Most InfluxDB API endpoints require parameters in the request--for example, specifying the database to use. + + + ### Common parameters + + + The following table shows common parameters used by many InfluxDB API endpoints. + + Many endpoints may require other parameters in the query string or in the + + request body that perform functions specific to those endpoints. + + + | Query parameter | Value type | Description | + + |:------------------------ |:--------------------- |:-------------------------------------------| + + | `db` | string | The database name | + + + InfluxDB HTTP API endpoints use standard HTTP request and response headers. + + The following table shows common headers used by many InfluxDB API endpoints. + + Some endpoints may use other headers that perform functions more specific to those endpoints--for example, + + the write endpoints accept the `Content-Encoding` header to indicate that line protocol is compressed in the + request body. + + + | Header | Value type | Description | + + |:------------------------ |:--------------------- |:-------------------------------------------| + + | `Accept` | string | The content type that the client can understand. | + + | `Authorization` | string | The authorization scheme and credential. | + + | `Content-Length` | integer | The size of the entity-body, in bytes. | + + | `Content-Type` | string | The format of the data in the request body. | + name: Headers and parameters + x-traitTag: true + - name: Processing engine + description: > + Manage Processing engine triggers, test plugins, and send requests to trigger On Request plugins. + + + InfluxDB 3 Enterprise provides the InfluxDB 3 processing engine, an embedded Python VM that can dynamically load + and trigger Python plugins in response to events in your database. + + Use Processing engine plugins and triggers to run code and perform tasks for different database events. + + + To get started with the processing engine, see the [Processing engine and Python + plugins](/influxdb3/enterprise/processing-engine/) guide. + x-related: + - title: Processing engine and Python plugins + href: /influxdb3/enterprise/plugins/ + - name: Query data + description: Query data using SQL or InfluxQL + x-related: + - title: Use the InfluxDB v1 HTTP query API and InfluxQL to query data + href: /influxdb3/enterprise/query-data/execute-queries/influxdb-v1-api/ + - name: Quick start + description: > + 1. [Create an admin token](#section/Authentication) to authorize API requests. + + ```bash + curl -X POST "http://localhost:8181/api/v3/configure/token/admin" + ``` + 2. [Check the status](#section/Server-information) of the InfluxDB server. + + ```bash + curl "http://localhost:8181/health" \ + --header "Authorization: Bearer ADMIN_TOKEN" + ``` + + 3. [Write data](#operation/PostWriteLP) to InfluxDB. + + ```bash + curl "http://localhost:8181/api/v3/write_lp?db=sensors&precision=auto" + --header "Authorization: Bearer ADMIN_TOKEN" \ + --data-raw "home,room=Kitchen temp=72.0 + home,room=Living\ room temp=71.5" + ``` + + If all data is written, the response is `204 No Content`. + + 4. [Query data](#operation/GetExecuteQuerySQL) from InfluxDB. + + ```bash + curl -G "http://localhost:8181/api/v3/query_sql" \ + --header "Authorization: Bearer ADMIN_TOKEN" \ + --data-urlencode "db=sensors" \ + --data-urlencode "q=SELECT * FROM home WHERE room='Living room'" \ + --data-urlencode "format=jsonl" + ``` + + Output: + + ```jsonl + {"room":"Living room","temp":71.5,"time":"2025-02-25T20:19:34.984098"} + ``` + + For more information about using InfluxDB 3 Enterprise, see the [Get started](/influxdb3/enterprise/get-started/) + guide. + x-traitTag: true + - name: Server information + description: Retrieve server metrics, status, and version information + - name: Table + description: Manage table schemas and data + - name: Token + description: Manage tokens for authentication and authorization + - name: Write data + description: | + Write data to InfluxDB 3 using line protocol format. + + #### Timestamp precision across write APIs + + InfluxDB 3 provides multiple write endpoints for compatibility with different InfluxDB versions. + The following table compares timestamp precision support across v1, v2, and v3 write APIs: + + | Precision | v1 (`/write`) | v2 (`/api/v2/write`) | v3 (`/api/v3/write_lp`) | + |-----------|---------------|----------------------|-------------------------| + | **Auto detection** | ❌ No | ❌ No | ✅ `auto` (default) | + | **Seconds** | ✅ `s` | ✅ `s` | ✅ `second` | + | **Milliseconds** | ✅ `ms` | ✅ `ms` | ✅ `millisecond` | + | **Microseconds** | ✅ `u` or `µ` | ✅ `us` | ✅ `microsecond` | + | **Nanoseconds** | ✅ `ns` | ✅ `ns` | ✅ `nanosecond` | + | **Default** | Nanosecond | Nanosecond | **Auto** (guessed) | + + All timestamps are stored internally as nanoseconds. +paths: + /api/v1/health: + get: + operationId: GetHealthV1 + summary: Health check (v1) + description: | + Checks the status of the service. + + Returns `OK` if the service is running. This endpoint does not return version information. + Use the [`/ping`](#operation/GetPing) endpoint to retrieve version details. + + > **Note**: This endpoint requires authentication by default in InfluxDB 3 Enterprise. + responses: + "200": + description: Service is running. Returns `OK`. + content: + text/plain: + schema: + type: string + example: OK + "401": + description: Unauthorized. Authentication is required. + "500": + description: Service is unavailable. + tags: + - Server information + - Compatibility endpoints + /api/v2/write: + post: + operationId: PostV2Write + responses: + "204": + description: Success ("No Content"). All data in the batch is written and queryable. + headers: + cluster-uuid: + $ref: "#/components/headers/ClusterUUID" + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "413": + description: Request entity too large. + summary: Write line protocol (v2-compatible) + description: > + Writes line protocol to the specified database. + + + This endpoint provides backward compatibility for InfluxDB 2.x write workloads using tools such as InfluxDB 2.x + client libraries, the Telegraf `outputs.influxdb_v2` output plugin, or third-party tools. + + + Use this endpoint to send data in [line protocol](/influxdb3/enterprise/reference/syntax/line-protocol/) format + to InfluxDB. + + Use query parameters to specify options for writing data. + + + #### Related + + + - [Use compatibility APIs to write data](/influxdb3/enterprise/write-data/http-api/compatibility-apis/) + parameters: + - name: Content-Type + in: header + description: | + The content type of the request payload. + schema: + $ref: "#/components/schemas/LineProtocol" + required: false + - description: | + The compression applied to the line protocol in the request payload. + To send a gzip payload, pass `Content-Encoding: gzip` header. + in: header + name: Content-Encoding + schema: + default: identity + description: | + Content coding. + Use `gzip` for compressed data or `identity` for unmodified, uncompressed data. + enum: + - gzip + - identity + type: string + - description: | + The size of the entity-body, in bytes, sent to InfluxDB. + in: header + name: Content-Length + schema: + description: The length in decimal number of octets. + type: integer + - description: | + The content type that the client can understand. + Writes only return a response body if they fail (partially or completely)--for example, + due to a syntax problem or type mismatch. + in: header + name: Accept + schema: + default: application/json + description: Error content type. + enum: + - application/json + type: string + - name: bucket + in: query + required: true + schema: + type: string + description: |- + A database name. + InfluxDB creates the database if it doesn't already exist, and then + writes all points in the batch to the database. + + This parameter is named `bucket` for compatibility with InfluxDB v2 client libraries. + - name: accept_partial + in: query + required: false + schema: + $ref: "#/components/schemas/AcceptPartial" + - $ref: "#/components/parameters/compatibilityPrecisionParam" + requestBody: + $ref: "#/components/requestBodies/lineProtocolRequestBody" + tags: + - Compatibility endpoints + - Write data + /api/v3/configure/database: + delete: + operationId: DeleteConfigureDatabase + parameters: + - $ref: "#/components/parameters/db" + - name: data_only + in: query + required: false + schema: + type: boolean + default: false + description: | + Delete only data while preserving the database schema and all associated resources + (tokens, triggers, last value caches, distinct value caches, processing engine configurations). + When `false` (default), the entire database is deleted. + - name: remove_tables + in: query + required: false + schema: + type: boolean + default: false + description: | + Used with `data_only=true` to remove table resources (caches) while preserving + database-level resources (tokens, triggers, processing engine configurations). + Has no effect when `data_only=false`. + - name: hard_delete_at + in: query + required: false + schema: + type: string + format: date-time + description: |- + Schedule the database for hard deletion at the specified time. + If not provided, the database will be soft deleted. + Use ISO 8601 date-time format (for example, "2025-12-31T23:59:59Z"). + + #### Deleting a database cannot be undone + + Deleting a database is a destructive action. + Once a database is deleted, data stored in that database cannot be recovered. + + + Also accepts special string values: + - `now` — hard delete immediately + - `never` — soft delete only (default behavior) + - `default` — use the system default hard deletion time + responses: + "200": + description: Success. Database deleted. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Database not found. + summary: Delete a database + description: | + Soft deletes a database. + The database is scheduled for deletion and unavailable for querying. + Use the `hard_delete_at` parameter to schedule a hard deletion. + Use the `data_only` parameter to delete data while preserving the database schema and resources. + tags: + - Database + get: + operationId: GetConfigureDatabase + responses: + "200": + description: Success. The response body contains the list of databases. + content: + application/json: + schema: + $ref: "#/components/schemas/ShowDatabasesResponse" + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Database not found. + summary: List databases + description: Retrieves a list of databases. + parameters: + - $ref: "#/components/parameters/formatRequired" + - name: show_deleted + in: query + required: false + schema: + type: boolean + default: false + description: | + Include soft-deleted databases in the response. + By default, only active databases are returned. + tags: + - Database + post: + operationId: PostConfigureDatabase + responses: + "200": + description: Success. Database created. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "409": + description: Database already exists. + summary: Create a database + description: Creates a new database in the system. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/CreateDatabaseRequest" + tags: + - Database + put: + operationId: update_database + responses: + "200": + description: Success. The database has been updated. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Database not found. + summary: Update a database + description: | + Updates database configuration, such as retention period. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateDatabaseRequest" + tags: + - Database + /api/v3/configure/database/retention_period: + delete: + operationId: DeleteDatabaseRetentionPeriod + summary: Remove database retention period + description: | + Removes the retention period from a database, setting it to infinite retention. + parameters: + - $ref: "#/components/parameters/db" + responses: + "204": + description: Success. The database retention period has been removed. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Database not found. + tags: + - Database + /api/v3/configure/distinct_cache: + delete: + operationId: DeleteConfigureDistinctCache + responses: + "200": + description: Success. The distinct cache has been deleted. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Cache not found. + summary: Delete distinct cache + description: Deletes a distinct cache. + parameters: + - $ref: "#/components/parameters/db" + - name: table + in: query + required: true + schema: + type: string + description: The name of the table containing the distinct cache. + - name: name + in: query + required: true + schema: + type: string + description: The name of the distinct cache to delete. + tags: + - Cache data + - Table + post: + operationId: PostConfigureDistinctCache + responses: + "201": + description: Success. The distinct cache has been created. + "400": + description: > + Bad request. + + + The server responds with status `400` if the request would overwrite an existing cache with a different + configuration. + "409": + description: Conflict. A distinct cache with this configuration already exists. + summary: Create distinct cache + description: Creates a distinct cache for a table. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/DistinctCacheCreateRequest" + tags: + - Cache data + - Table + /api/v3/configure/last_cache: + delete: + operationId: DeleteConfigureLastCache + responses: + "200": + description: Success. The last cache has been deleted. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Cache not found. + summary: Delete last cache + description: Deletes a last cache. + parameters: + - $ref: "#/components/parameters/db" + - name: table + in: query + required: true + schema: + type: string + description: The name of the table containing the last cache. + - name: name + in: query + required: true + schema: + type: string + description: The name of the last cache to delete. + tags: + - Cache data + - Table + post: + operationId: PostConfigureLastCache + responses: + "201": + description: Success. Last cache created. + "400": + description: Bad request. A cache with this name already exists or the request is malformed. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Cache not found. + summary: Create last cache + description: Creates a last cache for a table. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/LastCacheCreateRequest" + tags: + - Cache data + - Table + /api/v3/configure/plugin_environment/install_packages: + post: + operationId: PostInstallPluginPackages + summary: Install plugin packages + description: |- + Installs the specified Python packages into the processing engine plugin environment. + + This endpoint is synchronous and blocks until the packages are installed. + parameters: + - $ref: "#/components/parameters/ContentType" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + packages: + type: array + items: + type: string + description: | + A list of Python package names to install. + Can include version specifiers (e.g., "scipy==1.9.0"). + example: + - influxdb3-python + - scipy + - pandas==1.5.0 + - requests + required: + - packages + example: + packages: + - influxdb3-python + - scipy + - pandas==1.5.0 + - requests + responses: + "200": + description: Success. The packages are installed. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + tags: + - Processing engine + /api/v3/configure/plugin_environment/install_requirements: + post: + operationId: PostInstallPluginRequirements + summary: Install plugin requirements + description: > + Installs requirements from a requirements file (also known as a "pip requirements file") into the processing + engine plugin environment. + + + This endpoint is synchronous and blocks until the requirements are installed. + + + ### Related + + + - [Processing engine and Python plugins](/influxdb3/enterprise/plugins/) + + - [Python requirements file format](https://pip.pypa.io/en/stable/reference/requirements-file-format/) + parameters: + - $ref: "#/components/parameters/ContentType" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + requirements_location: + type: string + description: | + The path to the requirements file containing Python packages to install. + Can be a relative path (relative to the plugin directory) or an absolute path. + example: requirements.txt + required: + - requirements_location + example: + requirements_location: requirements.txt + responses: + "200": + description: Success. The requirements have been installed. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + tags: + - Processing engine + /api/v3/configure/processing_engine_trigger: + post: + operationId: PostConfigureProcessingEngineTrigger + summary: Create processing engine trigger + description: Creates a processing engine trigger with the specified plugin file and trigger specification. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/ProcessingEngineTriggerRequest" + examples: + schedule_cron: + summary: Schedule trigger using cron + description: > + In `"cron:CRON_EXPRESSION"`, `CRON_EXPRESSION` uses extended 6-field cron format. + + The cron expression `0 0 6 * * 1-5` means the trigger will run at 6:00 AM every weekday (Monday to + Friday). + value: + db: DATABASE_NAME + plugin_filename: schedule.py + trigger_name: schedule_cron_trigger + trigger_specification: cron:0 0 6 * * 1-5 + disabled: false + trigger_settings: + run_async: false + error_behavior: Log + schedule_every: + summary: Schedule trigger using interval + description: | + In `"every:DURATION"`, `DURATION` specifies the interval between trigger executions. + The duration `1h` means the trigger will run every hour. + value: + db: mydb + plugin_filename: schedule.py + trigger_name: schedule_every_trigger + trigger_specification: every:1h + disabled: false + trigger_settings: + run_async: false + error_behavior: Log + schedule_every_seconds: + summary: Schedule trigger using seconds interval + description: | + Example of scheduling a trigger to run every 30 seconds. + value: + db: mydb + plugin_filename: schedule.py + trigger_name: schedule_every_30s_trigger + trigger_specification: every:30s + disabled: false + trigger_settings: + run_async: false + error_behavior: Log + schedule_every_minutes: + summary: Schedule trigger using minutes interval + description: | + Example of scheduling a trigger to run every 5 minutes. + value: + db: mydb + plugin_filename: schedule.py + trigger_name: schedule_every_5m_trigger + trigger_specification: every:5m + disabled: false + trigger_settings: + run_async: false + error_behavior: Log + all_tables: + summary: All tables trigger example + description: | + Trigger that fires on write events to any table in the database. + value: + db: mydb + plugin_filename: all_tables.py + trigger_name: all_tables_trigger + trigger_specification: all_tables + disabled: false + trigger_settings: + run_async: false + error_behavior: Log + table_specific: + summary: Table-specific trigger example + description: | + Trigger that fires on write events to a specific table. + value: + db: mydb + plugin_filename: table.py + trigger_name: table_trigger + trigger_specification: table:sensors + disabled: false + trigger_settings: + run_async: false + error_behavior: Log + api_request: + summary: On-demand request trigger example + description: | + Creates an HTTP endpoint `/api/v3/engine/hello-world` for manual invocation. + value: + db: mydb + plugin_filename: request.py + trigger_name: hello_world_trigger + trigger_specification: request:hello-world + disabled: false + trigger_settings: + run_async: false + error_behavior: Log + cron_friday_afternoon: + summary: Cron trigger for Friday afternoons + description: | + Example of a cron trigger that runs every Friday at 2:30 PM. + value: + db: reports + plugin_filename: weekly_report.py + trigger_name: friday_report_trigger + trigger_specification: cron:0 30 14 * * 5 + disabled: false + trigger_settings: + run_async: false + error_behavior: Log + cron_monthly: + summary: Cron trigger for monthly execution + description: | + Example of a cron trigger that runs on the first day of every month at midnight. + value: + db: monthly_data + plugin_filename: monthly_cleanup.py + trigger_name: monthly_cleanup_trigger + trigger_specification: cron:0 0 0 1 * * + disabled: false + trigger_settings: + run_async: false + error_behavior: Log + responses: + "200": + description: Success. Processing engine trigger created. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Trigger not found. + tags: + - Processing engine + delete: + operationId: DeleteConfigureProcessingEngineTrigger + summary: Delete processing engine trigger + description: Deletes a processing engine trigger. + parameters: + - $ref: "#/components/parameters/db" + - name: trigger_name + in: query + required: true + schema: + type: string + - name: force + in: query + required: false + schema: + type: boolean + default: false + description: | + Force deletion of the trigger even if it has active executions. + By default, deletion fails if the trigger is currently executing. + responses: + "200": + description: Success. The processing engine trigger has been deleted. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Trigger not found. + tags: + - Processing engine + /api/v3/configure/processing_engine_trigger/disable: + post: + operationId: PostDisableProcessingEngineTrigger + summary: Disable processing engine trigger + description: Disables a processing engine trigger. + parameters: + - name: db + in: query + required: true + schema: + type: string + description: The database name. + - name: trigger_name + in: query + required: true + schema: + type: string + description: The name of the trigger. + responses: + "200": + description: Success. The processing engine trigger has been disabled. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Trigger not found. + tags: + - Processing engine + /api/v3/configure/processing_engine_trigger/enable: + post: + operationId: PostEnableProcessingEngineTrigger + summary: Enable processing engine trigger + description: Enables a processing engine trigger. + parameters: + - name: db + in: query + required: true + schema: + type: string + description: The database name. + - name: trigger_name + in: query + required: true + schema: + type: string + description: The name of the trigger. + responses: + "200": + description: Success. The processing engine trigger is enabled. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Trigger not found. + tags: + - Processing engine + /api/v3/configure/table: + delete: + operationId: DeleteConfigureTable + parameters: + - $ref: "#/components/parameters/db" + - name: table + in: query + required: true + schema: + type: string + - name: data_only + in: query + required: false + schema: + type: boolean + default: false + description: | + Delete only data while preserving the table schema and all associated resources + (last value caches, distinct value caches). + When `false` (default), the entire table is deleted. + - name: hard_delete_at + in: query + required: false + schema: + type: string + format: date-time + description: |- + Schedule the table for hard deletion at the specified time. + If not provided, the table will be soft deleted. + Use ISO 8601 format (for example, "2025-12-31T23:59:59Z"). + + + Also accepts special string values: + - `now` — hard delete immediately + - `never` — soft delete only (default behavior) + - `default` — use the system default hard deletion time + responses: + "200": + description: Success (no content). The table has been deleted. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Table not found. + summary: Delete a table + description: | + Soft deletes a table. + The table is scheduled for deletion and unavailable for querying. + Use the `hard_delete_at` parameter to schedule a hard deletion. + Use the `data_only` parameter to delete data while preserving the table schema and resources. + + #### Deleting a table cannot be undone + + Deleting a table is a destructive action. + Once a table is deleted, data stored in that table cannot be recovered. + tags: + - Table + post: + operationId: PostConfigureTable + responses: + "200": + description: Success. The table has been created. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Database not found. + summary: Create a table + description: Creates a new table within a database. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/CreateTableRequest" + tags: + - Table + put: + operationId: PatchConfigureTable + responses: + "200": + description: Success. The table has been updated. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Table not found. + summary: Update a table + description: | + Updates table configuration, such as retention period. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateTableRequest" + tags: + - Table + x-enterprise-only: true + /api/v3/configure/token: + delete: + operationId: DeleteToken + parameters: + - name: token_name + in: query + required: true + schema: + type: string + description: The name of the token to delete. + responses: + "200": + description: Success. The token has been deleted. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Token not found. + summary: Delete token + description: | + Deletes a token. + tags: + - Authentication + - Token + /api/v3/configure/token/admin: + post: + operationId: PostCreateAdminToken + responses: + "201": + description: | + Success. The admin token has been created. + The response body contains the token string and metadata. + content: + application/json: + schema: + $ref: "#/components/schemas/AdminTokenObject" + "401": + $ref: "#/components/responses/Unauthorized" + summary: Create admin token + description: | + Creates an admin token. + An admin token is a special type of token that has full access to all resources in the system. + tags: + - Authentication + - Token + /api/v3/configure/token/admin/regenerate: + post: + operationId: PostRegenerateAdminToken + summary: Regenerate admin token + description: | + Regenerates an admin token and revokes the previous token with the same name. + parameters: [] + responses: + "201": + description: Success. The admin token has been regenerated. + content: + application/json: + schema: + $ref: "#/components/schemas/AdminTokenObject" + "401": + $ref: "#/components/responses/Unauthorized" + tags: + - Authentication + - Token + /api/v3/configure/token/named_admin: + post: + operationId: PostCreateNamedAdminToken + responses: + "201": + description: | + Success. The named admin token has been created. + The response body contains the token string and metadata. + content: + application/json: + schema: + $ref: "#/components/schemas/AdminTokenObject" + "401": + $ref: "#/components/responses/Unauthorized" + "409": + description: A token with this name already exists. + summary: Create named admin token + description: | + Creates a named admin token. + A named admin token is a special type of admin token with a custom name for identification and management. + tags: + - Authentication + - Token + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + token_name: + type: string + description: The name for the admin token. + expiry_secs: + type: integer + description: Optional expiration time in seconds. If not provided, the token does not expire. + nullable: true + required: + - token_name + /api/v3/engine/{request_path}: + get: + operationId: GetProcessingEnginePluginRequest + responses: + "200": + description: Success. The plugin request has been executed. + "400": + description: Malformed request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Plugin not found. + "500": + description: Processing failure. + summary: On Request processing engine plugin request + description: > + Executes the On Request processing engine plugin specified in the trigger's `plugin_filename`. + + The request can include request headers, query string parameters, and a request body, which InfluxDB passes to + the plugin. + + + An On Request plugin implements the following signature: + + + ```python + + def process_request(influxdb3_local, query_parameters, request_headers, request_body, args=None) + + ``` + + + The response depends on the plugin implementation. + tags: + - Processing engine + post: + operationId: PostProcessingEnginePluginRequest + responses: + "200": + description: Success. The plugin request has been executed. + "400": + description: Malformed request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Plugin not found. + "500": + description: Processing failure. + summary: On Request processing engine plugin request + description: > + Executes the On Request processing engine plugin specified in the trigger's `plugin_filename`. + + The request can include request headers, query string parameters, and a request body, which InfluxDB passes to + the plugin. + + + An On Request plugin implements the following signature: + + + ```python + + def process_request(influxdb3_local, query_parameters, request_headers, request_body, args=None) + + ``` + + + The response depends on the plugin implementation. + parameters: + - $ref: "#/components/parameters/ContentType" + requestBody: + required: false + content: + application/json: + schema: + type: object + additionalProperties: true + tags: + - Processing engine + parameters: + - name: request_path + description: | + The path configured in the request trigger specification for the plugin. + + For example, if you define a trigger with the following: + + ```json + trigger_specification: "request:hello-world" + ``` + + then, the HTTP API exposes the following plugin endpoint: + + ``` + /api/v3/engine/hello-world + ``` + in: path + required: true + schema: + type: string + /api/v3/enterprise/configure/file_index: + post: + operationId: configure_file_index_create + summary: Create a file index + description: >- + Creates a file index for a database or table. + + + A file index improves query performance by indexing data files based on specified columns, enabling the query + engine to skip irrelevant files during query execution. + + + This endpoint is only available in InfluxDB 3 Enterprise. + x-enterprise-only: true + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/FileIndexCreateRequest" + responses: + "200": + description: Success. The file index has been created. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Database or table not found. + tags: + - Database + - Table + delete: + operationId: configure_file_index_delete + summary: Delete a file index + description: |- + Deletes a file index from a database or table. + + This endpoint is only available in InfluxDB 3 Enterprise. + x-enterprise-only: true + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/FileIndexDeleteRequest" + responses: + "200": + description: Success. The file index has been deleted. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Database, table, or file index not found. + tags: + - Database + - Table + /api/v3/enterprise/configure/node/stop: + post: + operationId: stop_node + summary: Mark a node as stopped + description: >- + Marks a node as stopped in the catalog, freeing up the licensed cores it was using for other nodes. + + + Use this endpoint after you have already stopped the physical instance (for example, using `kill` or stopping + the container). This endpoint does not shut down the running process — you must stop the instance first. + + + When the node is marked as stopped: + + 1. Licensed cores from the stopped node are freed for reuse + + 2. Other nodes in the cluster see the update after their catalog sync interval + + + This endpoint is only available in InfluxDB 3 Enterprise. + + + #### Related + + + - [influxdb3 stop node](/influxdb3/enterprise/reference/cli/influxdb3/stop/node/) + x-enterprise-only: true + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/StopNodeRequest" + responses: + "200": + description: Success. The node has been marked as stopped. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Node not found. + tags: + - Server information + /api/v3/enterprise/configure/table/retention_period: + post: + operationId: create_or_update_retention_period_for_table + summary: Set table retention period + description: >- + Sets or updates the retention period for a specific table. + + + Use this endpoint to control how long data in a table is retained independently of the database-level retention + period. + + + This endpoint is only available in InfluxDB 3 Enterprise. + + + #### Related + + + - [influxdb3 update table](/influxdb3/enterprise/reference/cli/influxdb3/update/table/) + x-enterprise-only: true + parameters: + - name: db + in: query + required: true + schema: + type: string + description: The database name. + - name: table + in: query + required: true + schema: + type: string + description: The table name. + - name: duration + in: query + required: true + schema: + type: string + description: The retention period as a human-readable duration (for example, "30d", "24h", "1y"). + responses: + "204": + description: Success. The table retention period has been set. + "400": + description: Bad request. Invalid duration format. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Database or table not found. + tags: + - Table + delete: + operationId: delete_retention_period_for_table + summary: Clear table retention period + description: >- + Removes the retention period from a specific table, reverting to the database-level retention period (or + infinite retention if no database-level retention is set). + + + This endpoint is only available in InfluxDB 3 Enterprise. + + + #### Related + + + - [influxdb3 update table](/influxdb3/enterprise/reference/cli/influxdb3/update/table/) + x-enterprise-only: true + parameters: + - name: db + in: query + required: true + schema: + type: string + description: The database name. + - name: table + in: query + required: true + schema: + type: string + description: The table name. + responses: + "204": + description: Success. The table retention period has been cleared. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Database or table not found. + tags: + - Table + /api/v3/enterprise/configure/token: + post: + operationId: PostCreateResourceToken + summary: Create a resource token + description: | + Creates a resource (fine-grained permissions) token. + A resource token is a token that has access to specific resources in the system. + + This endpoint is only available in InfluxDB 3 Enterprise. + responses: + "201": + description: | + Success. The resource token has been created. + The response body contains the token string and metadata. + content: + application/json: + schema: + $ref: "#/components/schemas/ResourceTokenObject" + "401": + $ref: "#/components/responses/Unauthorized" + tags: + - Authentication + - Token + x-enterprise-only: true + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/CreateTokenWithPermissionsRequest" + /api/v3/plugin_test/schedule: + post: + operationId: PostTestSchedulingPlugin + responses: + "200": + description: Success. The plugin test has been executed. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Plugin not enabled. + summary: Test scheduling plugin + description: Executes a test of a scheduling plugin. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/SchedulePluginTestRequest" + tags: + - Processing engine + /api/v3/plugin_test/wal: + post: + operationId: PostTestWALPlugin + responses: + "200": + description: Success. The plugin test has been executed. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Plugin not enabled. + summary: Test WAL plugin + description: Executes a test of a write-ahead logging (WAL) plugin. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/WALPluginTestRequest" + tags: + - Processing engine + /api/v3/plugins/directory: + put: + operationId: PutPluginDirectory + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/PluginDirectoryRequest" + responses: + "200": + description: Success. The plugin directory has been updated. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Forbidden. Admin token required. + "500": + description: Plugin not found. The `plugin_name` does not match any registered trigger. + summary: Update a multi-file plugin directory + description: | + Replaces all files in a multi-file plugin directory. The + `plugin_name` must match a registered trigger name. Each entry in + the `files` array specifies a `relative_path` and `content`—the + server writes them into the trigger's plugin directory. + + Use this endpoint to update multi-file plugins (directories with + `__init__.py` and supporting modules). For single-file plugins, + use `PUT /api/v3/plugins/files` instead. + tags: + - Processing engine + x-security-note: Requires an admin token + /api/v3/plugins/files: + post: + operationId: create_plugin_file + summary: Create a plugin file + description: | + Creates a single plugin file in the plugin directory. Writes the + `content` to a file named after `plugin_name`. Does not require an + existing trigger—use this to upload plugin files before creating + triggers that reference them. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/PluginFileRequest" + responses: + "200": + description: Success. The plugin file has been created. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Forbidden. Admin token required. + tags: + - Processing engine + x-security-note: Requires an admin token + put: + operationId: PutPluginFile + summary: Update a plugin file + description: | + Updates a single plugin file for an existing trigger. The + `plugin_name` must match a registered trigger name—the server + resolves the trigger's `plugin_filename` and overwrites that file + with the provided `content`. + + To upload a new plugin file before creating a trigger, use + `POST /api/v3/plugins/files` instead. To update a multi-file + plugin directory, use `PUT /api/v3/plugins/directory`. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/PluginFileRequest" + responses: + "200": + description: Success. The plugin file has been updated. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Forbidden. Admin token required. + "500": + description: Plugin not found. The `plugin_name` does not match any registered trigger. + tags: + - Processing engine + x-security-note: Requires an admin token + /api/v3/query_influxql: + get: + operationId: GetExecuteInfluxQLQuery + responses: + "200": + description: Success. The response body contains query results. + content: + application/json: + schema: + $ref: "#/components/schemas/QueryResponse" + text/csv: + schema: + type: string + application/vnd.apache.parquet: + schema: + type: string + application/jsonl: + schema: + type: string + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "404": + description: Database not found. + "405": + description: Method not allowed. + "422": + description: Unprocessable entity. + summary: Execute InfluxQL query + description: Executes an InfluxQL query to retrieve data from the specified database. + parameters: + - $ref: "#/components/parameters/dbQueryParam" + - name: q + in: query + required: true + schema: + type: string + - name: format + in: query + required: false + schema: + type: string + - $ref: "#/components/parameters/AcceptQueryHeader" + - name: params + in: query + required: false + schema: + type: string + description: JSON-encoded query parameters. Use this to pass bind parameters to parameterized queries. + description: JSON-encoded query parameters for parameterized queries. + tags: + - Query data + post: + operationId: PostExecuteQueryInfluxQL + responses: + "200": + description: Success. The response body contains query results. + content: + application/json: + schema: + $ref: "#/components/schemas/QueryResponse" + text/csv: + schema: + type: string + application/vnd.apache.parquet: + schema: + type: string + application/jsonl: + schema: + type: string + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "404": + description: Database not found. + "405": + description: Method not allowed. + "422": + description: Unprocessable entity. + summary: Execute InfluxQL query + description: Executes an InfluxQL query to retrieve data from the specified database. + parameters: + - $ref: "#/components/parameters/AcceptQueryHeader" + - $ref: "#/components/parameters/ContentType" + requestBody: + $ref: "#/components/requestBodies/queryRequestBody" + tags: + - Query data + /api/v3/query_sql: + get: + operationId: GetExecuteQuerySQL + responses: + "200": + description: Success. The response body contains query results. + content: + application/json: + schema: + $ref: "#/components/schemas/QueryResponse" + example: + results: + - series: + - name: mytable + columns: + - time + - value + values: + - - "2024-02-02T12:00:00Z" + - 42 + text/csv: + schema: + type: string + application/vnd.apache.parquet: + schema: + type: string + application/jsonl: + schema: + type: string + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "404": + description: Database not found. + "405": + description: Method not allowed. + "422": + description: Unprocessable entity. + summary: Execute SQL query + description: Executes an SQL query to retrieve data from the specified database. + parameters: + - $ref: "#/components/parameters/db" + - $ref: "#/components/parameters/querySqlParam" + - $ref: "#/components/parameters/format" + - $ref: "#/components/parameters/AcceptQueryHeader" + - $ref: "#/components/parameters/ContentType" + - name: params + in: query + required: false + schema: + type: string + description: JSON-encoded query parameters. Use this to pass bind parameters to parameterized queries. + description: JSON-encoded query parameters for parameterized queries. + tags: + - Query data + post: + operationId: PostExecuteQuerySQL + responses: + "200": + description: Success. The response body contains query results. + content: + application/json: + schema: + $ref: "#/components/schemas/QueryResponse" + text/csv: + schema: + type: string + application/vnd.apache.parquet: + schema: + type: string + application/jsonl: + schema: + type: string + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "404": + description: Database not found. + "405": + description: Method not allowed. + "422": + description: Unprocessable entity. + summary: Execute SQL query + description: Executes an SQL query to retrieve data from the specified database. + parameters: + - $ref: "#/components/parameters/AcceptQueryHeader" + - $ref: "#/components/parameters/ContentType" + requestBody: + $ref: "#/components/requestBodies/queryRequestBody" + tags: + - Query data + /api/v3/write_lp: + post: + operationId: PostWriteLP + parameters: + - $ref: "#/components/parameters/dbWriteParam" + - $ref: "#/components/parameters/accept_partial" + - $ref: "#/components/parameters/precisionParam" + - name: no_sync + in: query + schema: + $ref: "#/components/schemas/NoSync" + - name: Content-Type + in: header + description: | + The content type of the request payload. + schema: + $ref: "#/components/schemas/LineProtocol" + required: false + - name: Accept + in: header + description: | + The content type that the client can understand. + Writes only return a response body if they fail (partially or completely)--for example, + due to a syntax problem or type mismatch. + schema: + type: string + default: application/json + enum: + - application/json + required: false + - $ref: "#/components/parameters/ContentEncoding" + - $ref: "#/components/parameters/ContentLength" + responses: + "204": + description: Success ("No Content"). All data in the batch is written and queryable. + headers: + cluster-uuid: + $ref: "#/components/headers/ClusterUUID" + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "413": + description: Request entity too large. + "422": + description: Unprocessable entity. + summary: Write line protocol + description: > + Writes line protocol to the specified database. + + + This is the native InfluxDB 3 Enterprise write endpoint that provides enhanced control + + over write behavior with advanced parameters for high-performance and fault-tolerant operations. + + + Use this endpoint to send data in [line protocol](/influxdb3/enterprise/reference/syntax/line-protocol/) format + to InfluxDB. + + Use query parameters to specify options for writing data. + + + #### Features + + + - **Partial writes**: Use `accept_partial=true` to allow partial success when some lines in a batch fail + + - **Asynchronous writes**: Use `no_sync=true` to skip waiting for WAL synchronization, allowing faster response + times but sacrificing durability guarantees + + - **Flexible precision**: Automatic timestamp precision detection with `precision=auto` (default) + + + #### Auto precision detection + + + When you use `precision=auto` or omit the precision parameter, InfluxDB 3 automatically detects + + the timestamp precision based on the magnitude of the timestamp value: + + + - Timestamps < 5e9 → Second precision (multiplied by 1,000,000,000 to convert to nanoseconds) + + - Timestamps < 5e12 → Millisecond precision (multiplied by 1,000,000) + + - Timestamps < 5e15 → Microsecond precision (multiplied by 1,000) + + - Larger timestamps → Nanosecond precision (no conversion needed) + + + #### Related + + + - [Use the InfluxDB v3 write_lp API to write data](/influxdb3/enterprise/write-data/http-api/v3-write-lp/) + requestBody: + $ref: "#/components/requestBodies/lineProtocolRequestBody" + tags: + - Write data + x-codeSamples: + - label: cURL - Basic write + lang: Shell + source: | + curl --request POST "http://localhost:8181/api/v3/write_lp?db=sensors" \ + --header "Authorization: Bearer DATABASE_TOKEN" \ + --header "Content-Type: text/plain" \ + --data-raw "cpu,host=server01 usage=85.2 1638360000000000000" + - label: cURL - Write with millisecond precision + lang: Shell + source: | + curl --request POST "http://localhost:8181/api/v3/write_lp?db=sensors&precision=ms" \ + --header "Authorization: Bearer DATABASE_TOKEN" \ + --header "Content-Type: text/plain" \ + --data-raw "cpu,host=server01 usage=85.2 1638360000000" + - label: cURL - Asynchronous write with partial acceptance + lang: Shell + source: > + curl --request POST + "http://localhost:8181/api/v3/write_lp?db=sensors&accept_partial=true&no_sync=true&precision=auto" \ + --header "Authorization: Bearer DATABASE_TOKEN" \ + --header "Content-Type: text/plain" \ + --data-raw "cpu,host=server01 usage=85.2 + memory,host=server01 used=4096" + - label: cURL - Multiple measurements with tags + lang: Shell + source: | + curl --request POST "http://localhost:8181/api/v3/write_lp?db=sensors&precision=ns" \ + --header "Authorization: Bearer DATABASE_TOKEN" \ + --header "Content-Type: text/plain" \ + --data-raw "cpu,host=server01,region=us-west usage=85.2,load=0.75 1638360000000000000 + memory,host=server01,region=us-west used=4096,free=12288 1638360000000000000 + disk,host=server01,region=us-west,device=/dev/sda1 used=50.5,free=49.5 1638360000000000000" + /health: + get: + operationId: GetHealth + responses: + "200": + description: Service is running. Returns `OK`. + content: + text/plain: + schema: + type: string + example: OK + "401": + description: Unauthorized. Authentication is required. + "500": + description: Service is unavailable. + summary: Health check + description: | + Checks the status of the service. + + Returns `OK` if the service is running. This endpoint does not return version information. + Use the [`/ping`](#operation/GetPing) endpoint to retrieve version details. + + > **Note**: This endpoint requires authentication by default in InfluxDB 3 Enterprise. + tags: + - Server information + /metrics: + get: + operationId: GetMetrics + responses: + "200": + description: Success + summary: Metrics + description: Retrieves Prometheus-compatible server metrics. + tags: + - Server information + /ping: + get: + operationId: GetPing + responses: + "200": + description: Success. The response body contains server information. + headers: + x-influxdb-version: + description: The InfluxDB version number (for example, `3.8.0`). + schema: + type: string + example: 3.8.0 + x-influxdb-build: + description: The InfluxDB build type (`Core` or `Enterprise`). + schema: + type: string + example: Enterprise + content: + application/json: + schema: + type: object + properties: + version: + type: string + description: The InfluxDB version number. + example: 3.8.0 + revision: + type: string + description: The git revision hash for the build. + example: 83b589b883 + process_id: + type: string + description: A unique identifier for the server process. + example: b756d9e0-cecd-4f72-b6d0-19e2d4f8cbb7 + "401": + description: Unauthorized. Authentication is required. + "404": + description: | + Not Found. Returned for HEAD requests. + Use a GET request to retrieve version information. + x-client-method: ping + summary: Ping the server + description: | + Returns version information for the server. + + **Important**: Use a GET request. HEAD requests return `404 Not Found`. + + The response includes version information in both headers and the JSON body: + + - **Headers**: `x-influxdb-version` and `x-influxdb-build` + - **Body**: JSON object with `version`, `revision`, and `process_id` + + > **Note**: This endpoint requires authentication by default in InfluxDB 3 Enterprise. + tags: + - Server information + post: + operationId: ping + responses: + "200": + description: Success. The response body contains server information. + headers: + x-influxdb-version: + description: The InfluxDB version number (for example, `3.8.0`). + schema: + type: string + example: 3.8.0 + x-influxdb-build: + description: The InfluxDB build type (`Core` or `Enterprise`). + schema: + type: string + example: Enterprise + content: + application/json: + schema: + type: object + properties: + version: + type: string + description: The InfluxDB version number. + example: 3.8.0 + revision: + type: string + description: The git revision hash for the build. + example: 83b589b883 + process_id: + type: string + description: A unique identifier for the server process. + example: b756d9e0-cecd-4f72-b6d0-19e2d4f8cbb7 + "401": + description: Unauthorized. Authentication is required. + "404": + description: | + Not Found. Returned for HEAD requests. + Use a GET request to retrieve version information. + summary: Ping the server + description: Returns version information for the server. Accepts POST in addition to GET. + tags: + - Server information + /query: + get: + operationId: GetV1ExecuteQuery + responses: + "200": + description: | + Success. The response body contains query results. + content: + application/json: + schema: + $ref: "#/components/schemas/QueryResponse" + application/csv: + schema: + type: string + headers: + Content-Type: + description: > + The content type of the response. + + Default is `application/json`. + + + If the `Accept` request header is `application/csv` or `text/csv`, the `Content-type` response header is + `application/csv` + + and the response is formatted as CSV. + schema: + type: string + default: application/json + enum: + - application/json + - application/csv + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "404": + description: Database not found. + "405": + description: Method not allowed. + "422": + description: Unprocessable entity. + summary: Execute InfluxQL query (v1-compatible) + description: > + Executes an InfluxQL query to retrieve data from the specified database. + + + This endpoint is compatible with InfluxDB 1.x client libraries and third-party integrations such as Grafana. + + Use query parameters to specify the database and the InfluxQL query. + + + #### Related + + + - [Use the InfluxDB v1 HTTP query API and InfluxQL to query + data](/influxdb3/enterprise/query-data/execute-queries/influxdb-v1-api/) + parameters: + - name: Accept + in: header + schema: + type: string + default: application/json + enum: + - application/json + - application/csv + - text/csv + required: false + description: > + The content type that the client can understand. + + + If `text/csv` is specified, the `Content-type` response header is `application/csv` and the response is + formatted as CSV. + + + Returns an error if the format is invalid or non-UTF8. + - in: query + name: chunked + description: | + If true, the response is divided into chunks of size `chunk_size`. + schema: + type: boolean + default: false + - in: query + name: chunk_size + description: | + The number of records that will go into a chunk. + This parameter is only used if `chunked=true`. + schema: + type: integer + default: 10000 + - in: query + name: db + description: The database to query. If not provided, the InfluxQL query string must specify the database. + schema: + type: string + format: InfluxQL + - in: query + name: pretty + description: | + If true, the JSON response is formatted in a human-readable format. + schema: + type: boolean + default: false + - in: query + name: q + description: The InfluxQL query string. + required: true + schema: + type: string + - name: epoch + description: > + Formats timestamps as [unix (epoch) timestamps](/influxdb3/enterprise/reference/glossary/#unix-timestamp) + with the specified precision + + instead of [RFC3339 timestamps](/influxdb3/enterprise/reference/glossary/#rfc3339-timestamp) with nanosecond + precision. + in: query + schema: + $ref: "#/components/schemas/EpochCompatibility" + - $ref: "#/components/parameters/v1UsernameParam" + - $ref: "#/components/parameters/v1PasswordParam" + - name: rp + in: query + required: false + schema: + type: string + description: | + Retention policy name. Honored but discouraged. InfluxDB 3 doesn't use retention policies. + - name: Authorization + in: header + required: false + schema: + type: string + description: | + Authorization header for token-based authentication. + Supported schemes: + - `Bearer AUTH_TOKEN` - OAuth bearer token scheme + - `Token AUTH_TOKEN` - InfluxDB v2 token scheme + - `Basic ` - Basic authentication (username is ignored) + tags: + - Query data + - Compatibility endpoints + post: + operationId: PostExecuteV1Query + responses: + "200": + description: | + Success. The response body contains query results. + content: + application/json: + schema: + $ref: "#/components/schemas/QueryResponse" + application/csv: + schema: + type: string + headers: + Content-Type: + description: > + The content type of the response. + + Default is `application/json`. + + + If the `Accept` request header is `application/csv` or `text/csv`, the `Content-type` response header is + `application/csv` + + and the response is formatted as CSV. + schema: + type: string + default: application/json + enum: + - application/json + - application/csv + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "404": + description: Database not found. + "405": + description: Method not allowed. + "422": + description: Unprocessable entity. + summary: Execute InfluxQL query (v1-compatible) + description: > + Executes an InfluxQL query to retrieve data from the specified database. + + + #### Related + + + - [Use the InfluxDB v1 HTTP query API and InfluxQL to query + data](/influxdb3/enterprise/query-data/execute-queries/influxdb-v1-api/) + parameters: + - name: Accept + in: header + schema: + type: string + default: application/json + enum: + - application/json + - application/csv + - text/csv + required: false + description: > + The content type that the client can understand. + + + If `text/csv` is specified, the `Content-type` response header is `application/csv` and the response is + formatted as CSV. + + + Returns an error if the format is invalid or non-UTF8. + requestBody: + content: + application/json: + schema: + type: object + properties: + db: + type: string + description: The database to query. If not provided, the InfluxQL query string must specify the database. + q: + description: The InfluxQL query string. + type: string + chunked: + description: | + If true, the response is divided into chunks of size `chunk_size`. + type: boolean + chunk_size: + description: | + The number of records that will go into a chunk. + This parameter is only used if `chunked=true`. + type: integer + default: 10000 + epoch: + description: > + A unix timestamp precision. + + + - `h` for hours + + - `m` for minutes + + - `s` for seconds + + - `ms` for milliseconds + + - `u` or `µ` for microseconds + + - `ns` for nanoseconds + + + Formats timestamps as [unix (epoch) + timestamps](/influxdb3/enterprise/reference/glossary/#unix-timestamp) with the specified precision + + instead of [RFC3339 timestamps](/influxdb3/enterprise/reference/glossary/#rfc3339-timestamp) with + nanosecond precision. + enum: + - ns + - u + - µ + - ms + - s + - m + - h + type: string + pretty: + description: | + If true, the JSON response is formatted in a human-readable format. + type: boolean + required: + - q + application/x-www-form-urlencoded: + schema: + type: object + properties: + db: + type: string + description: The database to query. If not provided, the InfluxQL query string must specify the database. + q: + description: The InfluxQL query string. + type: string + chunked: + description: | + If true, the response is divided into chunks of size `chunk_size`. + type: boolean + chunk_size: + description: | + The number of records that will go into a chunk. + This parameter is only used if `chunked=true`. + type: integer + default: 10000 + epoch: + description: > + A unix timestamp precision. + + + - `h` for hours + + - `m` for minutes + + - `s` for seconds + + - `ms` for milliseconds + + - `u` or `µ` for microseconds + + - `ns` for nanoseconds + + + Formats timestamps as [unix (epoch) + timestamps](/influxdb3/enterprise/reference/glossary/#unix-timestamp) with the specified precision + + instead of [RFC3339 timestamps](/influxdb3/enterprise/reference/glossary/#rfc3339-timestamp) with + nanosecond precision. + enum: + - ns + - u + - µ + - ms + - s + - m + - h + type: string + pretty: + description: | + If true, the JSON response is formatted in a human-readable format. + type: boolean + required: + - q + application/vnd.influxql: + schema: + type: string + description: InfluxQL query string sent as the request body. + tags: + - Query data + - Compatibility endpoints + /write: + post: + operationId: PostV1Write + responses: + "204": + description: Success ("No Content"). All data in the batch is written and queryable. + headers: + cluster-uuid: + $ref: "#/components/headers/ClusterUUID" + "400": + description: | + Bad request. Some (a _partial write_) or all of the data from the batch was rejected and not written. + If a partial write occurred, then some points from the batch are written and queryable. + + The response body: + - indicates if a partial write occurred or all data was rejected. + - contains details about the [rejected points](/influxdb3/enterprise/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. + content: + application/json: + examples: + rejectedAllPoints: + summary: Rejected all points in the batch + value: | + { + "error": "write of line protocol failed", + "data": [ + { + "original_line": "dquote> home,room=Kitchen temp=hi", + "line_number": 2, + "error_message": "No fields were provided" + } + ] + } + partialWriteErrorWithRejectedPoints: + summary: Partial write rejected some points in the batch + value: | + { + "error": "partial write of line protocol occurred", + "data": [ + { + "original_line": "dquote> home,room=Kitchen temp=hi", + "line_number": 2, + "error_message": "No fields were provided" + } + ] + } + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "413": + description: Request entity too large. + summary: Write line protocol (v1-compatible) + description: > + Writes line protocol to the specified database. + + + This endpoint provides backward compatibility for InfluxDB 1.x write workloads using tools such as InfluxDB 1.x + client libraries, the Telegraf `outputs.influxdb` output plugin, or third-party tools. + + + Use this endpoint to send data in [line + protocol](https://docs.influxdata.com/influxdb3/enterprise/reference/syntax/line-protocol/) format to InfluxDB. + + Use query parameters to specify options for writing data. + + + #### Related + + + - [Use compatibility APIs to write data](/influxdb3/enterprise/write-data/http-api/compatibility-apis/) + parameters: + - $ref: "#/components/parameters/dbWriteParam" + - $ref: "#/components/parameters/compatibilityPrecisionParam" + - $ref: "#/components/parameters/v1UsernameParam" + - $ref: "#/components/parameters/v1PasswordParam" + - name: rp + in: query + required: false + schema: + type: string + description: | + Retention policy name. Honored but discouraged. InfluxDB 3 doesn't use retention policies. + - name: consistency + in: query + required: false + schema: + type: string + description: | + Write consistency level. Ignored by InfluxDB 3. Provided for compatibility with InfluxDB 1.x clients. + - name: Authorization + in: header + required: false + schema: + type: string + description: | + Authorization header for token-based authentication. + Supported schemes: + - `Bearer AUTH_TOKEN` - OAuth bearer token scheme + - `Token AUTH_TOKEN` - InfluxDB v2 token scheme + - `Basic ` - Basic authentication (username is ignored) + - name: Content-Type + in: header + description: | + The content type of the request payload. + schema: + $ref: "#/components/schemas/LineProtocol" + required: false + - name: Accept + in: header + description: | + The content type that the client can understand. + Writes only return a response body if they fail (partially or completely)--for example, + due to a syntax problem or type mismatch. + schema: + type: string + default: application/json + enum: + - application/json + required: false + - $ref: "#/components/parameters/ContentEncoding" + - $ref: "#/components/parameters/ContentLength" + requestBody: + $ref: "#/components/requestBodies/lineProtocolRequestBody" + tags: + - Compatibility endpoints + - Write data +components: + parameters: + AcceptQueryHeader: + name: Accept + in: header + schema: + type: string + default: application/json + enum: + - application/json + - application/jsonl + - application/vnd.apache.parquet + - text/csv + required: false + description: | + The content type that the client can understand. + ContentEncoding: + name: Content-Encoding + in: header + description: | + The compression applied to the line protocol in the request payload. + To send a gzip payload, pass `Content-Encoding: gzip` header. + schema: + $ref: "#/components/schemas/ContentEncoding" + required: false + ContentLength: + name: Content-Length + in: header + description: | + The size of the entity-body, in bytes, sent to InfluxDB. + schema: + $ref: "#/components/schemas/ContentLength" + ContentType: + name: Content-Type + description: | + The format of the data in the request body. + in: header + schema: + type: string + enum: + - application/json + required: false + db: + name: db + in: query + required: true + schema: + type: string + description: | + The name of the database. + dbWriteParam: + name: db + in: query + required: true + schema: + type: string + description: | + The name of the database. + InfluxDB creates the database if it doesn't already exist, and then + writes all points in the batch to the database. + dbQueryParam: + name: db + in: query + required: false + schema: + type: string + description: | + The name of the database. + + If you provide a query that specifies the database, you can omit the 'db' parameter from your request. + accept_partial: + name: accept_partial + in: query + required: false + schema: + $ref: "#/components/schemas/AcceptPartial" + compatibilityPrecisionParam: + name: precision + in: query + required: false + schema: + $ref: "#/components/schemas/PrecisionWriteCompatibility" + description: The precision for unix timestamps in the line protocol batch. + precisionParam: + name: precision + in: query + required: false + schema: + $ref: "#/components/schemas/PrecisionWrite" + description: The precision for unix timestamps in the line protocol batch. + querySqlParam: + name: q + in: query + required: true + schema: + type: string + format: SQL + description: | + The query to execute. + format: + name: format + in: query + required: false + schema: + $ref: "#/components/schemas/Format" + formatRequired: + name: format + in: query + required: true + schema: + $ref: "#/components/schemas/Format" + v1UsernameParam: + name: u + in: query + required: false + schema: + type: string + description: > + Username for v1 compatibility authentication. + + When using Basic authentication or query string authentication, InfluxDB 3 ignores this parameter but allows any + arbitrary string for compatibility with InfluxDB 1.x clients. + v1PasswordParam: + name: p + in: query + required: false + schema: + type: string + description: | + Password for v1 compatibility authentication. + For query string authentication, pass a database token with write permissions as this parameter. + InfluxDB 3 checks that the `p` value is an authorized token. + requestBodies: + lineProtocolRequestBody: + required: true + content: + text/plain: + schema: + type: string + examples: + line: + summary: Example line protocol + value: measurement,tag=value field=1 1234567890 + multiline: + summary: Example line protocol with UTF-8 characters + value: | + measurement,tag=value field=1 1234567890 + measurement,tag=value field=2 1234567900 + measurement,tag=value field=3 1234568000 + queryRequestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/QueryRequestObject" + schemas: + AdminTokenObject: + type: object + properties: + id: + type: integer + name: + type: string + token: + type: string + hash: + type: string + created_at: + type: string + format: date-time + expiry: + format: date-time + example: + id: 0 + name: _admin + token: apiv3_00xx0Xx0xx00XX0x0 + hash: 00xx0Xx0xx00XX0x0 + created_at: "2025-04-18T14:02:45.331Z" + expiry: null + ResourceTokenObject: + type: object + properties: + token_name: + type: string + permissions: + type: array + items: + type: object + properties: + resource_type: + type: string + enum: + - system + - db + actions: + type: array + items: + type: string + enum: + - read + - write + resource_names: + type: array + items: + type: string + description: List of resource names. Use "*" for all resources. + expiry_secs: + type: integer + description: The expiration time in seconds. + example: + token_name: All system information + permissions: + - resource_type: system + actions: + - read + resource_names: + - "*" + expiry_secs: 300000 + ContentEncoding: + type: string + enum: + - gzip + - identity + description: > + Content coding. + + Use `gzip` for compressed data or `identity` for unmodified, uncompressed data. + + + #### Multi-member gzip support + + + InfluxDB 3 supports multi-member gzip payloads (concatenated gzip files per [RFC + 1952](https://www.rfc-editor.org/rfc/rfc1952)). + + This allows you to: + + - Concatenate multiple gzip files and send them in a single request + + - Maintain compatibility with InfluxDB v1 and v2 write endpoints + + - Simplify batch operations using standard compression tools + default: identity + LineProtocol: + type: string + enum: + - text/plain + - text/plain; charset=utf-8 + description: | + `text/plain` is the content type for line protocol. `UTF-8` is the default character set. + default: text/plain; charset=utf-8 + ContentLength: + type: integer + description: The length in decimal number of octets. + Database: + type: string + AcceptPartial: + type: boolean + default: true + description: Accept partial writes. + Format: + type: string + enum: + - json + - csv + - parquet + - json_lines + - jsonl + - pretty + description: |- + The format of data in the response body. + `json_lines` is the canonical name; `jsonl` is accepted as an alias. + NoSync: + type: boolean + default: false + description: | + Acknowledges a successful write without waiting for WAL persistence. + + #### Related + + - [Use the HTTP API and client libraries to write data](/influxdb3/enterprise/write-data/api-client-libraries/) + - [Data durability](/influxdb3/enterprise/reference/internals/durability/) + PrecisionWriteCompatibility: + enum: + - ms + - s + - us + - u + - ns + - "n" + type: string + description: |- + The precision for unix timestamps in the line protocol batch. + Use `ms` for milliseconds, `s` for seconds, `us` or `u` for microseconds, or `ns` or `n` for nanoseconds. + Optional — defaults to nanosecond precision if omitted. + PrecisionWrite: + enum: + - auto + - nanosecond + - microsecond + - millisecond + - second + type: string + description: | + The precision for unix timestamps in the line protocol batch. + + Supported values: + - `auto` (default): Automatically detects precision based on timestamp magnitude + - `nanosecond`: Nanoseconds + - `microsecond`: Microseconds + - `millisecond`: Milliseconds + - `second`: Seconds + QueryRequestObject: + type: object + properties: + db: + description: | + The name of the database to query. + Required if the query (`q`) doesn't specify the database. + type: string + q: + description: The query to execute. + type: string + format: + description: The format of the query results. + type: string + enum: + - json + - csv + - parquet + - json_lines + - jsonl + - pretty + params: + description: | + Additional parameters for the query. + Use this field to pass query parameters. + type: object + additionalProperties: true + required: + - db + - q + example: + db: mydb + q: SELECT * FROM mytable + format: json + params: {} + CreateDatabaseRequest: + type: object + properties: + db: + type: string + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$|^[a-zA-Z0-9]$ + description: |- + The database name. Database names cannot contain underscores (_). + Names must start and end with alphanumeric characters and can contain hyphens (-) in the middle. + retention_period: + type: string + description: |- + The retention period for the database. Specifies how long data should be retained. + Use duration format (for example, "1d", "1h", "30m", "7d"). + example: 7d + required: + - db + CreateTableRequest: + type: object + properties: + db: + type: string + table: + type: string + tags: + type: array + items: + type: string + fields: + type: array + items: + type: object + properties: + name: + type: string + type: + type: string + enum: + - utf8 + - int64 + - uint64 + - float64 + - bool + required: + - name + - type + retention_period: + type: string + description: |- + The retention period for the table. Specifies how long data in this table should be retained. + Use duration format (for example, "1d", "1h", "30m", "7d"). + example: 30d + required: + - db + - table + - tags + - fields + DistinctCacheCreateRequest: + type: object + properties: + db: + type: string + table: + type: string + node_spec: + $ref: "#/components/schemas/ApiNodeSpec" + name: + type: string + description: Optional cache name. + columns: + type: array + items: + type: string + max_cardinality: + type: integer + description: Optional maximum cardinality. + max_age: + type: integer + description: Optional maximum age in seconds. + required: + - db + - table + - columns + example: + db: mydb + table: mytable + columns: + - tag1 + - tag2 + max_cardinality: 1000 + max_age: 3600 + LastCacheCreateRequest: + type: object + properties: + db: + type: string + table: + type: string + node_spec: + $ref: "#/components/schemas/ApiNodeSpec" + name: + type: string + description: Optional cache name. + key_columns: + type: array + items: + type: string + description: Optional list of key columns. + value_columns: + type: array + items: + type: string + description: Optional list of value columns. + count: + type: integer + description: Optional count. + ttl: + type: integer + description: Optional time-to-live in seconds. + required: + - db + - table + example: + db: mydb + table: mytable + key_columns: + - tag1 + value_columns: + - field1 + count: 100 + ttl: 3600 + ProcessingEngineTriggerRequest: + type: object + properties: + db: + type: string + plugin_filename: + type: string + description: | + The path and filename of the plugin to execute--for example, + `schedule.py` or `endpoints/report.py`. + The path can be absolute or relative to the `--plugins-dir` directory configured when starting InfluxDB 3. + + The plugin file must implement the trigger interface associated with the trigger's specification. + node_spec: + $ref: "#/components/schemas/ApiNodeSpec" + trigger_name: + type: string + trigger_settings: + description: | + Configuration for trigger error handling and execution behavior. + allOf: + - $ref: "#/components/schemas/TriggerSettings" + trigger_specification: + description: > + Specifies when and how the processing engine trigger should be invoked. + + + ## Supported trigger specifications: + + + ### Cron-based scheduling + + Format: `cron:CRON_EXPRESSION` + + + Uses extended (6-field) cron format (second minute hour day_of_month month day_of_week): + + ``` + + ┌───────────── second (0-59) + + │ ┌───────────── minute (0-59) + + │ │ ┌───────────── hour (0-23) + + │ │ │ ┌───────────── day of month (1-31) + + │ │ │ │ ┌───────────── month (1-12) + + │ │ │ │ │ ┌───────────── day of week (0-6, Sunday=0) + + │ │ │ │ │ │ + + * * * * * * + + ``` + + Examples: + + - `cron:0 0 6 * * 1-5` - Every weekday at 6:00 AM + + - `cron:0 30 14 * * 5` - Every Friday at 2:30 PM + + - `cron:0 0 0 1 * *` - First day of every month at midnight + + + ### Interval-based scheduling + + Format: `every:DURATION` + + + Supported durations: `s` (seconds), `m` (minutes), `h` (hours), `d` (days), `w` (weeks), `M` (months), `y` + (years): + + - `every:30s` - Every 30 seconds + + - `every:5m` - Every 5 minutes + + - `every:1h` - Every hour + + - `every:1d` - Every day + + - `every:1w` - Every week + + - `every:1M` - Every month + + - `every:1y` - Every year + + + **Maximum interval**: 1 year + + + ### Table-based triggers + + - `all_tables` - Triggers on write events to any table in the database + + - `table:TABLE_NAME` - Triggers on write events to a specific table + + + ### On-demand triggers + + Format: `request:REQUEST_PATH` + + + Creates an HTTP endpoint `/api/v3/engine/REQUEST_PATH` for manual invocation: + + - `request:hello-world` - Creates endpoint `/api/v3/engine/hello-world` + + - `request:data-export` - Creates endpoint `/api/v3/engine/data-export` + pattern: ^(cron:[0-9 *,/-]+|every:[0-9]+[smhd]|all_tables|table:[a-zA-Z_][a-zA-Z0-9_]*|request:[a-zA-Z0-9_-]+)$ + example: cron:0 0 6 * * 1-5 + trigger_arguments: + type: object + additionalProperties: true + description: Optional arguments passed to the plugin. + disabled: + type: boolean + default: false + description: Whether the trigger is disabled. + required: + - db + - plugin_filename + - trigger_name + - trigger_settings + - trigger_specification + - disabled + TriggerSettings: + type: object + description: | + Configuration settings for processing engine trigger error handling and execution behavior. + properties: + run_async: + type: boolean + default: false + description: | + Whether to run the trigger asynchronously. + When `true`, the trigger executes in the background without blocking. + When `false`, the trigger executes synchronously. + error_behavior: + type: string + enum: + - Log + - Retry + - Disable + description: | + Specifies how to handle errors that occur during trigger execution: + - `Log`: Log the error and continue (default) + - `Retry`: Retry the trigger execution + - `Disable`: Disable the trigger after an error + default: Log + required: + - run_async + - error_behavior + ApiNodeSpec: + x-enterprise-only: true + type: object + description: | + Optional specification for targeting specific nodes in a multi-node InfluxDB 3 Enterprise cluster. + Use this to control which node(s) should handle the cache or trigger. + properties: + node_id: + type: string + description: | + The ID of a specific node in the cluster. + If specified, the cache or trigger will only be created on this node. + node_group: + type: string + description: | + The name of a node group in the cluster. + If specified, the cache or trigger will be created on all nodes in this group. + WALPluginTestRequest: + type: object + description: | + Request body for testing a write-ahead logging (WAL) plugin. + properties: + filename: + type: string + description: | + The path and filename of the plugin to test. + database: + type: string + description: | + The database name to use for the test. + input_lp: + type: string + description: | + Line protocol data to use as input for the test. + cache_name: + type: string + description: | + Optional name of the cache to use in the test. + input_arguments: + type: object + additionalProperties: + type: string + description: | + Optional key-value pairs of arguments to pass to the plugin. + required: + - filename + - database + - input_lp + SchedulePluginTestRequest: + type: object + description: | + Request body for testing a scheduling plugin. + properties: + filename: + type: string + description: | + The path and filename of the plugin to test. + database: + type: string + description: | + The database name to use for the test. + schedule: + type: string + description: | + Optional schedule specification in cron or interval format. + cache_name: + type: string + description: | + Optional name of the cache to use in the test. + input_arguments: + type: object + additionalProperties: + type: string + description: | + Optional key-value pairs of arguments to pass to the plugin. + required: + - filename + - database + PluginFileRequest: + type: object + description: | + Request body for updating a plugin file. + properties: + plugin_name: + type: string + description: | + The name of the plugin file to update. + content: + type: string + description: | + The content of the plugin file. + required: + - plugin_name + - content + PluginDirectoryRequest: + type: object + description: | + Request body for updating plugin directory with multiple files. + properties: + plugin_name: + type: string + description: | + The name of the plugin directory to update. + files: + type: array + items: + $ref: "#/components/schemas/PluginFileEntry" + description: | + List of plugin files to include in the directory. + required: + - plugin_name + - files + PluginFileEntry: + type: object + description: | + Represents a single file in a plugin directory. + properties: + content: + type: string + description: | + The content of the file. + relative_path: + type: string + description: The relative path of the file within the plugin directory. + required: + - relative_path + - content + ShowDatabasesResponse: + type: object + properties: + databases: + type: array + items: + type: string + QueryResponse: + type: object + properties: + results: + type: array + items: + type: object + example: + results: + - series: + - name: mytable + columns: + - time + - value + values: + - - "2024-02-02T12:00:00Z" + - 42 + ErrorMessage: + type: object + properties: + error: + type: string + data: + type: object + nullable: true + LineProtocolError: + properties: + code: + description: Code is the machine-readable error code. + enum: + - internal error + - not found + - conflict + - invalid + - empty value + - unavailable + readOnly: true + type: string + err: + description: Stack of errors that occurred during processing of the request. Useful for debugging. + readOnly: true + type: string + line: + description: First line in the request body that contains malformed data. + format: int32 + readOnly: true + type: integer + message: + description: Human-readable message. + readOnly: true + type: string + op: + description: Describes the logical code operation when the error occurred. Useful for debugging. + readOnly: true + type: string + required: + - code + EpochCompatibility: + description: | + A unix timestamp precision. + - `h` for hours + - `m` for minutes + - `s` for seconds + - `ms` for milliseconds + - `u` or `µ` for microseconds + - `ns` for nanoseconds + enum: + - ns + - u + - µ + - ms + - s + - m + - h + type: string + UpdateDatabaseRequest: + type: object + properties: + retention_period: + type: string + description: | + The retention period for the database. Specifies how long data should be retained. + Use duration format (for example, "1d", "1h", "30m", "7d"). + example: 7d + description: Request schema for updating database configuration. + UpdateTableRequest: + type: object + properties: + db: + type: string + description: The name of the database containing the table. + table: + type: string + description: The name of the table to update. + retention_period: + type: string + description: | + The retention period for the table. Specifies how long data in this table should be retained. + Use duration format (for example, "1d", "1h", "30m", "7d"). + example: 30d + required: + - db + - table + description: Request schema for updating table configuration. + LicenseResponse: + type: object + properties: + license_type: + type: string + description: The type of license (for example, "enterprise", "trial"). + example: enterprise + expires_at: + type: string + format: date-time + description: The expiration date of the license in ISO 8601 format. + example: "2025-12-31T23:59:59Z" + features: + type: array + items: + type: string + description: List of features enabled by the license. + example: + - clustering + - processing_engine + - advanced_auth + status: + type: string + enum: + - active + - expired + - invalid + description: The current status of the license. + example: active + description: Response schema for license information. + CreateTokenWithPermissionsRequest: + type: object + properties: + token_name: + type: string + description: The name for the resource token. + permissions: + type: array + items: + $ref: "#/components/schemas/PermissionDetailsApi" + description: List of permissions to grant to the token. + expiry_secs: + type: integer + description: Optional expiration time in seconds. + nullable: true + required: + - token_name + - permissions + PermissionDetailsApi: + type: object + properties: + resource_type: + type: string + enum: + - system + - db + description: The type of resource. + resource_names: + type: array + items: + type: string + description: List of resource names. Use "*" for all resources. + actions: + type: array + items: + type: string + enum: + - read + - write + description: List of actions to grant. + required: + - resource_type + - resource_names + - actions + FileIndexCreateRequest: + type: object + description: Request body for creating a file index. + properties: + db: + type: string + description: The database name. + table: + type: string + description: The table name. If omitted, the file index applies to the database. + nullable: true + columns: + type: array + items: + type: string + description: The columns to use for the file index. + required: + - db + - columns + example: + db: mydb + table: mytable + columns: + - tag1 + - tag2 + FileIndexDeleteRequest: + type: object + description: Request body for deleting a file index. + properties: + db: + type: string + description: The database name. + table: + type: string + description: The table name. If omitted, deletes the database-level file index. + nullable: true + required: + - db + example: + db: mydb + table: mytable + StopNodeRequest: + type: object + description: Request body for marking a node as stopped in the catalog. + properties: + node_id: + type: string + description: The ID of the node to mark as stopped. + required: + - node_id + example: + node_id: node-1 + responses: + Unauthorized: + description: Unauthorized access. + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorMessage" + BadRequest: + description: | + Request failed. Possible reasons: + + - Invalid database name + - Malformed request body + - Invalid timestamp precision + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorMessage" + Forbidden: + description: Access denied. + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorMessage" + NotFound: + description: Resource not found. + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorMessage" + headers: + ClusterUUID: + description: | + The catalog UUID of the InfluxDB instance. + This header is included in all HTTP API responses and enables you to: + - Identify which cluster instance handled the request + - Monitor deployments across multiple InfluxDB instances + - Debug and troubleshoot distributed systems + schema: + type: string + format: uuid + example: 01234567-89ab-cdef-0123-456789abcdef + securitySchemes: + BasicAuthentication: + type: http + scheme: basic + description: >- + Use the `Authorization` header with the `Basic` scheme to authenticate v1 API requests. + + + Works with v1 compatibility [`/write`](#operation/PostV1Write) and [`/query`](#operation/GetV1Query) endpoints + in InfluxDB 3. + + + When authenticating requests, InfluxDB 3 checks that the `password` part of the decoded credential is an + authorized token + + and ignores the `username` part of the decoded credential. + + + ### Syntax + + + ```http + + Authorization: Basic + + ``` + + + ### Example + + + ```bash + + curl "http://localhost:8181/write?db=DATABASE_NAME&precision=s" \ + --user "":"AUTH_TOKEN" \ + --header "Content-type: text/plain; charset=utf-8" \ + --data-binary 'home,room=kitchen temp=72 1641024000' + ``` + + + Replace the following: + + + - **`DATABASE_NAME`**: your InfluxDB 3 Enterprise database + + - **`AUTH_TOKEN`**: an admin token or database token authorized for the database + QuerystringAuthentication: + type: apiKey + in: query + name: u=&p= + description: >- + Use InfluxDB 1.x API parameters to provide credentials through the query string for v1 API requests. + + + Querystring authentication works with v1-compatible [`/write`](#operation/PostV1Write) and + [`/query`](#operation/GetV1Query) endpoints. + + + When authenticating requests, InfluxDB 3 checks that the `p` (_password_) query parameter is an authorized token + + and ignores the `u` (_username_) query parameter. + + + ### Syntax + + + ```http + + https://localhost:8181/query/?[u=any]&p=AUTH_TOKEN + + https://localhost:8181/write/?[u=any]&p=AUTH_TOKEN + + ``` + + + ### Examples + + + ```bash + + curl "http://localhost:8181/write?db=DATABASE_NAME&precision=s&p=AUTH_TOKEN" \ + --header "Content-type: text/plain; charset=utf-8" \ + --data-binary 'home,room=kitchen temp=72 1641024000' + ``` + + + Replace the following: + + + - **`DATABASE_NAME`**: your InfluxDB 3 Enterprise database + + - **`AUTH_TOKEN`**: an admin token or database token authorized for the database + + + ```bash + + ####################################### + + # Use an InfluxDB 1.x compatible username and password + + # to query the InfluxDB v1 HTTP API + + ####################################### + + # Use authentication query parameters: + + # ?p=AUTH_TOKEN + + ####################################### + + + curl --get "http://localhost:8181/query" \ + --data-urlencode "p=AUTH_TOKEN" \ + --data-urlencode "db=DATABASE_NAME" \ + --data-urlencode "q=SELECT * FROM MEASUREMENT" + ``` + + + Replace the following: + + + - **`DATABASE_NAME`**: the database to query + + - **`AUTH_TOKEN`**: a database token with sufficient permissions to the database + BearerAuthentication: + type: http + scheme: bearer + bearerFormat: JWT + description: | + + Use the OAuth Bearer authentication + scheme to provide an authorization token to InfluxDB 3. + + Bearer authentication works with all endpoints. + + In your API requests, send an `Authorization` header. + For the header value, provide the word `Bearer` followed by a space and a database token. + + ### Syntax + + ```http + Authorization: Bearer AUTH_TOKEN + ``` + + ### Example + + ```bash + curl http://localhost:8181/api/v3/query_influxql \ + --header "Authorization: Bearer AUTH_TOKEN" + ``` + TokenAuthentication: + description: |- + Use InfluxDB v2 Token authentication to provide an authorization token to InfluxDB 3. + + The v2 Token scheme works with v1 and v2 compatibility endpoints in InfluxDB 3. + + In your API requests, send an `Authorization` header. + For the header value, provide the word `Token` followed by a space and a database token. + The word `Token` is case-sensitive. + + ### Syntax + + ```http + Authorization: Token AUTH_TOKEN + ``` + + ### Example + + ```sh + ######################################################## + # Use the Token authentication scheme with /api/v2/write + # to write data. + ######################################################## + + curl --request post "http://localhost:8181/api/v2/write?bucket=DATABASE_NAME&precision=s" \ + --header "Authorization: Token AUTH_TOKEN" \ + --data-binary 'home,room=kitchen temp=72 1463683075' + ``` + in: header + name: Authorization + type: apiKey +x-tagGroups: + - name: Using the InfluxDB HTTP API + tags: + - Quick start + - Authentication + - Cache data + - Common parameters + - Response codes + - Compatibility endpoints + - Database + - Processing engine + - Server information + - Table + - Token + - Query data + - Write data diff --git a/api-docs/influxdb3/core/v3/ref.yml b/static/openapi/influxdb3-core-openapi.yaml similarity index 72% rename from api-docs/influxdb3/core/v3/ref.yml rename to static/openapi/influxdb3-core-openapi.yaml index 32778f807..bd0d92843 100644 --- a/api-docs/influxdb3/core/v3/ref.yml +++ b/static/openapi/influxdb3-core-openapi.yaml @@ -17,11 +17,8 @@ info: - `/`: Compatibility endpoints for InfluxDB v1 workloads and clients - `/api/v2/write`: Compatibility endpoint for InfluxDB v2 workloads and clients - - version: '3.7.0' + To download the OpenAPI specification for this API, use the **Download** button above. + version: v3.8.0 license: name: MIT url: https://opensource.org/licenses/MIT @@ -29,6 +26,7 @@ info: name: InfluxData url: https://www.influxdata.com email: support@influxdata.com + x-source-hash: sha256:1259b96096eab6c8dbf3f76c974924f124e9b3e08eedc6b0c9a66d3108857c52 servers: - url: https://{baseurl} description: InfluxDB 3 Core API URL @@ -56,8 +54,13 @@ tags: | [Querystring authentication](#section/Authentication/QuerystringAuthentication) | v1 endpoints | x-traitTag: true + x-related: + - title: Authenticate v1 API requests + href: /influxdb3/core/guides/api-compatibility/v1/ + - title: Manage tokens + href: /influxdb3/core/admin/tokens/ - name: Cache data - description: | + description: |- Manage the in-memory cache. #### Distinct Value Cache @@ -84,76 +87,126 @@ tags: what fields to cache, what tags to use to identify each series, and the number of values to cache for each unique series. An LVC is associated with a table, which can have multiple LVCs. - - #### Related guides - - - [Manage the Distinct Value Cache](/influxdb3/core/admin/distinct-value-cache/) - - [Manage the Last Value Cache](/influxdb3/core/admin/last-value-cache/) + x-related: + - title: Manage the Distinct Value Cache + href: /influxdb3/core/admin/distinct-value-cache/ + - title: Manage the Last Value Cache + href: /influxdb3/core/admin/last-value-cache/ - name: Compatibility endpoints - description: | + description: > InfluxDB 3 provides compatibility endpoints for InfluxDB 1.x and InfluxDB 2.x workloads and clients. + ### Write data using v1- or v2-compatible endpoints + - [`/api/v2/write` endpoint](#operation/PostV2Write) for InfluxDB v2 clients and when you bring existing InfluxDB v2 write workloads to InfluxDB 3. - - [`/write` endpoint](#operation/PostV1Write) for InfluxDB v1 clients and when you bring existing InfluxDB v1 write workloads to InfluxDB 3. + - [`/write` endpoint](#operation/PostV1Write) for InfluxDB v1 clients and when you bring existing InfluxDB v1 + write workloads to InfluxDB 3. + For new workloads, use the [`/api/v3/write_lp` endpoint](#operation/PostWriteLP). + All endpoints accept the same line protocol format. + ### Query data - Use the HTTP [`/query`](#operation/GetV1ExecuteQuery) endpoint for InfluxDB v1 clients and v1 query workloads using InfluxQL. + + Use the HTTP [`/query`](#operation/GetV1ExecuteQuery) endpoint for InfluxDB v1 clients and v1 query workloads + using InfluxQL. + For new workloads, use one of the following: + - HTTP [`/api/v3/query_sql` endpoint](#operation/GetExecuteQuerySQL) for new query workloads using SQL. - - HTTP [`/api/v3/query_influxql` endpoint](#operation/GetExecuteInfluxQLQuery) for new query workloads using InfluxQL. - - Flight SQL and InfluxDB 3 _Flight+gRPC_ APIs for querying with SQL or InfluxQL. For more information about using Flight APIs, see [InfluxDB 3 client libraries](https://github.com/InfluxCommunity?q=influxdb3&type=public&language=&sort=). + + - HTTP [`/api/v3/query_influxql` endpoint](#operation/GetExecuteInfluxQLQuery) for new query workloads using + InfluxQL. + + - Flight SQL and InfluxDB 3 _Flight+gRPC_ APIs for querying with SQL or InfluxQL. For more information about using + Flight APIs, see [InfluxDB 3 client + libraries](https://github.com/InfluxCommunity?q=influxdb3&type=public&language=&sort=). + ### Server information - Server information endpoints such as `/health` and `metrics` are compatible with InfluxDB 1.x and InfluxDB 2.x clients. + + Server information endpoints such as `/health` and `metrics` are compatible with InfluxDB 1.x and InfluxDB 2.x + clients. + x-related: + - title: Use compatibility APIs to write data + href: /influxdb3/core/write-data/http-api/compatibility-apis/ - name: Database description: Manage databases - - description: | + - description: > Most InfluxDB API endpoints require parameters in the request--for example, specifying the database to use. + ### Common parameters + The following table shows common parameters used by many InfluxDB API endpoints. + Many endpoints may require other parameters in the query string or in the + request body that perform functions specific to those endpoints. + | Query parameter | Value type | Description | + |:------------------------ |:--------------------- |:-------------------------------------------| + | `db` | string | The database name | + InfluxDB HTTP API endpoints use standard HTTP request and response headers. + The following table shows common headers used by many InfluxDB API endpoints. + Some endpoints may use other headers that perform functions more specific to those endpoints--for example, - the write endpoints accept the `Content-Encoding` header to indicate that line protocol is compressed in the request body. + + the write endpoints accept the `Content-Encoding` header to indicate that line protocol is compressed in the + request body. + | Header | Value type | Description | + |:------------------------ |:--------------------- |:-------------------------------------------| + | `Accept` | string | The content type that the client can understand. | + | `Authorization` | string | The authorization scheme and credential. | + | `Content-Length` | integer | The size of the entity-body, in bytes. | + | `Content-Type` | string | The format of the data in the request body. | name: Headers and parameters x-traitTag: true - name: Processing engine - description: | + description: > Manage Processing engine triggers, test plugins, and send requests to trigger On Request plugins. - InfluxDB 3 Core provides the InfluxDB 3 processing engine, an embedded Python VM that can dynamically load and trigger Python plugins in response to events in your database. + + InfluxDB 3 Core provides the InfluxDB 3 processing engine, an embedded Python VM that can dynamically load and + trigger Python plugins in response to events in your database. + Use Processing engine plugins and triggers to run code and perform tasks for different database events. - To get started with the processing engine, see the [Processing engine and Python plugins](/influxdb3/core/processing-engine/) guide. + + To get started with the processing engine, see the [Processing engine and Python + plugins](/influxdb3/core/processing-engine/) guide. + x-related: + - title: Processing engine and Python plugins + href: /influxdb3/core/plugins/ - name: Query data description: Query data using SQL or InfluxQL + x-related: + - title: Use the InfluxDB v1 HTTP query API and InfluxQL to query data + href: /influxdb3/core/query-data/execute-queries/influxdb-v1-api/ - name: Quick start description: | 1. [Create an admin token](#section/Authentication) to authorize API requests. @@ -219,149 +272,71 @@ tags: | **Milliseconds** | ✅ `ms` | ✅ `ms` | ✅ `millisecond` | | **Microseconds** | ✅ `u` or `µ` | ✅ `us` | ✅ `microsecond` | | **Nanoseconds** | ✅ `ns` | ✅ `ns` | ✅ `nanosecond` | - | **Minutes** | ✅ `m` | ❌ No | ❌ No | - | **Hours** | ✅ `h` | ❌ No | ❌ No | | **Default** | Nanosecond | Nanosecond | **Auto** (guessed) | All timestamps are stored internally as nanoseconds. paths: - /write: - post: - operationId: PostV1Write - summary: Write line protocol (v1-compatible) + /api/v1/health: + get: + operationId: GetHealthV1 + summary: Health check (v1) description: | - Writes line protocol to the specified database. + Checks the status of the service. - This endpoint provides backward compatibility for InfluxDB 1.x write workloads using tools such as InfluxDB 1.x client libraries, the Telegraf `outputs.influxdb` output plugin, or third-party tools. + Returns `OK` if the service is running. This endpoint does not return version information. + Use the [`/ping`](#operation/GetPing) endpoint to retrieve version details. - Use this endpoint to send data in [line protocol](https://docs.influxdata.com/influxdb3/core/reference/syntax/line-protocol/) format to InfluxDB. - Use query parameters to specify options for writing data. - - #### Related - - - [Use compatibility APIs to write data](/influxdb3/core/write-data/http-api/compatibility-apis/) - parameters: - - $ref: '#/components/parameters/dbWriteParam' - - $ref: '#/components/parameters/compatibilityPrecisionParam' - - $ref: '#/components/parameters/v1UsernameParam' - - $ref: '#/components/parameters/v1PasswordParam' - - name: rp - in: query - required: false - schema: - type: string - description: | - Retention policy name. Honored but discouraged. InfluxDB 3 doesn't use retention policies. - - name: consistency - in: query - required: false - schema: - type: string - description: | - Write consistency level. Ignored by InfluxDB 3. Provided for compatibility with InfluxDB 1.x clients. - - name: Authorization - in: header - required: false - schema: - type: string - description: | - Authorization header for token-based authentication. - Supported schemes: - - `Bearer AUTH_TOKEN` - OAuth bearer token scheme - - `Token AUTH_TOKEN` - InfluxDB v2 token scheme - - `Basic ` - Basic authentication (username is ignored) - - name: Content-Type - in: header - description: | - The content type of the request payload. - schema: - $ref: '#/components/schemas/LineProtocol' - required: false - - name: Accept - in: header - description: | - The content type that the client can understand. - Writes only return a response body if they fail (partially or completely)--for example, - due to a syntax problem or type mismatch. - schema: - type: string - default: application/json - enum: - - application/json - required: false - - $ref: '#/components/parameters/ContentEncoding' - - $ref: '#/components/parameters/ContentLength' - requestBody: - $ref: '#/components/requestBodies/lineProtocolRequestBody' + > **Note**: This endpoint requires authentication by default in InfluxDB 3 Core. responses: - '204': - description: Success ("No Content"). All data in the batch is written and queryable. - headers: - cluster-uuid: - $ref: '#/components/headers/ClusterUUID' - '400': - description: | - Bad request. Some (a _partial write_) or all of the data from the batch was rejected and not written. - If a partial write occurred, then some points from the batch are written and queryable. - - The response body: - - indicates if a partial write occurred or all data was rejected. - - contains details about the [rejected points](/influxdb3/core/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. + "200": + description: Service is running. Returns `OK`. content: - application/json: - examples: - rejectedAllPoints: - summary: Rejected all points in the batch - value: | - { - "error": "write of line protocol failed", - "data": [ - { - "original_line": "dquote> home,room=Kitchen temp=hi", - "line_number": 2, - "error_message": "No fields were provided" - } - ] - } - partialWriteErrorWithRejectedPoints: - summary: Partial write rejected some points in the batch - value: | - { - "error": "partial write of line protocol occurred", - "data": [ - { - "original_line": "dquote> home,room=Kitchen temp=hi", - "line_number": 2, - "error_message": "No fields were provided" - } - ] - } - '401': - $ref: '#/components/responses/Unauthorized' - '403': - description: Access denied. - '413': - description: Request entity too large. + text/plain: + schema: + type: string + example: OK + "401": + description: Unauthorized. Authentication is required. + "500": + description: Service is unavailable. tags: + - Server information - Compatibility endpoints - - Write data - x-influxdata-guides: - - title: Use compatibility APIs to write data - href: /influxdb3/core/write-data/http-api/compatibility-apis/ /api/v2/write: post: operationId: PostV2Write + responses: + "204": + description: Success ("No Content"). All data in the batch is written and queryable. + headers: + cluster-uuid: + $ref: "#/components/headers/ClusterUUID" + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "413": + description: Request entity too large. summary: Write line protocol (v2-compatible) - description: | + description: > Writes line protocol to the specified database. - This endpoint provides backward compatibility for InfluxDB 2.x write workloads using tools such as InfluxDB 2.x client libraries, the Telegraf `outputs.influxdb_v2` output plugin, or third-party tools. - Use this endpoint to send data in [line protocol](/influxdb3/core/reference/syntax/line-protocol/) format to InfluxDB. + This endpoint provides backward compatibility for InfluxDB 2.x write workloads using tools such as InfluxDB 2.x + client libraries, the Telegraf `outputs.influxdb_v2` output plugin, or third-party tools. + + + Use this endpoint to send data in [line protocol](/influxdb3/core/reference/syntax/line-protocol/) format to + InfluxDB. + Use query parameters to specify options for writing data. + #### Related + - [Use compatibility APIs to write data](/influxdb3/core/write-data/http-api/compatibility-apis/) parameters: - name: Content-Type @@ -369,7 +344,7 @@ paths: description: | The content type of the request payload. schema: - $ref: '#/components/schemas/LineProtocol' + $ref: "#/components/schemas/LineProtocol" required: false - description: | The compression applied to the line protocol in the request payload. @@ -404,739 +379,60 @@ paths: enum: - application/json type: string - - name: db + - name: bucket in: query required: true schema: type: string - description: | + description: |- A database name. InfluxDB creates the database if it doesn't already exist, and then writes all points in the batch to the database. + + This parameter is named `bucket` for compatibility with InfluxDB v2 client libraries. - name: accept_partial in: query required: false schema: - $ref: '#/components/schemas/AcceptPartial' - - $ref: '#/components/parameters/compatibilityPrecisionParam' + $ref: "#/components/schemas/AcceptPartial" + - $ref: "#/components/parameters/compatibilityPrecisionParam" requestBody: - $ref: '#/components/requestBodies/lineProtocolRequestBody' - responses: - '204': - description: Success ("No Content"). All data in the batch is written and queryable. - headers: - cluster-uuid: - $ref: '#/components/headers/ClusterUUID' - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '403': - description: Access denied. - '413': - description: Request entity too large. + $ref: "#/components/requestBodies/lineProtocolRequestBody" tags: - Compatibility endpoints - Write data - x-influxdata-guides: - - title: Use compatibility APIs to write data - href: /influxdb3/core/write-data/http-api/compatibility-apis/ - /api/v3/write_lp: - post: - operationId: PostWriteLP - summary: Write line protocol - description: | - Writes line protocol to the specified database. - - This is the native InfluxDB 3 Core write endpoint that provides enhanced control - over write behavior with advanced parameters for high-performance and fault-tolerant operations. - - Use this endpoint to send data in [line protocol](/influxdb3/core/reference/syntax/line-protocol/) format to InfluxDB. - Use query parameters to specify options for writing data. - - #### Features - - - **Partial writes**: Use `accept_partial=true` to allow partial success when some lines in a batch fail - - **Asynchronous writes**: Use `no_sync=true` to skip waiting for WAL synchronization, allowing faster response times but sacrificing durability guarantees - - **Flexible precision**: Automatic timestamp precision detection with `precision=auto` (default) - - #### Auto precision detection - - When you use `precision=auto` or omit the precision parameter, InfluxDB 3 automatically detects - the timestamp precision based on the magnitude of the timestamp value: - - - Timestamps < 5e9 → Second precision (multiplied by 1,000,000,000 to convert to nanoseconds) - - Timestamps < 5e12 → Millisecond precision (multiplied by 1,000,000) - - Timestamps < 5e15 → Microsecond precision (multiplied by 1,000) - - Larger timestamps → Nanosecond precision (no conversion needed) - - #### Related - - - [Use the InfluxDB v3 write_lp API to write data](/influxdb3/core/write-data/http-api/v3-write-lp/) - parameters: - - $ref: '#/components/parameters/dbWriteParam' - - $ref: '#/components/parameters/accept_partial' - - $ref: '#/components/parameters/precisionParam' - - name: no_sync - in: query - schema: - $ref: '#/components/schemas/NoSync' - - name: Content-Type - in: header - description: | - The content type of the request payload. - schema: - $ref: '#/components/schemas/LineProtocol' - required: false - - name: Accept - in: header - description: | - The content type that the client can understand. - Writes only return a response body if they fail (partially or completely)--for example, - due to a syntax problem or type mismatch. - schema: - type: string - default: application/json - enum: - - application/json - required: false - - $ref: '#/components/parameters/ContentEncoding' - - $ref: '#/components/parameters/ContentLength' - requestBody: - $ref: '#/components/requestBodies/lineProtocolRequestBody' - responses: - '204': - description: Success ("No Content"). All data in the batch is written and queryable. - headers: - cluster-uuid: - $ref: '#/components/headers/ClusterUUID' - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '403': - description: Access denied. - '413': - description: Request entity too large. - '422': - description: Unprocessable entity. - x-codeSamples: - - label: cURL - Basic write - lang: Shell - source: | - curl --request POST "http://localhost:8181/api/v3/write_lp?db=sensors" \ - --header "Authorization: Bearer DATABASE_TOKEN" \ - --header "Content-Type: text/plain" \ - --data-raw "cpu,host=server01 usage=85.2 1638360000000000000" - - label: cURL - Write with millisecond precision - lang: Shell - source: | - curl --request POST "http://localhost:8181/api/v3/write_lp?db=sensors&precision=ms" \ - --header "Authorization: Bearer DATABASE_TOKEN" \ - --header "Content-Type: text/plain" \ - --data-raw "cpu,host=server01 usage=85.2 1638360000000" - - label: cURL - Asynchronous write with partial acceptance - lang: Shell - source: | - curl --request POST "http://localhost:8181/api/v3/write_lp?db=sensors&accept_partial=true&no_sync=true&precision=auto" \ - --header "Authorization: Bearer DATABASE_TOKEN" \ - --header "Content-Type: text/plain" \ - --data-raw "cpu,host=server01 usage=85.2 - memory,host=server01 used=4096" - - label: cURL - Multiple measurements with tags - lang: Shell - source: | - curl --request POST "http://localhost:8181/api/v3/write_lp?db=sensors&precision=ns" \ - --header "Authorization: Bearer DATABASE_TOKEN" \ - --header "Content-Type: text/plain" \ - --data-raw "cpu,host=server01,region=us-west usage=85.2,load=0.75 1638360000000000000 - memory,host=server01,region=us-west used=4096,free=12288 1638360000000000000 - disk,host=server01,region=us-west,device=/dev/sda1 used=50.5,free=49.5 1638360000000000000" - tags: - - Write data - /api/v3/query_sql: - get: - operationId: GetExecuteQuerySQL - summary: Execute SQL query - description: Executes an SQL query to retrieve data from the specified database. - parameters: - - $ref: '#/components/parameters/db' - - $ref: '#/components/parameters/querySqlParam' - - $ref: '#/components/parameters/format' - - $ref: '#/components/parameters/AcceptQueryHeader' - - $ref: '#/components/parameters/ContentType' - responses: - '200': - description: Success. The response body contains query results. - content: - application/json: - schema: - $ref: '#/components/schemas/QueryResponse' - example: - results: - - series: - - name: mytable - columns: - - time - - value - values: - - - '2024-02-02T12:00:00Z' - - 42 - text/csv: - schema: - type: string - application/vnd.apache.parquet: - schema: - type: string - application/jsonl: - schema: - type: string - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '403': - description: Access denied. - '404': - description: Database not found. - '405': - description: Method not allowed. - '422': - description: Unprocessable entity. - tags: - - Query data - post: - operationId: PostExecuteQuerySQL - summary: Execute SQL query - description: Executes an SQL query to retrieve data from the specified database. - parameters: - - $ref: '#/components/parameters/AcceptQueryHeader' - - $ref: '#/components/parameters/ContentType' - requestBody: - $ref: '#/components/requestBodies/queryRequestBody' - responses: - '200': - description: Success. The response body contains query results. - content: - application/json: - schema: - $ref: '#/components/schemas/QueryResponse' - text/csv: - schema: - type: string - application/vnd.apache.parquet: - schema: - type: string - application/jsonl: - schema: - type: string - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '403': - description: Access denied. - '404': - description: Database not found. - '405': - description: Method not allowed. - '422': - description: Unprocessable entity. - tags: - - Query data - /api/v3/query_influxql: - get: - operationId: GetExecuteInfluxQLQuery - summary: Execute InfluxQL query - description: Executes an InfluxQL query to retrieve data from the specified database. - parameters: - - $ref: '#/components/parameters/dbQueryParam' - - name: q - in: query - required: true - schema: - type: string - - name: format - in: query - required: false - schema: - type: string - - $ref: '#/components/parameters/AcceptQueryHeader' - responses: - '200': - description: Success. The response body contains query results. - content: - application/json: - schema: - $ref: '#/components/schemas/QueryResponse' - text/csv: - schema: - type: string - application/vnd.apache.parquet: - schema: - type: string - application/jsonl: - schema: - type: string - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '403': - description: Access denied. - '404': - description: Database not found. - '405': - description: Method not allowed. - '422': - description: Unprocessable entity. - tags: - - Query data - post: - operationId: PostExecuteQueryInfluxQL - summary: Execute InfluxQL query - description: Executes an InfluxQL query to retrieve data from the specified database. - parameters: - - $ref: '#/components/parameters/AcceptQueryHeader' - - $ref: '#/components/parameters/ContentType' - requestBody: - $ref: '#/components/requestBodies/queryRequestBody' - responses: - '200': - description: Success. The response body contains query results. - content: - application/json: - schema: - $ref: '#/components/schemas/QueryResponse' - text/csv: - schema: - type: string - application/vnd.apache.parquet: - schema: - type: string - application/jsonl: - schema: - type: string - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '403': - description: Access denied. - '404': - description: Database not found. - '405': - description: Method not allowed. - '422': - description: Unprocessable entity. - tags: - - Query data - /query: - get: - operationId: GetV1ExecuteQuery - summary: Execute InfluxQL query (v1-compatible) - description: | - Executes an InfluxQL query to retrieve data from the specified database. - - This endpoint is compatible with InfluxDB 1.x client libraries and third-party integrations such as Grafana. - Use query parameters to specify the database and the InfluxQL query. - - #### Related - - - [Use the InfluxDB v1 HTTP query API and InfluxQL to query data](/influxdb3/core/query-data/execute-queries/influxdb-v1-api/) - parameters: - - name: Accept - in: header - schema: - type: string - default: application/json - enum: - - application/json - - application/csv - - text/csv - required: false - description: | - The content type that the client can understand. - - If `text/csv` is specified, the `Content-type` response header is `application/csv` and the response is formatted as CSV. - - Returns an error if the format is invalid or non-UTF8. - - in: query - name: chunked - description: | - If true, the response is divided into chunks of size `chunk_size`. - schema: - type: boolean - default: false - - in: query - name: chunk_size - description: | - The number of records that will go into a chunk. - This parameter is only used if `chunked=true`. - schema: - type: integer - default: 10000 - - in: query - name: db - description: The database to query. If not provided, the InfluxQL query string must specify the database. - schema: - type: string - format: InfluxQL - - in: query - name: pretty - description: | - If true, the JSON response is formatted in a human-readable format. - schema: - type: boolean - default: false - - in: query - name: q - description: The InfluxQL query string. - required: true - schema: - type: string - - name: epoch - description: | - Formats timestamps as [unix (epoch) timestamps](/influxdb3/core/reference/glossary/#unix-timestamp) with the specified precision - instead of [RFC3339 timestamps](/influxdb3/core/reference/glossary/#rfc3339-timestamp) with nanosecond precision. - in: query - schema: - $ref: '#/components/schemas/EpochCompatibility' - - $ref: '#/components/parameters/v1UsernameParam' - - $ref: '#/components/parameters/v1PasswordParam' - - name: rp - in: query - required: false - schema: - type: string - description: | - Retention policy name. Honored but discouraged. InfluxDB 3 doesn't use retention policies. - - name: Authorization - in: header - required: false - schema: - type: string - description: | - Authorization header for token-based authentication. - Supported schemes: - - `Bearer AUTH_TOKEN` - OAuth bearer token scheme - - `Token AUTH_TOKEN` - InfluxDB v2 token scheme - - `Basic ` - Basic authentication (username is ignored) - responses: - '200': - description: | - Success. The response body contains query results. - content: - application/json: - schema: - $ref: '#/components/schemas/QueryResponse' - application/csv: - schema: - type: string - headers: - Content-Type: - description: | - The content type of the response. - Default is `application/json`. - - If the `Accept` request header is `application/csv` or `text/csv`, the `Content-type` response header is `application/csv` - and the response is formatted as CSV. - schema: - type: string - default: application/json - enum: - - application/json - - application/csv - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '403': - description: Access denied. - '404': - description: Database not found. - '405': - description: Method not allowed. - '422': - description: Unprocessable entity. - tags: - - Query data - - Compatibility endpoints - x-influxdata-guides: - - title: Use the InfluxDB v1 HTTP query API and InfluxQL to query data - href: /influxdb3/core/query-data/execute-queries/influxdb-v1-api/ - post: - operationId: PostExecuteV1Query - summary: Execute InfluxQL query (v1-compatible) - description: | - Executes an InfluxQL query to retrieve data from the specified database. - - #### Related - - - [Use the InfluxDB v1 HTTP query API and InfluxQL to query data](/influxdb3/core/query-data/execute-queries/influxdb-v1-api/) - requestBody: - content: - application/json: - schema: - type: object - properties: - db: - type: string - description: The database to query. If not provided, the InfluxQL query string must specify the database. - q: - description: The InfluxQL query string. - type: string - chunked: - description: | - If true, the response is divided into chunks of size `chunk_size`. - type: boolean - chunk_size: - description: | - The number of records that will go into a chunk. - This parameter is only used if `chunked=true`. - type: integer - default: 10000 - epoch: - description: | - A unix timestamp precision. - - - `h` for hours - - `m` for minutes - - `s` for seconds - - `ms` for milliseconds - - `u` or `µ` for microseconds - - `ns` for nanoseconds - - Formats timestamps as [unix (epoch) timestamps](/influxdb3/core/reference/glossary/#unix-timestamp) with the specified precision - instead of [RFC3339 timestamps](/influxdb3/core/reference/glossary/#rfc3339-timestamp) with nanosecond precision. - enum: - - ns - - u - - µ - - ms - - s - - m - - h - type: string - pretty: - description: | - If true, the JSON response is formatted in a human-readable format. - type: boolean - required: - - q - parameters: - - name: Accept - in: header - schema: - type: string - default: application/json - enum: - - application/json - - application/csv - - text/csv - required: false - description: | - The content type that the client can understand. - - If `text/csv` is specified, the `Content-type` response header is `application/csv` and the response is formatted as CSV. - - Returns an error if the format is invalid or non-UTF8. - responses: - '200': - description: | - Success. The response body contains query results. - content: - application/json: - schema: - $ref: '#/components/schemas/QueryResponse' - application/csv: - schema: - type: string - headers: - Content-Type: - description: | - The content type of the response. - Default is `application/json`. - - If the `Accept` request header is `application/csv` or `text/csv`, the `Content-type` response header is `application/csv` - and the response is formatted as CSV. - schema: - type: string - default: application/json - enum: - - application/json - - application/csv - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '403': - description: Access denied. - '404': - description: Database not found. - '405': - description: Method not allowed. - '422': - description: Unprocessable entity. - tags: - - Query data - - Compatibility endpoints - x-influxdata-guides: - - title: Use the InfluxDB v1 HTTP query API and InfluxQL to query data - href: /influxdb3/core/query-data/execute-queries/influxdb-v1-api/ - /health: - get: - operationId: GetHealth - summary: Health check - description: | - Checks the status of the service. - - Returns `OK` if the service is running. This endpoint does not return version information. - Use the [`/ping`](#operation/GetPing) endpoint to retrieve version details. - responses: - '200': - description: Service is running. Returns `OK`. - content: - text/plain: - schema: - type: string - example: OK - '500': - description: Service is unavailable. - tags: - - Server information - /api/v1/health: - get: - operationId: GetHealthV1 - summary: Health check (v1) - description: Checks the status of the service. - responses: - '200': - description: Service is running. - '500': - description: Service is unavailable. - tags: - - Server information - - Compatibility endpoints - /ping: - get: - operationId: GetPing - tags: - - Server information - summary: Ping the server - description: | - Returns version information for the server. - - **Important**: Use a GET request. HEAD requests return `404 Not Found`. - - The response includes version information in both headers and the JSON body: - - - **Headers**: `x-influxdb-version` and `x-influxdb-build` - - **Body**: JSON object with `version`, `revision`, and `process_id` - responses: - '200': - description: Success. The response body contains server information. - headers: - x-influxdb-version: - description: The InfluxDB version number (for example, `3.8.0`). - schema: - type: string - example: '3.8.0' - x-influxdb-build: - description: The InfluxDB build type (`Core` or `Enterprise`). - schema: - type: string - example: Core - content: - application/json: - schema: - type: object - properties: - version: - type: string - description: The InfluxDB version number. - example: '3.8.0' - revision: - type: string - description: The git revision hash for the build. - example: '5276213d5b' - process_id: - type: string - description: A unique identifier for the server process. - example: 'b756d9e0-cecd-4f72-b6d0-19e2d4f8cbb7' - '404': - description: | - Not Found. Returned for HEAD requests. - Use a GET request to retrieve version information. - /metrics: - get: - operationId: GetMetrics - summary: Metrics - description: Retrieves Prometheus-compatible server metrics. - responses: - '200': - description: Success. The response body contains Prometheus-compatible server metrics. - tags: - - Server information /api/v3/configure/database: - get: - operationId: GetConfigureDatabase - summary: List databases - description: Retrieves a list of databases. - parameters: - - $ref: '#/components/parameters/formatRequired' - responses: - '200': - description: Success. The response body contains the list of databases. - content: - application/json: - schema: - $ref: '#/components/schemas/ShowDatabasesResponse' - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '404': - description: Database not found. - tags: - - Database - post: - operationId: PostConfigureDatabase - summary: Create a database - description: Creates a new database in the system. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/CreateDatabaseRequest' - responses: - '201': - description: Success. Database created. - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '409': - description: Database already exists. - tags: - - Database delete: operationId: DeleteConfigureDatabase - summary: Delete a database - description: | - Soft deletes a database. - The database is scheduled for deletion and unavailable for querying. - Use the `hard_delete_at` parameter to schedule a hard deletion. parameters: - - $ref: '#/components/parameters/db' + - $ref: "#/components/parameters/db" + - name: data_only + in: query + required: false + schema: + type: boolean + default: false + description: | + Delete only data while preserving the database schema and all associated resources + (tokens, triggers, last value caches, distinct value caches, processing engine configurations). + When `false` (default), the entire database is deleted. + - name: remove_tables + in: query + required: false + schema: + type: boolean + default: false + description: | + Used with `data_only=true` to remove table resources (caches) while preserving + database-level resources (tokens, triggers, processing engine configurations). + Has no effect when `data_only=false`. - name: hard_delete_at in: query required: false schema: type: string format: date-time - description: | + description: |- Schedule the database for hard deletion at the specified time. If not provided, the database will be soft deleted. Use ISO 8601 date-time format (for example, "2025-12-31T23:59:59Z"). @@ -1145,13 +441,98 @@ paths: Deleting a database is a destructive action. Once a database is deleted, data stored in that database cannot be recovered. + + + Also accepts special string values: + - `now` — hard delete immediately + - `never` — soft delete only (default behavior) + - `default` — use the system default hard deletion time responses: - '200': + "200": description: Success. Database deleted. - '401': - $ref: '#/components/responses/Unauthorized' - '404': + "401": + $ref: "#/components/responses/Unauthorized" + "404": description: Database not found. + summary: Delete a database + description: | + Soft deletes a database. + The database is scheduled for deletion and unavailable for querying. + Use the `hard_delete_at` parameter to schedule a hard deletion. + Use the `data_only` parameter to delete data while preserving the database schema and resources. + tags: + - Database + get: + operationId: GetConfigureDatabase + responses: + "200": + description: Success. The response body contains the list of databases. + content: + application/json: + schema: + $ref: "#/components/schemas/ShowDatabasesResponse" + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Database not found. + summary: List databases + description: Retrieves a list of databases. + parameters: + - $ref: "#/components/parameters/formatRequired" + - name: show_deleted + in: query + required: false + schema: + type: boolean + default: false + description: | + Include soft-deleted databases in the response. + By default, only active databases are returned. + tags: + - Database + post: + operationId: PostConfigureDatabase + responses: + "200": + description: Success. Database created. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "409": + description: Database already exists. + summary: Create a database + description: Creates a new database in the system. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/CreateDatabaseRequest" + tags: + - Database + put: + operationId: update_database + responses: + "200": + description: Success. The database has been updated. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Database not found. + summary: Update a database + description: | + Updates database configuration, such as retention period. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateDatabaseRequest" tags: - Database /api/v3/configure/database/retention_period: @@ -1160,108 +541,33 @@ paths: summary: Remove database retention period description: | Removes the retention period from a database, setting it to infinite retention. - Data in the database will not expire based on time. parameters: - - $ref: '#/components/parameters/db' + - $ref: "#/components/parameters/db" responses: - '200': - description: Success. Retention period removed from database. - '401': - $ref: '#/components/responses/Unauthorized' - '404': + "204": + description: Success. The database retention period has been removed. + "401": + $ref: "#/components/responses/Unauthorized" + "404": description: Database not found. tags: - Database - /api/v3/configure/table: - post: - operationId: PostConfigureTable - summary: Create a table - description: Creates a new table within a database. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/CreateTableRequest' - responses: - '201': - description: Success. The table has been created. - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '404': - description: Database not found. - tags: - - Table - delete: - operationId: DeleteConfigureTable - summary: Delete a table - description: | - Soft deletes a table. - The table is scheduled for deletion and unavailable for querying. - Use the `hard_delete_at` parameter to schedule a hard deletion. - - #### Deleting a table cannot be undone - - Deleting a table is a destructive action. - Once a table is deleted, data stored in that table cannot be recovered. - parameters: - - $ref: '#/components/parameters/db' - - name: table - in: query - required: true - schema: - type: string - - name: hard_delete_at - in: query - required: false - schema: - type: string - format: date-time - description: | - Schedule the table for hard deletion at the specified time. - If not provided, the table will be soft deleted. - Use ISO 8601 format (for example, "2025-12-31T23:59:59Z"). - responses: - '200': - description: Success (no content). The table has been deleted. - '401': - $ref: '#/components/responses/Unauthorized' - '404': - description: Table not found. - tags: - - Table /api/v3/configure/distinct_cache: - post: - operationId: PostConfigureDistinctCache - summary: Create distinct cache - description: Creates a distinct cache for a table. - tags: - - Cache data - - Table - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/DistinctCacheCreateRequest' - responses: - '201': - description: Success. The distinct cache has been created. - '204': - description: Not created. A distinct cache with this configuration already exists. - '400': - description: | - Bad request. - - The server responds with status `400` if the request would overwrite an existing cache with a different configuration. delete: operationId: DeleteConfigureDistinctCache + responses: + "200": + description: Success. The distinct cache has been deleted. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Cache not found. summary: Delete distinct cache description: Deletes a distinct cache. parameters: - - $ref: '#/components/parameters/db' + - $ref: "#/components/parameters/db" - name: table in: query required: true @@ -1274,49 +580,50 @@ paths: schema: type: string description: The name of the distinct cache to delete. - responses: - '200': - description: Success. The distinct cache has been deleted. - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '404': - description: Cache not found. tags: - Cache data - Table - /api/v3/configure/last_cache: post: - operationId: PostConfigureLastCache - summary: Create last cache - description: Creates a last cache for a table. + operationId: PostConfigureDistinctCache + responses: + "201": + description: Success. The distinct cache has been created. + "400": + description: > + Bad request. + + + The server responds with status `400` if the request would overwrite an existing cache with a different + configuration. + "409": + description: Conflict. A distinct cache with this configuration already exists. + summary: Create distinct cache + description: Creates a distinct cache for a table. requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/LastCacheCreateRequest' - responses: - '201': - description: Success. Last cache created. - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '404': - description: Cache not found. - '409': - description: Cache already exists. + $ref: "#/components/schemas/DistinctCacheCreateRequest" tags: - Cache data - Table + /api/v3/configure/last_cache: delete: operationId: DeleteConfigureLastCache + responses: + "200": + description: Success. The last cache has been deleted. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Cache not found. summary: Delete last cache description: Deletes a last cache. parameters: - - $ref: '#/components/parameters/db' + - $ref: "#/components/parameters/db" - name: table in: query required: true @@ -1329,42 +636,144 @@ paths: schema: type: string description: The name of the last cache to delete. - responses: - '200': - description: Success. The last cache has been deleted. - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '404': - description: Cache not found. tags: - Cache data - Table - /api/v3/configure/processing_engine_trigger: post: - operationId: PostConfigureProcessingEngineTrigger - summary: Create processing engine trigger - description: | - Creates a processing engine trigger with the specified plugin file and trigger specification. - - ### Related guides - - - [Processing engine and Python plugins](/influxdb3/core/plugins/) + operationId: PostConfigureLastCache + responses: + "201": + description: Success. Last cache created. + "400": + description: Bad request. A cache with this name already exists or the request is malformed. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Cache not found. + summary: Create last cache + description: Creates a last cache for a table. requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/ProcessingEngineTriggerRequest' + $ref: "#/components/schemas/LastCacheCreateRequest" + tags: + - Cache data + - Table + /api/v3/configure/plugin_environment/install_packages: + post: + operationId: PostInstallPluginPackages + summary: Install plugin packages + description: |- + Installs the specified Python packages into the processing engine plugin environment. + + This endpoint is synchronous and blocks until the packages are installed. + parameters: + - $ref: "#/components/parameters/ContentType" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + packages: + type: array + items: + type: string + description: | + A list of Python package names to install. + Can include version specifiers (e.g., "scipy==1.9.0"). + example: + - influxdb3-python + - scipy + - pandas==1.5.0 + - requests + required: + - packages + example: + packages: + - influxdb3-python + - scipy + - pandas==1.5.0 + - requests + responses: + "200": + description: Success. The packages are installed. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + tags: + - Processing engine + /api/v3/configure/plugin_environment/install_requirements: + post: + operationId: PostInstallPluginRequirements + summary: Install plugin requirements + description: > + Installs requirements from a requirements file (also known as a "pip requirements file") into the processing + engine plugin environment. + + + This endpoint is synchronous and blocks until the requirements are installed. + + + ### Related + + + - [Processing engine and Python plugins](/influxdb3/core/plugins/) + + - [Python requirements file format](https://pip.pypa.io/en/stable/reference/requirements-file-format/) + parameters: + - $ref: "#/components/parameters/ContentType" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + requirements_location: + type: string + description: | + The path to the requirements file containing Python packages to install. + Can be a relative path (relative to the plugin directory) or an absolute path. + example: requirements.txt + required: + - requirements_location + example: + requirements_location: requirements.txt + responses: + "200": + description: Success. The requirements have been installed. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + tags: + - Processing engine + /api/v3/configure/processing_engine_trigger: + post: + operationId: PostConfigureProcessingEngineTrigger + summary: Create processing engine trigger + description: Creates a processing engine trigger with the specified plugin file and trigger specification. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/ProcessingEngineTriggerRequest" examples: schedule_cron: summary: Schedule trigger using cron - description: | + description: > In `"cron:CRON_EXPRESSION"`, `CRON_EXPRESSION` uses extended 6-field cron format. - The cron expression `0 0 6 * * 1-5` means the trigger will run at 6:00 AM every weekday (Monday to Friday). + + The cron expression `0 0 6 * * 1-5` means the trigger will run at 6:00 AM every weekday (Monday to + Friday). value: - db: mydb + db: DATABASE_NAME plugin_filename: schedule.py trigger_name: schedule_cron_trigger trigger_specification: cron:0 0 6 * * 1-5 @@ -1478,13 +887,13 @@ paths: run_async: false error_behavior: Log responses: - '200': + "200": description: Success. Processing engine trigger created. - '400': + "400": description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '404': + "401": + $ref: "#/components/responses/Unauthorized" + "404": description: Trigger not found. tags: - Processing engine @@ -1493,7 +902,7 @@ paths: summary: Delete processing engine trigger description: Deletes a processing engine trigger. parameters: - - $ref: '#/components/parameters/db' + - $ref: "#/components/parameters/db" - name: trigger_name in: query required: true @@ -1505,14 +914,17 @@ paths: schema: type: boolean default: false + description: | + Force deletion of the trigger even if it has active executions. + By default, deletion fails if the trigger is currently executing. responses: - '200': + "200": description: Success. The processing engine trigger has been deleted. - '400': + "400": description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '404': + "401": + $ref: "#/components/responses/Unauthorized" + "404": description: Trigger not found. tags: - Processing engine @@ -1522,21 +934,26 @@ paths: summary: Disable processing engine trigger description: Disables a processing engine trigger. parameters: - - $ref: '#/components/parameters/ContentType' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/ProcessingEngineTriggerRequest' + - name: db + in: query + required: true + schema: + type: string + description: The database name. + - name: trigger_name + in: query + required: true + schema: + type: string + description: The name of the trigger. responses: - '200': + "200": description: Success. The processing engine trigger has been disabled. - '400': + "400": description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '404': + "401": + $ref: "#/components/responses/Unauthorized" + "404": description: Trigger not found. tags: - Processing engine @@ -1546,89 +963,192 @@ paths: summary: Enable processing engine trigger description: Enables a processing engine trigger. parameters: - - $ref: '#/components/parameters/ContentType' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/ProcessingEngineTriggerRequest' + - name: db + in: query + required: true + schema: + type: string + description: The database name. + - name: trigger_name + in: query + required: true + schema: + type: string + description: The name of the trigger. responses: - '200': + "200": description: Success. The processing engine trigger is enabled. - '400': + "400": description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '404': + "401": + $ref: "#/components/responses/Unauthorized" + "404": description: Trigger not found. tags: - Processing engine - /api/v3/configure/plugin_environment/install_packages: - post: - operationId: PostInstallPluginPackages - summary: Install plugin packages - description: | - Installs the specified Python packages into the processing engine plugin environment. - - This endpoint is synchronous and blocks until the packages are installed. - - ### Related guides - - - [Processing engine and Python plugins](/influxdb3/core/plugins/) + /api/v3/configure/table: + delete: + operationId: DeleteConfigureTable parameters: - - $ref: '#/components/parameters/ContentType' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - packages: - type: array - items: - type: string - description: | - A list of Python package names to install. - Can include version specifiers (e.g., "scipy==1.9.0"). - example: - - influxdb3-python - - scipy - - pandas==1.5.0 - - requests - required: - - packages - example: - packages: - - influxdb3-python - - scipy - - pandas==1.5.0 - - requests + - $ref: "#/components/parameters/db" + - name: table + in: query + required: true + schema: + type: string + - name: data_only + in: query + required: false + schema: + type: boolean + default: false + description: | + Delete only data while preserving the table schema and all associated resources + (last value caches, distinct value caches). + When `false` (default), the entire table is deleted. + - name: hard_delete_at + in: query + required: false + schema: + type: string + format: date-time + description: |- + Schedule the table for hard deletion at the specified time. + If not provided, the table will be soft deleted. + Use ISO 8601 format (for example, "2025-12-31T23:59:59Z"). + + + Also accepts special string values: + - `now` — hard delete immediately + - `never` — soft delete only (default behavior) + - `default` — use the system default hard deletion time responses: - '200': - description: Success. The packages are installed. - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - tags: - - Processing engine - /api/v3/configure/plugin_environment/install_requirements: - post: - operationId: PostInstallPluginRequirements - summary: Install plugin requirements + "200": + description: Success (no content). The table has been deleted. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Table not found. + summary: Delete a table description: | - Installs requirements from a requirements file (also known as a "pip requirements file") into the processing engine plugin environment. + Soft deletes a table. + The table is scheduled for deletion and unavailable for querying. + Use the `hard_delete_at` parameter to schedule a hard deletion. + Use the `data_only` parameter to delete data while preserving the table schema and resources. - This endpoint is synchronous and blocks until the requirements are installed. + #### Deleting a table cannot be undone - ### Related - - - [Processing engine and Python plugins](/influxdb3/core/plugins/) - - [Python requirements file format](https://pip.pypa.io/en/stable/reference/requirements-file-format/) + Deleting a table is a destructive action. + Once a table is deleted, data stored in that table cannot be recovered. + tags: + - Table + post: + operationId: PostConfigureTable + responses: + "200": + description: Success. The table has been created. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Database not found. + summary: Create a table + description: Creates a new table within a database. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/CreateTableRequest" + tags: + - Table + /api/v3/configure/token: + delete: + operationId: DeleteToken parameters: - - $ref: '#/components/parameters/ContentType' + - name: token_name + in: query + required: true + schema: + type: string + description: The name of the token to delete. + responses: + "200": + description: Success. The token has been deleted. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Token not found. + summary: Delete token + description: | + Deletes a token. + tags: + - Authentication + - Token + /api/v3/configure/token/admin: + post: + operationId: PostCreateAdminToken + responses: + "201": + description: | + Success. The admin token has been created. + The response body contains the token string and metadata. + content: + application/json: + schema: + $ref: "#/components/schemas/AdminTokenObject" + "401": + $ref: "#/components/responses/Unauthorized" + summary: Create admin token + description: | + Creates an admin token. + An admin token is a special type of token that has full access to all resources in the system. + tags: + - Authentication + - Token + /api/v3/configure/token/admin/regenerate: + post: + operationId: PostRegenerateAdminToken + summary: Regenerate admin token + description: | + Regenerates an admin token and revokes the previous token with the same name. + parameters: [] + responses: + "201": + description: Success. The admin token has been regenerated. + content: + application/json: + schema: + $ref: "#/components/schemas/AdminTokenObject" + "401": + $ref: "#/components/responses/Unauthorized" + tags: + - Authentication + - Token + /api/v3/configure/token/named_admin: + post: + operationId: PostCreateNamedAdminToken + responses: + "201": + description: | + Success. The named admin token has been created. + The response body contains the token string and metadata. + content: + application/json: + schema: + $ref: "#/components/schemas/AdminTokenObject" + "401": + $ref: "#/components/responses/Unauthorized" + "409": + description: A token with this name already exists. + summary: Create named admin token + description: | + Creates a named admin token. + A named admin token is a special type of admin token with a custom name for identification and management. + tags: + - Authentication + - Token requestBody: required: true content: @@ -1636,58 +1156,93 @@ paths: schema: type: object properties: - requirements_location: + token_name: type: string - description: | - The path to the requirements file containing Python packages to install. - Can be a relative path (relative to the plugin directory) or an absolute path. - example: requirements.txt + description: The name for the admin token. + expiry_secs: + type: integer + description: Optional expiration time in seconds. If not provided, the token does not expire. + nullable: true required: - - requirements_location - example: - requirements_location: requirements.txt - responses: - '200': - description: Success. The requirements have been installed. - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - tags: - - Processing engine - /api/v3/plugin_test/wal: - post: - operationId: PostTestWALPlugin - summary: Test WAL plugin - description: Executes a test of a write-ahead logging (WAL) plugin. - responses: - '200': - description: Success. The plugin test has been executed. - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '404': - description: Plugin not enabled. - tags: - - Processing engine - /api/v3/plugin_test/schedule: - post: - operationId: PostTestSchedulingPlugin - summary: Test scheduling plugin - description: Executes a test of a scheduling plugin. - responses: - '200': - description: Success. The plugin test has been executed. - '400': - description: Bad request. - '401': - $ref: '#/components/responses/Unauthorized' - '404': - description: Plugin not enabled. - tags: - - Processing engine + - token_name /api/v3/engine/{request_path}: + get: + operationId: GetProcessingEnginePluginRequest + responses: + "200": + description: Success. The plugin request has been executed. + "400": + description: Malformed request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Plugin not found. + "500": + description: Processing failure. + summary: On Request processing engine plugin request + description: > + Executes the On Request processing engine plugin specified in the trigger's `plugin_filename`. + + The request can include request headers, query string parameters, and a request body, which InfluxDB passes to + the plugin. + + + An On Request plugin implements the following signature: + + + ```python + + def process_request(influxdb3_local, query_parameters, request_headers, request_body, args=None) + + ``` + + + The response depends on the plugin implementation. + tags: + - Processing engine + post: + operationId: PostProcessingEnginePluginRequest + responses: + "200": + description: Success. The plugin request has been executed. + "400": + description: Malformed request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Plugin not found. + "500": + description: Processing failure. + summary: On Request processing engine plugin request + description: > + Executes the On Request processing engine plugin specified in the trigger's `plugin_filename`. + + The request can include request headers, query string parameters, and a request body, which InfluxDB passes to + the plugin. + + + An On Request plugin implements the following signature: + + + ```python + + def process_request(influxdb3_local, query_parameters, request_headers, request_body, args=None) + + ``` + + + The response depends on the plugin implementation. + parameters: + - $ref: "#/components/parameters/ContentType" + requestBody: + required: false + content: + application/json: + schema: + type: object + additionalProperties: true + tags: + - Processing engine parameters: - name: request_path description: | @@ -1708,196 +1263,1064 @@ paths: required: true schema: type: string - get: - operationId: GetProcessingEnginePluginRequest - summary: On Request processing engine plugin request - description: | - Executes the On Request processing engine plugin specified in the trigger's `plugin_filename`. - The request can include request headers, query string parameters, and a request body, which InfluxDB passes to the plugin. - - An On Request plugin implements the following signature: - - ```python - def process_request(influxdb3_local, query_parameters, request_headers, request_body, args=None) - ``` - - The response depends on the plugin implementation. - responses: - '200': - description: Success. The plugin request has been executed. - '400': - description: Malformed request. - '401': - $ref: '#/components/responses/Unauthorized' - '404': - description: Plugin not found. - '500': - description: Processing failure. - tags: - - Processing engine + /api/v3/plugin_test/schedule: post: - operationId: PostProcessingEnginePluginRequest - summary: On Request processing engine plugin request - description: | - Executes the On Request processing engine plugin specified in the trigger's `plugin_filename`. - The request can include request headers, query string parameters, and a request body, which InfluxDB passes to the plugin. - - An On Request plugin implements the following signature: - - ```python - def process_request(influxdb3_local, query_parameters, request_headers, request_body, args=None) - ``` - - The response depends on the plugin implementation. - parameters: - - $ref: '#/components/parameters/ContentType' + operationId: PostTestSchedulingPlugin + responses: + "200": + description: Success. The plugin test has been executed. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Plugin not enabled. + summary: Test scheduling plugin + description: Executes a test of a scheduling plugin. requestBody: - required: false + required: true content: application/json: schema: - type: object - additionalProperties: true - responses: - '200': - description: Success. The plugin request has been executed. - '400': - description: Malformed request. - '401': - $ref: '#/components/responses/Unauthorized' - '404': - description: Plugin not found. - '500': - description: Processing failure. + $ref: "#/components/schemas/SchedulePluginTestRequest" tags: - Processing engine - /api/v3/configure/token/admin: + /api/v3/plugin_test/wal: post: - operationId: PostCreateAdminToken - summary: Create admin token - description: | - Creates an admin token. - An admin token is a special type of token that has full access to all resources in the system. + operationId: PostTestWALPlugin responses: - '201': - description: | - Success. The admin token has been created. - The response body contains the token string and metadata. - content: - application/json: - schema: - $ref: '#/components/schemas/AdminTokenObject' - '401': - $ref: '#/components/responses/Unauthorized' - tags: - - Authentication - - Token - /api/v3/configure/token/admin/regenerate: - post: - operationId: PostRegenerateAdminToken - summary: Regenerate admin token - description: | - Regenerates an admin token and revokes the previous token with the same name. - parameters: [] - responses: - '201': - description: Success. The admin token has been regenerated. - content: - application/json: - schema: - $ref: '#/components/schemas/AdminTokenObject' - '401': - $ref: '#/components/responses/Unauthorized' - tags: - - Authentication - - Token - /api/v3/configure/token: - delete: - operationId: DeleteToken - summary: Delete token - description: | - Deletes a token. - parameters: - - name: id - in: query - required: true - schema: - type: string - description: | - The ID of the token to delete. - responses: - '204': - description: Success. The token has been deleted. - '401': - $ref: '#/components/responses/Unauthorized' - '404': - description: Token not found. - tags: - - Authentication - - Token - /api/v3/configure/token/named_admin: - post: - operationId: PostCreateNamedAdminToken - summary: Create named admin token - description: | - Creates a named admin token. - A named admin token is an admin token with a specific name identifier. - parameters: - - name: name - in: query - required: true - schema: - type: string - description: | - The name for the admin token. - responses: - '201': - description: | - Success. The named admin token has been created. - The response body contains the token string and metadata. - content: - application/json: - schema: - $ref: '#/components/schemas/AdminTokenObject' - '401': - $ref: '#/components/responses/Unauthorized' - '409': - description: A token with this name already exists. - tags: - - Authentication - - Token - /api/v3/plugins/files: - put: - operationId: PutPluginFile - summary: Update plugin file - description: | - Updates a plugin file in the plugin directory. - x-security-note: Requires an admin token - responses: - '204': - description: Success. The plugin file has been updated. - '401': - $ref: '#/components/responses/Unauthorized' - '403': - description: Forbidden. Admin token required. + "200": + description: Success. The plugin test has been executed. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Plugin not enabled. + summary: Test WAL plugin + description: Executes a test of a write-ahead logging (WAL) plugin. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/WALPluginTestRequest" tags: - Processing engine /api/v3/plugins/directory: put: operationId: PutPluginDirectory - summary: Update plugin directory - description: | - Updates the plugin directory configuration. - x-security-note: Requires an admin token + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/PluginDirectoryRequest" responses: - '204': + "200": description: Success. The plugin directory has been updated. - '401': - $ref: '#/components/responses/Unauthorized' - '403': + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Forbidden. Admin token required. + "500": + description: Plugin not found. The `plugin_name` does not match any registered trigger. + summary: Update a multi-file plugin directory + description: | + Replaces all files in a multi-file plugin directory. The + `plugin_name` must match a registered trigger name. Each entry in + the `files` array specifies a `relative_path` and `content`—the + server writes them into the trigger's plugin directory. + + Use this endpoint to update multi-file plugins (directories with + `__init__.py` and supporting modules). For single-file plugins, + use `PUT /api/v3/plugins/files` instead. + tags: + - Processing engine + x-security-note: Requires an admin token + /api/v3/plugins/files: + post: + operationId: create_plugin_file + summary: Create a plugin file + description: | + Creates a single plugin file in the plugin directory. Writes the + `content` to a file named after `plugin_name`. Does not require an + existing trigger—use this to upload plugin files before creating + triggers that reference them. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/PluginFileRequest" + responses: + "200": + description: Success. The plugin file has been created. + "401": + $ref: "#/components/responses/Unauthorized" + "403": description: Forbidden. Admin token required. tags: - Processing engine + x-security-note: Requires an admin token + put: + operationId: PutPluginFile + summary: Update a plugin file + description: | + Updates a single plugin file for an existing trigger. The + `plugin_name` must match a registered trigger name—the server + resolves the trigger's `plugin_filename` and overwrites that file + with the provided `content`. + + To upload a new plugin file before creating a trigger, use + `POST /api/v3/plugins/files` instead. To update a multi-file + plugin directory, use `PUT /api/v3/plugins/directory`. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/PluginFileRequest" + responses: + "200": + description: Success. The plugin file has been updated. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Forbidden. Admin token required. + "500": + description: Plugin not found. The `plugin_name` does not match any registered trigger. + tags: + - Processing engine + x-security-note: Requires an admin token + /api/v3/query_influxql: + get: + operationId: GetExecuteInfluxQLQuery + responses: + "200": + description: Success. The response body contains query results. + content: + application/json: + schema: + $ref: "#/components/schemas/QueryResponse" + text/csv: + schema: + type: string + application/vnd.apache.parquet: + schema: + type: string + application/jsonl: + schema: + type: string + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "404": + description: Database not found. + "405": + description: Method not allowed. + "422": + description: Unprocessable entity. + summary: Execute InfluxQL query + description: Executes an InfluxQL query to retrieve data from the specified database. + parameters: + - $ref: "#/components/parameters/dbQueryParam" + - name: q + in: query + required: true + schema: + type: string + - name: format + in: query + required: false + schema: + type: string + - $ref: "#/components/parameters/AcceptQueryHeader" + - name: params + in: query + required: false + schema: + type: string + description: JSON-encoded query parameters. Use this to pass bind parameters to parameterized queries. + description: JSON-encoded query parameters for parameterized queries. + tags: + - Query data + post: + operationId: PostExecuteQueryInfluxQL + responses: + "200": + description: Success. The response body contains query results. + content: + application/json: + schema: + $ref: "#/components/schemas/QueryResponse" + text/csv: + schema: + type: string + application/vnd.apache.parquet: + schema: + type: string + application/jsonl: + schema: + type: string + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "404": + description: Database not found. + "405": + description: Method not allowed. + "422": + description: Unprocessable entity. + summary: Execute InfluxQL query + description: Executes an InfluxQL query to retrieve data from the specified database. + parameters: + - $ref: "#/components/parameters/AcceptQueryHeader" + - $ref: "#/components/parameters/ContentType" + requestBody: + $ref: "#/components/requestBodies/queryRequestBody" + tags: + - Query data + /api/v3/query_sql: + get: + operationId: GetExecuteQuerySQL + responses: + "200": + description: Success. The response body contains query results. + content: + application/json: + schema: + $ref: "#/components/schemas/QueryResponse" + example: + results: + - series: + - name: mytable + columns: + - time + - value + values: + - - "2024-02-02T12:00:00Z" + - 42 + text/csv: + schema: + type: string + application/vnd.apache.parquet: + schema: + type: string + application/jsonl: + schema: + type: string + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "404": + description: Database not found. + "405": + description: Method not allowed. + "422": + description: Unprocessable entity. + summary: Execute SQL query + description: Executes an SQL query to retrieve data from the specified database. + parameters: + - $ref: "#/components/parameters/db" + - $ref: "#/components/parameters/querySqlParam" + - $ref: "#/components/parameters/format" + - $ref: "#/components/parameters/AcceptQueryHeader" + - $ref: "#/components/parameters/ContentType" + - name: params + in: query + required: false + schema: + type: string + description: JSON-encoded query parameters. Use this to pass bind parameters to parameterized queries. + description: JSON-encoded query parameters for parameterized queries. + tags: + - Query data + post: + operationId: PostExecuteQuerySQL + responses: + "200": + description: Success. The response body contains query results. + content: + application/json: + schema: + $ref: "#/components/schemas/QueryResponse" + text/csv: + schema: + type: string + application/vnd.apache.parquet: + schema: + type: string + application/jsonl: + schema: + type: string + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "404": + description: Database not found. + "405": + description: Method not allowed. + "422": + description: Unprocessable entity. + summary: Execute SQL query + description: Executes an SQL query to retrieve data from the specified database. + parameters: + - $ref: "#/components/parameters/AcceptQueryHeader" + - $ref: "#/components/parameters/ContentType" + requestBody: + $ref: "#/components/requestBodies/queryRequestBody" + tags: + - Query data + /api/v3/write_lp: + post: + operationId: PostWriteLP + parameters: + - $ref: "#/components/parameters/dbWriteParam" + - $ref: "#/components/parameters/accept_partial" + - $ref: "#/components/parameters/precisionParam" + - name: no_sync + in: query + schema: + $ref: "#/components/schemas/NoSync" + - name: Content-Type + in: header + description: | + The content type of the request payload. + schema: + $ref: "#/components/schemas/LineProtocol" + required: false + - name: Accept + in: header + description: | + The content type that the client can understand. + Writes only return a response body if they fail (partially or completely)--for example, + due to a syntax problem or type mismatch. + schema: + type: string + default: application/json + enum: + - application/json + required: false + - $ref: "#/components/parameters/ContentEncoding" + - $ref: "#/components/parameters/ContentLength" + responses: + "204": + description: Success ("No Content"). All data in the batch is written and queryable. + headers: + cluster-uuid: + $ref: "#/components/headers/ClusterUUID" + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "413": + description: Request entity too large. + "422": + description: Unprocessable entity. + summary: Write line protocol + description: > + Writes line protocol to the specified database. + + + This is the native InfluxDB 3 Core write endpoint that provides enhanced control + + over write behavior with advanced parameters for high-performance and fault-tolerant operations. + + + Use this endpoint to send data in [line protocol](/influxdb3/core/reference/syntax/line-protocol/) format to + InfluxDB. + + Use query parameters to specify options for writing data. + + + #### Features + + + - **Partial writes**: Use `accept_partial=true` to allow partial success when some lines in a batch fail + + - **Asynchronous writes**: Use `no_sync=true` to skip waiting for WAL synchronization, allowing faster response + times but sacrificing durability guarantees + + - **Flexible precision**: Automatic timestamp precision detection with `precision=auto` (default) + + + #### Auto precision detection + + + When you use `precision=auto` or omit the precision parameter, InfluxDB 3 automatically detects + + the timestamp precision based on the magnitude of the timestamp value: + + + - Timestamps < 5e9 → Second precision (multiplied by 1,000,000,000 to convert to nanoseconds) + + - Timestamps < 5e12 → Millisecond precision (multiplied by 1,000,000) + + - Timestamps < 5e15 → Microsecond precision (multiplied by 1,000) + + - Larger timestamps → Nanosecond precision (no conversion needed) + + + #### Related + + + - [Use the InfluxDB v3 write_lp API to write data](/influxdb3/core/write-data/http-api/v3-write-lp/) + requestBody: + $ref: "#/components/requestBodies/lineProtocolRequestBody" + tags: + - Write data + x-codeSamples: + - label: cURL - Basic write + lang: Shell + source: | + curl --request POST "http://localhost:8181/api/v3/write_lp?db=sensors" \ + --header "Authorization: Bearer DATABASE_TOKEN" \ + --header "Content-Type: text/plain" \ + --data-raw "cpu,host=server01 usage=85.2 1638360000000000000" + - label: cURL - Write with millisecond precision + lang: Shell + source: | + curl --request POST "http://localhost:8181/api/v3/write_lp?db=sensors&precision=ms" \ + --header "Authorization: Bearer DATABASE_TOKEN" \ + --header "Content-Type: text/plain" \ + --data-raw "cpu,host=server01 usage=85.2 1638360000000" + - label: cURL - Asynchronous write with partial acceptance + lang: Shell + source: > + curl --request POST + "http://localhost:8181/api/v3/write_lp?db=sensors&accept_partial=true&no_sync=true&precision=auto" \ + --header "Authorization: Bearer DATABASE_TOKEN" \ + --header "Content-Type: text/plain" \ + --data-raw "cpu,host=server01 usage=85.2 + memory,host=server01 used=4096" + - label: cURL - Multiple measurements with tags + lang: Shell + source: | + curl --request POST "http://localhost:8181/api/v3/write_lp?db=sensors&precision=ns" \ + --header "Authorization: Bearer DATABASE_TOKEN" \ + --header "Content-Type: text/plain" \ + --data-raw "cpu,host=server01,region=us-west usage=85.2,load=0.75 1638360000000000000 + memory,host=server01,region=us-west used=4096,free=12288 1638360000000000000 + disk,host=server01,region=us-west,device=/dev/sda1 used=50.5,free=49.5 1638360000000000000" + /health: + get: + operationId: GetHealth + responses: + "200": + description: Service is running. Returns `OK`. + content: + text/plain: + schema: + type: string + example: OK + "401": + description: Unauthorized. Authentication is required. + "500": + description: Service is unavailable. + summary: Health check + description: | + Checks the status of the service. + + Returns `OK` if the service is running. This endpoint does not return version information. + Use the [`/ping`](#operation/GetPing) endpoint to retrieve version details. + + > **Note**: This endpoint requires authentication by default in InfluxDB 3 Core. + tags: + - Server information + /metrics: + get: + operationId: GetMetrics + responses: + "200": + description: Success + summary: Metrics + description: Retrieves Prometheus-compatible server metrics. + tags: + - Server information + /ping: + get: + operationId: GetPing + responses: + "200": + description: Success. The response body contains server information. + headers: + x-influxdb-version: + description: The InfluxDB version number (for example, `3.8.0`). + schema: + type: string + example: 3.8.0 + x-influxdb-build: + description: The InfluxDB build type (`Core` or `Enterprise`). + schema: + type: string + example: Core + content: + application/json: + schema: + type: object + properties: + version: + type: string + description: The InfluxDB version number. + example: 3.8.0 + revision: + type: string + description: The git revision hash for the build. + example: 83b589b883 + process_id: + type: string + description: A unique identifier for the server process. + example: b756d9e0-cecd-4f72-b6d0-19e2d4f8cbb7 + "401": + description: Unauthorized. Authentication is required. + "404": + description: | + Not Found. Returned for HEAD requests. + Use a GET request to retrieve version information. + x-client-method: ping + summary: Ping the server + description: | + Returns version information for the server. + + **Important**: Use a GET request. HEAD requests return `404 Not Found`. + + The response includes version information in both headers and the JSON body: + + - **Headers**: `x-influxdb-version` and `x-influxdb-build` + - **Body**: JSON object with `version`, `revision`, and `process_id` + + > **Note**: This endpoint requires authentication by default in InfluxDB 3 Core. + tags: + - Server information + post: + operationId: ping + responses: + "200": + description: Success. The response body contains server information. + headers: + x-influxdb-version: + description: The InfluxDB version number (for example, `3.8.0`). + schema: + type: string + example: 3.8.0 + x-influxdb-build: + description: The InfluxDB build type (`Core` or `Enterprise`). + schema: + type: string + example: Core + content: + application/json: + schema: + type: object + properties: + version: + type: string + description: The InfluxDB version number. + example: 3.8.0 + revision: + type: string + description: The git revision hash for the build. + example: 83b589b883 + process_id: + type: string + description: A unique identifier for the server process. + example: b756d9e0-cecd-4f72-b6d0-19e2d4f8cbb7 + "401": + description: Unauthorized. Authentication is required. + "404": + description: | + Not Found. Returned for HEAD requests. + Use a GET request to retrieve version information. + summary: Ping the server + description: Returns version information for the server. Accepts POST in addition to GET. + tags: + - Server information + /query: + get: + operationId: GetV1ExecuteQuery + responses: + "200": + description: | + Success. The response body contains query results. + content: + application/json: + schema: + $ref: "#/components/schemas/QueryResponse" + application/csv: + schema: + type: string + headers: + Content-Type: + description: > + The content type of the response. + + Default is `application/json`. + + + If the `Accept` request header is `application/csv` or `text/csv`, the `Content-type` response header is + `application/csv` + + and the response is formatted as CSV. + schema: + type: string + default: application/json + enum: + - application/json + - application/csv + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "404": + description: Database not found. + "405": + description: Method not allowed. + "422": + description: Unprocessable entity. + summary: Execute InfluxQL query (v1-compatible) + description: > + Executes an InfluxQL query to retrieve data from the specified database. + + + This endpoint is compatible with InfluxDB 1.x client libraries and third-party integrations such as Grafana. + + Use query parameters to specify the database and the InfluxQL query. + + + #### Related + + + - [Use the InfluxDB v1 HTTP query API and InfluxQL to query + data](/influxdb3/core/query-data/execute-queries/influxdb-v1-api/) + parameters: + - name: Accept + in: header + schema: + type: string + default: application/json + enum: + - application/json + - application/csv + - text/csv + required: false + description: > + The content type that the client can understand. + + + If `text/csv` is specified, the `Content-type` response header is `application/csv` and the response is + formatted as CSV. + + + Returns an error if the format is invalid or non-UTF8. + - in: query + name: chunked + description: | + If true, the response is divided into chunks of size `chunk_size`. + schema: + type: boolean + default: false + - in: query + name: chunk_size + description: | + The number of records that will go into a chunk. + This parameter is only used if `chunked=true`. + schema: + type: integer + default: 10000 + - in: query + name: db + description: The database to query. If not provided, the InfluxQL query string must specify the database. + schema: + type: string + format: InfluxQL + - in: query + name: pretty + description: | + If true, the JSON response is formatted in a human-readable format. + schema: + type: boolean + default: false + - in: query + name: q + description: The InfluxQL query string. + required: true + schema: + type: string + - name: epoch + description: > + Formats timestamps as [unix (epoch) timestamps](/influxdb3/core/reference/glossary/#unix-timestamp) with the + specified precision + + instead of [RFC3339 timestamps](/influxdb3/core/reference/glossary/#rfc3339-timestamp) with nanosecond + precision. + in: query + schema: + $ref: "#/components/schemas/EpochCompatibility" + - $ref: "#/components/parameters/v1UsernameParam" + - $ref: "#/components/parameters/v1PasswordParam" + - name: rp + in: query + required: false + schema: + type: string + description: | + Retention policy name. Honored but discouraged. InfluxDB 3 doesn't use retention policies. + - name: Authorization + in: header + required: false + schema: + type: string + description: | + Authorization header for token-based authentication. + Supported schemes: + - `Bearer AUTH_TOKEN` - OAuth bearer token scheme + - `Token AUTH_TOKEN` - InfluxDB v2 token scheme + - `Basic ` - Basic authentication (username is ignored) + tags: + - Query data + - Compatibility endpoints + post: + operationId: PostExecuteV1Query + responses: + "200": + description: | + Success. The response body contains query results. + content: + application/json: + schema: + $ref: "#/components/schemas/QueryResponse" + application/csv: + schema: + type: string + headers: + Content-Type: + description: > + The content type of the response. + + Default is `application/json`. + + + If the `Accept` request header is `application/csv` or `text/csv`, the `Content-type` response header is + `application/csv` + + and the response is formatted as CSV. + schema: + type: string + default: application/json + enum: + - application/json + - application/csv + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "404": + description: Database not found. + "405": + description: Method not allowed. + "422": + description: Unprocessable entity. + summary: Execute InfluxQL query (v1-compatible) + description: > + Executes an InfluxQL query to retrieve data from the specified database. + + + #### Related + + + - [Use the InfluxDB v1 HTTP query API and InfluxQL to query + data](/influxdb3/core/query-data/execute-queries/influxdb-v1-api/) + parameters: + - name: Accept + in: header + schema: + type: string + default: application/json + enum: + - application/json + - application/csv + - text/csv + required: false + description: > + The content type that the client can understand. + + + If `text/csv` is specified, the `Content-type` response header is `application/csv` and the response is + formatted as CSV. + + + Returns an error if the format is invalid or non-UTF8. + requestBody: + content: + application/json: + schema: + type: object + properties: + db: + type: string + description: The database to query. If not provided, the InfluxQL query string must specify the database. + q: + description: The InfluxQL query string. + type: string + chunked: + description: | + If true, the response is divided into chunks of size `chunk_size`. + type: boolean + chunk_size: + description: | + The number of records that will go into a chunk. + This parameter is only used if `chunked=true`. + type: integer + default: 10000 + epoch: + description: > + A unix timestamp precision. + + + - `h` for hours + + - `m` for minutes + + - `s` for seconds + + - `ms` for milliseconds + + - `u` or `µ` for microseconds + + - `ns` for nanoseconds + + + Formats timestamps as [unix (epoch) timestamps](/influxdb3/core/reference/glossary/#unix-timestamp) + with the specified precision + + instead of [RFC3339 timestamps](/influxdb3/core/reference/glossary/#rfc3339-timestamp) with + nanosecond precision. + enum: + - ns + - u + - µ + - ms + - s + - m + - h + type: string + pretty: + description: | + If true, the JSON response is formatted in a human-readable format. + type: boolean + required: + - q + application/x-www-form-urlencoded: + schema: + type: object + properties: + db: + type: string + description: The database to query. If not provided, the InfluxQL query string must specify the database. + q: + description: The InfluxQL query string. + type: string + chunked: + description: | + If true, the response is divided into chunks of size `chunk_size`. + type: boolean + chunk_size: + description: | + The number of records that will go into a chunk. + This parameter is only used if `chunked=true`. + type: integer + default: 10000 + epoch: + description: > + A unix timestamp precision. + + + - `h` for hours + + - `m` for minutes + + - `s` for seconds + + - `ms` for milliseconds + + - `u` or `µ` for microseconds + + - `ns` for nanoseconds + + + Formats timestamps as [unix (epoch) timestamps](/influxdb3/core/reference/glossary/#unix-timestamp) + with the specified precision + + instead of [RFC3339 timestamps](/influxdb3/core/reference/glossary/#rfc3339-timestamp) with + nanosecond precision. + enum: + - ns + - u + - µ + - ms + - s + - m + - h + type: string + pretty: + description: | + If true, the JSON response is formatted in a human-readable format. + type: boolean + required: + - q + application/vnd.influxql: + schema: + type: string + description: InfluxQL query string sent as the request body. + tags: + - Query data + - Compatibility endpoints + /write: + post: + operationId: PostV1Write + responses: + "204": + description: Success ("No Content"). All data in the batch is written and queryable. + headers: + cluster-uuid: + $ref: "#/components/headers/ClusterUUID" + "400": + description: | + Bad request. Some (a _partial write_) or all of the data from the batch was rejected and not written. + If a partial write occurred, then some points from the batch are written and queryable. + + The response body: + - indicates if a partial write occurred or all data was rejected. + - contains details about the [rejected points](/influxdb3/core/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. + content: + application/json: + examples: + rejectedAllPoints: + summary: Rejected all points in the batch + value: | + { + "error": "write of line protocol failed", + "data": [ + { + "original_line": "dquote> home,room=Kitchen temp=hi", + "line_number": 2, + "error_message": "No fields were provided" + } + ] + } + partialWriteErrorWithRejectedPoints: + summary: Partial write rejected some points in the batch + value: | + { + "error": "partial write of line protocol occurred", + "data": [ + { + "original_line": "dquote> home,room=Kitchen temp=hi", + "line_number": 2, + "error_message": "No fields were provided" + } + ] + } + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "413": + description: Request entity too large. + summary: Write line protocol (v1-compatible) + description: > + Writes line protocol to the specified database. + + + This endpoint provides backward compatibility for InfluxDB 1.x write workloads using tools such as InfluxDB 1.x + client libraries, the Telegraf `outputs.influxdb` output plugin, or third-party tools. + + + Use this endpoint to send data in [line + protocol](https://docs.influxdata.com/influxdb3/core/reference/syntax/line-protocol/) format to InfluxDB. + + Use query parameters to specify options for writing data. + + + #### Related + + + - [Use compatibility APIs to write data](/influxdb3/core/write-data/http-api/compatibility-apis/) + parameters: + - $ref: "#/components/parameters/dbWriteParam" + - $ref: "#/components/parameters/compatibilityPrecisionParam" + - $ref: "#/components/parameters/v1UsernameParam" + - $ref: "#/components/parameters/v1PasswordParam" + - name: rp + in: query + required: false + schema: + type: string + description: | + Retention policy name. Honored but discouraged. InfluxDB 3 doesn't use retention policies. + - name: consistency + in: query + required: false + schema: + type: string + description: | + Write consistency level. Ignored by InfluxDB 3. Provided for compatibility with InfluxDB 1.x clients. + - name: Authorization + in: header + required: false + schema: + type: string + description: | + Authorization header for token-based authentication. + Supported schemes: + - `Bearer AUTH_TOKEN` - OAuth bearer token scheme + - `Token AUTH_TOKEN` - InfluxDB v2 token scheme + - `Basic ` - Basic authentication (username is ignored) + - name: Content-Type + in: header + description: | + The content type of the request payload. + schema: + $ref: "#/components/schemas/LineProtocol" + required: false + - name: Accept + in: header + description: | + The content type that the client can understand. + Writes only return a response body if they fail (partially or completely)--for example, + due to a syntax problem or type mismatch. + schema: + type: string + default: application/json + enum: + - application/json + required: false + - $ref: "#/components/parameters/ContentEncoding" + - $ref: "#/components/parameters/ContentLength" + requestBody: + $ref: "#/components/requestBodies/lineProtocolRequestBody" + tags: + - Compatibility endpoints + - Write data components: parameters: AcceptQueryHeader: @@ -1921,7 +2344,7 @@ components: The compression applied to the line protocol in the request payload. To send a gzip payload, pass `Content-Encoding: gzip` header. schema: - $ref: '#/components/schemas/ContentEncoding' + $ref: "#/components/schemas/ContentEncoding" required: false ContentLength: name: Content-Length @@ -1929,7 +2352,7 @@ components: description: | The size of the entity-body, in bytes, sent to InfluxDB. schema: - $ref: '#/components/schemas/ContentLength' + $ref: "#/components/schemas/ContentLength" ContentType: name: Content-Type description: | @@ -1973,20 +2396,20 @@ components: in: query required: false schema: - $ref: '#/components/schemas/AcceptPartial' + $ref: "#/components/schemas/AcceptPartial" compatibilityPrecisionParam: name: precision in: query - required: true + required: false schema: - $ref: '#/components/schemas/PrecisionWriteCompatibility' + $ref: "#/components/schemas/PrecisionWriteCompatibility" description: The precision for unix timestamps in the line protocol batch. precisionParam: name: precision in: query - required: true + required: false schema: - $ref: '#/components/schemas/PrecisionWrite' + $ref: "#/components/schemas/PrecisionWrite" description: The precision for unix timestamps in the line protocol batch. querySqlParam: name: q @@ -2002,22 +2425,24 @@ components: in: query required: false schema: - $ref: '#/components/schemas/Format' + $ref: "#/components/schemas/Format" formatRequired: name: format in: query required: true schema: - $ref: '#/components/schemas/Format' + $ref: "#/components/schemas/Format" v1UsernameParam: name: u in: query required: false schema: type: string - description: | + description: > Username for v1 compatibility authentication. - When using Basic authentication or query string authentication, InfluxDB 3 ignores this parameter but allows any arbitrary string for compatibility with InfluxDB 1.x clients. + + When using Basic authentication or query string authentication, InfluxDB 3 ignores this parameter but allows any + arbitrary string for compatibility with InfluxDB 1.x clients. v1PasswordParam: name: p in: query @@ -2026,7 +2451,7 @@ components: type: string description: | Password for v1 compatibility authentication. - For query string authentication, pass an admin token. + For query string authentication, pass a database token with write permissions as this parameter. InfluxDB 3 checks that the `p` value is an authorized token. requestBodies: lineProtocolRequestBody: @@ -2050,7 +2475,7 @@ components: content: application/json: schema: - $ref: '#/components/schemas/QueryRequestObject' + $ref: "#/components/schemas/QueryRequestObject" schemas: AdminTokenObject: type: object @@ -2073,23 +2498,31 @@ components: name: _admin token: apiv3_00xx0Xx0xx00XX0x0 hash: 00xx0Xx0xx00XX0x0 - created_at: '2025-04-18T14:02:45.331Z' + created_at: "2025-04-18T14:02:45.331Z" expiry: null ContentEncoding: type: string enum: - gzip - identity - description: | + description: > Content coding. + Use `gzip` for compressed data or `identity` for unmodified, uncompressed data. + #### Multi-member gzip support - InfluxDB 3 supports multi-member gzip payloads (concatenated gzip files per [RFC 1952](https://www.rfc-editor.org/rfc/rfc1952)). + + InfluxDB 3 supports multi-member gzip payloads (concatenated gzip files per [RFC + 1952](https://www.rfc-editor.org/rfc/rfc1952)). + This allows you to: + - Concatenate multiple gzip files and send them in a single request + - Maintain compatibility with InfluxDB v1 and v2 write endpoints + - Simplify batch operations using standard compression tools default: identity LineProtocol: @@ -2103,8 +2536,6 @@ components: ContentLength: type: integer description: The length in decimal number of octets. - Database: - type: string AcceptPartial: type: boolean default: true @@ -2115,9 +2546,12 @@ components: - json - csv - parquet + - json_lines - jsonl - description: | + - pretty + description: |- The format of data in the response body. + `json_lines` is the canonical name; `jsonl` is accepted as an alias. NoSync: type: boolean default: false @@ -2133,11 +2567,14 @@ components: - ms - s - us + - u - ns + - "n" type: string - description: | + description: |- The precision for unix timestamps in the line protocol batch. - Use `ms` for milliseconds, `s` for seconds, `us` for microseconds, or `ns` for nanoseconds. + Use `ms` for milliseconds, `s` for seconds, `us` or `u` for microseconds, or `ns` or `n` for nanoseconds. + Optional — defaults to nanosecond precision if omitted. PrecisionWrite: enum: - auto @@ -2173,6 +2610,7 @@ components: - json - csv - parquet + - json_lines - jsonl - pretty params: @@ -2194,9 +2632,13 @@ components: properties: db: type: string + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$|^[a-zA-Z0-9]$ + description: |- + The database name. Database names cannot contain underscores (_). + Names must start and end with alphanumeric characters and can contain hyphens (-) in the middle. retention_period: type: string - description: | + description: |- The retention period for the database. Specifies how long data should be retained. Use duration format (for example, "1d", "1h", "30m", "7d"). example: 7d @@ -2231,6 +2673,12 @@ components: required: - name - type + retention_period: + type: string + description: |- + The retention period for the table. Specifies how long data in this table should be retained. + Use duration format (for example, "1d", "1h", "30m", "7d"). + example: 30d required: - db - table @@ -2325,56 +2773,93 @@ components: description: | Configuration for trigger error handling and execution behavior. allOf: - - $ref: '#/components/schemas/TriggerSettings' + - $ref: "#/components/schemas/TriggerSettings" trigger_specification: - type: string - description: | + description: > Specifies when and how the processing engine trigger should be invoked. + ## Supported trigger specifications: + ### Cron-based scheduling + Format: `cron:CRON_EXPRESSION` + Uses extended (6-field) cron format (second minute hour day_of_month month day_of_week): + ``` + ┌───────────── second (0-59) + │ ┌───────────── minute (0-59) + │ │ ┌───────────── hour (0-23) + │ │ │ ┌───────────── day of month (1-31) + │ │ │ │ ┌───────────── month (1-12) + │ │ │ │ │ ┌───────────── day of week (0-6, Sunday=0) + │ │ │ │ │ │ + * * * * * * + ``` + Examples: + - `cron:0 0 6 * * 1-5` - Every weekday at 6:00 AM + - `cron:0 30 14 * * 5` - Every Friday at 2:30 PM + - `cron:0 0 0 1 * *` - First day of every month at midnight + ### Interval-based scheduling + Format: `every:DURATION` - Supported durations: `s` (seconds), `m` (minutes), `h` (hours), `d` (days), `w` (weeks), `M` (months), `y` (years): + + Supported durations: `s` (seconds), `m` (minutes), `h` (hours), `d` (days), `w` (weeks), `M` (months), `y` + (years): + - `every:30s` - Every 30 seconds + - `every:5m` - Every 5 minutes + - `every:1h` - Every hour + - `every:1d` - Every day + - `every:1w` - Every week + - `every:1M` - Every month + - `every:1y` - Every year + **Maximum interval**: 1 year + ### Table-based triggers + - `all_tables` - Triggers on write events to any table in the database + - `table:TABLE_NAME` - Triggers on write events to a specific table + ### On-demand triggers + Format: `request:REQUEST_PATH` + Creates an HTTP endpoint `/api/v3/engine/REQUEST_PATH` for manual invocation: + - `request:hello-world` - Creates endpoint `/api/v3/engine/hello-world` + - `request:data-export` - Creates endpoint `/api/v3/engine/data-export` pattern: ^(cron:[0-9 *,/-]+|every:[0-9]+[smhd]|all_tables|table:[a-zA-Z_][a-zA-Z0-9_]*|request:[a-zA-Z0-9_-]+)$ example: cron:0 0 6 * * 1-5 @@ -2420,6 +2905,116 @@ components: required: - run_async - error_behavior + WALPluginTestRequest: + type: object + description: | + Request body for testing a write-ahead logging (WAL) plugin. + properties: + filename: + type: string + description: | + The path and filename of the plugin to test. + database: + type: string + description: | + The database name to use for the test. + input_lp: + type: string + description: | + Line protocol data to use as input for the test. + cache_name: + type: string + description: | + Optional name of the cache to use in the test. + input_arguments: + type: object + additionalProperties: + type: string + description: | + Optional key-value pairs of arguments to pass to the plugin. + required: + - filename + - database + - input_lp + SchedulePluginTestRequest: + type: object + description: | + Request body for testing a scheduling plugin. + properties: + filename: + type: string + description: | + The path and filename of the plugin to test. + database: + type: string + description: | + The database name to use for the test. + schedule: + type: string + description: | + Optional schedule specification in cron or interval format. + cache_name: + type: string + description: | + Optional name of the cache to use in the test. + input_arguments: + type: object + additionalProperties: + type: string + description: | + Optional key-value pairs of arguments to pass to the plugin. + required: + - filename + - database + PluginFileRequest: + type: object + description: | + Request body for updating a plugin file. + properties: + plugin_name: + type: string + description: | + The name of the plugin file to update. + content: + type: string + description: | + The content of the plugin file. + required: + - plugin_name + - content + PluginDirectoryRequest: + type: object + description: | + Request body for updating plugin directory with multiple files. + properties: + plugin_name: + type: string + description: | + The name of the plugin directory to update. + files: + type: array + items: + $ref: "#/components/schemas/PluginFileEntry" + description: | + List of plugin files to include in the directory. + required: + - plugin_name + - files + PluginFileEntry: + type: object + description: | + Represents a single file in a plugin directory. + properties: + content: + type: string + description: | + The content of the file. + relative_path: + type: string + description: The relative path of the file within the plugin directory. + required: + - relative_path + - content ShowDatabasesResponse: type: object properties: @@ -2442,7 +3037,7 @@ components: - time - value values: - - - '2024-02-02T12:00:00Z' + - - "2024-02-02T12:00:00Z" - 42 ErrorMessage: type: object @@ -2452,38 +3047,6 @@ components: data: type: object nullable: true - LineProtocolError: - properties: - code: - description: Code is the machine-readable error code. - enum: - - internal error - - not found - - conflict - - invalid - - empty value - - unavailable - readOnly: true - type: string - err: - description: Stack of errors that occurred during processing of the request. Useful for debugging. - readOnly: true - type: string - line: - description: First line in the request body that contains malformed data. - format: int32 - readOnly: true - type: integer - message: - description: Human-readable message. - readOnly: true - type: string - op: - description: Describes the logical code operation when the error occurred. Useful for debugging. - readOnly: true - type: string - required: - - code EpochCompatibility: description: | A unix timestamp precision. @@ -2512,62 +3075,13 @@ components: Use duration format (for example, "1d", "1h", "30m", "7d"). example: 7d description: Request schema for updating database configuration. - UpdateTableRequest: - type: object - properties: - db: - type: string - description: The name of the database containing the table. - table: - type: string - description: The name of the table to update. - retention_period: - type: string - description: | - The retention period for the table. Specifies how long data in this table should be retained. - Use duration format (for example, "1d", "1h", "30m", "7d"). - example: 30d - required: - - db - - table - description: Request schema for updating table configuration. - LicenseResponse: - type: object - properties: - license_type: - type: string - description: The type of license (for example, "enterprise", "trial"). - example: enterprise - expires_at: - type: string - format: date-time - description: The expiration date of the license in ISO 8601 format. - example: '2025-12-31T23:59:59Z' - features: - type: array - items: - type: string - description: List of features enabled by the license. - example: - - clustering - - processing_engine - - advanced_auth - status: - type: string - enum: - - active - - expired - - invalid - description: The current status of the license. - example: active - description: Response schema for license information. responses: Unauthorized: description: Unauthorized access. content: application/json: schema: - $ref: '#/components/schemas/ErrorMessage' + $ref: "#/components/schemas/ErrorMessage" BadRequest: description: | Request failed. Possible reasons: @@ -2578,19 +3092,19 @@ components: content: application/json: schema: - $ref: '#/components/schemas/ErrorMessage' + $ref: "#/components/schemas/ErrorMessage" Forbidden: description: Access denied. content: application/json: schema: - $ref: '#/components/schemas/ErrorMessage' + $ref: "#/components/schemas/ErrorMessage" NotFound: description: Resource not found. content: application/json: schema: - $ref: '#/components/schemas/ErrorMessage' + $ref: "#/components/schemas/ErrorMessage" headers: ClusterUUID: description: | @@ -2607,88 +3121,126 @@ components: BasicAuthentication: type: http scheme: basic - description: | + description: >- Use the `Authorization` header with the `Basic` scheme to authenticate v1 API requests. - Works with v1 compatibility [`/write`](#operation/PostV1Write) and [`/query`](#operation/GetV1Query) endpoints in InfluxDB 3. - When authenticating requests, InfluxDB 3 checks that the `password` part of the decoded credential is an authorized token + Works with v1 compatibility [`/write`](#operation/PostV1Write) and [`/query`](#operation/GetV1Query) endpoints + in InfluxDB 3. + + + When authenticating requests, InfluxDB 3 checks that the `password` part of the decoded credential is an + authorized token + and ignores the `username` part of the decoded credential. + + ### Syntax + + + ```http + + Authorization: Basic + + ``` + + ### Example + ```bash + curl "http://localhost:8181/write?db=DATABASE_NAME&precision=s" \ --user "":"AUTH_TOKEN" \ --header "Content-type: text/plain; charset=utf-8" \ --data-binary 'home,room=kitchen temp=72 1641024000' ``` + Replace the following: + - **`DATABASE_NAME`**: your InfluxDB 3 Core database - - **`AUTH_TOKEN`**: an admin token - #### Related guides - - - [Authenticate v1 API requests](/influxdb3/core/guides/api-compatibility/v1/) - - [Manage tokens](/influxdb3/core/admin/tokens/) + - **`AUTH_TOKEN`**: an admin token or database token authorized for the database QuerystringAuthentication: type: apiKey in: query name: u=&p= - description: | + description: >- Use InfluxDB 1.x API parameters to provide credentials through the query string for v1 API requests. - Querystring authentication works with v1-compatible [`/write`](#operation/PostV1Write) and [`/query`](#operation/GetV1Query) endpoints. + + Querystring authentication works with v1-compatible [`/write`](#operation/PostV1Write) and + [`/query`](#operation/GetV1Query) endpoints. + When authenticating requests, InfluxDB 3 checks that the `p` (_password_) query parameter is an authorized token + and ignores the `u` (_username_) query parameter. + ### Syntax + ```http - http://localhost:8181/query/?[u=any]&p=DATABASE_TOKEN - http://localhost:8181/write/?[u=any]&p=DATABASE_TOKEN + + https://localhost:8181/query/?[u=any]&p=AUTH_TOKEN + + https://localhost:8181/write/?[u=any]&p=AUTH_TOKEN + ``` + ### Examples + ```bash + curl "http://localhost:8181/write?db=DATABASE_NAME&precision=s&p=AUTH_TOKEN" \ --header "Content-type: text/plain; charset=utf-8" \ --data-binary 'home,room=kitchen temp=72 1641024000' ``` + Replace the following: + - **`DATABASE_NAME`**: your InfluxDB 3 Core database - - **`AUTH_TOKEN`**: an admin token + + - **`AUTH_TOKEN`**: an admin token or database token authorized for the database + ```bash + ####################################### + # Use an InfluxDB 1.x compatible username and password + # to query the InfluxDB v1 HTTP API + ####################################### + # Use authentication query parameters: - # ?p=DATABASE_TOKEN + + # ?p=AUTH_TOKEN + ####################################### + curl --get "http://localhost:8181/query" \ --data-urlencode "p=AUTH_TOKEN" \ --data-urlencode "db=DATABASE_NAME" \ --data-urlencode "q=SELECT * FROM MEASUREMENT" ``` + Replace the following: + - **`DATABASE_NAME`**: the database to query - - **`AUTH_TOKEN`**: an [admin token](/influxdb3/core/admin/tokens/) - #### Related guides - - - [Authenticate v1 API requests](/influxdb3/core/guides/api-compatibility/v1/) - - [Manage tokens](/influxdb3/core/admin/tokens/) + - **`AUTH_TOKEN`**: a database token with sufficient permissions to the database BearerAuthentication: type: http scheme: bearer @@ -2701,8 +3253,7 @@ components: Bearer authentication works with all endpoints. In your API requests, send an `Authorization` header. - For the header value, provide the word `Bearer` followed by a space and an admin token. - + For the header value, provide the word `Bearer` followed by a space and a database token. ### Syntax @@ -2717,7 +3268,7 @@ components: --header "Authorization: Bearer AUTH_TOKEN" ``` TokenAuthentication: - description: | + description: |- Use InfluxDB v2 Token authentication to provide an authorization token to InfluxDB 3. The v2 Token scheme works with v1 and v2 compatibility endpoints in InfluxDB 3. @@ -2744,10 +3295,6 @@ components: --header "Authorization: Token AUTH_TOKEN" \ --data-binary 'home,room=kitchen temp=72 1463683075' ``` - - ### Related guides - - - [Manage tokens](/influxdb3/core/admin/tokens/) in: header name: Authorization type: apiKey diff --git a/static/openapi/influxdb3-enterprise-openapi.yaml b/static/openapi/influxdb3-enterprise-openapi.yaml new file mode 100644 index 000000000..3d6c70af5 --- /dev/null +++ b/static/openapi/influxdb3-enterprise-openapi.yaml @@ -0,0 +1,3799 @@ +openapi: 3.0.3 +info: + title: InfluxDB 3 Enterprise API Service + description: | + The InfluxDB HTTP API for InfluxDB 3 Enterprise provides a programmatic interface for + interacting with InfluxDB 3 Enterprise databases and resources. + Use this API to: + + - Write data to InfluxDB 3 Enterprise databases + - Query data using SQL or InfluxQL + - Process data using Processing engine plugins + - Manage databases, tables, and Processing engine triggers + - Perform administrative tasks and access system information + + The API includes endpoints under the following paths: + - `/api/v3`: InfluxDB 3 Enterprise native endpoints + - `/`: Compatibility endpoints for InfluxDB v1 workloads and clients + - `/api/v2/write`: Compatibility endpoint for InfluxDB v2 workloads and clients + + To download the OpenAPI specification for this API, use the **Download** button above. + version: v3.8.0 + license: + name: MIT + url: https://opensource.org/licenses/MIT + contact: + name: InfluxData + url: https://www.influxdata.com + email: support@influxdata.com + x-source-hash: sha256:1259b96096eab6c8dbf3f76c974924f124e9b3e08eedc6b0c9a66d3108857c52 +servers: + - url: https://{baseurl} + description: InfluxDB 3 Enterprise API URL + variables: + baseurl: + enum: + - localhost:8181 + default: localhost:8181 + description: InfluxDB 3 Enterprise URL +security: + - BearerAuthentication: [] + - TokenAuthentication: [] + - BasicAuthentication: [] + - QuerystringAuthentication: [] +tags: + - name: Authentication + description: | + Depending on your workflow, use one of the following schemes to authenticate to the InfluxDB 3 API: + + | Authentication scheme | Works with | + |:-------------------|:-----------| + | [Bearer authentication](#section/Authentication/BearerAuthentication) | All endpoints | + | [Token authentication](#section/Authentication/TokenAuthentication) | v1, v2 endpoints | + | [Basic authentication](#section/Authentication/BasicAuthentication) | v1 endpoints | + | [Querystring authentication](#section/Authentication/QuerystringAuthentication) | v1 endpoints | + + x-traitTag: true + x-related: + - title: Authenticate v1 API requests + href: /influxdb3/enterprise/guides/api-compatibility/v1/ + - title: Manage tokens + href: /influxdb3/enterprise/admin/tokens/ + - name: Cache data + description: |- + Manage the in-memory cache. + + #### Distinct Value Cache + + The Distinct Value Cache (DVC) lets you cache distinct + values of one or more columns in a table, improving the performance of + queries that return distinct tag and field values. + + The DVC is an in-memory cache that stores distinct values for specific columns + in a table. When you create an DVC, you can specify what columns' distinct + values to cache, the maximum number of distinct value combinations to cache, and + the maximum age of cached values. A DVC is associated with a table, which can + have multiple DVCs. + + #### Last value cache + + The Last Value Cache (LVC) lets you cache the most recent + values for specific fields in a table, improving the performance of queries that + return the most recent value of a field for specific series or the last N values + of a field. + + The LVC is an in-memory cache that stores the last N number of values for + specific fields of series in a table. When you create an LVC, you can specify + what fields to cache, what tags to use to identify each series, and the + number of values to cache for each unique series. + An LVC is associated with a table, which can have multiple LVCs. + x-related: + - title: Manage the Distinct Value Cache + href: /influxdb3/enterprise/admin/distinct-value-cache/ + - title: Manage the Last Value Cache + href: /influxdb3/enterprise/admin/last-value-cache/ + - name: Compatibility endpoints + description: > + InfluxDB 3 provides compatibility endpoints for InfluxDB 1.x and InfluxDB 2.x workloads and clients. + + + ### Write data using v1- or v2-compatible endpoints + + + - [`/api/v2/write` endpoint](#operation/PostV2Write) + for InfluxDB v2 clients and when you bring existing InfluxDB v2 write workloads to InfluxDB 3. + - [`/write` endpoint](#operation/PostV1Write) for InfluxDB v1 clients and when you bring existing InfluxDB v1 + write workloads to InfluxDB 3. + + + For new workloads, use the [`/api/v3/write_lp` endpoint](#operation/PostWriteLP). + + + All endpoints accept the same line protocol format. + + + ### Query data + + + Use the HTTP [`/query`](#operation/GetV1ExecuteQuery) endpoint for InfluxDB v1 clients and v1 query workloads + using InfluxQL. + + + For new workloads, use one of the following: + + + - HTTP [`/api/v3/query_sql` endpoint](#operation/GetExecuteQuerySQL) for new query workloads using SQL. + + - HTTP [`/api/v3/query_influxql` endpoint](#operation/GetExecuteInfluxQLQuery) for new query workloads using + InfluxQL. + + - Flight SQL and InfluxDB 3 _Flight+gRPC_ APIs for querying with SQL or InfluxQL. For more information about using + Flight APIs, see [InfluxDB 3 client + libraries](https://github.com/InfluxCommunity?q=influxdb3&type=public&language=&sort=). + + + ### Server information + + + Server information endpoints such as `/health` and `metrics` are compatible with InfluxDB 1.x and InfluxDB 2.x + clients. + x-related: + - title: Use compatibility APIs to write data + href: /influxdb3/enterprise/write-data/http-api/compatibility-apis/ + - name: Database + description: Manage databases + - description: > + Most InfluxDB API endpoints require parameters in the request--for example, specifying the database to use. + + + ### Common parameters + + + The following table shows common parameters used by many InfluxDB API endpoints. + + Many endpoints may require other parameters in the query string or in the + + request body that perform functions specific to those endpoints. + + + | Query parameter | Value type | Description | + + |:------------------------ |:--------------------- |:-------------------------------------------| + + | `db` | string | The database name | + + + InfluxDB HTTP API endpoints use standard HTTP request and response headers. + + The following table shows common headers used by many InfluxDB API endpoints. + + Some endpoints may use other headers that perform functions more specific to those endpoints--for example, + + the write endpoints accept the `Content-Encoding` header to indicate that line protocol is compressed in the + request body. + + + | Header | Value type | Description | + + |:------------------------ |:--------------------- |:-------------------------------------------| + + | `Accept` | string | The content type that the client can understand. | + + | `Authorization` | string | The authorization scheme and credential. | + + | `Content-Length` | integer | The size of the entity-body, in bytes. | + + | `Content-Type` | string | The format of the data in the request body. | + name: Headers and parameters + x-traitTag: true + - name: Processing engine + description: > + Manage Processing engine triggers, test plugins, and send requests to trigger On Request plugins. + + + InfluxDB 3 Enterprise provides the InfluxDB 3 processing engine, an embedded Python VM that can dynamically load + and trigger Python plugins in response to events in your database. + + Use Processing engine plugins and triggers to run code and perform tasks for different database events. + + + To get started with the processing engine, see the [Processing engine and Python + plugins](/influxdb3/enterprise/processing-engine/) guide. + x-related: + - title: Processing engine and Python plugins + href: /influxdb3/enterprise/plugins/ + - name: Query data + description: Query data using SQL or InfluxQL + x-related: + - title: Use the InfluxDB v1 HTTP query API and InfluxQL to query data + href: /influxdb3/enterprise/query-data/execute-queries/influxdb-v1-api/ + - name: Quick start + description: > + 1. [Create an admin token](#section/Authentication) to authorize API requests. + + ```bash + curl -X POST "http://localhost:8181/api/v3/configure/token/admin" + ``` + 2. [Check the status](#section/Server-information) of the InfluxDB server. + + ```bash + curl "http://localhost:8181/health" \ + --header "Authorization: Bearer ADMIN_TOKEN" + ``` + + 3. [Write data](#operation/PostWriteLP) to InfluxDB. + + ```bash + curl "http://localhost:8181/api/v3/write_lp?db=sensors&precision=auto" + --header "Authorization: Bearer ADMIN_TOKEN" \ + --data-raw "home,room=Kitchen temp=72.0 + home,room=Living\ room temp=71.5" + ``` + + If all data is written, the response is `204 No Content`. + + 4. [Query data](#operation/GetExecuteQuerySQL) from InfluxDB. + + ```bash + curl -G "http://localhost:8181/api/v3/query_sql" \ + --header "Authorization: Bearer ADMIN_TOKEN" \ + --data-urlencode "db=sensors" \ + --data-urlencode "q=SELECT * FROM home WHERE room='Living room'" \ + --data-urlencode "format=jsonl" + ``` + + Output: + + ```jsonl + {"room":"Living room","temp":71.5,"time":"2025-02-25T20:19:34.984098"} + ``` + + For more information about using InfluxDB 3 Enterprise, see the [Get started](/influxdb3/enterprise/get-started/) + guide. + x-traitTag: true + - name: Server information + description: Retrieve server metrics, status, and version information + - name: Table + description: Manage table schemas and data + - name: Token + description: Manage tokens for authentication and authorization + - name: Write data + description: | + Write data to InfluxDB 3 using line protocol format. + + #### Timestamp precision across write APIs + + InfluxDB 3 provides multiple write endpoints for compatibility with different InfluxDB versions. + The following table compares timestamp precision support across v1, v2, and v3 write APIs: + + | Precision | v1 (`/write`) | v2 (`/api/v2/write`) | v3 (`/api/v3/write_lp`) | + |-----------|---------------|----------------------|-------------------------| + | **Auto detection** | ❌ No | ❌ No | ✅ `auto` (default) | + | **Seconds** | ✅ `s` | ✅ `s` | ✅ `second` | + | **Milliseconds** | ✅ `ms` | ✅ `ms` | ✅ `millisecond` | + | **Microseconds** | ✅ `u` or `µ` | ✅ `us` | ✅ `microsecond` | + | **Nanoseconds** | ✅ `ns` | ✅ `ns` | ✅ `nanosecond` | + | **Default** | Nanosecond | Nanosecond | **Auto** (guessed) | + + All timestamps are stored internally as nanoseconds. +paths: + /api/v1/health: + get: + operationId: GetHealthV1 + summary: Health check (v1) + description: | + Checks the status of the service. + + Returns `OK` if the service is running. This endpoint does not return version information. + Use the [`/ping`](#operation/GetPing) endpoint to retrieve version details. + + > **Note**: This endpoint requires authentication by default in InfluxDB 3 Enterprise. + responses: + "200": + description: Service is running. Returns `OK`. + content: + text/plain: + schema: + type: string + example: OK + "401": + description: Unauthorized. Authentication is required. + "500": + description: Service is unavailable. + tags: + - Server information + - Compatibility endpoints + /api/v2/write: + post: + operationId: PostV2Write + responses: + "204": + description: Success ("No Content"). All data in the batch is written and queryable. + headers: + cluster-uuid: + $ref: "#/components/headers/ClusterUUID" + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "413": + description: Request entity too large. + summary: Write line protocol (v2-compatible) + description: > + Writes line protocol to the specified database. + + + This endpoint provides backward compatibility for InfluxDB 2.x write workloads using tools such as InfluxDB 2.x + client libraries, the Telegraf `outputs.influxdb_v2` output plugin, or third-party tools. + + + Use this endpoint to send data in [line protocol](/influxdb3/enterprise/reference/syntax/line-protocol/) format + to InfluxDB. + + Use query parameters to specify options for writing data. + + + #### Related + + + - [Use compatibility APIs to write data](/influxdb3/enterprise/write-data/http-api/compatibility-apis/) + parameters: + - name: Content-Type + in: header + description: | + The content type of the request payload. + schema: + $ref: "#/components/schemas/LineProtocol" + required: false + - description: | + The compression applied to the line protocol in the request payload. + To send a gzip payload, pass `Content-Encoding: gzip` header. + in: header + name: Content-Encoding + schema: + default: identity + description: | + Content coding. + Use `gzip` for compressed data or `identity` for unmodified, uncompressed data. + enum: + - gzip + - identity + type: string + - description: | + The size of the entity-body, in bytes, sent to InfluxDB. + in: header + name: Content-Length + schema: + description: The length in decimal number of octets. + type: integer + - description: | + The content type that the client can understand. + Writes only return a response body if they fail (partially or completely)--for example, + due to a syntax problem or type mismatch. + in: header + name: Accept + schema: + default: application/json + description: Error content type. + enum: + - application/json + type: string + - name: bucket + in: query + required: true + schema: + type: string + description: |- + A database name. + InfluxDB creates the database if it doesn't already exist, and then + writes all points in the batch to the database. + + This parameter is named `bucket` for compatibility with InfluxDB v2 client libraries. + - name: accept_partial + in: query + required: false + schema: + $ref: "#/components/schemas/AcceptPartial" + - $ref: "#/components/parameters/compatibilityPrecisionParam" + requestBody: + $ref: "#/components/requestBodies/lineProtocolRequestBody" + tags: + - Compatibility endpoints + - Write data + /api/v3/configure/database: + delete: + operationId: DeleteConfigureDatabase + parameters: + - $ref: "#/components/parameters/db" + - name: data_only + in: query + required: false + schema: + type: boolean + default: false + description: | + Delete only data while preserving the database schema and all associated resources + (tokens, triggers, last value caches, distinct value caches, processing engine configurations). + When `false` (default), the entire database is deleted. + - name: remove_tables + in: query + required: false + schema: + type: boolean + default: false + description: | + Used with `data_only=true` to remove table resources (caches) while preserving + database-level resources (tokens, triggers, processing engine configurations). + Has no effect when `data_only=false`. + - name: hard_delete_at + in: query + required: false + schema: + type: string + format: date-time + description: |- + Schedule the database for hard deletion at the specified time. + If not provided, the database will be soft deleted. + Use ISO 8601 date-time format (for example, "2025-12-31T23:59:59Z"). + + #### Deleting a database cannot be undone + + Deleting a database is a destructive action. + Once a database is deleted, data stored in that database cannot be recovered. + + + Also accepts special string values: + - `now` — hard delete immediately + - `never` — soft delete only (default behavior) + - `default` — use the system default hard deletion time + responses: + "200": + description: Success. Database deleted. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Database not found. + summary: Delete a database + description: | + Soft deletes a database. + The database is scheduled for deletion and unavailable for querying. + Use the `hard_delete_at` parameter to schedule a hard deletion. + Use the `data_only` parameter to delete data while preserving the database schema and resources. + tags: + - Database + get: + operationId: GetConfigureDatabase + responses: + "200": + description: Success. The response body contains the list of databases. + content: + application/json: + schema: + $ref: "#/components/schemas/ShowDatabasesResponse" + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Database not found. + summary: List databases + description: Retrieves a list of databases. + parameters: + - $ref: "#/components/parameters/formatRequired" + - name: show_deleted + in: query + required: false + schema: + type: boolean + default: false + description: | + Include soft-deleted databases in the response. + By default, only active databases are returned. + tags: + - Database + post: + operationId: PostConfigureDatabase + responses: + "200": + description: Success. Database created. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "409": + description: Database already exists. + summary: Create a database + description: Creates a new database in the system. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/CreateDatabaseRequest" + tags: + - Database + put: + operationId: update_database + responses: + "200": + description: Success. The database has been updated. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Database not found. + summary: Update a database + description: | + Updates database configuration, such as retention period. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateDatabaseRequest" + tags: + - Database + /api/v3/configure/database/retention_period: + delete: + operationId: DeleteDatabaseRetentionPeriod + summary: Remove database retention period + description: | + Removes the retention period from a database, setting it to infinite retention. + parameters: + - $ref: "#/components/parameters/db" + responses: + "204": + description: Success. The database retention period has been removed. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Database not found. + tags: + - Database + /api/v3/configure/distinct_cache: + delete: + operationId: DeleteConfigureDistinctCache + responses: + "200": + description: Success. The distinct cache has been deleted. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Cache not found. + summary: Delete distinct cache + description: Deletes a distinct cache. + parameters: + - $ref: "#/components/parameters/db" + - name: table + in: query + required: true + schema: + type: string + description: The name of the table containing the distinct cache. + - name: name + in: query + required: true + schema: + type: string + description: The name of the distinct cache to delete. + tags: + - Cache data + - Table + post: + operationId: PostConfigureDistinctCache + responses: + "201": + description: Success. The distinct cache has been created. + "400": + description: > + Bad request. + + + The server responds with status `400` if the request would overwrite an existing cache with a different + configuration. + "409": + description: Conflict. A distinct cache with this configuration already exists. + summary: Create distinct cache + description: Creates a distinct cache for a table. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/DistinctCacheCreateRequest" + tags: + - Cache data + - Table + /api/v3/configure/last_cache: + delete: + operationId: DeleteConfigureLastCache + responses: + "200": + description: Success. The last cache has been deleted. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Cache not found. + summary: Delete last cache + description: Deletes a last cache. + parameters: + - $ref: "#/components/parameters/db" + - name: table + in: query + required: true + schema: + type: string + description: The name of the table containing the last cache. + - name: name + in: query + required: true + schema: + type: string + description: The name of the last cache to delete. + tags: + - Cache data + - Table + post: + operationId: PostConfigureLastCache + responses: + "201": + description: Success. Last cache created. + "400": + description: Bad request. A cache with this name already exists or the request is malformed. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Cache not found. + summary: Create last cache + description: Creates a last cache for a table. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/LastCacheCreateRequest" + tags: + - Cache data + - Table + /api/v3/configure/plugin_environment/install_packages: + post: + operationId: PostInstallPluginPackages + summary: Install plugin packages + description: |- + Installs the specified Python packages into the processing engine plugin environment. + + This endpoint is synchronous and blocks until the packages are installed. + parameters: + - $ref: "#/components/parameters/ContentType" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + packages: + type: array + items: + type: string + description: | + A list of Python package names to install. + Can include version specifiers (e.g., "scipy==1.9.0"). + example: + - influxdb3-python + - scipy + - pandas==1.5.0 + - requests + required: + - packages + example: + packages: + - influxdb3-python + - scipy + - pandas==1.5.0 + - requests + responses: + "200": + description: Success. The packages are installed. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + tags: + - Processing engine + /api/v3/configure/plugin_environment/install_requirements: + post: + operationId: PostInstallPluginRequirements + summary: Install plugin requirements + description: > + Installs requirements from a requirements file (also known as a "pip requirements file") into the processing + engine plugin environment. + + + This endpoint is synchronous and blocks until the requirements are installed. + + + ### Related + + + - [Processing engine and Python plugins](/influxdb3/enterprise/plugins/) + + - [Python requirements file format](https://pip.pypa.io/en/stable/reference/requirements-file-format/) + parameters: + - $ref: "#/components/parameters/ContentType" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + requirements_location: + type: string + description: | + The path to the requirements file containing Python packages to install. + Can be a relative path (relative to the plugin directory) or an absolute path. + example: requirements.txt + required: + - requirements_location + example: + requirements_location: requirements.txt + responses: + "200": + description: Success. The requirements have been installed. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + tags: + - Processing engine + /api/v3/configure/processing_engine_trigger: + post: + operationId: PostConfigureProcessingEngineTrigger + summary: Create processing engine trigger + description: Creates a processing engine trigger with the specified plugin file and trigger specification. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/ProcessingEngineTriggerRequest" + examples: + schedule_cron: + summary: Schedule trigger using cron + description: > + In `"cron:CRON_EXPRESSION"`, `CRON_EXPRESSION` uses extended 6-field cron format. + + The cron expression `0 0 6 * * 1-5` means the trigger will run at 6:00 AM every weekday (Monday to + Friday). + value: + db: DATABASE_NAME + plugin_filename: schedule.py + trigger_name: schedule_cron_trigger + trigger_specification: cron:0 0 6 * * 1-5 + disabled: false + trigger_settings: + run_async: false + error_behavior: Log + schedule_every: + summary: Schedule trigger using interval + description: | + In `"every:DURATION"`, `DURATION` specifies the interval between trigger executions. + The duration `1h` means the trigger will run every hour. + value: + db: mydb + plugin_filename: schedule.py + trigger_name: schedule_every_trigger + trigger_specification: every:1h + disabled: false + trigger_settings: + run_async: false + error_behavior: Log + schedule_every_seconds: + summary: Schedule trigger using seconds interval + description: | + Example of scheduling a trigger to run every 30 seconds. + value: + db: mydb + plugin_filename: schedule.py + trigger_name: schedule_every_30s_trigger + trigger_specification: every:30s + disabled: false + trigger_settings: + run_async: false + error_behavior: Log + schedule_every_minutes: + summary: Schedule trigger using minutes interval + description: | + Example of scheduling a trigger to run every 5 minutes. + value: + db: mydb + plugin_filename: schedule.py + trigger_name: schedule_every_5m_trigger + trigger_specification: every:5m + disabled: false + trigger_settings: + run_async: false + error_behavior: Log + all_tables: + summary: All tables trigger example + description: | + Trigger that fires on write events to any table in the database. + value: + db: mydb + plugin_filename: all_tables.py + trigger_name: all_tables_trigger + trigger_specification: all_tables + disabled: false + trigger_settings: + run_async: false + error_behavior: Log + table_specific: + summary: Table-specific trigger example + description: | + Trigger that fires on write events to a specific table. + value: + db: mydb + plugin_filename: table.py + trigger_name: table_trigger + trigger_specification: table:sensors + disabled: false + trigger_settings: + run_async: false + error_behavior: Log + api_request: + summary: On-demand request trigger example + description: | + Creates an HTTP endpoint `/api/v3/engine/hello-world` for manual invocation. + value: + db: mydb + plugin_filename: request.py + trigger_name: hello_world_trigger + trigger_specification: request:hello-world + disabled: false + trigger_settings: + run_async: false + error_behavior: Log + cron_friday_afternoon: + summary: Cron trigger for Friday afternoons + description: | + Example of a cron trigger that runs every Friday at 2:30 PM. + value: + db: reports + plugin_filename: weekly_report.py + trigger_name: friday_report_trigger + trigger_specification: cron:0 30 14 * * 5 + disabled: false + trigger_settings: + run_async: false + error_behavior: Log + cron_monthly: + summary: Cron trigger for monthly execution + description: | + Example of a cron trigger that runs on the first day of every month at midnight. + value: + db: monthly_data + plugin_filename: monthly_cleanup.py + trigger_name: monthly_cleanup_trigger + trigger_specification: cron:0 0 0 1 * * + disabled: false + trigger_settings: + run_async: false + error_behavior: Log + responses: + "200": + description: Success. Processing engine trigger created. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Trigger not found. + tags: + - Processing engine + delete: + operationId: DeleteConfigureProcessingEngineTrigger + summary: Delete processing engine trigger + description: Deletes a processing engine trigger. + parameters: + - $ref: "#/components/parameters/db" + - name: trigger_name + in: query + required: true + schema: + type: string + - name: force + in: query + required: false + schema: + type: boolean + default: false + description: | + Force deletion of the trigger even if it has active executions. + By default, deletion fails if the trigger is currently executing. + responses: + "200": + description: Success. The processing engine trigger has been deleted. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Trigger not found. + tags: + - Processing engine + /api/v3/configure/processing_engine_trigger/disable: + post: + operationId: PostDisableProcessingEngineTrigger + summary: Disable processing engine trigger + description: Disables a processing engine trigger. + parameters: + - name: db + in: query + required: true + schema: + type: string + description: The database name. + - name: trigger_name + in: query + required: true + schema: + type: string + description: The name of the trigger. + responses: + "200": + description: Success. The processing engine trigger has been disabled. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Trigger not found. + tags: + - Processing engine + /api/v3/configure/processing_engine_trigger/enable: + post: + operationId: PostEnableProcessingEngineTrigger + summary: Enable processing engine trigger + description: Enables a processing engine trigger. + parameters: + - name: db + in: query + required: true + schema: + type: string + description: The database name. + - name: trigger_name + in: query + required: true + schema: + type: string + description: The name of the trigger. + responses: + "200": + description: Success. The processing engine trigger is enabled. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Trigger not found. + tags: + - Processing engine + /api/v3/configure/table: + delete: + operationId: DeleteConfigureTable + parameters: + - $ref: "#/components/parameters/db" + - name: table + in: query + required: true + schema: + type: string + - name: data_only + in: query + required: false + schema: + type: boolean + default: false + description: | + Delete only data while preserving the table schema and all associated resources + (last value caches, distinct value caches). + When `false` (default), the entire table is deleted. + - name: hard_delete_at + in: query + required: false + schema: + type: string + format: date-time + description: |- + Schedule the table for hard deletion at the specified time. + If not provided, the table will be soft deleted. + Use ISO 8601 format (for example, "2025-12-31T23:59:59Z"). + + + Also accepts special string values: + - `now` — hard delete immediately + - `never` — soft delete only (default behavior) + - `default` — use the system default hard deletion time + responses: + "200": + description: Success (no content). The table has been deleted. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Table not found. + summary: Delete a table + description: | + Soft deletes a table. + The table is scheduled for deletion and unavailable for querying. + Use the `hard_delete_at` parameter to schedule a hard deletion. + Use the `data_only` parameter to delete data while preserving the table schema and resources. + + #### Deleting a table cannot be undone + + Deleting a table is a destructive action. + Once a table is deleted, data stored in that table cannot be recovered. + tags: + - Table + post: + operationId: PostConfigureTable + responses: + "200": + description: Success. The table has been created. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Database not found. + summary: Create a table + description: Creates a new table within a database. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/CreateTableRequest" + tags: + - Table + put: + operationId: PatchConfigureTable + responses: + "200": + description: Success. The table has been updated. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Table not found. + summary: Update a table + description: | + Updates table configuration, such as retention period. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateTableRequest" + tags: + - Table + x-enterprise-only: true + /api/v3/configure/token: + delete: + operationId: DeleteToken + parameters: + - name: token_name + in: query + required: true + schema: + type: string + description: The name of the token to delete. + responses: + "200": + description: Success. The token has been deleted. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Token not found. + summary: Delete token + description: | + Deletes a token. + tags: + - Authentication + - Token + /api/v3/configure/token/admin: + post: + operationId: PostCreateAdminToken + responses: + "201": + description: | + Success. The admin token has been created. + The response body contains the token string and metadata. + content: + application/json: + schema: + $ref: "#/components/schemas/AdminTokenObject" + "401": + $ref: "#/components/responses/Unauthorized" + summary: Create admin token + description: | + Creates an admin token. + An admin token is a special type of token that has full access to all resources in the system. + tags: + - Authentication + - Token + /api/v3/configure/token/admin/regenerate: + post: + operationId: PostRegenerateAdminToken + summary: Regenerate admin token + description: | + Regenerates an admin token and revokes the previous token with the same name. + parameters: [] + responses: + "201": + description: Success. The admin token has been regenerated. + content: + application/json: + schema: + $ref: "#/components/schemas/AdminTokenObject" + "401": + $ref: "#/components/responses/Unauthorized" + tags: + - Authentication + - Token + /api/v3/configure/token/named_admin: + post: + operationId: PostCreateNamedAdminToken + responses: + "201": + description: | + Success. The named admin token has been created. + The response body contains the token string and metadata. + content: + application/json: + schema: + $ref: "#/components/schemas/AdminTokenObject" + "401": + $ref: "#/components/responses/Unauthorized" + "409": + description: A token with this name already exists. + summary: Create named admin token + description: | + Creates a named admin token. + A named admin token is a special type of admin token with a custom name for identification and management. + tags: + - Authentication + - Token + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + token_name: + type: string + description: The name for the admin token. + expiry_secs: + type: integer + description: Optional expiration time in seconds. If not provided, the token does not expire. + nullable: true + required: + - token_name + /api/v3/engine/{request_path}: + get: + operationId: GetProcessingEnginePluginRequest + responses: + "200": + description: Success. The plugin request has been executed. + "400": + description: Malformed request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Plugin not found. + "500": + description: Processing failure. + summary: On Request processing engine plugin request + description: > + Executes the On Request processing engine plugin specified in the trigger's `plugin_filename`. + + The request can include request headers, query string parameters, and a request body, which InfluxDB passes to + the plugin. + + + An On Request plugin implements the following signature: + + + ```python + + def process_request(influxdb3_local, query_parameters, request_headers, request_body, args=None) + + ``` + + + The response depends on the plugin implementation. + tags: + - Processing engine + post: + operationId: PostProcessingEnginePluginRequest + responses: + "200": + description: Success. The plugin request has been executed. + "400": + description: Malformed request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Plugin not found. + "500": + description: Processing failure. + summary: On Request processing engine plugin request + description: > + Executes the On Request processing engine plugin specified in the trigger's `plugin_filename`. + + The request can include request headers, query string parameters, and a request body, which InfluxDB passes to + the plugin. + + + An On Request plugin implements the following signature: + + + ```python + + def process_request(influxdb3_local, query_parameters, request_headers, request_body, args=None) + + ``` + + + The response depends on the plugin implementation. + parameters: + - $ref: "#/components/parameters/ContentType" + requestBody: + required: false + content: + application/json: + schema: + type: object + additionalProperties: true + tags: + - Processing engine + parameters: + - name: request_path + description: | + The path configured in the request trigger specification for the plugin. + + For example, if you define a trigger with the following: + + ```json + trigger_specification: "request:hello-world" + ``` + + then, the HTTP API exposes the following plugin endpoint: + + ``` + /api/v3/engine/hello-world + ``` + in: path + required: true + schema: + type: string + /api/v3/enterprise/configure/file_index: + post: + operationId: configure_file_index_create + summary: Create a file index + description: >- + Creates a file index for a database or table. + + + A file index improves query performance by indexing data files based on specified columns, enabling the query + engine to skip irrelevant files during query execution. + + + This endpoint is only available in InfluxDB 3 Enterprise. + x-enterprise-only: true + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/FileIndexCreateRequest" + responses: + "200": + description: Success. The file index has been created. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Database or table not found. + tags: + - Database + - Table + delete: + operationId: configure_file_index_delete + summary: Delete a file index + description: |- + Deletes a file index from a database or table. + + This endpoint is only available in InfluxDB 3 Enterprise. + x-enterprise-only: true + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/FileIndexDeleteRequest" + responses: + "200": + description: Success. The file index has been deleted. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Database, table, or file index not found. + tags: + - Database + - Table + /api/v3/enterprise/configure/node/stop: + post: + operationId: stop_node + summary: Mark a node as stopped + description: >- + Marks a node as stopped in the catalog, freeing up the licensed cores it was using for other nodes. + + + Use this endpoint after you have already stopped the physical instance (for example, using `kill` or stopping + the container). This endpoint does not shut down the running process — you must stop the instance first. + + + When the node is marked as stopped: + + 1. Licensed cores from the stopped node are freed for reuse + + 2. Other nodes in the cluster see the update after their catalog sync interval + + + This endpoint is only available in InfluxDB 3 Enterprise. + + + #### Related + + + - [influxdb3 stop node](/influxdb3/enterprise/reference/cli/influxdb3/stop/node/) + x-enterprise-only: true + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/StopNodeRequest" + responses: + "200": + description: Success. The node has been marked as stopped. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Node not found. + tags: + - Server information + /api/v3/enterprise/configure/table/retention_period: + post: + operationId: create_or_update_retention_period_for_table + summary: Set table retention period + description: >- + Sets or updates the retention period for a specific table. + + + Use this endpoint to control how long data in a table is retained independently of the database-level retention + period. + + + This endpoint is only available in InfluxDB 3 Enterprise. + + + #### Related + + + - [influxdb3 update table](/influxdb3/enterprise/reference/cli/influxdb3/update/table/) + x-enterprise-only: true + parameters: + - name: db + in: query + required: true + schema: + type: string + description: The database name. + - name: table + in: query + required: true + schema: + type: string + description: The table name. + - name: duration + in: query + required: true + schema: + type: string + description: The retention period as a human-readable duration (for example, "30d", "24h", "1y"). + responses: + "204": + description: Success. The table retention period has been set. + "400": + description: Bad request. Invalid duration format. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Database or table not found. + tags: + - Table + delete: + operationId: delete_retention_period_for_table + summary: Clear table retention period + description: >- + Removes the retention period from a specific table, reverting to the database-level retention period (or + infinite retention if no database-level retention is set). + + + This endpoint is only available in InfluxDB 3 Enterprise. + + + #### Related + + + - [influxdb3 update table](/influxdb3/enterprise/reference/cli/influxdb3/update/table/) + x-enterprise-only: true + parameters: + - name: db + in: query + required: true + schema: + type: string + description: The database name. + - name: table + in: query + required: true + schema: + type: string + description: The table name. + responses: + "204": + description: Success. The table retention period has been cleared. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Database or table not found. + tags: + - Table + /api/v3/enterprise/configure/token: + post: + operationId: PostCreateResourceToken + summary: Create a resource token + description: | + Creates a resource (fine-grained permissions) token. + A resource token is a token that has access to specific resources in the system. + + This endpoint is only available in InfluxDB 3 Enterprise. + responses: + "201": + description: | + Success. The resource token has been created. + The response body contains the token string and metadata. + content: + application/json: + schema: + $ref: "#/components/schemas/ResourceTokenObject" + "401": + $ref: "#/components/responses/Unauthorized" + tags: + - Authentication + - Token + x-enterprise-only: true + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/CreateTokenWithPermissionsRequest" + /api/v3/plugin_test/schedule: + post: + operationId: PostTestSchedulingPlugin + responses: + "200": + description: Success. The plugin test has been executed. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Plugin not enabled. + summary: Test scheduling plugin + description: Executes a test of a scheduling plugin. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/SchedulePluginTestRequest" + tags: + - Processing engine + /api/v3/plugin_test/wal: + post: + operationId: PostTestWALPlugin + responses: + "200": + description: Success. The plugin test has been executed. + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "404": + description: Plugin not enabled. + summary: Test WAL plugin + description: Executes a test of a write-ahead logging (WAL) plugin. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/WALPluginTestRequest" + tags: + - Processing engine + /api/v3/plugins/directory: + put: + operationId: PutPluginDirectory + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/PluginDirectoryRequest" + responses: + "200": + description: Success. The plugin directory has been updated. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Forbidden. Admin token required. + "500": + description: Plugin not found. The `plugin_name` does not match any registered trigger. + summary: Update a multi-file plugin directory + description: | + Replaces all files in a multi-file plugin directory. The + `plugin_name` must match a registered trigger name. Each entry in + the `files` array specifies a `relative_path` and `content`—the + server writes them into the trigger's plugin directory. + + Use this endpoint to update multi-file plugins (directories with + `__init__.py` and supporting modules). For single-file plugins, + use `PUT /api/v3/plugins/files` instead. + tags: + - Processing engine + x-security-note: Requires an admin token + /api/v3/plugins/files: + post: + operationId: create_plugin_file + summary: Create a plugin file + description: | + Creates a single plugin file in the plugin directory. Writes the + `content` to a file named after `plugin_name`. Does not require an + existing trigger—use this to upload plugin files before creating + triggers that reference them. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/PluginFileRequest" + responses: + "200": + description: Success. The plugin file has been created. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Forbidden. Admin token required. + tags: + - Processing engine + x-security-note: Requires an admin token + put: + operationId: PutPluginFile + summary: Update a plugin file + description: | + Updates a single plugin file for an existing trigger. The + `plugin_name` must match a registered trigger name—the server + resolves the trigger's `plugin_filename` and overwrites that file + with the provided `content`. + + To upload a new plugin file before creating a trigger, use + `POST /api/v3/plugins/files` instead. To update a multi-file + plugin directory, use `PUT /api/v3/plugins/directory`. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/PluginFileRequest" + responses: + "200": + description: Success. The plugin file has been updated. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Forbidden. Admin token required. + "500": + description: Plugin not found. The `plugin_name` does not match any registered trigger. + tags: + - Processing engine + x-security-note: Requires an admin token + /api/v3/query_influxql: + get: + operationId: GetExecuteInfluxQLQuery + responses: + "200": + description: Success. The response body contains query results. + content: + application/json: + schema: + $ref: "#/components/schemas/QueryResponse" + text/csv: + schema: + type: string + application/vnd.apache.parquet: + schema: + type: string + application/jsonl: + schema: + type: string + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "404": + description: Database not found. + "405": + description: Method not allowed. + "422": + description: Unprocessable entity. + summary: Execute InfluxQL query + description: Executes an InfluxQL query to retrieve data from the specified database. + parameters: + - $ref: "#/components/parameters/dbQueryParam" + - name: q + in: query + required: true + schema: + type: string + - name: format + in: query + required: false + schema: + type: string + - $ref: "#/components/parameters/AcceptQueryHeader" + - name: params + in: query + required: false + schema: + type: string + description: JSON-encoded query parameters. Use this to pass bind parameters to parameterized queries. + description: JSON-encoded query parameters for parameterized queries. + tags: + - Query data + post: + operationId: PostExecuteQueryInfluxQL + responses: + "200": + description: Success. The response body contains query results. + content: + application/json: + schema: + $ref: "#/components/schemas/QueryResponse" + text/csv: + schema: + type: string + application/vnd.apache.parquet: + schema: + type: string + application/jsonl: + schema: + type: string + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "404": + description: Database not found. + "405": + description: Method not allowed. + "422": + description: Unprocessable entity. + summary: Execute InfluxQL query + description: Executes an InfluxQL query to retrieve data from the specified database. + parameters: + - $ref: "#/components/parameters/AcceptQueryHeader" + - $ref: "#/components/parameters/ContentType" + requestBody: + $ref: "#/components/requestBodies/queryRequestBody" + tags: + - Query data + /api/v3/query_sql: + get: + operationId: GetExecuteQuerySQL + responses: + "200": + description: Success. The response body contains query results. + content: + application/json: + schema: + $ref: "#/components/schemas/QueryResponse" + example: + results: + - series: + - name: mytable + columns: + - time + - value + values: + - - "2024-02-02T12:00:00Z" + - 42 + text/csv: + schema: + type: string + application/vnd.apache.parquet: + schema: + type: string + application/jsonl: + schema: + type: string + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "404": + description: Database not found. + "405": + description: Method not allowed. + "422": + description: Unprocessable entity. + summary: Execute SQL query + description: Executes an SQL query to retrieve data from the specified database. + parameters: + - $ref: "#/components/parameters/db" + - $ref: "#/components/parameters/querySqlParam" + - $ref: "#/components/parameters/format" + - $ref: "#/components/parameters/AcceptQueryHeader" + - $ref: "#/components/parameters/ContentType" + - name: params + in: query + required: false + schema: + type: string + description: JSON-encoded query parameters. Use this to pass bind parameters to parameterized queries. + description: JSON-encoded query parameters for parameterized queries. + tags: + - Query data + post: + operationId: PostExecuteQuerySQL + responses: + "200": + description: Success. The response body contains query results. + content: + application/json: + schema: + $ref: "#/components/schemas/QueryResponse" + text/csv: + schema: + type: string + application/vnd.apache.parquet: + schema: + type: string + application/jsonl: + schema: + type: string + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "404": + description: Database not found. + "405": + description: Method not allowed. + "422": + description: Unprocessable entity. + summary: Execute SQL query + description: Executes an SQL query to retrieve data from the specified database. + parameters: + - $ref: "#/components/parameters/AcceptQueryHeader" + - $ref: "#/components/parameters/ContentType" + requestBody: + $ref: "#/components/requestBodies/queryRequestBody" + tags: + - Query data + /api/v3/write_lp: + post: + operationId: PostWriteLP + parameters: + - $ref: "#/components/parameters/dbWriteParam" + - $ref: "#/components/parameters/accept_partial" + - $ref: "#/components/parameters/precisionParam" + - name: no_sync + in: query + schema: + $ref: "#/components/schemas/NoSync" + - name: Content-Type + in: header + description: | + The content type of the request payload. + schema: + $ref: "#/components/schemas/LineProtocol" + required: false + - name: Accept + in: header + description: | + The content type that the client can understand. + Writes only return a response body if they fail (partially or completely)--for example, + due to a syntax problem or type mismatch. + schema: + type: string + default: application/json + enum: + - application/json + required: false + - $ref: "#/components/parameters/ContentEncoding" + - $ref: "#/components/parameters/ContentLength" + responses: + "204": + description: Success ("No Content"). All data in the batch is written and queryable. + headers: + cluster-uuid: + $ref: "#/components/headers/ClusterUUID" + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "413": + description: Request entity too large. + "422": + description: Unprocessable entity. + summary: Write line protocol + description: > + Writes line protocol to the specified database. + + + This is the native InfluxDB 3 Enterprise write endpoint that provides enhanced control + + over write behavior with advanced parameters for high-performance and fault-tolerant operations. + + + Use this endpoint to send data in [line protocol](/influxdb3/enterprise/reference/syntax/line-protocol/) format + to InfluxDB. + + Use query parameters to specify options for writing data. + + + #### Features + + + - **Partial writes**: Use `accept_partial=true` to allow partial success when some lines in a batch fail + + - **Asynchronous writes**: Use `no_sync=true` to skip waiting for WAL synchronization, allowing faster response + times but sacrificing durability guarantees + + - **Flexible precision**: Automatic timestamp precision detection with `precision=auto` (default) + + + #### Auto precision detection + + + When you use `precision=auto` or omit the precision parameter, InfluxDB 3 automatically detects + + the timestamp precision based on the magnitude of the timestamp value: + + + - Timestamps < 5e9 → Second precision (multiplied by 1,000,000,000 to convert to nanoseconds) + + - Timestamps < 5e12 → Millisecond precision (multiplied by 1,000,000) + + - Timestamps < 5e15 → Microsecond precision (multiplied by 1,000) + + - Larger timestamps → Nanosecond precision (no conversion needed) + + + #### Related + + + - [Use the InfluxDB v3 write_lp API to write data](/influxdb3/enterprise/write-data/http-api/v3-write-lp/) + requestBody: + $ref: "#/components/requestBodies/lineProtocolRequestBody" + tags: + - Write data + x-codeSamples: + - label: cURL - Basic write + lang: Shell + source: | + curl --request POST "http://localhost:8181/api/v3/write_lp?db=sensors" \ + --header "Authorization: Bearer DATABASE_TOKEN" \ + --header "Content-Type: text/plain" \ + --data-raw "cpu,host=server01 usage=85.2 1638360000000000000" + - label: cURL - Write with millisecond precision + lang: Shell + source: | + curl --request POST "http://localhost:8181/api/v3/write_lp?db=sensors&precision=ms" \ + --header "Authorization: Bearer DATABASE_TOKEN" \ + --header "Content-Type: text/plain" \ + --data-raw "cpu,host=server01 usage=85.2 1638360000000" + - label: cURL - Asynchronous write with partial acceptance + lang: Shell + source: > + curl --request POST + "http://localhost:8181/api/v3/write_lp?db=sensors&accept_partial=true&no_sync=true&precision=auto" \ + --header "Authorization: Bearer DATABASE_TOKEN" \ + --header "Content-Type: text/plain" \ + --data-raw "cpu,host=server01 usage=85.2 + memory,host=server01 used=4096" + - label: cURL - Multiple measurements with tags + lang: Shell + source: | + curl --request POST "http://localhost:8181/api/v3/write_lp?db=sensors&precision=ns" \ + --header "Authorization: Bearer DATABASE_TOKEN" \ + --header "Content-Type: text/plain" \ + --data-raw "cpu,host=server01,region=us-west usage=85.2,load=0.75 1638360000000000000 + memory,host=server01,region=us-west used=4096,free=12288 1638360000000000000 + disk,host=server01,region=us-west,device=/dev/sda1 used=50.5,free=49.5 1638360000000000000" + /health: + get: + operationId: GetHealth + responses: + "200": + description: Service is running. Returns `OK`. + content: + text/plain: + schema: + type: string + example: OK + "401": + description: Unauthorized. Authentication is required. + "500": + description: Service is unavailable. + summary: Health check + description: | + Checks the status of the service. + + Returns `OK` if the service is running. This endpoint does not return version information. + Use the [`/ping`](#operation/GetPing) endpoint to retrieve version details. + + > **Note**: This endpoint requires authentication by default in InfluxDB 3 Enterprise. + tags: + - Server information + /metrics: + get: + operationId: GetMetrics + responses: + "200": + description: Success + summary: Metrics + description: Retrieves Prometheus-compatible server metrics. + tags: + - Server information + /ping: + get: + operationId: GetPing + responses: + "200": + description: Success. The response body contains server information. + headers: + x-influxdb-version: + description: The InfluxDB version number (for example, `3.8.0`). + schema: + type: string + example: 3.8.0 + x-influxdb-build: + description: The InfluxDB build type (`Core` or `Enterprise`). + schema: + type: string + example: Enterprise + content: + application/json: + schema: + type: object + properties: + version: + type: string + description: The InfluxDB version number. + example: 3.8.0 + revision: + type: string + description: The git revision hash for the build. + example: 83b589b883 + process_id: + type: string + description: A unique identifier for the server process. + example: b756d9e0-cecd-4f72-b6d0-19e2d4f8cbb7 + "401": + description: Unauthorized. Authentication is required. + "404": + description: | + Not Found. Returned for HEAD requests. + Use a GET request to retrieve version information. + x-client-method: ping + summary: Ping the server + description: | + Returns version information for the server. + + **Important**: Use a GET request. HEAD requests return `404 Not Found`. + + The response includes version information in both headers and the JSON body: + + - **Headers**: `x-influxdb-version` and `x-influxdb-build` + - **Body**: JSON object with `version`, `revision`, and `process_id` + + > **Note**: This endpoint requires authentication by default in InfluxDB 3 Enterprise. + tags: + - Server information + post: + operationId: ping + responses: + "200": + description: Success. The response body contains server information. + headers: + x-influxdb-version: + description: The InfluxDB version number (for example, `3.8.0`). + schema: + type: string + example: 3.8.0 + x-influxdb-build: + description: The InfluxDB build type (`Core` or `Enterprise`). + schema: + type: string + example: Enterprise + content: + application/json: + schema: + type: object + properties: + version: + type: string + description: The InfluxDB version number. + example: 3.8.0 + revision: + type: string + description: The git revision hash for the build. + example: 83b589b883 + process_id: + type: string + description: A unique identifier for the server process. + example: b756d9e0-cecd-4f72-b6d0-19e2d4f8cbb7 + "401": + description: Unauthorized. Authentication is required. + "404": + description: | + Not Found. Returned for HEAD requests. + Use a GET request to retrieve version information. + summary: Ping the server + description: Returns version information for the server. Accepts POST in addition to GET. + tags: + - Server information + /query: + get: + operationId: GetV1ExecuteQuery + responses: + "200": + description: | + Success. The response body contains query results. + content: + application/json: + schema: + $ref: "#/components/schemas/QueryResponse" + application/csv: + schema: + type: string + headers: + Content-Type: + description: > + The content type of the response. + + Default is `application/json`. + + + If the `Accept` request header is `application/csv` or `text/csv`, the `Content-type` response header is + `application/csv` + + and the response is formatted as CSV. + schema: + type: string + default: application/json + enum: + - application/json + - application/csv + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "404": + description: Database not found. + "405": + description: Method not allowed. + "422": + description: Unprocessable entity. + summary: Execute InfluxQL query (v1-compatible) + description: > + Executes an InfluxQL query to retrieve data from the specified database. + + + This endpoint is compatible with InfluxDB 1.x client libraries and third-party integrations such as Grafana. + + Use query parameters to specify the database and the InfluxQL query. + + + #### Related + + + - [Use the InfluxDB v1 HTTP query API and InfluxQL to query + data](/influxdb3/enterprise/query-data/execute-queries/influxdb-v1-api/) + parameters: + - name: Accept + in: header + schema: + type: string + default: application/json + enum: + - application/json + - application/csv + - text/csv + required: false + description: > + The content type that the client can understand. + + + If `text/csv` is specified, the `Content-type` response header is `application/csv` and the response is + formatted as CSV. + + + Returns an error if the format is invalid or non-UTF8. + - in: query + name: chunked + description: | + If true, the response is divided into chunks of size `chunk_size`. + schema: + type: boolean + default: false + - in: query + name: chunk_size + description: | + The number of records that will go into a chunk. + This parameter is only used if `chunked=true`. + schema: + type: integer + default: 10000 + - in: query + name: db + description: The database to query. If not provided, the InfluxQL query string must specify the database. + schema: + type: string + format: InfluxQL + - in: query + name: pretty + description: | + If true, the JSON response is formatted in a human-readable format. + schema: + type: boolean + default: false + - in: query + name: q + description: The InfluxQL query string. + required: true + schema: + type: string + - name: epoch + description: > + Formats timestamps as [unix (epoch) timestamps](/influxdb3/enterprise/reference/glossary/#unix-timestamp) + with the specified precision + + instead of [RFC3339 timestamps](/influxdb3/enterprise/reference/glossary/#rfc3339-timestamp) with nanosecond + precision. + in: query + schema: + $ref: "#/components/schemas/EpochCompatibility" + - $ref: "#/components/parameters/v1UsernameParam" + - $ref: "#/components/parameters/v1PasswordParam" + - name: rp + in: query + required: false + schema: + type: string + description: | + Retention policy name. Honored but discouraged. InfluxDB 3 doesn't use retention policies. + - name: Authorization + in: header + required: false + schema: + type: string + description: | + Authorization header for token-based authentication. + Supported schemes: + - `Bearer AUTH_TOKEN` - OAuth bearer token scheme + - `Token AUTH_TOKEN` - InfluxDB v2 token scheme + - `Basic ` - Basic authentication (username is ignored) + tags: + - Query data + - Compatibility endpoints + post: + operationId: PostExecuteV1Query + responses: + "200": + description: | + Success. The response body contains query results. + content: + application/json: + schema: + $ref: "#/components/schemas/QueryResponse" + application/csv: + schema: + type: string + headers: + Content-Type: + description: > + The content type of the response. + + Default is `application/json`. + + + If the `Accept` request header is `application/csv` or `text/csv`, the `Content-type` response header is + `application/csv` + + and the response is formatted as CSV. + schema: + type: string + default: application/json + enum: + - application/json + - application/csv + "400": + description: Bad request. + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "404": + description: Database not found. + "405": + description: Method not allowed. + "422": + description: Unprocessable entity. + summary: Execute InfluxQL query (v1-compatible) + description: > + Executes an InfluxQL query to retrieve data from the specified database. + + + #### Related + + + - [Use the InfluxDB v1 HTTP query API and InfluxQL to query + data](/influxdb3/enterprise/query-data/execute-queries/influxdb-v1-api/) + parameters: + - name: Accept + in: header + schema: + type: string + default: application/json + enum: + - application/json + - application/csv + - text/csv + required: false + description: > + The content type that the client can understand. + + + If `text/csv` is specified, the `Content-type` response header is `application/csv` and the response is + formatted as CSV. + + + Returns an error if the format is invalid or non-UTF8. + requestBody: + content: + application/json: + schema: + type: object + properties: + db: + type: string + description: The database to query. If not provided, the InfluxQL query string must specify the database. + q: + description: The InfluxQL query string. + type: string + chunked: + description: | + If true, the response is divided into chunks of size `chunk_size`. + type: boolean + chunk_size: + description: | + The number of records that will go into a chunk. + This parameter is only used if `chunked=true`. + type: integer + default: 10000 + epoch: + description: > + A unix timestamp precision. + + + - `h` for hours + + - `m` for minutes + + - `s` for seconds + + - `ms` for milliseconds + + - `u` or `µ` for microseconds + + - `ns` for nanoseconds + + + Formats timestamps as [unix (epoch) + timestamps](/influxdb3/enterprise/reference/glossary/#unix-timestamp) with the specified precision + + instead of [RFC3339 timestamps](/influxdb3/enterprise/reference/glossary/#rfc3339-timestamp) with + nanosecond precision. + enum: + - ns + - u + - µ + - ms + - s + - m + - h + type: string + pretty: + description: | + If true, the JSON response is formatted in a human-readable format. + type: boolean + required: + - q + application/x-www-form-urlencoded: + schema: + type: object + properties: + db: + type: string + description: The database to query. If not provided, the InfluxQL query string must specify the database. + q: + description: The InfluxQL query string. + type: string + chunked: + description: | + If true, the response is divided into chunks of size `chunk_size`. + type: boolean + chunk_size: + description: | + The number of records that will go into a chunk. + This parameter is only used if `chunked=true`. + type: integer + default: 10000 + epoch: + description: > + A unix timestamp precision. + + + - `h` for hours + + - `m` for minutes + + - `s` for seconds + + - `ms` for milliseconds + + - `u` or `µ` for microseconds + + - `ns` for nanoseconds + + + Formats timestamps as [unix (epoch) + timestamps](/influxdb3/enterprise/reference/glossary/#unix-timestamp) with the specified precision + + instead of [RFC3339 timestamps](/influxdb3/enterprise/reference/glossary/#rfc3339-timestamp) with + nanosecond precision. + enum: + - ns + - u + - µ + - ms + - s + - m + - h + type: string + pretty: + description: | + If true, the JSON response is formatted in a human-readable format. + type: boolean + required: + - q + application/vnd.influxql: + schema: + type: string + description: InfluxQL query string sent as the request body. + tags: + - Query data + - Compatibility endpoints + /write: + post: + operationId: PostV1Write + responses: + "204": + description: Success ("No Content"). All data in the batch is written and queryable. + headers: + cluster-uuid: + $ref: "#/components/headers/ClusterUUID" + "400": + description: | + Bad request. Some (a _partial write_) or all of the data from the batch was rejected and not written. + If a partial write occurred, then some points from the batch are written and queryable. + + The response body: + - indicates if a partial write occurred or all data was rejected. + - contains details about the [rejected points](/influxdb3/enterprise/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. + content: + application/json: + examples: + rejectedAllPoints: + summary: Rejected all points in the batch + value: | + { + "error": "write of line protocol failed", + "data": [ + { + "original_line": "dquote> home,room=Kitchen temp=hi", + "line_number": 2, + "error_message": "No fields were provided" + } + ] + } + partialWriteErrorWithRejectedPoints: + summary: Partial write rejected some points in the batch + value: | + { + "error": "partial write of line protocol occurred", + "data": [ + { + "original_line": "dquote> home,room=Kitchen temp=hi", + "line_number": 2, + "error_message": "No fields were provided" + } + ] + } + "401": + $ref: "#/components/responses/Unauthorized" + "403": + description: Access denied. + "413": + description: Request entity too large. + summary: Write line protocol (v1-compatible) + description: > + Writes line protocol to the specified database. + + + This endpoint provides backward compatibility for InfluxDB 1.x write workloads using tools such as InfluxDB 1.x + client libraries, the Telegraf `outputs.influxdb` output plugin, or third-party tools. + + + Use this endpoint to send data in [line + protocol](https://docs.influxdata.com/influxdb3/enterprise/reference/syntax/line-protocol/) format to InfluxDB. + + Use query parameters to specify options for writing data. + + + #### Related + + + - [Use compatibility APIs to write data](/influxdb3/enterprise/write-data/http-api/compatibility-apis/) + parameters: + - $ref: "#/components/parameters/dbWriteParam" + - $ref: "#/components/parameters/compatibilityPrecisionParam" + - $ref: "#/components/parameters/v1UsernameParam" + - $ref: "#/components/parameters/v1PasswordParam" + - name: rp + in: query + required: false + schema: + type: string + description: | + Retention policy name. Honored but discouraged. InfluxDB 3 doesn't use retention policies. + - name: consistency + in: query + required: false + schema: + type: string + description: | + Write consistency level. Ignored by InfluxDB 3. Provided for compatibility with InfluxDB 1.x clients. + - name: Authorization + in: header + required: false + schema: + type: string + description: | + Authorization header for token-based authentication. + Supported schemes: + - `Bearer AUTH_TOKEN` - OAuth bearer token scheme + - `Token AUTH_TOKEN` - InfluxDB v2 token scheme + - `Basic ` - Basic authentication (username is ignored) + - name: Content-Type + in: header + description: | + The content type of the request payload. + schema: + $ref: "#/components/schemas/LineProtocol" + required: false + - name: Accept + in: header + description: | + The content type that the client can understand. + Writes only return a response body if they fail (partially or completely)--for example, + due to a syntax problem or type mismatch. + schema: + type: string + default: application/json + enum: + - application/json + required: false + - $ref: "#/components/parameters/ContentEncoding" + - $ref: "#/components/parameters/ContentLength" + requestBody: + $ref: "#/components/requestBodies/lineProtocolRequestBody" + tags: + - Compatibility endpoints + - Write data +components: + parameters: + AcceptQueryHeader: + name: Accept + in: header + schema: + type: string + default: application/json + enum: + - application/json + - application/jsonl + - application/vnd.apache.parquet + - text/csv + required: false + description: | + The content type that the client can understand. + ContentEncoding: + name: Content-Encoding + in: header + description: | + The compression applied to the line protocol in the request payload. + To send a gzip payload, pass `Content-Encoding: gzip` header. + schema: + $ref: "#/components/schemas/ContentEncoding" + required: false + ContentLength: + name: Content-Length + in: header + description: | + The size of the entity-body, in bytes, sent to InfluxDB. + schema: + $ref: "#/components/schemas/ContentLength" + ContentType: + name: Content-Type + description: | + The format of the data in the request body. + in: header + schema: + type: string + enum: + - application/json + required: false + db: + name: db + in: query + required: true + schema: + type: string + description: | + The name of the database. + dbWriteParam: + name: db + in: query + required: true + schema: + type: string + description: | + The name of the database. + InfluxDB creates the database if it doesn't already exist, and then + writes all points in the batch to the database. + dbQueryParam: + name: db + in: query + required: false + schema: + type: string + description: | + The name of the database. + + If you provide a query that specifies the database, you can omit the 'db' parameter from your request. + accept_partial: + name: accept_partial + in: query + required: false + schema: + $ref: "#/components/schemas/AcceptPartial" + compatibilityPrecisionParam: + name: precision + in: query + required: false + schema: + $ref: "#/components/schemas/PrecisionWriteCompatibility" + description: The precision for unix timestamps in the line protocol batch. + precisionParam: + name: precision + in: query + required: false + schema: + $ref: "#/components/schemas/PrecisionWrite" + description: The precision for unix timestamps in the line protocol batch. + querySqlParam: + name: q + in: query + required: true + schema: + type: string + format: SQL + description: | + The query to execute. + format: + name: format + in: query + required: false + schema: + $ref: "#/components/schemas/Format" + formatRequired: + name: format + in: query + required: true + schema: + $ref: "#/components/schemas/Format" + v1UsernameParam: + name: u + in: query + required: false + schema: + type: string + description: > + Username for v1 compatibility authentication. + + When using Basic authentication or query string authentication, InfluxDB 3 ignores this parameter but allows any + arbitrary string for compatibility with InfluxDB 1.x clients. + v1PasswordParam: + name: p + in: query + required: false + schema: + type: string + description: | + Password for v1 compatibility authentication. + For query string authentication, pass a database token with write permissions as this parameter. + InfluxDB 3 checks that the `p` value is an authorized token. + requestBodies: + lineProtocolRequestBody: + required: true + content: + text/plain: + schema: + type: string + examples: + line: + summary: Example line protocol + value: measurement,tag=value field=1 1234567890 + multiline: + summary: Example line protocol with UTF-8 characters + value: | + measurement,tag=value field=1 1234567890 + measurement,tag=value field=2 1234567900 + measurement,tag=value field=3 1234568000 + queryRequestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/QueryRequestObject" + schemas: + AdminTokenObject: + type: object + properties: + id: + type: integer + name: + type: string + token: + type: string + hash: + type: string + created_at: + type: string + format: date-time + expiry: + format: date-time + example: + id: 0 + name: _admin + token: apiv3_00xx0Xx0xx00XX0x0 + hash: 00xx0Xx0xx00XX0x0 + created_at: "2025-04-18T14:02:45.331Z" + expiry: null + ResourceTokenObject: + type: object + properties: + token_name: + type: string + permissions: + type: array + items: + type: object + properties: + resource_type: + type: string + enum: + - system + - db + actions: + type: array + items: + type: string + enum: + - read + - write + resource_names: + type: array + items: + type: string + description: List of resource names. Use "*" for all resources. + expiry_secs: + type: integer + description: The expiration time in seconds. + example: + token_name: All system information + permissions: + - resource_type: system + actions: + - read + resource_names: + - "*" + expiry_secs: 300000 + ContentEncoding: + type: string + enum: + - gzip + - identity + description: > + Content coding. + + Use `gzip` for compressed data or `identity` for unmodified, uncompressed data. + + + #### Multi-member gzip support + + + InfluxDB 3 supports multi-member gzip payloads (concatenated gzip files per [RFC + 1952](https://www.rfc-editor.org/rfc/rfc1952)). + + This allows you to: + + - Concatenate multiple gzip files and send them in a single request + + - Maintain compatibility with InfluxDB v1 and v2 write endpoints + + - Simplify batch operations using standard compression tools + default: identity + LineProtocol: + type: string + enum: + - text/plain + - text/plain; charset=utf-8 + description: | + `text/plain` is the content type for line protocol. `UTF-8` is the default character set. + default: text/plain; charset=utf-8 + ContentLength: + type: integer + description: The length in decimal number of octets. + Database: + type: string + AcceptPartial: + type: boolean + default: true + description: Accept partial writes. + Format: + type: string + enum: + - json + - csv + - parquet + - json_lines + - jsonl + - pretty + description: |- + The format of data in the response body. + `json_lines` is the canonical name; `jsonl` is accepted as an alias. + NoSync: + type: boolean + default: false + description: | + Acknowledges a successful write without waiting for WAL persistence. + + #### Related + + - [Use the HTTP API and client libraries to write data](/influxdb3/enterprise/write-data/api-client-libraries/) + - [Data durability](/influxdb3/enterprise/reference/internals/durability/) + PrecisionWriteCompatibility: + enum: + - ms + - s + - us + - u + - ns + - "n" + type: string + description: |- + The precision for unix timestamps in the line protocol batch. + Use `ms` for milliseconds, `s` for seconds, `us` or `u` for microseconds, or `ns` or `n` for nanoseconds. + Optional — defaults to nanosecond precision if omitted. + PrecisionWrite: + enum: + - auto + - nanosecond + - microsecond + - millisecond + - second + type: string + description: | + The precision for unix timestamps in the line protocol batch. + + Supported values: + - `auto` (default): Automatically detects precision based on timestamp magnitude + - `nanosecond`: Nanoseconds + - `microsecond`: Microseconds + - `millisecond`: Milliseconds + - `second`: Seconds + QueryRequestObject: + type: object + properties: + db: + description: | + The name of the database to query. + Required if the query (`q`) doesn't specify the database. + type: string + q: + description: The query to execute. + type: string + format: + description: The format of the query results. + type: string + enum: + - json + - csv + - parquet + - json_lines + - jsonl + - pretty + params: + description: | + Additional parameters for the query. + Use this field to pass query parameters. + type: object + additionalProperties: true + required: + - db + - q + example: + db: mydb + q: SELECT * FROM mytable + format: json + params: {} + CreateDatabaseRequest: + type: object + properties: + db: + type: string + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$|^[a-zA-Z0-9]$ + description: |- + The database name. Database names cannot contain underscores (_). + Names must start and end with alphanumeric characters and can contain hyphens (-) in the middle. + retention_period: + type: string + description: |- + The retention period for the database. Specifies how long data should be retained. + Use duration format (for example, "1d", "1h", "30m", "7d"). + example: 7d + required: + - db + CreateTableRequest: + type: object + properties: + db: + type: string + table: + type: string + tags: + type: array + items: + type: string + fields: + type: array + items: + type: object + properties: + name: + type: string + type: + type: string + enum: + - utf8 + - int64 + - uint64 + - float64 + - bool + required: + - name + - type + retention_period: + type: string + description: |- + The retention period for the table. Specifies how long data in this table should be retained. + Use duration format (for example, "1d", "1h", "30m", "7d"). + example: 30d + required: + - db + - table + - tags + - fields + DistinctCacheCreateRequest: + type: object + properties: + db: + type: string + table: + type: string + node_spec: + $ref: "#/components/schemas/ApiNodeSpec" + name: + type: string + description: Optional cache name. + columns: + type: array + items: + type: string + max_cardinality: + type: integer + description: Optional maximum cardinality. + max_age: + type: integer + description: Optional maximum age in seconds. + required: + - db + - table + - columns + example: + db: mydb + table: mytable + columns: + - tag1 + - tag2 + max_cardinality: 1000 + max_age: 3600 + LastCacheCreateRequest: + type: object + properties: + db: + type: string + table: + type: string + node_spec: + $ref: "#/components/schemas/ApiNodeSpec" + name: + type: string + description: Optional cache name. + key_columns: + type: array + items: + type: string + description: Optional list of key columns. + value_columns: + type: array + items: + type: string + description: Optional list of value columns. + count: + type: integer + description: Optional count. + ttl: + type: integer + description: Optional time-to-live in seconds. + required: + - db + - table + example: + db: mydb + table: mytable + key_columns: + - tag1 + value_columns: + - field1 + count: 100 + ttl: 3600 + ProcessingEngineTriggerRequest: + type: object + properties: + db: + type: string + plugin_filename: + type: string + description: | + The path and filename of the plugin to execute--for example, + `schedule.py` or `endpoints/report.py`. + The path can be absolute or relative to the `--plugins-dir` directory configured when starting InfluxDB 3. + + The plugin file must implement the trigger interface associated with the trigger's specification. + node_spec: + $ref: "#/components/schemas/ApiNodeSpec" + trigger_name: + type: string + trigger_settings: + description: | + Configuration for trigger error handling and execution behavior. + allOf: + - $ref: "#/components/schemas/TriggerSettings" + trigger_specification: + description: > + Specifies when and how the processing engine trigger should be invoked. + + + ## Supported trigger specifications: + + + ### Cron-based scheduling + + Format: `cron:CRON_EXPRESSION` + + + Uses extended (6-field) cron format (second minute hour day_of_month month day_of_week): + + ``` + + ┌───────────── second (0-59) + + │ ┌───────────── minute (0-59) + + │ │ ┌───────────── hour (0-23) + + │ │ │ ┌───────────── day of month (1-31) + + │ │ │ │ ┌───────────── month (1-12) + + │ │ │ │ │ ┌───────────── day of week (0-6, Sunday=0) + + │ │ │ │ │ │ + + * * * * * * + + ``` + + Examples: + + - `cron:0 0 6 * * 1-5` - Every weekday at 6:00 AM + + - `cron:0 30 14 * * 5` - Every Friday at 2:30 PM + + - `cron:0 0 0 1 * *` - First day of every month at midnight + + + ### Interval-based scheduling + + Format: `every:DURATION` + + + Supported durations: `s` (seconds), `m` (minutes), `h` (hours), `d` (days), `w` (weeks), `M` (months), `y` + (years): + + - `every:30s` - Every 30 seconds + + - `every:5m` - Every 5 minutes + + - `every:1h` - Every hour + + - `every:1d` - Every day + + - `every:1w` - Every week + + - `every:1M` - Every month + + - `every:1y` - Every year + + + **Maximum interval**: 1 year + + + ### Table-based triggers + + - `all_tables` - Triggers on write events to any table in the database + + - `table:TABLE_NAME` - Triggers on write events to a specific table + + + ### On-demand triggers + + Format: `request:REQUEST_PATH` + + + Creates an HTTP endpoint `/api/v3/engine/REQUEST_PATH` for manual invocation: + + - `request:hello-world` - Creates endpoint `/api/v3/engine/hello-world` + + - `request:data-export` - Creates endpoint `/api/v3/engine/data-export` + pattern: ^(cron:[0-9 *,/-]+|every:[0-9]+[smhd]|all_tables|table:[a-zA-Z_][a-zA-Z0-9_]*|request:[a-zA-Z0-9_-]+)$ + example: cron:0 0 6 * * 1-5 + trigger_arguments: + type: object + additionalProperties: true + description: Optional arguments passed to the plugin. + disabled: + type: boolean + default: false + description: Whether the trigger is disabled. + required: + - db + - plugin_filename + - trigger_name + - trigger_settings + - trigger_specification + - disabled + TriggerSettings: + type: object + description: | + Configuration settings for processing engine trigger error handling and execution behavior. + properties: + run_async: + type: boolean + default: false + description: | + Whether to run the trigger asynchronously. + When `true`, the trigger executes in the background without blocking. + When `false`, the trigger executes synchronously. + error_behavior: + type: string + enum: + - Log + - Retry + - Disable + description: | + Specifies how to handle errors that occur during trigger execution: + - `Log`: Log the error and continue (default) + - `Retry`: Retry the trigger execution + - `Disable`: Disable the trigger after an error + default: Log + required: + - run_async + - error_behavior + ApiNodeSpec: + x-enterprise-only: true + type: object + description: | + Optional specification for targeting specific nodes in a multi-node InfluxDB 3 Enterprise cluster. + Use this to control which node(s) should handle the cache or trigger. + properties: + node_id: + type: string + description: | + The ID of a specific node in the cluster. + If specified, the cache or trigger will only be created on this node. + node_group: + type: string + description: | + The name of a node group in the cluster. + If specified, the cache or trigger will be created on all nodes in this group. + WALPluginTestRequest: + type: object + description: | + Request body for testing a write-ahead logging (WAL) plugin. + properties: + filename: + type: string + description: | + The path and filename of the plugin to test. + database: + type: string + description: | + The database name to use for the test. + input_lp: + type: string + description: | + Line protocol data to use as input for the test. + cache_name: + type: string + description: | + Optional name of the cache to use in the test. + input_arguments: + type: object + additionalProperties: + type: string + description: | + Optional key-value pairs of arguments to pass to the plugin. + required: + - filename + - database + - input_lp + SchedulePluginTestRequest: + type: object + description: | + Request body for testing a scheduling plugin. + properties: + filename: + type: string + description: | + The path and filename of the plugin to test. + database: + type: string + description: | + The database name to use for the test. + schedule: + type: string + description: | + Optional schedule specification in cron or interval format. + cache_name: + type: string + description: | + Optional name of the cache to use in the test. + input_arguments: + type: object + additionalProperties: + type: string + description: | + Optional key-value pairs of arguments to pass to the plugin. + required: + - filename + - database + PluginFileRequest: + type: object + description: | + Request body for updating a plugin file. + properties: + plugin_name: + type: string + description: | + The name of the plugin file to update. + content: + type: string + description: | + The content of the plugin file. + required: + - plugin_name + - content + PluginDirectoryRequest: + type: object + description: | + Request body for updating plugin directory with multiple files. + properties: + plugin_name: + type: string + description: | + The name of the plugin directory to update. + files: + type: array + items: + $ref: "#/components/schemas/PluginFileEntry" + description: | + List of plugin files to include in the directory. + required: + - plugin_name + - files + PluginFileEntry: + type: object + description: | + Represents a single file in a plugin directory. + properties: + content: + type: string + description: | + The content of the file. + relative_path: + type: string + description: The relative path of the file within the plugin directory. + required: + - relative_path + - content + ShowDatabasesResponse: + type: object + properties: + databases: + type: array + items: + type: string + QueryResponse: + type: object + properties: + results: + type: array + items: + type: object + example: + results: + - series: + - name: mytable + columns: + - time + - value + values: + - - "2024-02-02T12:00:00Z" + - 42 + ErrorMessage: + type: object + properties: + error: + type: string + data: + type: object + nullable: true + LineProtocolError: + properties: + code: + description: Code is the machine-readable error code. + enum: + - internal error + - not found + - conflict + - invalid + - empty value + - unavailable + readOnly: true + type: string + err: + description: Stack of errors that occurred during processing of the request. Useful for debugging. + readOnly: true + type: string + line: + description: First line in the request body that contains malformed data. + format: int32 + readOnly: true + type: integer + message: + description: Human-readable message. + readOnly: true + type: string + op: + description: Describes the logical code operation when the error occurred. Useful for debugging. + readOnly: true + type: string + required: + - code + EpochCompatibility: + description: | + A unix timestamp precision. + - `h` for hours + - `m` for minutes + - `s` for seconds + - `ms` for milliseconds + - `u` or `µ` for microseconds + - `ns` for nanoseconds + enum: + - ns + - u + - µ + - ms + - s + - m + - h + type: string + UpdateDatabaseRequest: + type: object + properties: + retention_period: + type: string + description: | + The retention period for the database. Specifies how long data should be retained. + Use duration format (for example, "1d", "1h", "30m", "7d"). + example: 7d + description: Request schema for updating database configuration. + UpdateTableRequest: + type: object + properties: + db: + type: string + description: The name of the database containing the table. + table: + type: string + description: The name of the table to update. + retention_period: + type: string + description: | + The retention period for the table. Specifies how long data in this table should be retained. + Use duration format (for example, "1d", "1h", "30m", "7d"). + example: 30d + required: + - db + - table + description: Request schema for updating table configuration. + LicenseResponse: + type: object + properties: + license_type: + type: string + description: The type of license (for example, "enterprise", "trial"). + example: enterprise + expires_at: + type: string + format: date-time + description: The expiration date of the license in ISO 8601 format. + example: "2025-12-31T23:59:59Z" + features: + type: array + items: + type: string + description: List of features enabled by the license. + example: + - clustering + - processing_engine + - advanced_auth + status: + type: string + enum: + - active + - expired + - invalid + description: The current status of the license. + example: active + description: Response schema for license information. + CreateTokenWithPermissionsRequest: + type: object + properties: + token_name: + type: string + description: The name for the resource token. + permissions: + type: array + items: + $ref: "#/components/schemas/PermissionDetailsApi" + description: List of permissions to grant to the token. + expiry_secs: + type: integer + description: Optional expiration time in seconds. + nullable: true + required: + - token_name + - permissions + PermissionDetailsApi: + type: object + properties: + resource_type: + type: string + enum: + - system + - db + description: The type of resource. + resource_names: + type: array + items: + type: string + description: List of resource names. Use "*" for all resources. + actions: + type: array + items: + type: string + enum: + - read + - write + description: List of actions to grant. + required: + - resource_type + - resource_names + - actions + FileIndexCreateRequest: + type: object + description: Request body for creating a file index. + properties: + db: + type: string + description: The database name. + table: + type: string + description: The table name. If omitted, the file index applies to the database. + nullable: true + columns: + type: array + items: + type: string + description: The columns to use for the file index. + required: + - db + - columns + example: + db: mydb + table: mytable + columns: + - tag1 + - tag2 + FileIndexDeleteRequest: + type: object + description: Request body for deleting a file index. + properties: + db: + type: string + description: The database name. + table: + type: string + description: The table name. If omitted, deletes the database-level file index. + nullable: true + required: + - db + example: + db: mydb + table: mytable + StopNodeRequest: + type: object + description: Request body for marking a node as stopped in the catalog. + properties: + node_id: + type: string + description: The ID of the node to mark as stopped. + required: + - node_id + example: + node_id: node-1 + responses: + Unauthorized: + description: Unauthorized access. + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorMessage" + BadRequest: + description: | + Request failed. Possible reasons: + + - Invalid database name + - Malformed request body + - Invalid timestamp precision + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorMessage" + Forbidden: + description: Access denied. + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorMessage" + NotFound: + description: Resource not found. + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorMessage" + headers: + ClusterUUID: + description: | + The catalog UUID of the InfluxDB instance. + This header is included in all HTTP API responses and enables you to: + - Identify which cluster instance handled the request + - Monitor deployments across multiple InfluxDB instances + - Debug and troubleshoot distributed systems + schema: + type: string + format: uuid + example: 01234567-89ab-cdef-0123-456789abcdef + securitySchemes: + BasicAuthentication: + type: http + scheme: basic + description: >- + Use the `Authorization` header with the `Basic` scheme to authenticate v1 API requests. + + + Works with v1 compatibility [`/write`](#operation/PostV1Write) and [`/query`](#operation/GetV1Query) endpoints + in InfluxDB 3. + + + When authenticating requests, InfluxDB 3 checks that the `password` part of the decoded credential is an + authorized token + + and ignores the `username` part of the decoded credential. + + + ### Syntax + + + ```http + + Authorization: Basic + + ``` + + + ### Example + + + ```bash + + curl "http://localhost:8181/write?db=DATABASE_NAME&precision=s" \ + --user "":"AUTH_TOKEN" \ + --header "Content-type: text/plain; charset=utf-8" \ + --data-binary 'home,room=kitchen temp=72 1641024000' + ``` + + + Replace the following: + + + - **`DATABASE_NAME`**: your InfluxDB 3 Enterprise database + + - **`AUTH_TOKEN`**: an admin token or database token authorized for the database + QuerystringAuthentication: + type: apiKey + in: query + name: u=&p= + description: >- + Use InfluxDB 1.x API parameters to provide credentials through the query string for v1 API requests. + + + Querystring authentication works with v1-compatible [`/write`](#operation/PostV1Write) and + [`/query`](#operation/GetV1Query) endpoints. + + + When authenticating requests, InfluxDB 3 checks that the `p` (_password_) query parameter is an authorized token + + and ignores the `u` (_username_) query parameter. + + + ### Syntax + + + ```http + + https://localhost:8181/query/?[u=any]&p=AUTH_TOKEN + + https://localhost:8181/write/?[u=any]&p=AUTH_TOKEN + + ``` + + + ### Examples + + + ```bash + + curl "http://localhost:8181/write?db=DATABASE_NAME&precision=s&p=AUTH_TOKEN" \ + --header "Content-type: text/plain; charset=utf-8" \ + --data-binary 'home,room=kitchen temp=72 1641024000' + ``` + + + Replace the following: + + + - **`DATABASE_NAME`**: your InfluxDB 3 Enterprise database + + - **`AUTH_TOKEN`**: an admin token or database token authorized for the database + + + ```bash + + ####################################### + + # Use an InfluxDB 1.x compatible username and password + + # to query the InfluxDB v1 HTTP API + + ####################################### + + # Use authentication query parameters: + + # ?p=AUTH_TOKEN + + ####################################### + + + curl --get "http://localhost:8181/query" \ + --data-urlencode "p=AUTH_TOKEN" \ + --data-urlencode "db=DATABASE_NAME" \ + --data-urlencode "q=SELECT * FROM MEASUREMENT" + ``` + + + Replace the following: + + + - **`DATABASE_NAME`**: the database to query + + - **`AUTH_TOKEN`**: a database token with sufficient permissions to the database + BearerAuthentication: + type: http + scheme: bearer + bearerFormat: JWT + description: | + + Use the OAuth Bearer authentication + scheme to provide an authorization token to InfluxDB 3. + + Bearer authentication works with all endpoints. + + In your API requests, send an `Authorization` header. + For the header value, provide the word `Bearer` followed by a space and a database token. + + ### Syntax + + ```http + Authorization: Bearer AUTH_TOKEN + ``` + + ### Example + + ```bash + curl http://localhost:8181/api/v3/query_influxql \ + --header "Authorization: Bearer AUTH_TOKEN" + ``` + TokenAuthentication: + description: |- + Use InfluxDB v2 Token authentication to provide an authorization token to InfluxDB 3. + + The v2 Token scheme works with v1 and v2 compatibility endpoints in InfluxDB 3. + + In your API requests, send an `Authorization` header. + For the header value, provide the word `Token` followed by a space and a database token. + The word `Token` is case-sensitive. + + ### Syntax + + ```http + Authorization: Token AUTH_TOKEN + ``` + + ### Example + + ```sh + ######################################################## + # Use the Token authentication scheme with /api/v2/write + # to write data. + ######################################################## + + curl --request post "http://localhost:8181/api/v2/write?bucket=DATABASE_NAME&precision=s" \ + --header "Authorization: Token AUTH_TOKEN" \ + --data-binary 'home,room=kitchen temp=72 1463683075' + ``` + in: header + name: Authorization + type: apiKey +x-tagGroups: + - name: Using the InfluxDB HTTP API + tags: + - Quick start + - Authentication + - Cache data + - Common parameters + - Response codes + - Compatibility endpoints + - Database + - Processing engine + - Server information + - Table + - Token + - Query data + - Write data From b951d3c27afecdb549b261826fb4c65162b9e58d Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Mon, 9 Mar 2026 20:22:31 -0500 Subject: [PATCH 05/27] feat(ci): add doc review pipeline with auto-labeling and Copilot review (#6890) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * feat: add doc review pipeline implementation plan Detailed plan for two interconnected systems: 1. Label system overhaul (22 automation-driven labels replacing 30+ inconsistent ones) 2. Doc review workflow (Claude visual review + Copilot structural review with screenshots) This is a plan document only — no implementation changes. https://claude.ai/code/session_01D5rLaHdQv9iBL55UEsdQFt * fix: split product:v3 into v3-monolith and v3-distributed labels - product:v3-monolith: Core, Enterprise (single-node / clusterable) - product:v3-distributed: Cloud Serverless, Cloud Dedicated, Clustered - Updated auto-label path mappings to match content directory structure - Updated migration mapping and label count (22 → 23) https://claude.ai/code/session_01D5rLaHdQv9iBL55UEsdQFt * feat: define agent instruction file architecture in Phase 3 - One CLAUDE.md (pointer) → role-specific files in .claude/agents/ - doc-triage-agent.md: label taxonomy, path mapping, priority rules - doc-review-agent.md: review scope, severity classification, output format - Prompt file (.github/prompts/) references agent file, stays workflow-specific - Updated file summary and implementation order https://claude.ai/code/session_01D5rLaHdQv9iBL55UEsdQFt * feat: move visual/screenshot review from Claude to Copilot Claude now handles diff-only Markdown review (frontmatter, shortcodes, style, terminology). Copilot handles visual review by analyzing screenshots posted as images in PR comments. Key changes: - Job 3 (Claude) runs in parallel with Jobs 1→2→4 (diff-only, no screenshots) - Job 4 (Copilot) analyzes screenshots via @copilot PR comment mentions - Two prompt files: doc-review.md (Claude), copilot-visual-review.md (Copilot) - doc-review-agent.md scoped to diff-only (no screenshot analysis) - Q1 resolved: screenshots delivered to Copilot via PR comment images - Reduced Claude API cost (no image processing) - Added Copilot failure handling (fallback to human review of artifacts) https://claude.ai/code/session_01D5rLaHdQv9iBL55UEsdQFt * chore: resolve all open questions in doc review pipeline plan Convert Q2–Q5 from open recommendations to resolved decisions: - Q2: Advisory only (no required status checks) until false-positive rate confirmed - Q3: Playwright for CI screenshots, Puppeteer for local debugging - Q4: Poll preview URL with 15s interval and 10-min timeout - Q5: Cost acceptable with existing mitigations (path filters, skip-review, concurrency) Rename section from "Open Questions" to "Decisions (Resolved)". https://claude.ai/code/session_01D5rLaHdQv9iBL55UEsdQFt * Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Fix label naming inconsistency and document workflow migration requirements (#6893) * Initial plan * fix: resolve label naming inconsistency and document workflow updates - Rename review:approved to approval:codeowner to avoid confusion with review/* labels - Add note explaining the distinct prefix to prevent implementor confusion - Document required workflow updates for sync-plugin-docs label migration - Specify exact files and line numbers that need updating Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> * feat(ci): add doc review pipeline and deduplicate instruction files Add Phase 2-3 pipeline components: doc-review workflow (3-job architecture), Claude/Copilot review prompts, URL resolver script, triage and review agents, and label guide. Deduplicate AGENTS.md (254→96 lines) by removing content available in referenced docs. Remove duplicate sections from copilot-instructions.md (264→221 lines). AGENTS.md now contains only high-signal guidelines loaded every session: commands, constraints, style rules, product paths, and reference pointers. * task: updated PR pipeline plan * task: remove old cli plan * task: products file now contains content path mappings and (GitHub) label groups for each product. Product group labels will be used to assign reviewers and help with content checks. * feat(ci): add auto-label workflow for PR product detection Add auto-label workflow that applies product and source labels to PRs based on changed file paths, using data/products.yml as the source of truth. Add workflow-utils.js shared helper for product path matching. * refactor(ci): extract shared label and review format definitions Consolidate duplicated label definitions and review comment format into shared source-of-truth files to prevent context drift. New files: - data/labels.yml: source, waiting, workflow, review, and product:shared label definitions (names, colors, descriptions) - .github/templates/review-comment.md: severity levels, comment structure, result rules, and result-to-label mapping Updated consumers to reference shared files instead of inline copies: - .claude/agents/doc-review-agent.md - .claude/agents/doc-triage-agent.md - .github/prompts/copilot-visual-review.md - .github/LABEL_GUIDE.md Workflow fixes: - Pin all GitHub Actions to SHA hashes - Fix fromJson() for url-count comparison in doc-review.yml - Fix fallback handler to remove all review:* labels before re-adding * refactor(ci): replace Claude review with Copilot native code review - Remove claude-code-action job, use `copilot-reviews` reviewer instead - Extract review criteria to .github/instructions/content-review.instructions.md - Simplify copilot-instructions.md by removing duplicated content - Harden auto-label workflow (scoped permissions, pagination, concurrency) - Upsert visual review comments instead of creating duplicates - Delete unused .github/prompts/doc-review.md * Update .github/workflows/doc-review.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update .github/DOC-REVIEW-PIPELINE-PLAN.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * task: update review pipeline plan * task: add label-migration scripts. These are one-use scripts that we'll remove after the label migration * Update .github/workflows/doc-review.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update .github/workflows/doc-review.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update .github/workflows/auto-label.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * style: remove unnecessary escape in regex character class * feat(ci): add workflow_dispatch to auto-label and doc-review workflows - Add workflow_dispatch with pr_number input to both workflows for manual testing and on-demand re-runs - Migrate sync-plugin-docs label references to source:sync - Add area:agents, area:ci, area:links, release:*, good-first-issue, source:feedback, waiting:pr to labels.yml - Update products.yml: influxdb_cloud label_group v2 -> v2-cloud - Track label renames and deletions in LABEL_GUIDE.md * fix(ci): replace npm ci with targeted js-yaml install in auto-label npm ci fails in sparse checkout because package-lock.json is not included. The workflow only needs js-yaml for YAML parsing. * fix(ci): add --legacy-peer-deps to auto-label npm install * task: updated labels for migration * docs: update pipeline plan with test results and completion status * test: reapply reverted serve.md changes for e2e pipeline test Reverse the revert from 2f8efd6 to provide content changes that exercise the auto-label and doc-review workflows end-to-end. * fix(ci): fix preview URL polling in doc-review visual review curl --head outputs response headers before the status code from -w, so STATUS contained "HTTP/2 200 ...200" instead of just "200". Drop --head and add -o /dev/null to capture only the status code. * fix: correct broken fragment links in InfluxDB 3 serve.md files (#6910) * Initial plan * fix: correct broken links in serve.md files for enterprise config-options Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> * Update content/influxdb3/enterprise/reference/cli/influxdb3/serve.md --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> Co-authored-by: Jason Stirnaman --------- Co-authored-by: Claude Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> --- .claude/agents/doc-review-agent.md | 82 ++ .claude/agents/doc-triage-agent.md | 72 ++ .claude/settings.json | 93 +-- .github/DOC-REVIEW-PIPELINE-PLAN.md | 704 ++++++++++++++++++ .github/ISSUE_TEMPLATE/sync-plugin-docs.yml | 2 +- .github/LABEL_GUIDE.md | 100 +++ .github/copilot-instructions.md | 258 +------ .../content-review.instructions.md | 76 ++ .github/prompts/copilot-visual-review.md | 34 + .github/scripts/resolve-review-urls.js | 38 + .github/scripts/workflow-utils.js | 104 +++ .github/templates/review-comment.md | 98 +++ .github/workflows/auto-label.yml | 122 +++ .github/workflows/doc-review.yml | 264 +++++++ .github/workflows/sync-plugins.yml | 6 +- AGENTS.md | 279 ++----- CLAUDE.md | 3 +- .../core/reference/cli/influxdb3/serve.md | 20 +- .../reference/cli/influxdb3/serve.md | 23 +- data/labels.yml | 86 +++ data/products.yml | 30 + .../2025-01-10-docs-cli-workflow-design.md | 134 ---- helper-scripts/label-migration/README.md | 95 +++ .../label-migration/create-labels.sh | 97 +++ .../label-migration/delete-labels.sh | 137 ++++ .../label-migration/migrate-labels.sh | 104 +++ 26 files changed, 2416 insertions(+), 645 deletions(-) create mode 100644 .claude/agents/doc-review-agent.md create mode 100644 .claude/agents/doc-triage-agent.md create mode 100644 .github/DOC-REVIEW-PIPELINE-PLAN.md create mode 100644 .github/LABEL_GUIDE.md create mode 100644 .github/instructions/content-review.instructions.md create mode 100644 .github/prompts/copilot-visual-review.md create mode 100644 .github/scripts/resolve-review-urls.js create mode 100644 .github/scripts/workflow-utils.js create mode 100644 .github/templates/review-comment.md create mode 100644 .github/workflows/auto-label.yml create mode 100644 .github/workflows/doc-review.yml create mode 100644 data/labels.yml delete mode 100644 docs/plans/2025-01-10-docs-cli-workflow-design.md create mode 100644 helper-scripts/label-migration/README.md create mode 100755 helper-scripts/label-migration/create-labels.sh create mode 100755 helper-scripts/label-migration/delete-labels.sh create mode 100755 helper-scripts/label-migration/migrate-labels.sh diff --git a/.claude/agents/doc-review-agent.md b/.claude/agents/doc-review-agent.md new file mode 100644 index 000000000..a16adae0d --- /dev/null +++ b/.claude/agents/doc-review-agent.md @@ -0,0 +1,82 @@ +--- +name: doc-review-agent +description: | + Diff-only PR review agent for documentation changes. Reviews Markdown + changes against style guide, frontmatter rules, shortcode syntax, and + documentation standards. Available for local Claude Code review sessions. +model: sonnet +--- + +You are a documentation review agent for the InfluxData docs-v2 repository. +Your job is to review PR diffs for documentation quality issues. You review +Markdown source only — visual/rendered review is handled separately by Copilot. + +## Review Scope + +Check the PR diff for these categories. Reference the linked docs for +detailed rules — do not invent rules that aren't documented. + +### 1. Frontmatter + +Rules: [DOCS-FRONTMATTER.md](../../DOCS-FRONTMATTER.md) + +- `title` and `description` are required on every page +- `menu` structure matches the product's menu key +- `weight` is present and uses the correct range (1-99, 101-199, etc.) +- `source` paths for shared content point to valid `/shared/` paths +- No duplicate or conflicting frontmatter keys + +### 2. Shortcode Syntax + +Rules: [DOCS-SHORTCODES.md](../../DOCS-SHORTCODES.md) + +- Shortcodes use correct opening/closing syntax (`{{< >}}` vs `{{% %}}` + depending on whether inner content is Markdown) +- Required parameters are present +- Closing tags match opening tags +- Callouts use GitHub-style syntax: `> [!Note]`, `> [!Warning]`, etc. + +### 3. Semantic Line Feeds + +Rules: [DOCS-CONTRIBUTING.md](../../DOCS-CONTRIBUTING.md) + +- One sentence per line +- Long sentences should be on their own line, not concatenated + +### 4. Heading Hierarchy + +- No h1 headings in content (h1 comes from `title` frontmatter) +- Headings don't skip levels (h2 → h4 without h3) + +### 5. Terminology and Product Names + +- Use official product names: "InfluxDB 3 Core", "InfluxDB 3 Enterprise", + "InfluxDB Cloud Serverless", "InfluxDB Cloud Dedicated", etc. +- Don't mix v2/v3 terminology in v3 docs (e.g., "bucket" in Core docs) +- Version references match the content path + +### 6. Links + +- Internal links use relative paths or Hugo `relref` shortcodes +- No hardcoded `docs.influxdata.com` links in content files +- Anchor links match actual heading IDs + +### 7. Shared Content + +- `source:` frontmatter points to an existing shared file path +- Shared files don't contain frontmatter (only content) +- Changes to shared content are intentional (affects multiple products) + +## Output Format + +Follow the shared review comment format, severity definitions, and label +mapping in +[.github/templates/review-comment.md](../../.github/templates/review-comment.md). + +## What NOT to Review + +- Rendered HTML appearance (Copilot handles this) +- Code correctness inside code blocks (pytest handles this) +- Link validity (link-checker workflow handles this) +- Vale style linting (Vale handles this) +- Files outside the diff diff --git a/.claude/agents/doc-triage-agent.md b/.claude/agents/doc-triage-agent.md new file mode 100644 index 000000000..59a4b4eff --- /dev/null +++ b/.claude/agents/doc-triage-agent.md @@ -0,0 +1,72 @@ +--- +name: doc-triage-agent +description: | + Triage agent for documentation issues and PRs. Applies product labels, + assesses priority, and determines readiness for automated workflows. + Uses data/products.yml as the single source of truth for path-to-product + mapping. +model: sonnet +--- + +You are a documentation triage agent for the InfluxData docs-v2 repository. +Your job is to label, prioritize, and route issues and PRs for the +documentation team. + +## Label Taxonomy + +Apply labels using the definitions in these source files: + +- **Product labels** (`product:*`): Read + [data/products.yml](../../data/products.yml) — match changed file paths + against each product's `content_path`, apply `product:{label_group}`. + Apply all matching labels. For shared content, apply `product:shared` plus + labels for all products that reference the shared file. +- **Non-product labels**: Read + [data/labels.yml](../../data/labels.yml) for all source, waiting, workflow, + and review label names and descriptions. +- **Review labels** (`review:*`): Defined in `data/labels.yml` but applied + only by the doc-review workflow, not during triage. + +## Priority Assessment + +Assess priority based on: + +1. **Product tier:** InfluxDB 3 Core/Enterprise > Cloud Dedicated/Serverless > v2 > v1 +2. **Issue type:** Incorrect information > missing content > style issues +3. **Scope:** Security/data-loss implications > functional docs > reference docs +4. **Staleness:** Issues with `waiting:*` labels older than 14 days should be + escalated or re-triaged + +## Decision Logic + +### When to apply `agent-ready` + +Apply when ALL of these are true: +- The issue has clear, actionable requirements +- No external dependencies (no `waiting:*` labels) +- The fix is within the documentation scope (not a product bug) +- Product labels are applied (agent needs to know which content to modify) + +### When to apply `waiting:*` + +Apply when the issue: +- References undocumented API behavior → `waiting:engineering` +- Requires a product decision about feature naming or scope → `waiting:product` +- Needs clarification from the reporter about expected behavior → add a comment asking, don't apply waiting + +### When to apply `review:needs-human` + +Apply during triage only if: +- The issue involves complex cross-product implications +- The content change could affect shared content used by many products +- The issue requires domain expertise the agent doesn't have + +## Triage Workflow + +1. Read the issue/PR title and body +2. Identify affected products from content paths or mentions +3. Apply product labels +4. Apply source label if applicable +5. Assess whether the issue is ready for agent work +6. Apply `agent-ready` or `waiting:*` as appropriate +7. Post a brief triage comment summarizing the labeling decision diff --git a/.claude/settings.json b/.claude/settings.json index f5838526b..c21b0380a 100644 --- a/.claude/settings.json +++ b/.claude/settings.json @@ -1,51 +1,51 @@ { "permissions": { "allow": [ - "Bash(.ci/vale/vale.sh:*)", - "Bash(npm:*)", - "Bash(yarn:*)", - "Bash(pnpm:*)", - "Bash(npx:*)", - "Bash(node:*)", - "Bash(python:*)", - "Bash(python3:*)", - "Bash(pip:*)", - "Bash(poetry:*)", - "Bash(make:*)", - "Bash(cargo:*)", - "Bash(go:*)", - "Bash(curl:*)", - "Bash(gh:*)", - "Bash(hugo:*)", - "Bash(htmlq:*)", - "Bash(jq:*)", - "Bash(yq:*)", - "Bash(mkdir:*)", - "Bash(cat:*)", - "Bash(ls:*)", - "Bash(echo:*)", - "Bash(rg:*)", - "Bash(grep:*)", - "Bash(find:*)", - "Bash(bash:*)", - "Bash(wc:*)", - "Bash(sort:*)", - "Bash(uniq:*)", - "Bash(head:*)", - "Bash(tail:*)", - "Bash(awk:*)", - "Bash(touch:*)", - "Bash(docker:*)", - "Edit", - "Read", - "Write", - "Grep", - "Glob", - "LS", - "Skill(superpowers:brainstorming)", - "Skill(superpowers:brainstorming:*)", - "mcp__acp__Bash" - ], + "Bash(.ci/vale/vale.sh:*)", + "Bash(npm:*)", + "Bash(yarn:*)", + "Bash(pnpm:*)", + "Bash(npx:*)", + "Bash(node:*)", + "Bash(python:*)", + "Bash(python3:*)", + "Bash(pip:*)", + "Bash(poetry:*)", + "Bash(make:*)", + "Bash(cargo:*)", + "Bash(go:*)", + "Bash(curl:*)", + "Bash(gh:*)", + "Bash(hugo:*)", + "Bash(htmlq:*)", + "Bash(jq:*)", + "Bash(yq:*)", + "Bash(mkdir:*)", + "Bash(cat:*)", + "Bash(ls:*)", + "Bash(echo:*)", + "Bash(rg:*)", + "Bash(grep:*)", + "Bash(find:*)", + "Bash(bash:*)", + "Bash(wc:*)", + "Bash(sort:*)", + "Bash(uniq:*)", + "Bash(head:*)", + "Bash(tail:*)", + "Bash(awk:*)", + "Bash(touch:*)", + "Bash(docker:*)", + "Edit", + "Read", + "Write", + "Grep", + "Glob", + "LS", + "Skill(superpowers:brainstorming)", + "Skill(superpowers:brainstorming:*)", + "mcp__acp__Bash" + ], "deny": [ "Read(./.env)", "Read(./.env.*)", @@ -58,5 +58,8 @@ "Bash(rm:*)", "Read(/tmp)" ] + }, + "enabledPlugins": { + "github@claude-plugins-official": true } } diff --git a/.github/DOC-REVIEW-PIPELINE-PLAN.md b/.github/DOC-REVIEW-PIPELINE-PLAN.md new file mode 100644 index 000000000..60815f485 --- /dev/null +++ b/.github/DOC-REVIEW-PIPELINE-PLAN.md @@ -0,0 +1,704 @@ +# Doc Review Pipeline — Implementation Plan + +**Status:** Complete — all phases implemented and tested +**Repository:** influxdata/docs-v2 +**Author:** Triage agent (Claude Code) +**Date:** 2026-02-28 + +--- + +## Table of Contents + +1. [Goal](#goal) +2. [What Already Exists](#what-already-exists) +3. [Architecture Overview](#architecture-overview) +4. [Phase 1: Label System Overhaul](#phase-1-label-system-overhaul) +5. [Phase 2: Doc Review Workflow](#phase-2-doc-review-workflow) +6. [Phase 3: Documentation and Agent Instructions](#phase-3-documentation-and-agent-instructions) +7. [Future Phases (Not In Scope)](#future-phases-not-in-scope) +8. [Decisions (Resolved)](#decisions-resolved) +9. [Risk Assessment](#risk-assessment) + +--- + +## Goal + +Build two interconnected systems: + +1. **Label system** — An automation-driven label taxonomy that supports + cross-repo automation, agentic workflows, and human-in-the-loop review. +2. **Doc review pipeline** — A GitHub Actions workflow that automates + documentation PR review using Copilot for both code review (diff-based, + using auto-loaded instruction files) and visual review (rendered HTML + at preview URLs), with rendered-page verification that catches issues + invisible in the Markdown source. + +The pipeline catches issues only visible in rendered output — expanded +shortcodes, broken layouts, incorrect product names — by having Copilot +analyze the rendered HTML of deployed preview pages. + +--- + +## What Already Exists + +### Infrastructure + +| Component | Location | Notes | +|-----------|----------|-------| +| PR preview deployment | `.github/workflows/pr-preview.yml` | Builds Hugo site, deploys to `gh-pages` branch at `influxdata.github.io/docs-v2/pr-preview/pr-{N}/` | +| Changed file detection | `.github/scripts/detect-preview-pages.js` | Detects changed files, maps content to public URLs, handles shared content | +| Content-to-URL mapping | `scripts/lib/content-utils.js` | `getChangedContentFiles()`, `mapContentToPublic()`, `expandSharedContentChanges()` | +| Screenshot tooling | `scripts/puppeteer/screenshot.js` | Puppeteer-based screenshot utility (already a dependency) | +| Playwright | `package.json` | Already a dependency (`^1.58.1`) | +| Claude agent instructions | `CLAUDE.md`, `AGENTS.md`, `.claude/` | Review criteria, style guide, skills, commands | +| Copilot instructions | `.github/copilot-instructions.md` | Style guide, repo structure, patterns | +| Copilot pattern instructions | `.github/instructions/` | Auto-loaded by Copilot based on changed file patterns | +| Auto-labeling (path-based) | Not yet implemented | Needed for Phase 1 | +| Link checker workflow | `.github/workflows/pr-link-check.yml` | Validates links on PR changes | +| Sync plugins workflow | `.github/workflows/sync-plugins.yml` | Issue-triggered workflow pattern to follow | +| Audit documentation workflow | `.github/workflows/audit-documentation.yml` | Creates issues from audit results | + +### Labels (Current State) + +The repo has 30+ labels with inconsistent naming patterns and significant +overlap. Product labels use long names (`InfluxDB 3 Core and Enterprise`), +workflow states are minimal (`release:pending` is the only actively used one), +and there is no agent-readiness or blocking-state taxonomy. + +--- + +## Architecture Overview + +``` +PR opened/updated (content paths) + │ + ├──────────────────────────┐ + ▼ ▼ +┌─ Job 1: Resolve URLs ────┐ ┌─ Job 2: Copilot Code Review ───┐ +│ resolve-review-urls.js │ │ gh pr edit --add-reviewer │ +│ changed files → URLs │ │ copilot-reviews │ +│ Output: url list │ │ Uses .github/instructions/ │ +└──────────┬───────────────┘ │ for auto-loaded review rules │ + │ └──────────────┬─────────────────┘ + ▼ │ +┌─ Job 3: Copilot Visual Review ────────┐ │ +│ Wait for preview deployment │ │ +│ Post preview URLs + review prompt │ │ +│ @copilot analyzes rendered HTML │ │ +│ Checks: layout, shortcodes, 404s │ │ +└──────────────┬───────────────────────┘ │ + │ │ + ▼ ▼ + Human reviews what remains +``` + +**Job 2 (Copilot code review) runs in parallel with Jobs 1→3** — it uses +GitHub's native Copilot reviewer, which analyzes the PR diff using +auto-loaded instruction files from `.github/instructions/`. + +--- + +## Phase 1: Label System Overhaul + +### Rationale + +The label system is a prerequisite for agentic workflows. Agents need clear +signals about issue readiness (`agent-ready`), blocking states +(`waiting:engineering`, `waiting:product`), and product scope +(`product:v3-monolith`, `product:v3-distributed`). +Consistent label patterns also enable GitHub API queries for dashboards and +automation. + +### 1.1 — Label taxonomy + +> **Note:** The tables below are a planning snapshot. The authoritative +> definitions live in `data/labels.yml` (non-product labels) and +> `data/products.yml` (product labels). See `.github/LABEL_GUIDE.md` for +> the current index. + +**24 labels organized into 6 categories:** + +#### Product labels (11) — Color: `#FFA500` (yellow) + +| Label | Description | +|-------|-------------| +| `product:v3-monolith` | InfluxDB 3 Core and Enterprise (single-node / clusterable) | +| `product:v3-distributed` | InfluxDB 3 Cloud Serverless, Cloud Dedicated, Clustered | +| `product:v2` | InfluxDB v2 (Cloud, OSS) | +| `product:v1` | InfluxDB v1 OSS | +| `product:v1-enterprise` | InfluxDB Enterprise v1 | +| `product:telegraf` | Telegraf documentation | +| `product:chronograf` | Chronograf documentation | +| `product:kapacitor` | Kapacitor documentation | +| `product:flux` | Flux language documentation | +| `product:explorer` | InfluxDB 3 Explorer | +| `product:shared` | Shared content across products | + +#### Source tracking labels (4) — Color: `#9370DB` (purple) + +| Label | Description | +|-------|-------------| +| `source:auto-detected` | Created by change detection within this repo | +| `source:dar` | Generated by DAR pipeline (issue analysis → draft) | +| `source:sync` | Synced from an external repository | +| `source:manual` | Human-created issue | + +#### Waiting states (2) — Color: `#FF8C00` (orange) + +| Label | Description | +|-------|-------------| +| `waiting:engineering` | Waiting for engineer confirmation | +| `waiting:product` | Waiting for product/PM decision | + +#### Workflow states (2) — Color: `#00FF00` / `#1E90FF` + +| Label | Description | +|-------|-------------| +| `agent-ready` | Agent can work on this autonomously | +| `skip-review` | Skip automated doc review pipeline | + +> [!Note] +> Human codeowner approval uses GitHub's native PR review mechanism (CODEOWNERS file), not a label. The `review:*` labels below are applied **manually** after reviewing Copilot feedback. + +#### Review outcome labels (3) — Color: `#28A745` / `#DC3545` / `#FFC107` + +| Label | Description | +|-------|-------------| +| `review:approved` | Review passed — no blocking issues found | +| `review:changes-requested` | Review found blocking issues | +| `review:needs-human` | Review inconclusive, needs human | + +> [!Note] +> All labels use colons (`:`) as separators for consistency. The `review:*` labels +> are mutually exclusive. They are applied manually after review — the CI workflow +> does not manage labels. Copilot code review uses GitHub's native "Comment" +> review type. + +#### Existing labels to keep (renamed) (2) + +| Old Name | New Name | Description | +|----------|----------|-------------| +| `AI assistant tooling` | `ai:tooling` | Related to AI assistant infrastructure | +| `ci:testing-and-validation` | `ci:testing` | CI/testing infrastructure | + +### 1.2 — Migration scripts + +Create migration scripts in `helper-scripts/label-migration/`: + +- **`create-labels.sh`** — Creates all new labels using `gh label create --force` (idempotent) +- **`migrate-labels.sh`** — Migrates existing issues from old labels to new labels using `gh issue edit` +- **`delete-labels.sh`** — Deletes old labels (requires interactive confirmation) +- **`README.md`** — Execution order, prerequisites, rollback instructions + +**Migration mapping:** + +| Old Label | New Label | +|-----------|-----------| +| `InfluxDB 3 Core and Enterprise` | `product:v3-monolith` | +| `InfluxDB v3` | `product:v3-monolith` (review individually — some may be distributed) | +| `Processing engine` | `product:v3-monolith` | +| `InfluxDB v2` | `product:v2` | +| `InfluxDB v1` | `product:v1` | +| `Enterprise 1.x` | `product:v1-enterprise` | +| `Chronograf 1.x` | `product:chronograf` | +| `Kapacitor` | `product:kapacitor` | +| `Flux` | `product:flux` | +| `InfluxDB 3 Explorer` | `product:explorer` | +| `Pending Release` | `release:pending` | +| `release/influxdb3` | `release:pending` | +| `sync-plugin-docs` | `source:sync` | + +> [!Important] +> **Workflow Updates Required:** +> The `sync-plugin-docs` label is used in GitHub Actions workflows. After migrating this label to `source:sync`, the following files must be updated: +> - `.github/workflows/sync-plugins.yml` (lines 28, 173, 421) +> - `.github/ISSUE_TEMPLATE/sync-plugin-docs.yml` (line 4) +> +> Update all references from `sync-plugin-docs` to `source:sync` to ensure the plugin sync automation continues to work after the label migration. + +> [!Note] +> `release:pending` is an existing workflow state label that we are keeping as-is. +> The migration scripts **must ensure** this label exists (create it if missing) and **must not** delete it in the cleanup step. + +**Labels to delete after migration:** +`bug`, `priority`, `documentation`, `Proposal`, `Research Phase`, +`ready-for-collaboration`, `ui`, `javascript`, `dependencies`, +`integration-demo-blog`, `API`, `Docker`, `Grafana`, `Ask AI`, +plus all old product labels listed above. + +**Execution:** +1. Run `create-labels.sh` (safe, idempotent) +2. Run `migrate-labels.sh` +3. Human verifies a sample of issues +4. Run `delete-labels.sh` (destructive, requires confirmation) + +### 1.3 — Auto-labeling workflow + +**File:** `.github/workflows/auto-label.yml` + +**Trigger:** `pull_request: [opened, synchronize]` + +**Logic:** +- List changed files via `github.rest.pulls.listFiles()` +- Read `data/products.yml` for path-to-label mappings (single source of truth): + - Each product entry has `content_path` and `label_group` fields + - Match file paths against `content/{content_path}/` → `product:{label_group}` + - Example: `content/influxdb3/core/` matches `content_path: influxdb3/core`, + `label_group: v3-monolith` → applies `product:v3-monolith` +- Shared content handling: + - `content/shared/` changes apply `product:shared` label + - Additionally expand shared content to affected products using + `expandSharedContentChanges()` from `scripts/lib/content-utils.js` + - Apply all affected product labels (additive) +- Multi-product PRs: apply all matching `product:*` labels (additive) +- Only add labels that are not already present (idempotent) +- Runs as `actions/github-script@v7` + +--- + +## Phase 2: Doc Review Workflow + +### 2.1 — Workflow file + +**File:** `.github/workflows/doc-review.yml` + +**Trigger:** + +```yaml +on: + pull_request: + types: [opened, synchronize, ready_for_review] + paths: + - 'content/**' + - 'layouts/**' + - 'assets/**' + - 'data/**' +``` + +**Permissions:** `contents: read`, `pull-requests: write` + +**Concurrency:** `group: doc-review-${{ github.event.number }}`, `cancel-in-progress: true` + +**Skip conditions:** Draft PRs, fork PRs, PRs with a `skip-review` label (new label to be added in Phase 1 via the label migration scripts). + +### 2.2 — Job 1: Resolve URLs + +**Purpose:** Map changed files to preview URLs. + +**Implementation:** +- Reuse the existing `detect-preview-pages.js` script and `content-utils.js` library +- Same logic as `pr-preview.yml` Job 1, but output a JSON artifact instead of deploying +- Output format: `[{"file": "content/influxdb3/core/write-data/_index.md", "url": "/influxdb3/core/write-data/"}]` +- Upload as `urls.json` workflow artifact + +**Key detail:** This job runs `getChangedContentFiles()` and `mapContentToPublic()` +from `scripts/lib/content-utils.js`, which already handles shared content +expansion (if `content/shared/foo.md` changes, all pages with +`source: /shared/foo.md` are included). + +### 2.3 — Job 2: Copilot Code Review + +**Purpose:** Review Markdown changes against the style guide and documentation +standards using GitHub's native Copilot code review. Visual review of rendered +pages is handled separately in Job 3. + +**Dependencies:** None beyond the PR itself. This job runs in parallel with +Jobs 1→3. + +**Implementation:** +- Adds `copilot-reviews` as a PR reviewer via `gh pr edit --add-reviewer` +- Copilot automatically reviews the PR diff using instruction files from + `.github/instructions/` that are auto-loaded based on changed file patterns +- No custom prompt or API key required + +**Review criteria file:** `.github/instructions/content-review.instructions.md` + +This file is auto-loaded by Copilot for PRs that change `content/**/*.md` +files. It checks for: + +1. **Frontmatter correctness** — Required fields, menu structure, weights +2. **Shortcode syntax** — Correct usage, closing tags, parameters +3. **Semantic line feeds** — One sentence per line +4. **Heading hierarchy** — No h1 in content (title comes from frontmatter) +5. **Product-specific terminology** — Correct product names, versions +6. **Link format** — Relative links, proper shortcode links +7. **Shared content** — `source:` frontmatter correctness +8. **Code blocks** — Language identifiers, line length, long CLI options + +**Severity classification:** +- `BLOCKING` — Wrong product names, invalid frontmatter, broken shortcode syntax +- `WARNING` — Style inconsistencies, missing semantic line feeds +- `INFO` — Suggestions, not problems + +**Output:** +- Copilot posts inline review comments using GitHub's native "Comment" + review type +- `review:*` labels are applied manually by humans after reviewing the + Copilot feedback — the workflow does not manage labels + +### 2.4 — Job 3: Copilot Visual Review (rendered HTML) + +**Purpose:** Have Copilot analyze the rendered preview pages to catch visual +and structural issues invisible in the Markdown source. + +**Dependencies:** Depends on Job 1 (needs URL list). Must wait for the +`pr-preview.yml` deployment to be live. + +**Why Copilot for visual review:** +- Copilot can analyze rendered HTML content at public preview URLs — no + screenshot capture or image upload required. +- Visual review is a good fit for Copilot because the rendered pages are + self-contained artifacts (no need to cross-reference repo files). +- Copilot code review (Job 2) handles the diff; visual review catches what + the diff review cannot. + +**Implementation:** + +1. **Wait for preview deployment:** + - Poll `https://influxdata.github.io/docs-v2/pr-preview/pr-{N}/` with + `curl --head` until it returns 200 + - Timeout: 10 minutes (preview build takes ~75s + deploy time) + - Poll interval: 15 seconds + - If timeout, skip visual review; Copilot code review (Job 2) still runs + +2. **Post preview URLs and trigger Copilot review:** + - Use `actions/github-script@v7` to post a PR comment listing the preview + URLs from Job 1, formatted as clickable links + - Post a follow-up comment tagging `@copilot` with instructions to review + the rendered pages at the preview URLs. The comment should instruct + Copilot to check each page for: + - Raw shortcode syntax visible on the page (`{{<` or `{{%`) + - Placeholder text that should have been replaced + - Broken layouts: overlapping text, missing images, collapsed sections + - Code blocks rendered incorrectly (raw HTML/Markdown fences visible) + - Navigation/sidebar entries correct + - Visible 404 or error state + - Product name inconsistencies in the rendered page header/breadcrumbs + - The review instruction template is stored in + `.github/prompts/copilot-visual-review.md` for maintainability + - Preview URL count capped at 50 pages (matching `MAX_PAGES` in + `detect-preview-pages.js`) + +3. **Comment upsert pattern:** + - Visual review comments use a marker-based upsert pattern — the workflow + updates an existing comment if one with the marker exists, otherwise + creates a new one. This prevents duplicate comments on `synchronize` + events. + +### 2.6 — Workflow failure handling + +- If preview deployment times out: skip Copilot visual review (Job 3), + Copilot code review (Job 2) still runs independently. Post a comment + explaining visual review was skipped. +- If Copilot does not respond to the `@copilot` mention: the preview URLs + remain in the comment for human review. +- Never block PR merge on workflow failures — the workflow adds comments + but does not set required status checks or manage labels. + +--- + +## Phase 3: Documentation and Agent Instructions + +### 3.1 — Instruction file architecture + +**Principle:** One `CLAUDE.md` that references role-specific files. No per-role +CLAUDE files — Claude Code only reads one `CLAUDE.md` per directory level. The +role context comes from the task prompt (GitHub Actions workflow), not the config +file. + +``` +CLAUDE.md ← lightweight pointer (already exists) + ├── references .github/LABEL_GUIDE.md ← label taxonomy + usage + ├── references .claude/agents/ ← role-specific agent instructions + │ ├── doc-triage-agent.md ← triage + auto-label logic + │ └── doc-review-agent.md ← local review sessions (Claude Code) + └── references .github/instructions/ ← Copilot auto-loaded instructions + └── content-review.instructions.md ← review criteria for content/**/*.md +``` + +**How review roles are assigned at runtime:** +- **Copilot code review (CI):** GitHub's native reviewer. Auto-loads + instruction files from `.github/instructions/` based on changed file + patterns. No custom prompt or API key needed. +- **Copilot visual review (CI):** Triggered by `@copilot` mention in a PR + comment with preview URLs and a review template. +- **Claude local review:** Uses `.claude/agents/doc-review-agent.md` for + local Claude Code sessions. Not used in CI. +- Shared rules (style guide, frontmatter, shortcodes) stay in the existing + referenced files (`DOCS-CONTRIBUTING.md`, `DOCS-SHORTCODES.md`, etc.) +- No duplication — each instruction file says what's unique to that context + +### 3.2 — Agent instruction files + +#### `.claude/agents/doc-triage-agent.md` + +Role-specific instructions for issue/PR triage. Contents: + +- **Label taxonomy** — Full label list with categories, colors, descriptions +- **Path-to-product mapping** — Which content paths map to which `product:*` labels +- **Priority rules** — How to assess priority based on product, scope, and issue type +- **Decision logic** — When to apply `agent-ready`, `waiting:*`, `review:needs-human` +- **Migration context** — Old label → new label mapping (useful during transition) + +This file does NOT duplicate style guide rules. It references +`DOCS-CONTRIBUTING.md` for those. + +#### `.claude/agents/doc-review-agent.md` + +Role-specific instructions for **local** Claude Code review sessions. This +file is NOT used in CI — the CI review is handled by Copilot using +`.github/instructions/content-review.instructions.md`. + +Contents: + +- **Review scope** — Markdown diff review only (frontmatter, shortcodes, + semantic line feeds, heading hierarchy, terminology, links, shared content). +- **Severity classification** — BLOCKING / WARNING / INFO definitions with examples +- **Output format** — Structured review comment template + +This file references `DOCS-CONTRIBUTING.md` for style rules and +`DOCS-SHORTCODES.md` for shortcode syntax — it does NOT restate them. + +### 3.3 — Label usage guide + +**File:** `.github/LABEL_GUIDE.md` + +Contents: +- Label categories with descriptions and colors +- Common workflows (issue triage, DAR pipeline, manual work) +- GitHub filter queries for agents and humans +- Auto-labeling behavior reference + +### 3.4 — Update existing pointer files + +**`CLAUDE.md`** — Add one line to the "Full instruction resources" list: +```markdown +- [.github/LABEL_GUIDE.md](.github/LABEL_GUIDE.md) - Label taxonomy and pipeline usage +``` + +**`AGENTS.md`** — Add a section referencing the label guide and agent roles: +```markdown +## Doc Review Pipeline +- Label guide: `.github/LABEL_GUIDE.md` +- Triage agent: `.claude/agents/doc-triage-agent.md` +- Review agent: `.claude/agents/doc-review-agent.md` +``` + +**`.github/copilot-instructions.md`** — Add the label guide to the +"Specialized Resources" table. + +These are small additions — no restructuring of existing files. + +### 3.5 — Review instruction files + +#### `.github/instructions/content-review.instructions.md` (Copilot code review) + +Auto-loaded by Copilot for PRs that change `content/**/*.md` files. Contains +the review criteria (frontmatter, shortcodes, heading hierarchy, terminology, +links, code blocks) with severity classification. + +This file replaces the original `.github/prompts/doc-review.md` Claude prompt. +The review criteria are the same but delivered through Copilot's native +instruction file mechanism instead of a custom action. + +#### `.github/templates/review-comment.md` (shared format) + +Shared definitions for severity levels, comment structure, and result → label +mapping. Used by `doc-review-agent.md` (local review sessions) and the +Copilot visual review template. + +#### Copilot visual review template + +The `@copilot` visual review comment is constructed inline in the +`doc-review.yml` workflow using the review template from +`.github/templates/review-comment.md`. Contains: + +- The visual review checklist (raw shortcodes, broken layouts, 404s, etc.) +- Instructions for analyzing the rendered pages at the preview URLs +- Output format guidance (what to flag, severity levels) + +--- + +## Future Phases (Not In Scope) + +These are explicitly **not** part of this plan. Documented here for context. + +### v2 — Screenshot-based visual review +- Add Playwright screenshot capture script (`.github/scripts/capture-screenshots.js`) + for design/layout PRs where HTML analysis isn't sufficient. +- Capture full-page PNGs of preview pages, upload as workflow artifacts. +- Useful for PRs touching `layouts/`, `assets/css/`, or template changes + where visual regression matters. +- The existing `scripts/puppeteer/screenshot.js` remains for local debugging; + the CI script should use Playwright for reliability. + +### v3 — Stale PR management +- Cron job that scans for stale PRs (draft >3 days with no review activity) + and pings the author. +- Metrics tracking: % of PRs that pass Copilot review on first attempt. + +### v4 — Agent-driven issue resolution +- Auto-assign doc issues to agents based on `agent-ready` label. +- Claude or Copilot drafts the fix, then the other agent reviews. +- Closes the loop: issue → draft → review → human approval. + +--- + +## Decisions (Resolved) + +### Q1: How should Copilot review rendered pages? — RESOLVED + +**Decision:** Copilot reviews rendered HTML at public preview URLs — no +screenshots needed. Job 3 posts preview URLs in a PR comment, then tags +`@copilot` with a review prompt. See section 2.5 for implementation details. + +This approach works because: +- Preview pages are publicly accessible at `influxdata.github.io/docs-v2/pr-preview/pr-{N}/` +- Copilot can analyze HTML content at public URLs +- No screenshot capture, image upload, or artifact management required + +Screenshot capture is deferred to Future Phases (v2) for design/layout PRs +where visual regression testing matters. + +### Q2: Should the review workflow be a required status check? — RESOLVED + +**Decision:** No. Start as advisory (comments only). The workflow posts review +comments but does not set required status checks or manage labels. `review:*` +labels are applied manually after review. Make it required only after the team +confirms the false-positive rate is acceptable (see Future Phases). + +### Q3: Should screenshots use Playwright or Puppeteer? — DEFERRED + +**Decision:** Deferred to Future Phases (v2). The current implementation +reviews rendered HTML at preview URLs, not screenshots. When screenshot +capture is added later, use Playwright for CI and keep Puppeteer for local +debugging. + +### Q4: How to handle the `pr-preview.yml` dependency? — RESOLVED + +**Decision:** Option A — poll the preview URL with timeout. Job 3 polls +`https://influxdata.github.io/docs-v2/pr-preview/pr-{N}/` with `curl --head` +every 15 seconds until it returns 200, with a 10-minute timeout. If timeout is +reached, skip Copilot visual review; Copilot code review (Job 2) still runs +independently. + +Rationale: Polling is simple, self-contained, and resilient. The URL pattern is +deterministic. Option B (`workflow_run`) adds complexity and doesn't handle +cases where preview doesn't deploy. Option C (combined workflow) makes the +workflow too large and eliminates the parallelism benefit. + +### Q5: Cost and rate limiting — RESOLVED + +**Decision:** Acceptable. Both code review and visual review use the repo's +Copilot allocation. No external API keys or per-call costs. + +Mitigations already designed into the workflow: +- `paths` filter ensures only doc-content PRs trigger the workflow. +- `skip-review` label allows trivial PRs to opt out. +- Concurrency group cancels in-progress reviews when the PR is updated. +- Preview URL count is capped at 50 pages (matching `MAX_PAGES` in + `resolve-review-urls.js`). +- Draft and fork PRs are skipped entirely. + +### Q6: Label separator convention — RESOLVED + +**Decision:** Use colons (`:`) everywhere. No slashes. One separator for +consistency — expecting humans or agents to infer different semantics from +separator choice is unrealistic. Mutually exclusive behavior (e.g., `review:*` +labels) is enforced in workflow code, not punctuation. + +### Q7: Human approval mechanism — RESOLVED + +**Decision:** Use GitHub's native PR review system (CODEOWNERS file) for human +approval. No `approval:codeowner` label. The `review:*` labels are exclusively +for automated pipeline outcomes. + +### Q8: Product path mapping — RESOLVED + +**Decision:** Extend `data/products.yml` with `content_path` and `label_group` +fields. This file becomes the single source of truth for path-to-product +resolution, used by the auto-label workflow, matrix-generator, and documentation +(AGENTS.md). Eliminates duplicated mappings across multiple files. + +### Q9: `sync-plugin-docs` label migration — RESOLVED + +**Decision:** Migrate to `source:sync` (not `source:auto-detected`). Plugin +sync is a distinct operation from change detection. `source:sync` is general +enough to cover future external repo syncs without being hyper-specific. + +### Q10: Multi-product and shared content labeling — RESOLVED + +**Decision:** Auto-labeling is additive — apply all matching `product:*` labels. +Changes to `content/shared/` get the `product:shared` label plus all expanded +product labels (resolved via `expandSharedContentChanges()`). + +--- + +## Risk Assessment + +| Risk | Impact | Mitigation | +|------|--------|------------| +| Preview not deployed in time | Low | 10-minute polling timeout, fall back to code-only review | +| False positives in review | Medium | Start as advisory (not required check), iterate instruction files | +| Label migration data loss | Low | Migrate before deleting; human verification gate | +| Copilot visual review misses issues | Medium | Preview URLs remain in comment for human review; start advisory | +| Copilot code review quality | Medium | Review criteria in `.github/instructions/` can be iterated; local Claude review available as backup | +| Product mapping drift | Low | Single source of truth in `data/products.yml`; auto-label and matrix-generator both derive from it | + +--- + +## File Summary + +Files to create or modify: + +| Action | File | Phase | Status | +|--------|------|-------|--------| +| Modify | `data/products.yml` | 1.0 | Done | +| Modify | `data/labels.yml` | 1.1 | Done | +| Create | `helper-scripts/label-migration/create-labels.sh` | 1.2 | Done | +| Create | `helper-scripts/label-migration/migrate-labels.sh` | 1.2 | Done | +| Create | `helper-scripts/label-migration/delete-labels.sh` | 1.2 | Done | +| Create | `helper-scripts/label-migration/README.md` | 1.2 | Done | +| Create | `.github/workflows/auto-label.yml` | 1.3 | Done | +| Create | `.github/workflows/doc-review.yml` | 2.1 | Done | +| Create | `.claude/agents/doc-triage-agent.md` | 3.2 | Done | +| Create | `.claude/agents/doc-review-agent.md` | 3.2 | Done | +| Create | `.github/LABEL_GUIDE.md` | 3.3 | Done | +| Create | `.github/instructions/content-review.instructions.md` | 3.5 | Done | +| Create | `.github/templates/review-comment.md` | 2.5/3.5 | Done | +| Modify | `CLAUDE.md` | 3.4 | Done | +| Modify | `AGENTS.md` | 3.4 | Done | +| Modify | `.github/copilot-instructions.md` | 3.4 | Done | + +--- + +## Implementation Order + +1. ~~**Phase 1.0** — Extend `data/products.yml` with `content_path` and `label_group`~~ ✅ +2. ~~**Phase 1.1–1.2** — Create label migration scripts~~ ✅ +3. ~~**Phase 1.3** — Create auto-label workflow~~ ✅ +4. ~~**Execute label migration** — Run scripts, then manual cleanup~~ ✅ +5. ~~**Phase 3.2** — Create agent instruction files~~ ✅ +6. ~~**Phase 2.1–2.3** — Workflow skeleton + URL resolution + Copilot code review~~ ✅ +7. ~~**Phase 2.5** — Copilot visual review job~~ ✅ +8. ~~**Phase 3.3–3.5** — Label guide, instruction files, pointer updates~~ ✅ +9. ~~**Test end-to-end** — Triggered workflows via `workflow_dispatch` against PR #6890~~ ✅ + +### End-to-end test results (2026-03-09) + +Triggered via `workflow_dispatch` with `pr_number=6890` on branch +`claude/triage-agent-plan-EOY0u`. + +| Workflow | Job | Result | Notes | +|----------|-----|--------|-------| +| Auto-label PRs | auto-label | Pass | Loaded 14 path mappings, 0 product labels (correct — no content changes) | +| Doc Review | resolve-urls | Pass | 0 preview URLs (correct — no content changes) | +| Doc Review | copilot-review | Pass | `copilot-reviews` added as reviewer | +| Doc Review | copilot-visual-review | Skipped | Correct — 0 URLs to review | + +**Fixes applied during testing:** +- `npm ci` replaced with targeted `js-yaml` install (sparse checkout lacks lock file) +- Added `workflow_dispatch` with `pr_number` input for on-demand re-runs + +**Remaining:** Visual review (Job 3) needs a content-changing PR to fully exercise +the preview URL polling and Copilot `@copilot` mention flow. diff --git a/.github/ISSUE_TEMPLATE/sync-plugin-docs.yml b/.github/ISSUE_TEMPLATE/sync-plugin-docs.yml index 382af5ce3..0331a501c 100644 --- a/.github/ISSUE_TEMPLATE/sync-plugin-docs.yml +++ b/.github/ISSUE_TEMPLATE/sync-plugin-docs.yml @@ -1,7 +1,7 @@ name: Sync Plugin Documentation description: Request synchronization of plugin documentation from influxdb3_plugins repository title: "Sync plugin docs: [PLUGIN_NAMES]" -labels: ["sync-plugin-docs", "documentation", "automation"] +labels: ["source:sync", "documentation", "automation"] assignees: [] body: - type: markdown diff --git a/.github/LABEL_GUIDE.md b/.github/LABEL_GUIDE.md new file mode 100644 index 000000000..14de67670 --- /dev/null +++ b/.github/LABEL_GUIDE.md @@ -0,0 +1,100 @@ +# Label Guide + +Label taxonomy for the docs-v2 repository. Used by automation workflows, +triage agents, and human contributors. + +## Label Definitions + +- **Product labels** (`product:*`): Derived from + [data/products.yml](../data/products.yml) — each product's `label_group` + field determines the label name, `content_path` determines which files + trigger it. Applied by the [auto-label workflow](workflows/auto-label.yml). + Multi-product PRs get all matching labels. Shared content changes get + `product:shared` plus labels for all products that reference the shared file. + +- **Source, waiting, workflow, and review labels**: Defined in + [data/labels.yml](../data/labels.yml) — names, colors, and descriptions. + +- **Review label behavior** (severity levels, result rules, result → label + mapping): Defined in + [templates/review-comment.md](templates/review-comment.md). + +Human approval uses GitHub's native PR review system (CODEOWNERS), not labels. + +## Renamed Labels + +| Old Name | New Name | +|----------|----------| +| `AI assistant tooling` | `ai:tooling` | +| `ci:testing-and-validation` | `ci:testing` | +| `design` | `area:site-ui` | +| `InfluxDB Cloud` | `product:v2-cloud` | +| `user feedback` | `source:feedback` | +| `ai:tooling` | `area:agents` | + +## Deleted Labels + +| Label | Replacement | Reason | +|-------|-------------|--------| +| `Pending PR` | `waiting:pr` | Consolidated into `waiting:` namespace | +| `broke-link` | `area:links` | Consolidated into `area:` namespace | + +## Common Workflows + +### Issue triage + +1. Read issue → identify product(s) → apply `product:*` labels +2. Apply `source:*` label if applicable +3. Determine readiness → apply `agent-ready` or `waiting:*` + +### PR review pipeline + +1. PR opened → auto-label applies `product:*` labels +2. Doc review workflow triggers (unless `skip-review` is present) +3. Copilot code review runs on the diff (uses + [`.github/instructions/`](instructions/) files from the base branch) +4. Copilot visual review checks rendered preview pages +5. Human reviewer uses GitHub's PR review for final approval + +Review labels (`review:*`) are applied manually after review, not by CI. + +### GitHub Filter Queries + +``` +# PRs needing human review +label:review:needs-human is:pr is:open + +# Agent-ready issues +label:agent-ready is:issue is:open -label:waiting:engineering -label:waiting:product + +# All InfluxDB 3 issues +label:product:v3-monolith,product:v3-distributed is:issue is:open + +# Blocked issues +label:waiting:engineering,waiting:product is:issue is:open + +# PRs that skipped review +label:skip-review is:pr +``` + +## Auto-labeling Behavior + +The [auto-label workflow](workflows/auto-label.yml) runs on +`pull_request: [opened, synchronize]` and: + +- Reads path-to-product mappings from `data/products.yml` +- Matches changed files to product labels +- Expands shared content changes to affected product labels +- Adds labels idempotently (skips labels already present) +- Skips draft and fork PRs + +## References + +- Label definitions: `data/labels.yml` +- Product definitions: `data/products.yml` +- Review comment format: `.github/templates/review-comment.md` +- Auto-label workflow: `.github/workflows/auto-label.yml` +- Doc review workflow: `.github/workflows/doc-review.yml` +- Triage agent: `.claude/agents/doc-triage-agent.md` +- Review agent: `.claude/agents/doc-review-agent.md` +- Migration scripts: `helper-scripts/label-migration/` diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index b31410cbf..975b1a0f0 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -2,261 +2,61 @@ > **For GitHub Copilot and other AI coding agents** > -> This is the primary instruction file for GitHub Copilot working with the InfluxData documentation site. -> > **Instruction resources**: > -> - [.github/agents/copilot-instructions-agent.md](agents/copilot-instructions-agent.md) - **Creating/improving Copilot instructions** -> - [.claude/skills/](../.claude/skills/) - **Detailed workflows** (content editing, testing, InfluxDB setup, templates) > - [.github/instructions/](instructions/) - **Pattern-specific** (auto-loaded by file type) -> - [.github/agents/](agents/) - **Specialist agents** (TypeScript/Hugo, Copilot management) -> - [AGENTS.md](../AGENTS.md), [CLAUDE.md](../CLAUDE.md) - General AI assistant guides +> - [AGENTS.md](../AGENTS.md) - Shared project guidelines (style, constraints, content structure) +> - [.github/LABEL_GUIDE.md](LABEL_GUIDE.md) - Label taxonomy and review pipeline ## Quick Reference -| Task | Command | Time | Details | -| ---------------- | ----------------------------------------------------- | ------- | ------------------------------------- | -| Install | `CYPRESS_INSTALL_BINARY=0 yarn install` | \~4s | Skip Cypress for CI | -| Build | `npx hugo --quiet` | \~75s | NEVER CANCEL | -| Dev Server | `npx hugo server` | \~92s | Port 1313 | -| Create Docs | `docs create --products ` | varies | AI-assisted scaffolding | -| Create & Open | `docs create --products --open` | instant | Non-blocking (background) | -| Create & Wait | `docs create --products --open --wait` | varies | Blocking (interactive) | -| Edit Docs | `docs edit ` | instant | Non-blocking (background) | -| Edit Docs (wait) | `docs edit --wait` | varies | Blocking (interactive) | -| List Files | `docs edit --list` | instant | Show files without opening | -| Add Placeholders | `docs placeholders ` | instant | Add placeholder syntax to code blocks | -| Audit Docs | `docs audit --products ` | varies | Audit documentation coverage | -| Release Notes | `docs release-notes --products ` | varies | Generate release notes from commits | -| Test All | `yarn test:codeblocks:all` | 15-45m | NEVER CANCEL | -| Lint | `yarn lint` | \~1m | Pre-commit checks | +| Task | Command | Time | +| ---------------- | ----------------------------------------------------- | ------- | +| Install | `CYPRESS_INSTALL_BINARY=0 yarn install` | \~4s | +| Build | `npx hugo --quiet` | \~75s | +| Dev Server | `npx hugo server` | \~92s | +| Create Docs | `docs create --products ` | varies | +| Edit Docs | `docs edit ` | instant | +| Add Placeholders | `docs placeholders ` | instant | +| Audit Docs | `docs audit --products ` | varies | +| Test All | `yarn test:codeblocks:all` | 15-45m | +| Lint | `yarn lint` | \~1m | + +**NEVER CANCEL** Hugo builds (\~75s) or test runs (15-45m). ## CLI Tools -**For when to use CLI vs direct editing**, see [docs-cli-workflow skill](../.claude/skills/docs-cli-workflow/SKILL.md). - ```bash -# Create new documentation (AI-assisted scaffolding) -docs create --products -docs create --products influxdb3_core --open # Non-blocking -docs create --products influxdb3_core --open --wait # Blocking - -# Find and edit documentation by URL -docs edit # Non-blocking (agent-friendly) -docs edit --list # List files only -docs edit --wait # Wait for editor - -# Other tools -docs placeholders # Add placeholder syntax to code blocks -docs audit --products # Audit documentation coverage -docs release-notes --products - -# Get help -docs --help -docs create --help +docs --help # Full reference ``` -**Key points**: - -- Accepts both product keys (`influxdb3_core`) and paths (`/influxdb3/core`) -- Non-blocking by default (agent-friendly) -- Use `--wait` for interactive editing -- `--products` and `--repos` are mutually exclusive for audit/release-notes +Non-blocking by default. Use `--wait` for interactive editing. ## Workflows -### Content Editing +- **Content editing**: See [content-editing skill](../.claude/skills/content-editing/SKILL.md) +- **Testing**: See [DOCS-TESTING.md](../DOCS-TESTING.md) +- **Hugo templates**: See [hugo-template-dev skill](../.claude/skills/hugo-template-dev/SKILL.md) -See [content-editing skill](../.claude/skills/content-editing/SKILL.md) for complete workflow: +## Product and Content Paths -- Creating/editing content with CLI -- Shared content management -- Testing and validation - -### Testing - -See [DOCS-TESTING.md](../DOCS-TESTING.md) and [cypress-e2e-testing skill](../.claude/skills/cypress-e2e-testing/SKILL.md). - -Quick tests (NEVER CANCEL long-running): - -```bash -yarn test:codeblocks:all # 15-45m -yarn test:links # 1-5m -yarn lint # 1m -``` - -### InfluxDB 3 Setup - -See [influxdb3-test-setup skill](../.claude/skills/influxdb3-test-setup/SKILL.md). - -Quick setup: - -```bash -./test/scripts/init-influxdb3.sh core # Per-worktree, port 8282 -./test/scripts/init-influxdb3.sh enterprise # Shared, port 8181 -./test/scripts/init-influxdb3.sh all # Both -``` - -### Hugo Template Development - -See [hugo-template-dev skill](../.claude/skills/hugo-template-dev/SKILL.md) for template syntax, data access, and testing strategies. - -## Repository Structure - -### Content Organization - -- **InfluxDB 3**: `/content/influxdb3/` (core, enterprise, cloud-dedicated, cloud-serverless, clustered, explorer) -- **InfluxDB v2**: `/content/influxdb/` (v2, cloud) -- **InfluxDB v1**: `/content/influxdb/v1` -- **InfluxDB Enterprise (v1)**: `/content/enterprise_influxdb/v1/` -- **Telegraf**: `/content/telegraf/v1/` -- **Kapacitor**: `/content/kapacitor/` -- **Chronograf**: `/content/chronograf/` -- **Flux**: `/content/flux/` -- **Examples**: `/content/example.md` (comprehensive shortcode reference) -- **Shared content**: `/content/shared/` - -### Key Files - -- **Config**: `/config/_default/`, `package.json`, `compose.yaml`, `lefthook.yml` -- **Testing**: `cypress.config.js`, `pytest.ini`, `.vale.ini` -- **Assets**: `/assets/` (JS, CSS), `/layouts/` (templates), `/data/` (YAML/JSON) -- **Build output**: `/public/` (\~529MB, gitignored) - -## Technology Stack - -- **Hugo** - Static site generator -- **Node.js/Yarn** - Package management -- **Testing**: Pytest, Cypress, link-checker, Vale -- **Tools**: Docker, ESLint, Prettier, Lefthook - -## Common Issues - -### Network Restrictions - -Commands that may fail in restricted environments: - -- Docker builds (external repos) -- `docker compose up local-dev` (Alpine packages) -- Cypress installation (use `CYPRESS_INSTALL_BINARY=0`) - -### Pre-commit Validation - -```bash -# Quick validation before commits -yarn prettier --write "**/*.{css,js,ts,jsx,tsx}" -yarn eslint assets/js/**/*.js -npx hugo --quiet -``` - -## Documentation Coverage - -- **InfluxDB 3**: Core, Enterprise, Cloud (Dedicated/Serverless), Clustered, Explorer, plugins -- **InfluxDB v2/v1**: OSS, Cloud, Enterprise -- **Tools**: Telegraf, Kapacitor, Chronograf, Flux -- **API Reference**: All InfluxDB editions +Defined in [data/products.yml](../data/products.yml). ## Content Guidelines -**Style guide**: Google Developer Documentation Style Guide\ -**Voice**: Active, present tense, second person\ -**Line breaks**: Semantic line feeds (one sentence per line)\ -**Files**: lowercase-with-hyphens.md +- [DOCS-CONTRIBUTING.md](../DOCS-CONTRIBUTING.md) - Style, workflow, commit format +- [DOCS-SHORTCODES.md](../DOCS-SHORTCODES.md) - Shortcode reference +- [DOCS-FRONTMATTER.md](../DOCS-FRONTMATTER.md) - Frontmatter reference +- [content/example.md](../content/example.md) - Working shortcode examples -### Quick Shortcodes +## File Pattern-Specific Instructions -````markdown -# Callouts (GitHub-style alerts) -> [!Note] / [!Warning] / [!Tip] / [!Important] / [!Caution] - -# Required elements -{{< req >}} -{{< req type="key" >}} - -# Code placeholders -```sh { placeholders="DATABASE_NAME|API_TOKEN" } -curl https://example.com/api?db=DATABASE_NAME -```` - -```` - -**Complete reference**: [DOCS-SHORTCODES.md](../DOCS-SHORTCODES.md) - -### Required Frontmatter - -```yaml -title: # Required -description: # Required -menu: - product_menu_key: - name: # Optional - parent: # Optional -weight: # Required: 1-99, 101-199, 201-299... -```` - -**Shared content**: Add `source: /shared/path/to/file.md` - -**Complete reference**: [DOCS-FRONTMATTER.md](../DOCS-FRONTMATTER.md) - -### Resources - -- [DOCS-CONTRIBUTING.md](../DOCS-CONTRIBUTING.md) - Workflow & guidelines -- [DOCS-SHORTCODES.md](../DOCS-SHORTCODES.md) - Complete shortcodes -- [DOCS-FRONTMATTER.md](../DOCS-FRONTMATTER.md) - Complete metadata -- [DOCS-TESTING.md](../DOCS-TESTING.md) - Testing procedures -- [content/example.md](../content/example.md) - Working examples - -## Troubleshooting - -| Issue | Solution | -| ------------------------ | ---------------------------------------------------------------- | -| Pytest collected 0 items | Use `python` not `py` for language identifier | -| Hugo build errors | Check `/config/_default/` | -| Docker build fails | Expected in restricted networks - use local Hugo | -| Cypress install fails | Use `CYPRESS_INSTALL_BINARY=0 yarn install` | -| Link validation slow | Test specific files: `yarn test:links content/file.md` | -| Vale "0 errors in stdin" | File is outside repo - Vale Docker can only access repo files | -| Vale false positives | Add terms to `.ci/vale/styles/InfluxDataDocs/Terms/ignore.txt` | -| Vale duration warnings | Duration literals (`30d`) are valid - check InfluxDataDocs.Units | - -## Specialized Instructions - -### File Pattern-Specific Instructions - -These instructions are automatically loaded by GitHub Copilot based on the files you're working with: +Auto-loaded by GitHub Copilot based on changed files: | Pattern | File | Description | | ------------------------ | ----------------------------------------------------------------- | ------------------------------------------------ | | `content/**/*.md` | [content.instructions.md](instructions/content.instructions.md) | Content file guidelines, frontmatter, shortcodes | +| `content/**/*.md` | [content-review.instructions.md](instructions/content-review.instructions.md) | Review criteria for content changes | | `layouts/**/*.html` | [layouts.instructions.md](instructions/layouts.instructions.md) | Shortcode implementation patterns and testing | | `api-docs/**/*.yml` | [api-docs.instructions.md](instructions/api-docs.instructions.md) | OpenAPI spec workflow | | `assets/js/**/*.{js,ts}` | [assets.instructions.md](instructions/assets.instructions.md) | TypeScript/JavaScript and CSS development | - -### Specialized Resources - -**Custom Agents** (`.github/agents/`): - -- [typescript-hugo-agent.md](agents/typescript-hugo-agent.md) - TypeScript/Hugo development -- [copilot-instructions-agent.md](agents/copilot-instructions-agent.md) - Managing Copilot instructions - -**Claude Skills** (`.claude/skills/` - detailed workflows): - -- [content-editing](../.claude/skills/content-editing/SKILL.md) - Complete content workflow -- [docs-cli-workflow](../.claude/skills/docs-cli-workflow/SKILL.md) - CLI decision guidance -- [cypress-e2e-testing](../.claude/skills/cypress-e2e-testing/SKILL.md) - E2E testing -- [hugo-template-dev](../.claude/skills/hugo-template-dev/SKILL.md) - Hugo templates -- [influxdb3-test-setup](../.claude/skills/influxdb3-test-setup/SKILL.md) - InfluxDB 3 setup -- [vale-linting](../.claude/skills/vale-linting/SKILL.md) - Vale configuration and debugging - -**Documentation**: - -- [DOCS-TESTING.md](../DOCS-TESTING.md) - Testing procedures -- [DOCS-CONTRIBUTING.md](../DOCS-CONTRIBUTING.md) - Contribution guidelines -- [DOCS-FRONTMATTER.md](../DOCS-FRONTMATTER.md) - Frontmatter reference -- [DOCS-SHORTCODES.md](../DOCS-SHORTCODES.md) - Shortcodes reference - -## Important Notes - -- This is a large site (5,359+ pages) with complex build processes -- **NEVER CANCEL** long-running operations (Hugo builds, tests) -- Set appropriate timeouts: Hugo build (180s+), tests (30+ minutes) diff --git a/.github/instructions/content-review.instructions.md b/.github/instructions/content-review.instructions.md new file mode 100644 index 000000000..185786556 --- /dev/null +++ b/.github/instructions/content-review.instructions.md @@ -0,0 +1,76 @@ +--- +applyTo: "content/**/*.md" +--- + +# Content Review Criteria + +Review documentation changes against these rules. Only flag issues you are +confident about. Reference the linked docs for detailed rules. + +## Frontmatter + +Rules: [DOCS-FRONTMATTER.md](../../DOCS-FRONTMATTER.md) + +- `title` and `description` are required on every page +- `menu` structure matches the product's menu key +- `weight` is present for pages in navigation +- `source` paths point to valid `/shared/` paths +- No duplicate or conflicting frontmatter keys + +## Shortcode Syntax + +Rules: [DOCS-SHORTCODES.md](../../DOCS-SHORTCODES.md) + +- `{{< >}}` for HTML output, `{{% %}}` for Markdown-processed content +- Closing tags match opening tags +- Required parameters are present +- Callouts use GitHub-style syntax: `> [!Note]`, `> [!Warning]`, etc. + +## Heading Hierarchy + +- No h1 headings in content (h1 comes from `title` frontmatter) +- Headings don't skip levels (h2 -> h4 without h3) + +## Semantic Line Feeds + +Rules: [DOCS-CONTRIBUTING.md](../../DOCS-CONTRIBUTING.md) + +- One sentence per line (better diffs) +- Long sentences on their own line, not concatenated + +## Terminology and Product Names + +Products defined in [data/products.yml](../../data/products.yml): + +- Use official names: "InfluxDB 3 Core", "InfluxDB 3 Enterprise", + "InfluxDB Cloud Serverless", "InfluxDB Cloud Dedicated" +- Don't mix v2/v3 terminology (e.g., "bucket" in v3 Core docs) +- Version references match the content path + +## Links + +- Internal links use relative paths or Hugo `relref` shortcodes +- No hardcoded `docs.influxdata.com` links in content files +- Anchor links match actual heading IDs + +## Code Blocks + +- Use `python` not `py` for language identifiers (pytest requirement) +- Long options in CLI examples (`--output` not `-o`) +- Keep lines within 80 characters +- Include language identifier on fenced code blocks + +## Shared Content + +- `source:` frontmatter points to an existing shared file +- Shared files don't contain frontmatter (only content) +- Changes to shared content affect multiple products — flag if unintentional + +## Severity + +- **BLOCKING**: Broken rendering, wrong product names, missing required + frontmatter, malformed shortcodes, h1 in content body +- **WARNING**: Missing semantic line feeds, skipped heading levels, missing + `weight`, long CLI options not used +- **INFO**: Suggestions, code block missing language identifier, opportunities + to use shared content diff --git a/.github/prompts/copilot-visual-review.md b/.github/prompts/copilot-visual-review.md new file mode 100644 index 000000000..2ce9de154 --- /dev/null +++ b/.github/prompts/copilot-visual-review.md @@ -0,0 +1,34 @@ +# Visual Review Prompt + +Review the rendered documentation pages at the preview URLs listed below. +Check each page for visual and structural issues that are invisible in the +Markdown source. + +## Checklist + +For each preview URL, verify: + +- [ ] **No raw shortcodes** — No `{{<` or `{{%` syntax visible on the page +- [ ] **No placeholder text** — No `PLACEHOLDER`, `TODO`, `FIXME`, or + template variables visible in rendered content +- [ ] **Layout intact** — No overlapping text, missing images, or collapsed + sections +- [ ] **Code blocks render correctly** — No raw HTML fences or Markdown + syntax visible inside code blocks +- [ ] **Product names correct** — Page header, breadcrumbs, and sidebar show + the correct product name +- [ ] **No 404s or errors** — Page loads without error states +- [ ] **Navigation correct** — Sidebar entries link to the right pages and + the page appears in the expected location + +## Output + +Follow the shared review comment format, severity definitions, and label +mapping in +[templates/review-comment.md](../templates/review-comment.md). + +Adapt the "Files Reviewed" section to list preview URLs instead of file +paths. + +## Preview URLs + diff --git a/.github/scripts/resolve-review-urls.js b/.github/scripts/resolve-review-urls.js new file mode 100644 index 000000000..8869555d7 --- /dev/null +++ b/.github/scripts/resolve-review-urls.js @@ -0,0 +1,38 @@ +/** + * Resolve Review URLs + * + * Maps changed content files to URL paths for the doc-review workflow. + * Reuses the same content-utils functions as detect-preview-pages.js. + * + * Outputs (for GitHub Actions): + * - urls: JSON array of URL paths + * - url-count: Number of URLs + */ + +import { appendFileSync } from 'fs'; +import { + getChangedContentFiles, + mapContentToPublic, +} from '../../scripts/lib/content-utils.js'; + +const GITHUB_OUTPUT = process.env.GITHUB_OUTPUT || '/dev/stdout'; +const BASE_REF = process.env.BASE_REF || 'origin/master'; +const MAX_PAGES = 50; + +if (!/^origin\/[a-zA-Z0-9._/-]+$/.test(BASE_REF)) { + console.error(`Invalid BASE_REF: ${BASE_REF}`); + process.exit(1); +} + +const changed = getChangedContentFiles(BASE_REF); +const htmlPaths = mapContentToPublic(changed, 'public'); + +const urls = Array.from(htmlPaths) + .sort() + .map((p) => '/' + p.replace(/^public\//, '').replace(/\/index\.html$/, '/')) + .slice(0, MAX_PAGES); + +appendFileSync(GITHUB_OUTPUT, `urls=${JSON.stringify(urls)}\n`); +appendFileSync(GITHUB_OUTPUT, `url-count=${urls.length}\n`); + +console.log(`Detected ${urls.length} preview URLs`); diff --git a/.github/scripts/workflow-utils.js b/.github/scripts/workflow-utils.js new file mode 100644 index 000000000..38f49695a --- /dev/null +++ b/.github/scripts/workflow-utils.js @@ -0,0 +1,104 @@ +/** + * Workflow Utilities + * + * Canonical import for GitHub Actions workflow scripts. Re-exports shared + * utilities from scripts/lib/ and adds workflow-specific helpers. + * + * Usage from github-script inline steps: + * + * const utils = await import(`${process.cwd()}/.github/scripts/workflow-utils.js`); + * const pathToLabel = await utils.getProductLabelMap(); + * const labels = utils.matchFilesToLabels(changedFiles, pathToLabel); + * + * Usage from .github/scripts/ ESM modules: + * + * import { getProductLabelMap, findPagesReferencingSharedContent } from './workflow-utils.js'; + */ + +import { readFileSync } from 'fs'; +import { findPagesReferencingSharedContent } from '../../scripts/lib/content-utils.js'; + +// --- Re-export content utilities --- +export { + findPagesReferencingSharedContent, + expandSharedContentChanges, + getChangedContentFiles, + mapContentToPublic, + categorizeContentFiles, + getSourceFromFrontmatter, +} from '../../scripts/lib/content-utils.js'; + +/** + * Build a Map of content path prefixes to product label names + * by reading data/products.yml. + * + * Requires `js-yaml` to be installed (e.g., `npm install js-yaml`). + * + * @param {string} [productsPath='data/products.yml'] - Path to products.yml + * @returns {Promise>} Map of "content/{path}/" → "product:{label_group}" + */ +export async function getProductLabelMap(productsPath = 'data/products.yml') { + const { load } = await import('js-yaml'); + const products = load(readFileSync(productsPath, 'utf8')); + const pathToLabel = new Map(); + + for (const product of Object.values(products)) { + const cp = product.content_path; + const lg = product.label_group; + if (!cp || !lg) continue; + + if (typeof cp === 'string' && typeof lg === 'string') { + pathToLabel.set(`content/${cp}/`, `product:${lg}`); + } else if (typeof cp === 'object' && typeof lg === 'object') { + for (const version of Object.keys(cp)) { + if (lg[version]) { + pathToLabel.set(`content/${cp[version]}/`, `product:${lg[version]}`); + } + } + } + } + + return pathToLabel; +} + +/** + * Match a list of file paths against the product label map. + * For shared content files, expands to find affected products. + * + * @param {string[]} files - Changed file paths + * @param {Map} pathToLabel - From getProductLabelMap() + * @returns {Set} Set of label names to apply + */ +export function matchFilesToLabels(files, pathToLabel) { + const labels = new Set(); + + for (const file of files) { + if (file.startsWith('content/shared/')) { + labels.add('product:shared'); + + try { + const referencingPages = findPagesReferencingSharedContent(file); + for (const page of referencingPages) { + for (const [prefix, label] of pathToLabel) { + if (page.startsWith(prefix)) { + labels.add(label); + break; + } + } + } + } catch { + // Shared content expansion failed — product:shared still applied + } + continue; + } + + for (const [prefix, label] of pathToLabel) { + if (file.startsWith(prefix)) { + labels.add(label); + break; + } + } + } + + return labels; +} diff --git a/.github/templates/review-comment.md b/.github/templates/review-comment.md new file mode 100644 index 000000000..790ff2912 --- /dev/null +++ b/.github/templates/review-comment.md @@ -0,0 +1,98 @@ +# Review Comment Format + +Shared definitions for severity levels, comment structure, and result → label +mapping. Used by doc-review-agent.md (local review sessions) and +copilot-visual-review.md (rendered page review). + +## Severity Levels + +### BLOCKING + +Issues that will cause incorrect rendering, broken pages, or misleading +content. These must be fixed before merge. + +Examples: +- Missing required frontmatter (`title`, `description`) +- Unclosed or malformed shortcode tags +- Wrong product name in content (e.g., "InfluxDB 3" in v2 docs) +- Broken `source:` path for shared content +- h1 heading in content body +- Raw shortcode syntax visible on rendered page (`{{<` or `{{%`) +- 404 errors on preview pages +- Wrong product name in header or breadcrumbs + +### WARNING + +Style issues or minor visual problems that should be fixed but don't break +functionality or correctness. + +Examples: +- Missing semantic line feeds (multiple sentences on one line) +- Heading level skipped (h2 → h4) +- Long option not used in CLI examples (`-o` instead of `--output`) +- Missing `weight` in frontmatter +- Minor layout issues (overlapping text, collapsed sections) +- Missing images +- Placeholder text visible (`TODO`, `FIXME`) + +### INFO + +Suggestions and observations. Not problems. + +Examples: +- Opportunity to use a shared content file +- Unusually long page that could be split +- Code block missing language identifier +- Cosmetic improvements + +## Comment Structure + +Post a single review comment on the PR with this structure: + +```markdown +## Doc Review Summary + +**Result:** APPROVED | CHANGES REQUESTED | NEEDS HUMAN REVIEW + +### Issues Found + +#### BLOCKING + +- **file:line** — Description of the issue + - Suggested fix: ... + +#### WARNING + +- **file:line** — Description of the issue + +#### INFO + +- **file:line** — Observation + +### Files Reviewed + +- `path/to/file.md` — Brief summary of changes +``` + +Adapt the "Files Reviewed" section to the review context: +- **Source review:** list file paths from the diff +- **Visual review (Copilot):** list preview URLs instead of file paths + +## Result Rules + +- Zero BLOCKING issues → **APPROVED** +- Any BLOCKING issues → **CHANGES REQUESTED** +- Cannot determine severity or diff is ambiguous → **NEEDS HUMAN REVIEW** +- Only report issues you are confident about. Do not guess. +- Group issues by file when multiple issues exist in the same file. + +## Result → Label Mapping + +| Result | Label | +|--------|-------| +| APPROVED | `review:approved` | +| CHANGES REQUESTED | `review:changes-requested` | +| NEEDS HUMAN REVIEW | `review:needs-human` | + +Labels are mutually exclusive. Apply manually after review — Copilot code +review uses GitHub's native "Comment" review type and does not manage labels. diff --git a/.github/workflows/auto-label.yml b/.github/workflows/auto-label.yml new file mode 100644 index 000000000..7dfccb43c --- /dev/null +++ b/.github/workflows/auto-label.yml @@ -0,0 +1,122 @@ +name: Auto-label PRs + +on: + pull_request: + types: [opened, synchronize] + workflow_dispatch: + inputs: + pr_number: + description: 'PR number to label' + required: true + type: number + +permissions: {} + +concurrency: + group: auto-label-${{ github.event.number || inputs.pr_number }} + cancel-in-progress: true + +jobs: + auto-label: + runs-on: ubuntu-latest + permissions: + contents: read + pull-requests: write + # Skip draft PRs and fork PRs (workflow_dispatch always runs) + if: | + github.event_name == 'workflow_dispatch' || + (!github.event.pull_request.draft && + github.event.pull_request.head.repo.full_name == github.repository) + steps: + - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1 + with: + persist-credentials: false + sparse-checkout: | + content + data/products.yml + scripts/lib/content-utils.js + .github/scripts/workflow-utils.js + package.json + sparse-checkout-cone-mode: false + + - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 + with: + node-version: 22 + + - name: Install js-yaml + run: npm install --no-save --ignore-scripts --no-package-lock --legacy-peer-deps js-yaml + + - name: Apply product labels + uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b # v7.1.0 + with: + script: | + const { + getProductLabelMap, + matchFilesToLabels, + } = await import( + `${process.cwd()}/.github/scripts/workflow-utils.js` + ); + + const prNumber = + context.issue.number || + Number('${{ inputs.pr_number }}'); + + if (!prNumber) { + core.setFailed('No PR number available'); + return; + } + + // --- Build path-to-label mapping from products.yml --- + const pathToLabel = await getProductLabelMap(); + core.info( + `Loaded ${pathToLabel.size} path-to-label mappings from products.yml` + ); + + // --- Get changed files from the PR (paginated) --- + const files = await github.paginate( + github.rest.pulls.listFiles, + { + owner: context.repo.owner, + repo: context.repo.repo, + pull_number: prNumber, + per_page: 100, + } + ); + + const changedFiles = files.map(f => f.filename); + core.info(`PR has ${changedFiles.length} changed files`); + + // --- Match files to product labels --- + const labelsToAdd = matchFilesToLabels(changedFiles, pathToLabel); + + if (labelsToAdd.size === 0) { + core.info('No product labels to add'); + return; + } + + // --- Get existing PR labels to avoid duplicates --- + const { data: prData } = await github.rest.issues.get({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: prNumber, + }); + + const existingLabels = new Set(prData.labels.map(l => l.name)); + const newLabels = [...labelsToAdd].filter( + l => !existingLabels.has(l) + ); + + if (newLabels.length === 0) { + core.info('All matching labels already present'); + return; + } + + // --- Apply labels --- + await github.rest.issues.addLabels({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: prNumber, + labels: newLabels, + }); + + core.info(`Added labels: ${newLabels.join(', ')}`); diff --git a/.github/workflows/doc-review.yml b/.github/workflows/doc-review.yml new file mode 100644 index 000000000..9ccf81b2a --- /dev/null +++ b/.github/workflows/doc-review.yml @@ -0,0 +1,264 @@ +name: Doc Review + +on: + pull_request: + types: [opened, synchronize, ready_for_review] + paths: + - 'content/**' + - 'layouts/**' + - 'assets/**' + - 'data/**' + workflow_dispatch: + inputs: + pr_number: + description: 'PR number to review' + required: true + type: number + +permissions: {} + +concurrency: + group: doc-review-${{ github.event.number || inputs.pr_number }} + cancel-in-progress: true + +jobs: + # ----------------------------------------------------------------- + # Job 1: Resolve preview URLs from changed content files + # ----------------------------------------------------------------- + resolve-urls: + runs-on: ubuntu-latest + permissions: + contents: read + pull-requests: read + if: | + github.event_name == 'workflow_dispatch' || + (!github.event.pull_request.draft && + github.event.pull_request.head.repo.full_name == github.repository && + !contains(github.event.pull_request.labels.*.name, 'skip-review')) + outputs: + urls: ${{ steps.detect.outputs.urls }} + url-count: ${{ steps.detect.outputs.url-count }} + steps: + - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1 + with: + persist-credentials: false + fetch-depth: 0 + sparse-checkout: | + content + data/products.yml + scripts/lib/content-utils.js + .github/scripts/resolve-review-urls.js + package.json + sparse-checkout-cone-mode: false + + - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 + with: + node-version: 22 + + - name: Resolve base ref + id: base + env: + GH_TOKEN: ${{ github.token }} + PR_NUMBER: ${{ github.event.pull_request.number || inputs.pr_number }} + run: | + if [ -n "${{ github.base_ref }}" ]; then + echo "ref=origin/${{ github.base_ref }}" >> "$GITHUB_OUTPUT" + else + BASE=$(gh pr view "$PR_NUMBER" --repo "${{ github.repository }}" --json baseRefName -q .baseRefName) + git fetch origin "$BASE" + echo "ref=origin/$BASE" >> "$GITHUB_OUTPUT" + fi + + - name: Detect changed pages + id: detect + env: + BASE_REF: ${{ steps.base.outputs.ref }} + run: node .github/scripts/resolve-review-urls.js + + # ----------------------------------------------------------------- + # Job 2: Copilot code review (runs in parallel with Job 1) + # ----------------------------------------------------------------- + copilot-review: + runs-on: ubuntu-latest + permissions: + pull-requests: write + if: | + github.event_name == 'workflow_dispatch' || + (!github.event.pull_request.draft && + github.event.pull_request.head.repo.full_name == github.repository && + !contains(github.event.pull_request.labels.*.name, 'skip-review')) + steps: + - name: Request Copilot review + env: + GH_TOKEN: ${{ github.token }} + PR_NUMBER: ${{ github.event.pull_request.number || inputs.pr_number }} + REPO: ${{ github.repository }} + run: gh pr edit "$PR_NUMBER" --repo "$REPO" --add-reviewer "copilot-reviews" + + # ----------------------------------------------------------------- + # Job 3: Copilot visual review (depends on Job 1 for URLs) + # ----------------------------------------------------------------- + copilot-visual-review: + runs-on: ubuntu-latest + permissions: + contents: read + pull-requests: write + needs: resolve-urls + if: needs.resolve-urls.result == 'success' && fromJson(needs.resolve-urls.outputs.url-count) > 0 + steps: + - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1 + with: + persist-credentials: false + sparse-checkout: .github/prompts/copilot-visual-review.md + sparse-checkout-cone-mode: false + + - name: Wait for preview deployment + id: wait + env: + PR_NUMBER: ${{ github.event.pull_request.number || inputs.pr_number }} + run: | + PREVIEW_URL="https://influxdata.github.io/docs-v2/pr-preview/pr-${PR_NUMBER}/" + TIMEOUT=600 # 10 minutes + INTERVAL=15 + ELAPSED=0 + + echo "Waiting for preview at ${PREVIEW_URL}" + + while [ "$ELAPSED" -lt "$TIMEOUT" ]; do + STATUS=$(curl -s -o /dev/null -L -w "%{http_code}" "$PREVIEW_URL" || echo "000") + if [ "$STATUS" = "200" ]; then + echo "Preview is live" + echo "available=true" >> "$GITHUB_OUTPUT" + exit 0 + fi + echo "Status: ${STATUS} (${ELAPSED}s / ${TIMEOUT}s)" + sleep "$INTERVAL" + ELAPSED=$((ELAPSED + INTERVAL)) + done + + echo "Preview deployment timed out after ${TIMEOUT}s" + echo "available=false" >> "$GITHUB_OUTPUT" + + - name: Post visual review request + if: steps.wait.outputs.available == 'true' + uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b # v7.1.0 + env: + PREVIEW_URLS: ${{ needs.resolve-urls.outputs.urls }} + PR_NUMBER: ${{ github.event.pull_request.number || inputs.pr_number }} + with: + script: | + const fs = require('fs'); + + let urls; + try { + urls = JSON.parse(process.env.PREVIEW_URLS); + } catch (e) { + core.warning(`Failed to parse PREVIEW_URLS: ${e.message}`); + return; + } + + const prNumber = context.issue.number || Number(process.env.PR_NUMBER); + const previewBase = `https://influxdata.github.io/docs-v2/pr-preview/pr-${prNumber}`; + + // Build preview URL list + const urlList = urls + .map(u => `- [${u}](${previewBase}${u})`) + .join('\n'); + + // Read the Copilot visual review template + const template = fs.readFileSync( + '.github/prompts/copilot-visual-review.md', + 'utf8' + ); + + const marker = ''; + const body = [ + marker, + '## Preview Pages for Review', + '', + `${urls.length} page(s) changed in this PR:`, + '', + '
', + 'Preview URLs', + '', + urlList, + '', + '
', + '', + '---', + '', + `@copilot please review the preview pages listed above using the template below:`, + '', + template.trim(), + '', + urlList, + ].join('\n'); + + // Update existing comment or create new one + const { data: comments } = await github.rest.issues.listComments({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: prNumber, + }); + const existing = comments.find(c => c.body.includes(marker)); + + if (existing) { + await github.rest.issues.updateComment({ + owner: context.repo.owner, + repo: context.repo.repo, + comment_id: existing.id, + body, + }); + } else { + await github.rest.issues.createComment({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: prNumber, + body, + }); + } + + core.info(`Posted visual review request with ${urls.length} URLs`); + + - name: Post timeout notice + if: steps.wait.outputs.available == 'false' + uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b # v7.1.0 + env: + PR_NUMBER: ${{ github.event.pull_request.number || inputs.pr_number }} + with: + script: | + const prNumber = context.issue.number || Number(process.env.PR_NUMBER); + const marker = ''; + const body = [ + marker, + '## Visual Review Skipped', + '', + 'The PR preview deployment did not become available within 10 minutes.', + 'Visual review was skipped. The Copilot code review (Job 2) still ran.', + '', + 'To trigger visual review manually, re-run this workflow after the', + 'preview is deployed.', + ].join('\n'); + + const { data: comments } = await github.rest.issues.listComments({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: prNumber, + }); + const existing = comments.find(c => c.body.includes(marker)); + + if (existing) { + await github.rest.issues.updateComment({ + owner: context.repo.owner, + repo: context.repo.repo, + comment_id: existing.id, + body, + }); + } else { + await github.rest.issues.createComment({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: prNumber, + body, + }); + } diff --git a/.github/workflows/sync-plugins.yml b/.github/workflows/sync-plugins.yml index 50c9ecb4e..d840f4247 100644 --- a/.github/workflows/sync-plugins.yml +++ b/.github/workflows/sync-plugins.yml @@ -25,7 +25,7 @@ jobs: # Only run on issues with sync-plugin-docs label or manual dispatch if: | github.event_name == 'workflow_dispatch' || - (github.event_name == 'issues' && contains(github.event.issue.labels.*.name, 'sync-plugin-docs')) + (github.event_name == 'issues' && contains(github.event.issue.labels.*.name, 'source:sync')) steps: - name: Parse issue inputs @@ -170,7 +170,7 @@ jobs: repo: context.repo.repo, issue_number: parseInt(issueNumber), state: 'closed', - labels: ['sync-plugin-docs', 'validation-failed'] + labels: ['source:sync', 'validation-failed'] }); } @@ -418,7 +418,7 @@ jobs: repo: context.repo.repo, issue_number: ${{ steps.inputs.outputs.issue_number }}, state: 'closed', - labels: ['sync-plugin-docs', 'completed'] + labels: ['source:sync', 'completed'] }); - name: Report failure diff --git a/AGENTS.md b/AGENTS.md index ecc293d22..c05d86e2b 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,240 +1,99 @@ # InfluxData Documentation (docs-v2) -> **For general AI assistants (Claude, ChatGPT, Gemini, etc.)** -> -> This guide provides comprehensive instructions for AI assistants helping with the InfluxData documentation repository. It focuses on content creation, writing workflows, and style guidelines. -> +> **Shared project guidelines for all AI assistants** +> > **Other instruction resources**: -> - [.github/copilot-instructions.md](.github/copilot-instructions.md) - For GitHub Copilot (focused on coding and automation) -> - [CLAUDE.md](CLAUDE.md) - For Claude with MCP (minimal pointer) +> - [.github/copilot-instructions.md](.github/copilot-instructions.md) - GitHub Copilot (CLI tools, workflows, repo structure) +> - [CLAUDE.md](CLAUDE.md) - Claude with MCP (pointer file) > - [.claude/](.claude/) - Claude MCP configuration (commands, agents, skills) > - [.github/instructions/](.github/instructions/) - File pattern-specific instructions -## Project Overview +## Commands -This repository powers [docs.influxdata.com](https://docs.influxdata.com), a Hugo-based static documentation site covering InfluxDB 3, InfluxDB v2/v1, Telegraf, and related products. - -**Key Characteristics:** -- **Scale**: 5,359+ pages -- **Build time**: ~75 seconds (NEVER cancel Hugo builds) -- **Tech stack**: Hugo, Node.js, Docker, Vale, Pytest, Cypress -- **Test time**: 15-45 minutes for full code block tests - -## Quick Commands - -| Task | Command | Time | -|------|---------|------| -| Install dependencies | `CYPRESS_INSTALL_BINARY=0 yarn install` | ~4s | -| Build site | `npx hugo --quiet` | ~75s | -| Dev server | `npx hugo server` | ~92s | -| Test code blocks | `yarn test:codeblocks:all` | 15-45m | +| Task | Command | Notes | +|------|---------|-------| +| Install | `CYPRESS_INSTALL_BINARY=0 yarn install` | ~4s | +| Build | `npx hugo --quiet` | ~75s — **NEVER CANCEL** | +| Dev server | `npx hugo server` | ~92s, port 1313 | +| Test code blocks | `yarn test:codeblocks:all` | 15-45m — **NEVER CANCEL** | | Lint | `yarn lint` | ~1m | -## Repository Structure +## Constraints -``` -docs-v2/ -├── content/ # Documentation content -│ ├── influxdb3/ # InfluxDB 3 (core, enterprise, cloud-*) -│ ├── influxdb/ # InfluxDB v2 and v1 -│ ├── enterprise_influxdb/ # InfluxDB Enterprise v1 -│ ├── telegraf/ # Telegraf docs -│ ├── shared/ # Shared content across products -│ └── example.md # Shortcode testing playground -├── layouts/ # Hugo templates and shortcodes -├── assets/ # JS, CSS, TypeScript -├── api-docs/ # OpenAPI specifications -├── data/ # YAML/JSON data files -├── public/ # Build output (gitignored, ~529MB) -└── .github/ - └── copilot-instructions.md # Primary AI instructions -``` +- **NEVER cancel** Hugo builds (~75s) or test runs (15-45m) — the site has 5,359+ pages +- Set timeouts: Hugo 180s+, tests 30m+ +- Use `python` not `py` for code block language identifiers (pytest won't collect `py` blocks) +- Shared content files (`content/shared/`) have no frontmatter — the consuming page provides it +- Product names and versions come from `data/products.yml` (single source of truth) +- Commit format: `type(scope): description` — see [DOCS-CONTRIBUTING.md](DOCS-CONTRIBUTING.md#commit-guidelines) +- Network-restricted environments: Cypress (`CYPRESS_INSTALL_BINARY=0`), Docker builds, and Alpine packages may fail -**Content Paths**: See [copilot-instructions.md](.github/copilot-instructions.md#content-organization) +## Style Rules -## Common Workflows +Follows [Google Developer Documentation Style Guide](https://developers.google.com/style) with these project-specific additions: -### Editing a page in your browser +- **Semantic line feeds** — one sentence per line (better diffs) +- **No h1 in content** — `title` frontmatter auto-generates h1 +- Active voice, present tense, second person +- Long options in CLI examples (`--output` not `-o`) +- Code blocks within 80 characters -1. Navigate to the desired page on [docs.influxdata.com](https://docs.influxdata.com) -2. Click the "Edit this page" link at the bottom -3. Make changes in the GitHub web editor -4. Commit changes via a pull request +## Content Structure -### Creating/Editing Content Manually +**Required frontmatter**: `title`, `description`, `menu`, `weight` +— see [DOCS-FRONTMATTER.md](DOCS-FRONTMATTER.md) -**Frontmatter** (page metadata): -```yaml -title: Page Title # Required - becomes h1 -description: Brief desc # Required - for SEO -menu: - influxdb_2_0: - name: Nav Label # Optional - nav display name - parent: Parent Node # Optional - for nesting -weight: 1 # Required - sort order -``` +**Shared content**: `source: /shared/path/to/content.md` +— shared files use `{{% show-in %}}` / `{{% hide-in %}}` for product-specific content -**Shared Content** (avoid duplication): -```yaml -source: /shared/path/to/content.md -``` +**Shortcodes**: Callouts use `> [!Note]` / `> [!Warning]` syntax +— see [DOCS-SHORTCODES.md](DOCS-SHORTCODES.md) and [content/example.md](content/example.md) -Shared content files (`/shared/path/to/content.md`): -- Don't store frontmatter -- Can use `{{% show-in %}}`, `{{% hide-in %}}`, and the `version` keyword (`/influxdb3/version/content.md`) +## Product Content Paths -**Common Shortcodes**: -- Callouts: `> [!Note]`, `> [!Warning]`, `> [!Important]`, `> [!Tip]` -- Tabs: `{{< tabs-wrapper >}}` + `{{% tabs %}}` + `{{% tab-content %}}` -- Required: `{{< req >}}` or `{{< req type="key" >}}` -- Code placeholders: `{ placeholders="" }` +Canonical paths from `data/products.yml`: -**📖 Complete Reference**: [DOCS-SHORTCODES.md](DOCS-SHORTCODES.md) | [DOCS-FRONTMATTER.md](DOCS-FRONTMATTER.md) +| Product | Content Path | +|---------|-------------| +| InfluxDB 3 Core | `content/influxdb3/core/` | +| InfluxDB 3 Enterprise | `content/influxdb3/enterprise/` | +| InfluxDB 3 Explorer | `content/influxdb3/explorer/` | +| InfluxDB Cloud Serverless | `content/influxdb3/cloud-serverless/` | +| InfluxDB Cloud Dedicated | `content/influxdb3/cloud-dedicated/` | +| InfluxDB Clustered | `content/influxdb3/clustered/` | +| InfluxDB OSS v2 | `content/influxdb/v2/` | +| InfluxDB OSS v1 | `content/influxdb/v1/` | +| InfluxDB Cloud (TSM) | `content/influxdb/cloud/` | +| InfluxDB Enterprise v1 | `content/enterprise_influxdb/` | +| Telegraf | `content/telegraf/` | +| Chronograf | `content/chronograf/` | +| Kapacitor | `content/kapacitor/` | +| Flux | `content/flux/` | +| Shared content | `content/shared/` | -### Testing Changes +## Doc Review Pipeline -**Always test before committing**: -```bash -# Verify server renders (check 200 status) -curl -s -o /dev/null -w "%{http_code}" http://localhost:1313/influxdb3/core/ +Automated PR review for documentation changes. +See [.github/LABEL_GUIDE.md](.github/LABEL_GUIDE.md) for the label taxonomy. -# Test specific content -yarn test:links content/influxdb3/core/**/*.md +| Resource | Path | +|----------|------| +| Label guide | [.github/LABEL_GUIDE.md](.github/LABEL_GUIDE.md) | +| Triage agent | [.claude/agents/doc-triage-agent.md](.claude/agents/doc-triage-agent.md) | +| Content review instructions | [.github/instructions/content-review.instructions.md](.github/instructions/content-review.instructions.md) | +| Review agent (local) | [.claude/agents/doc-review-agent.md](.claude/agents/doc-review-agent.md) | +| Auto-label workflow | [.github/workflows/auto-label.yml](.github/workflows/auto-label.yml) | +| Doc review workflow | [.github/workflows/doc-review.yml](.github/workflows/doc-review.yml) | -# Run style linting -.ci/vale/vale.sh content/**/*.md -``` - -**📖 Complete Reference**: [DOCS-TESTING.md](DOCS-TESTING.md) - -### Committing Changes - -**Commit Message Format**: -``` -type(scope): description - -Examples: -- fix(enterprise): correct Docker environment variable -- feat(influxdb3): add new plugin documentation -- docs(core): update configuration examples -``` - -**Types**: `fix`, `feat`, `style`, `refactor`, `test`, `chore` - -**Scopes**: `enterprise`, `influxdb3`, `core`, `cloud`, `telegraf`, etc. - -**Pre-commit hooks** run automatically (Vale, Prettier, tests). Skip with: -```bash -git commit -m "message" --no-verify -``` - -**📖 Complete Reference**: [DOCS-CONTRIBUTING.md](DOCS-CONTRIBUTING.md#commit-guidelines) - -## Key Patterns - -### Content Organization - -- **Product versions**: Managed in `/data/products.yml` -- **Semantic line feeds**: One sentence per line for better diffs -- **Heading hierarchy**: Use h2-h6 only (h1 auto-generated from frontmatter) -- **Image naming**: `project/version-context-description.png` - -### Code Examples - -**Testable code blocks** (pytest): -```python -print("Hello, world!") -``` - - - -``` -Hello, world! -``` - -**Language identifiers**: Use `python` not `py`, `bash` not `sh` (for pytest collection) - -### API Documentation - -- **Location**: `/api-docs/` directory -- **Format**: OpenAPI 3.0 YAML -- **Generation**: Uses Redoc + custom processing -- **📖 Workflow**: [api-docs/README.md](api-docs/README.md) - -### JavaScript/TypeScript - -- **Entry point**: `assets/js/main.js` -- **Pattern**: Component-based with `data-component` attributes -- **Debugging**: Source maps or debug helpers available -- **📖 Details**: [DOCS-CONTRIBUTING.md](DOCS-CONTRIBUTING.md#javascript-in-the-documentation-ui) - -## Important Constraints - -### Performance -- **NEVER cancel Hugo builds** - they take ~75s normally -- **NEVER cancel test runs** - code block tests take 15-45 minutes -- **Set timeouts**: Hugo (180s+), tests (30+ minutes) - -### Style Guidelines -- Use Google Developer Documentation style -- Active voice, present tense, second person for instructions -- No emojis unless explicitly requested -- Use long options in CLI examples (`--option` vs `-o`) -- Format code blocks within 80 characters - -### Network Restrictions -Some operations may fail in restricted environments: -- Docker builds requiring external repos -- `docker compose up local-dev` (Alpine packages) -- Cypress installation (use `CYPRESS_INSTALL_BINARY=0`) - -## Documentation References +## Reference | Document | Purpose | |----------|---------| -| [DOCS-CONTRIBUTING.md](DOCS-CONTRIBUTING.md) | Contribution workflow, style guidelines | -| [DOCS-TESTING.md](DOCS-TESTING.md) | Testing procedures (code blocks, links, linting) | +| [DOCS-CONTRIBUTING.md](DOCS-CONTRIBUTING.md) | Style guidelines, commit format, contribution workflow | +| [DOCS-TESTING.md](DOCS-TESTING.md) | Code block testing, link validation, Vale linting | | [DOCS-SHORTCODES.md](DOCS-SHORTCODES.md) | Complete shortcode reference | | [DOCS-FRONTMATTER.md](DOCS-FRONTMATTER.md) | Complete frontmatter field reference | -| [.github/copilot-instructions.md](.github/copilot-instructions.md) | Primary AI assistant instructions | | [api-docs/README.md](api-docs/README.md) | API documentation workflow | -| [content/example.md](content/example.md) | Live shortcode examples for testing | - -## Specialized Topics - -### Working with Specific Products - -| Product | Content Path | Special Notes | -|---------|-------------|---------------| -| InfluxDB 3 Core | `/content/influxdb3/core/` | Latest architecture | -| InfluxDB 3 Enterprise | `/content/influxdb3/enterprise/` | Core + licensed features, clustered | -| InfluxDB Cloud Dedicated | `/content/influxdb3/cloud-dedicated/`, `/content/influxdb3/cloud-serverless/` | Managed and distributed | -| InfluxDB Clustered | `/content/influxdb3/clustered/` | Self-managed and distributed | -| InfluxDB Cloud | `/content/influxdb/cloud/` | Legacy but active | -| InfluxDB v2 | `/content/influxdb/v2/` | Legacy but active | -| InfluxDB Enterprise v1 | `/content/enterprise_influxdb/v1/` | Legacy but active enterprise, clustered | - -### Advanced Tasks - -- **Vale configuration**: `.ci/vale/styles/` for custom rules -- **Link checking**: Uses custom `link-checker` binary -- **Docker testing**: `compose.yaml` defines test services -- **Lefthook**: Git hooks configuration in `lefthook.yml` - -## Troubleshooting - -| Issue | Solution | -|-------|----------| -| Pytest collected 0 items | Use `python` not `py` for code block language | -| Hugo build errors | Check `/config/_default/` configuration | -| Link validation slow | Test specific files: `yarn test:links content/file.md` | -| Vale errors | Check `.ci/vale/styles/config/vocabularies` | - -## Critical Reminders - -1. **Be a critical thinking partner** - Challenge assumptions, identify issues -2. **Test before committing** - Run relevant tests locally -3. **Reference, don't duplicate** - Link to detailed docs instead of copying -4. **Respect build times** - Don't cancel long-running operations -5. **Follow conventions** - Use established patterns for consistency - +| [content/example.md](content/example.md) | Live shortcode examples | +| [.github/copilot-instructions.md](.github/copilot-instructions.md) | CLI tools, repo structure, workflows | +| [.github/LABEL_GUIDE.md](.github/LABEL_GUIDE.md) | Label taxonomy and review pipeline | diff --git a/CLAUDE.md b/CLAUDE.md index fe99fa453..a549ac075 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -6,7 +6,8 @@ > > **Full instruction resources**: > - [.github/copilot-instructions.md](.github/copilot-instructions.md) - For GitHub Copilot (technical setup, automation) -> - [AGENTS.md](AGENTS.md) - For general AI assistants (content creation, workflows, style guidelines) +> - [AGENTS.md](AGENTS.md) - Shared project guidelines (style, constraints, content structure) +> - [.github/LABEL_GUIDE.md](.github/LABEL_GUIDE.md) - Label taxonomy and pipeline usage > - [.claude/](.claude/) - Claude MCP configuration directory with: > - Custom commands in `.claude/commands/` > - Specialized agents in `.claude/agents/` diff --git a/content/influxdb3/core/reference/cli/influxdb3/serve.md b/content/influxdb3/core/reference/cli/influxdb3/serve.md index 35fdd5835..b087a11e7 100644 --- a/content/influxdb3/core/reference/cli/influxdb3/serve.md +++ b/content/influxdb3/core/reference/cli/influxdb3/serve.md @@ -63,7 +63,7 @@ influxdb3 serve [OPTIONS] | | `--aws-session-token` | _See [configuration options](/influxdb3/core/reference/config-options/#aws-session-token)_ | | | `--aws-skip-signature` | _See [configuration options](/influxdb3/core/reference/config-options/#aws-skip-signature)_ | | | `--azure-allow-http` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#azure-allow-http)_ | -| | `--azure-endpoint` | _See [configuration options](/influxdb3/enterprise/reference/config-options/##azure-endpoint)_ | +| | `--azure-endpoint` | _See [configuration options](/influxdb3/core/reference/config-options/#azure-endpoint)_ | | | `--azure-storage-access-key` | _See [configuration options](/influxdb3/core/reference/config-options/#azure-storage-access-key)_ | | | `--azure-storage-account` | _See [configuration options](/influxdb3/core/reference/config-options/#azure-storage-account)_ | | | `--bucket` | _See [configuration options](/influxdb3/core/reference/config-options/#bucket)_ | @@ -71,14 +71,14 @@ influxdb3 serve [OPTIONS] | | `--datafusion-config` | _See [configuration options](/influxdb3/core/reference/config-options/#datafusion-config)_ | | | `--datafusion-max-parquet-fanout` | _See [configuration options](/influxdb3/core/reference/config-options/#datafusion-max-parquet-fanout)_ | | | `--datafusion-num-threads` | _See [configuration options](/influxdb3/core/reference/config-options/#datafusion-num-threads)_ | -| | `--datafusion-runtime-disable-lifo-slot` | _See [configuration options](/influxdb3/core/reference/config-options/#datafusion-runtime-disable-lifo-slot)_ | -| | `--datafusion-runtime-event-interval` | _See [configuration options](/influxdb3/core/reference/config-options/#datafusion-runtime-event-interval)_ | -| | `--datafusion-runtime-global-queue-interval` | _See [configuration options](/influxdb3/core/reference/config-options/#datafusion-runtime-global-queue-interval)_ | -| | `--datafusion-runtime-max-blocking-threads` | _See [configuration options](/influxdb3/core/reference/config-options/#datafusion-runtime-max-blocking-threads)_ | -| | `--datafusion-runtime-max-io-events-per-tick` | _See [configuration options](/influxdb3/core/reference/config-options/#datafusion-runtime-max-io-events-per-tick)_ | -| | `--datafusion-runtime-thread-keep-alive` | _See [configuration options](/influxdb3/core/reference/config-options/#datafusion-runtime-thread-keep-alive)_ | -| | `--datafusion-runtime-thread-priority` | _See [configuration options](/influxdb3/core/reference/config-options/#datafusion-runtime-thread-priority)_ | -| | `--datafusion-runtime-type` | _See [configuration options](/influxdb3/core/reference/config-options/#datafusion-runtime-type)_ | +| | `--datafusion-runtime-disable-lifo-slot` | Development-only Tokio runtime configuration | +| | `--datafusion-runtime-event-interval` | Development-only Tokio runtime configuration | +| | `--datafusion-runtime-global-queue-interval` | Development-only Tokio runtime configuration | +| | `--datafusion-runtime-max-blocking-threads` | Development-only Tokio runtime configuration | +| | `--datafusion-runtime-max-io-events-per-tick` | Development-only Tokio runtime configuration | +| | `--datafusion-runtime-thread-keep-alive` | Development-only Tokio runtime configuration | +| | `--datafusion-runtime-thread-priority` | Development-only Tokio runtime configuration | +| | `--datafusion-runtime-type` | Development-only Tokio runtime configuration | | | `--datafusion-use-cached-parquet-loader` | _See [configuration options](/influxdb3/core/reference/config-options/#datafusion-use-cached-parquet-loader)_ | | | `--delete-grace-period` | _See [configuration options](/influxdb3/core/reference/config-options/#delete-grace-period)_ | | | `--disable-authz` | _See [configuration options](/influxdb3/core/reference/config-options/#disable-authz)_ | @@ -118,7 +118,7 @@ influxdb3 serve [OPTIONS] | | `--table-index-cache-concurrency-limit` | _See [configuration options](/influxdb3/core/reference/config-options/#table-index-cache-concurrency-limit)_ | | | `--table-index-cache-max-entries` | _See [configuration options](/influxdb3/core/reference/config-options/#table-index-cache-max-entries)_ | | | `--tcp-listener-file-path` | _See [configuration options](/influxdb3/core/reference/config-options/#tcp-listener-file-path)_ | -| | `--telemetry-disable-upload` | _See [configuration options](/influxdb3/core/reference/config-options/#telemetry-disable-upload)_ | +| | `--telemetry-disable-upload` | _See [configuration options](/influxdb3/core/reference/config-options/#disable-telemetry-upload)_ | | | `--telemetry-endpoint` | _See [configuration options](/influxdb3/core/reference/config-options/#telemetry-endpoint)_ | | | `--tls-cert` | _See [configuration options](/influxdb3/core/reference/config-options/#tls-cert)_ | | | `--tls-key` | _See [configuration options](/influxdb3/core/reference/config-options/#tls-key)_ | diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/serve.md b/content/influxdb3/enterprise/reference/cli/influxdb3/serve.md index 804a826ec..4ade8944d 100644 --- a/content/influxdb3/enterprise/reference/cli/influxdb3/serve.md +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/serve.md @@ -62,7 +62,7 @@ influxdb3 serve [OPTIONS] | | `--aws-session-token` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#aws-session-token)_ | | | `--aws-skip-signature` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#aws-skip-signature)_ | | | `--azure-allow-http` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#azure-allow-http)_ | -| | `--azure-endpoint` | _See [configuration options](/influxdb3/enterprise/reference/config-options/##azure-endpoint)_ | +| | `--azure-endpoint` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#azure-endpoint)_ | | | `--azure-storage-access-key` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#azure-storage-access-key)_ | | | `--azure-storage-account` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#azure-storage-account)_ | | | `--bucket` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#bucket)_ | @@ -73,19 +73,18 @@ influxdb3 serve [OPTIONS] | | `--compaction-gen2-duration` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compaction-gen2-duration)_ | | | `--compaction-max-num-files-per-plan` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compaction-max-num-files-per-plan)_ | | | `--compaction-multipliers` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compaction-multipliers)_ | -| | `--compaction-row-limit` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compaction-row-limit)_ | | | `--data-dir` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#data-dir)_ | | | `--datafusion-config` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-config)_ | | | `--datafusion-max-parquet-fanout` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-max-parquet-fanout)_ | | | `--datafusion-num-threads` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-num-threads)_ | -| | `--datafusion-runtime-disable-lifo-slot` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-runtime-disable-lifo-slot)_ | -| | `--datafusion-runtime-event-interval` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-runtime-event-interval)_ | -| | `--datafusion-runtime-global-queue-interval` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-runtime-global-queue-interval)_ | -| | `--datafusion-runtime-max-blocking-threads` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-runtime-max-blocking-threads)_ | -| | `--datafusion-runtime-max-io-events-per-tick` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-runtime-max-io-events-per-tick)_ | -| | `--datafusion-runtime-thread-keep-alive` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-runtime-thread-keep-alive)_ | -| | `--datafusion-runtime-thread-priority` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-runtime-thread-priority)_ | -| | `--datafusion-runtime-type` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-runtime-type)_ | +| | `--datafusion-runtime-disable-lifo-slot` | Development-only Tokio runtime configuration | +| | `--datafusion-runtime-event-interval` | Development-only Tokio runtime configuration | +| | `--datafusion-runtime-global-queue-interval` | Development-only Tokio runtime configuration | +| | `--datafusion-runtime-max-blocking-threads` | Development-only Tokio runtime configuration | +| | `--datafusion-runtime-max-io-events-per-tick` | Development-only Tokio runtime configuration | +| | `--datafusion-runtime-thread-keep-alive` | Development-only Tokio runtime configuration | +| | `--datafusion-runtime-thread-priority` | Development-only Tokio runtime configuration | +| | `--datafusion-runtime-type` | Development-only Tokio runtime configuration | | | `--datafusion-use-cached-parquet-loader` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-use-cached-parquet-loader)_ | | | `--delete-grace-period` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#delete-grace-period)_ | | | `--disable-authz` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#disable-authz)_ | @@ -113,7 +112,7 @@ influxdb3 serve [OPTIONS] | | `--node-id` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#node-id)_ | | | `--node-id-from-env` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#node-id-from-env)_ | | | `--num-cores` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#num-cores)_ | -| | `--num-datafusion-threads` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#num-datafusion-threads)_ | +| | `--num-datafusion-threads` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#datafusion-num-threads)_ | | | `--num-database-limit` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#num-database-limit)_ | | | `--num-table-limit` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#num-table-limit)_ | | | `--num-total-columns-per-table-limit` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#num-total-columns-per-table-limit)_ | @@ -140,7 +139,7 @@ influxdb3 serve [OPTIONS] | | `--table-index-cache-concurrency-limit` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#table-index-cache-concurrency-limit)_ | | | `--table-index-cache-max-entries` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#table-index-cache-max-entries)_ | | | `--tcp-listener-file-path` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#tcp-listener-file-path)_ | -| | `--telemetry-disable-upload` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#telemetry-disable-upload)_ | +| | `--telemetry-disable-upload` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#disable-telemetry-upload)_ | | | `--telemetry-endpoint` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#telemetry-endpoint)_ | | | `--tls-cert` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#tls-cert)_ | | | `--tls-key` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#tls-key)_ | diff --git a/data/labels.yml b/data/labels.yml new file mode 100644 index 000000000..a4965bc49 --- /dev/null +++ b/data/labels.yml @@ -0,0 +1,86 @@ +# Label definitions for the docs-v2 repository. +# +# Source of truth for non-product label names, colors, and descriptions. +# Product labels are derived from data/products.yml (label_group + content_path), +# except product:shared which is defined here (applies across products). +# Review label behavior (severity, result rules) is in .github/templates/review-comment.md. +# +# When a label value is a string, it's the description and the group color applies. +# When a label value is an object, it has its own color. + +product: + description: Cross-product labels not derived from a single products.yml entry. + labels: + product:shared: + color: "#FFA500" + description: Shared content that applies to multiple products + +source: + color: "#9370DB" + description: Track how an issue or PR was created. + labels: + source:auto-detected: Created by change detection within this repo + source:dar: Generated by the DAR pipeline + source:sync: Synced from an external repository + source:feedback: From user feedback + source:manual: Human-created issue + +waiting: + color: "#FF8C00" + description: Indicate external blockers. + labels: + waiting:engineering: Waiting for engineer confirmation + waiting:pr: Blocked on another PR merging first + waiting:product: Waiting for product or PM decision + +workflow: + description: Control automation behavior. + labels: + agent-ready: + color: "#00FF00" + description: Issue can be worked autonomously by an agent + skip-review: + color: "#1E90FF" + description: PR skips the automated doc review pipeline + +area: + color: "#a89129" + description: What part of the repo a change affects. + labels: + area:agents: "AI agents, skills, hooks, and MCP config" + area:ci: "Continuous integration pipeline (verify, test, validate, publish)" + area:links: "Link management (validation, checking, fixing)" + area:site-ui: "Documentation site UI: templates, styles, JS/TS" + +release: + description: Release-gated merge workflow. + labels: + release:pending: + color: "#FEF2C0" + description: Waiting for product release before merging + release:ready: + color: "#0E8A16" + description: Product released, docs ready for review/merge + +onboarding: + description: Contributor onboarding. + labels: + good-first-issue: + color: "#f9f348" + description: Easy update. Good for first timers! + +review: + description: >- + Automated review outcomes. Mutually exclusive. + See .github/templates/review-comment.md for severity definitions + and result-to-label mapping. + labels: + review:approved: + color: "#28A745" + description: Automated review passed + review:changes-requested: + color: "#DC3545" + description: Automated review found blocking issues + review:needs-human: + color: "#FFC107" + description: Automated review inconclusive diff --git a/data/products.yml b/data/products.yml index 1a0cbdca5..90d37e054 100644 --- a/data/products.yml +++ b/data/products.yml @@ -2,6 +2,8 @@ influxdb3_core: name: InfluxDB 3 Core altname: InfluxDB 3 Core namespace: influxdb3 + content_path: influxdb3/core + label_group: v3-monolith menu_category: self-managed versions: [core] list_order: 2 @@ -38,6 +40,8 @@ influxdb3_enterprise: name: InfluxDB 3 Enterprise altname: InfluxDB 3 Enterprise namespace: influxdb3 + content_path: influxdb3/enterprise + label_group: v3-monolith menu_category: self-managed versions: [enterprise] list_order: 2 @@ -74,6 +78,8 @@ influxdb3_explorer: name: InfluxDB 3 Explorer altname: Explorer namespace: influxdb3_explorer + content_path: influxdb3/explorer + label_group: explorer menu_category: tools list_order: 1 latest: explorer @@ -90,6 +96,8 @@ influxdb3_cloud_serverless: name: InfluxDB Cloud Serverless altname: InfluxDB Cloud namespace: influxdb + content_path: influxdb3/cloud-serverless + label_group: v3-distributed menu_category: managed versions: [cloud-serverless] list_order: 2 @@ -123,6 +131,8 @@ influxdb3_cloud_dedicated: name: InfluxDB Cloud Dedicated altname: InfluxDB Cloud namespace: influxdb + content_path: influxdb3/cloud-dedicated + label_group: v3-distributed menu_category: managed versions: [cloud-dedicated] list_order: 3 @@ -154,6 +164,8 @@ influxdb3_clustered: name: InfluxDB Clustered altname: InfluxDB Clustered namespace: influxdb + content_path: influxdb3/clustered + label_group: v3-distributed menu_category: self-managed versions: [clustered] list_order: 3 @@ -188,6 +200,12 @@ influxdb: name__v1: InfluxDB OSS v1 altname: InfluxDB OSS namespace: influxdb + content_path: + v2: influxdb/v2 + v1: influxdb/v1 + label_group: + v2: v2 + v1: v1 succeeded_by: influxdb3_core menu_category: self-managed list_order: 1 @@ -233,6 +251,8 @@ influxdb_cloud: name__vcloud: InfluxDB Cloud (TSM) altname: InfluxDB Cloud namespace: influxdb + content_path: influxdb/cloud + label_group: v2-cloud menu_category: managed versions: [cloud] list_order: 1 @@ -262,6 +282,8 @@ influxdb_cloud: telegraf: name: Telegraf namespace: telegraf + content_path: telegraf + label_group: telegraf menu_category: other list_order: 6 versions: [v1] @@ -286,6 +308,8 @@ telegraf_controller: chronograf: name: Chronograf namespace: chronograf + content_path: chronograf + label_group: chronograf menu_category: other list_order: 7 versions: [v1] @@ -301,6 +325,8 @@ chronograf: kapacitor: name: Kapacitor namespace: kapacitor + content_path: kapacitor + label_group: kapacitor menu_category: other list_order: 7 versions: [v1] @@ -316,6 +342,8 @@ kapacitor: enterprise_influxdb: name: 'InfluxDB Enterprise v1' namespace: enterprise_influxdb + content_path: enterprise_influxdb + label_group: v1-enterprise menu_category: self-managed list_order: 5 versions: [v1] @@ -370,6 +398,8 @@ influxdb_cloud1: flux: name: Flux namespace: flux + content_path: flux + label_group: flux menu_category: languages list_order: 8 versions: [v0] diff --git a/docs/plans/2025-01-10-docs-cli-workflow-design.md b/docs/plans/2025-01-10-docs-cli-workflow-design.md deleted file mode 100644 index 1aba665c9..000000000 --- a/docs/plans/2025-01-10-docs-cli-workflow-design.md +++ /dev/null @@ -1,134 +0,0 @@ -# docs-cli-workflow Skill Design - -## Overview - -A Claude Code skill that guides when to use `docs create` and `docs edit` CLI tools versus direct file editing for InfluxData documentation. - -## Problem - -Claude under-utilizes the `docs create` and `docs edit` CLI tools even when they would provide significant value: - -- Better scaffolding for multi-product content -- Context gathering (link extraction, structure analysis) -- Education about style guidelines and shortcodes -- Automatic file location from URLs - -## Skill Identity - -- **Name**: `docs-cli-workflow` -- **Location**: `.claude/skills/docs-cli-workflow/SKILL.md` -- **Scope**: Decision guidance only (not full workflow management) -- **Behavior**: Suggest and wait for user confirmation - -## Activation - -### Trigger Keywords - -The skill activates when user messages contain: - -- "new page", "new doc", "create documentation", "add a page" -- "edit this URL", "edit ", "update this page" (with URL) -- "document this feature", "write docs for" -- "I have a draft", "from this draft" -- References to docs.influxdata.com URLs - -### Non-Triggers (Direct Editing is Fine) - -- "fix this typo in content/..." -- "update the frontmatter in..." -- Explicit file paths the user already knows -- Small edits to existing files user has open - -## Decision Logic - -### When to Suggest `docs create` - -| Trigger | Why CLI is Better | -| ---------------------------------- | --------------------------------------------------------- | -| Content targets multiple products | CLI scaffolds shared content pattern automatically | -| User unsure where page should live | CLI analyzes structure, suggests location | -| Draft references existing docs | CLI extracts links, provides context to avoid duplication | -| User unfamiliar with conventions | CLI prompt includes style guide, shortcode examples | -| Complex new feature documentation | CLI gathers product metadata, version info | - -### When to Suggest `docs edit` - -| Trigger | Why CLI is Better | -| -------------------------------------- | ------------------------------------------------------ | -| User provides docs.influxdata.com URL | CLI finds source file(s) including shared content | -| User doesn't know source file location | CLI maps URL → file path(s) | -| Page uses shared content | CLI identifies both frontmatter file AND shared source | - -### When to Skip CLI (Edit Directly) - -| Scenario | Why Direct is Fine | -| -------------------------------- | ------------------------------- | -| User provides explicit file path | They already know where to edit | -| Small typo/link fixes | Overhead not worth it | -| User says "just edit it" | Explicit preference | -| Frontmatter-only changes | No content generation needed | - -## Suggestion Format - -### For `docs create` - -``` -I'd recommend using the docs CLI for this: - -npx docs create --products - -**Why**: [1-2 sentences explaining the specific benefit for this request] - -Options: -1. **Use CLI** - I'll run the command and guide you through product selection -2. **Edit directly** - Skip the CLI, I'll create/edit files manually - -Which do you prefer? -``` - -### For `docs edit` - -``` -I can use the docs CLI to find the source files for this page: - -npx docs edit - -**Why**: [1-2 sentences - e.g., "This will locate the source file and any shared content it uses"] - -Options: -1. **Use CLI** - I'll find and open the relevant files -2. **I know the file** - Tell me the path and I'll edit directly - -Which do you prefer? -``` - -### Principles - -- Show the actual command (educational) -- Explain *why* for this specific case -- Always offer the direct alternative -- Keep it brief - 4-6 lines max - -## Edge Cases - -| Edge Case | Behavior | -| ---------------------------------------- | ------------------------------------------------------ | -| User already in a `docs create` workflow | Don't re-suggest | -| URL points to non-existent page | Suggest `docs create --url` instead of `docs edit` | -| User provides both URL and draft | Suggest `docs create --url --from-draft ` | -| User declines CLI twice in session | Stop suggesting, note preference | - -## Post-Confirmation Behavior - -After user confirms they want to use the CLI: - -1. Run the appropriate command -2. Let the CLI handle the rest (product selection, file generation, etc.) -3. No additional skill guidance needed - -## Related Files - -- `scripts/docs-cli.js` - Main CLI entry point -- `scripts/docs-create.js` - Content scaffolding implementation -- `scripts/docs-edit.js` - File finder implementation -- `scripts/lib/content-scaffolding.js` - Context preparation logic diff --git a/helper-scripts/label-migration/README.md b/helper-scripts/label-migration/README.md new file mode 100644 index 000000000..99e979d2f --- /dev/null +++ b/helper-scripts/label-migration/README.md @@ -0,0 +1,95 @@ +# Label Migration Scripts + +Migrate the docs-v2 repository from 80+ ad-hoc labels to the 24-label taxonomy +defined in [DOC-REVIEW-PIPELINE-PLAN.md](../../.github/DOC-REVIEW-PIPELINE-PLAN.md). + +## Prerequisites + +- `gh` CLI authenticated with access to `influxdata/docs-v2` +- Run from any directory (scripts use `REPO` env var, defaults to `influxdata/docs-v2`) + +## Execution Order + +### Step 1: Create new labels (safe, idempotent) + +```bash +./create-labels.sh # Creates 24 new labels +./create-labels.sh --dry-run # Preview without creating +``` + +Uses `gh label create --force`, which creates new labels or updates existing +ones. Safe to run multiple times. + +### Step 2: Migrate issues to new labels + +```bash +./migrate-labels.sh # Adds new labels to issues with old labels +./migrate-labels.sh --dry-run # Preview without modifying issues +``` + +Adds new labels to issues/PRs that have old labels. Does NOT remove old labels. +Flags `InfluxDB v3` issues for manual review (may be monolith or distributed). + +### Step 3: Verify migration + +Before deleting old labels, verify a sample of migrated issues: + +```bash +# Check issues with new product labels +gh issue list -R influxdata/docs-v2 -l "product:v3-monolith" --state all +gh issue list -R influxdata/docs-v2 -l "product:v3-distributed" --state all + +# Check the flagged InfluxDB v3 issues +gh issue list -R influxdata/docs-v2 -l "InfluxDB v3" --state all +``` + +### Step 4: Delete old labels (destructive, interactive) + +```bash +./delete-labels.sh # Deletes old labels with confirmation prompts +./delete-labels.sh --dry-run # Preview without deleting +``` + +Prompts for confirmation before each batch of deletions. Batches: +1. Old product labels (15 labels) +2. Old release labels (2 labels) +3. Old source tracking labels (1 label) +4. Renamed labels (2 labels) +5. Unused/generic labels (14 labels) + +### Step 5: Update workflow references + +After deleting `sync-plugin-docs`, update these files to use `source:sync`: +- `.github/workflows/sync-plugins.yml` (lines 28, 173, 421) +- `.github/ISSUE_TEMPLATE/sync-plugin-docs.yml` (line 4) + +## Targeting a different repo + +```bash +REPO=myorg/myrepo ./create-labels.sh +REPO=myorg/myrepo ./migrate-labels.sh --dry-run +``` + +## Rollback + +If something goes wrong after Step 2 (migration): +- Old labels still exist (not deleted until Step 4) +- New labels can be removed: `gh label delete "product:v3-monolith" -R influxdata/docs-v2 --yes` +- Issues retain both old and new labels until old labels are deleted + +If something goes wrong after Step 4 (deletion): +- Old labels are gone but issues retain the new labels +- Re-create old labels manually if needed: `gh label create "InfluxDB v3" -R influxdata/docs-v2 --color EC8909` + +## Label Taxonomy + +See the full taxonomy in [DOC-REVIEW-PIPELINE-PLAN.md](../../.github/DOC-REVIEW-PIPELINE-PLAN.md#11--label-taxonomy). + +| Category | Count | Prefix | Example | +|----------|-------|--------|---------| +| Product | 11 | `product:` | `product:v3-monolith` | +| Source tracking | 4 | `source:` | `source:sync` | +| Waiting states | 2 | `waiting:` | `waiting:engineering` | +| Workflow states | 2 | (none) | `agent-ready`, `skip-review` | +| Review outcomes | 3 | `review:` | `review:approved` | +| Renamed | 2 | various | `ai:tooling`, `ci:testing` | diff --git a/helper-scripts/label-migration/create-labels.sh b/helper-scripts/label-migration/create-labels.sh new file mode 100755 index 000000000..0aea302c9 --- /dev/null +++ b/helper-scripts/label-migration/create-labels.sh @@ -0,0 +1,97 @@ +#!/usr/bin/env bash +set -euo pipefail + +# Create all labels defined in the doc review pipeline plan. +# Safe and idempotent — uses --force to update existing labels. +# +# Usage: +# ./create-labels.sh # Create labels in influxdata/docs-v2 +# ./create-labels.sh --dry-run # Print commands without executing +# REPO=owner/repo ./create-labels.sh # Target a different repo + +REPO="${REPO:-influxdata/docs-v2}" +DRY_RUN=false + +if [[ "${1:-}" == "--dry-run" ]]; then + DRY_RUN=true + echo "=== DRY RUN — no labels will be created ===" + echo +fi + +create_label() { + local name="$1" + local color="$2" + local description="$3" + + if $DRY_RUN; then + printf " %-30s #%-6s %s\n" "$name" "$color" "$description" + else + if gh label create "$name" \ + --repo "$REPO" \ + --color "$color" \ + --description "$description" \ + --force 2>/dev/null; then + printf " ✓ %-30s\n" "$name" + else + printf " ✗ %-30s (failed)\n" "$name" + fi + fi +} + +echo "Repository: $REPO" +echo + +# --- Product labels (11) — yellow --- +echo "Product labels:" +create_label "product:v3-monolith" "FFA500" "InfluxDB 3 Core and Enterprise (single-node / clusterable)" +create_label "product:v3-distributed" "FFA500" "InfluxDB 3 Cloud Serverless, Cloud Dedicated, Clustered" +create_label "product:v2" "FFA500" "InfluxDB v2 (Cloud TSM, OSS)" +create_label "product:v1" "FFA500" "InfluxDB v1 OSS" +create_label "product:v1-enterprise" "FFA500" "InfluxDB Enterprise v1" +create_label "product:telegraf" "FFA500" "Telegraf documentation" +create_label "product:chronograf" "FFA500" "Chronograf documentation" +create_label "product:kapacitor" "FFA500" "Kapacitor documentation" +create_label "product:flux" "FFA500" "Flux language documentation" +create_label "product:explorer" "FFA500" "InfluxDB 3 Explorer" +create_label "product:shared" "FFA500" "Shared content across products" +echo + +# --- Source tracking labels (4) — purple --- +echo "Source tracking labels:" +create_label "source:auto-detected" "9370DB" "Created by change detection within this repo" +create_label "source:dar" "9370DB" "Generated by DAR pipeline (issue analysis)" +create_label "source:sync" "9370DB" "Synced from an external repository" +create_label "source:manual" "9370DB" "Human-created issue" +echo + +# --- Waiting states (2) — orange --- +echo "Waiting state labels:" +create_label "waiting:engineering" "FF8C00" "Waiting for engineer confirmation" +create_label "waiting:product" "FF8C00" "Waiting for product/PM decision" +echo + +# --- Workflow states (2) — green/blue --- +echo "Workflow state labels:" +create_label "agent-ready" "00FF00" "Agent can work on this autonomously" +create_label "skip-review" "1E90FF" "Skip automated doc review pipeline" +echo + +# --- Review outcome labels (3) — green/red/yellow --- +echo "Review outcome labels:" +create_label "review:approved" "28A745" "Automated review passed — no blocking issues" +create_label "review:changes-requested" "DC3545" "Automated review found blocking issues" +create_label "review:needs-human" "FFC107" "Automated review inconclusive, needs human" +echo + +# --- Renamed labels (2) --- +echo "Renamed labels:" +create_label "ai:tooling" "3fb91f" "Related to AI assistant infrastructure" +create_label "ci:testing" "a1fd0f" "CI/testing infrastructure" +echo + +# --- Ensure existing workflow labels exist --- +echo "Existing labels (ensure present):" +create_label "release:pending" "FEF2C0" "Waiting for product release before merging" +echo + +echo "Done. Total: 24 new + 1 existing = 25 labels." diff --git a/helper-scripts/label-migration/delete-labels.sh b/helper-scripts/label-migration/delete-labels.sh new file mode 100755 index 000000000..58bc2c9ee --- /dev/null +++ b/helper-scripts/label-migration/delete-labels.sh @@ -0,0 +1,137 @@ +#!/usr/bin/env bash +set -euo pipefail + +# Delete old labels after migration is verified. +# DESTRUCTIVE — requires interactive confirmation for each batch. +# +# Run this ONLY after: +# 1. create-labels.sh has been run +# 2. migrate-labels.sh has been run +# 3. A sample of migrated issues has been manually verified +# +# Usage: +# ./delete-labels.sh # Delete labels (with confirmation prompts) +# ./delete-labels.sh --dry-run # Print what would be deleted +# REPO=owner/repo ./delete-labels.sh # Target a different repo + +REPO="${REPO:-influxdata/docs-v2}" +DRY_RUN=false + +if [[ "${1:-}" == "--dry-run" ]]; then + DRY_RUN=true + echo "=== DRY RUN — no labels will be deleted ===" + echo +fi + +delete_label() { + local name="$1" + + if $DRY_RUN; then + printf " Would delete: %s\n" "$name" + return + fi + + if gh label delete "$name" \ + --repo "$REPO" \ + --yes 2>/dev/null; then + printf " ✓ Deleted: %s\n" "$name" + else + printf " - Skipped: %s (not found or already deleted)\n" "$name" + fi +} + +confirm_batch() { + local batch_name="$1" + + if $DRY_RUN; then + return 0 + fi + + echo + read -r -p "Delete $batch_name labels? [y/N] " response + case "$response" in + [yY][eE][sS]|[yY]) return 0 ;; + *) echo " Skipped."; return 1 ;; + esac +} + +echo "Repository: $REPO" +echo +echo "⚠ This script deletes labels. Run migrate-labels.sh first." +echo + +# --- Old product labels (migrated to product:* labels) --- +echo "=== Old product labels ===" +if confirm_batch "old product"; then + delete_label "InfluxDB 3 Core and Enterprise" + delete_label "InfluxDB v3" + delete_label "Processing engine" + delete_label "InfluxDB v2" + delete_label "InfluxDB v1" + delete_label "Enterprise 1.x" + delete_label "Chronograf 1.x" + delete_label "Kapacitor" + delete_label "Flux" + delete_label "InfluxDB 3 Explorer" + delete_label "InfluxDB Cloud Dedicated" + delete_label "InfluxDB Cloud Serverless" + delete_label "InfluxDB Clustered" + delete_label "InfluxDB Cloud" + delete_label "Telegraf" +fi +echo + +# --- Old release labels (migrated to release:pending) --- +echo "=== Old release labels ===" +if confirm_batch "old release"; then + delete_label "Pending Release" + delete_label "release/influxdb3" +fi +echo + +# --- Old source tracking labels --- +echo "=== Old source tracking labels ===" +if confirm_batch "old source tracking"; then + delete_label "sync-plugin-docs" +fi +echo + +# --- Renamed labels --- +echo "=== Renamed labels (old names) ===" +if confirm_batch "renamed label (old names)"; then + delete_label "AI assistant tooling" + delete_label "ci:testing-and-validation" +fi +echo + +# --- Unused/generic labels --- +echo "=== Unused/generic labels ===" +echo "These labels have inconsistent naming or overlap with the new taxonomy." +if confirm_batch "unused/generic"; then + delete_label "bug" + delete_label "priority" + delete_label "documentation" + delete_label "Proposal" + delete_label "Research Phase" + delete_label "ready-for-collaboration" + delete_label "ui" + delete_label "javascript" + delete_label "dependencies" + delete_label "integration-demo-blog" + delete_label "API" + delete_label "Docker" + delete_label "Grafana" + delete_label "Ask AI" +fi +echo + +echo "=== Done ===" +echo +echo "Labels NOT deleted (kept intentionally or not in scope):" +echo " - release:pending, release:ready, release/telegraf, release/v1" +echo " - good-first-issue, user feedback, validation-failed" +echo " - duplicate, enhancement, help wanted, question, wontfix" +echo " - design, security, security/misc, Epic, feat, fix, chore" +echo " - And others not in the migration scope" +echo +echo "Review remaining labels with: gh label list -R $REPO" diff --git a/helper-scripts/label-migration/migrate-labels.sh b/helper-scripts/label-migration/migrate-labels.sh new file mode 100755 index 000000000..a1f309ab3 --- /dev/null +++ b/helper-scripts/label-migration/migrate-labels.sh @@ -0,0 +1,104 @@ +#!/usr/bin/env bash +set -euo pipefail + +# Migrate issues and PRs from old labels to new labels. +# For each mapping, finds all issues with the old label and adds the new label. +# Does NOT remove old labels — that happens in delete-labels.sh after verification. +# +# Usage: +# ./migrate-labels.sh # Migrate labels in influxdata/docs-v2 +# ./migrate-labels.sh --dry-run # Print what would happen without executing +# REPO=owner/repo ./migrate-labels.sh # Target a different repo + +REPO="${REPO:-influxdata/docs-v2}" +DRY_RUN=false + +if [[ "${1:-}" == "--dry-run" ]]; then + DRY_RUN=true + echo "=== DRY RUN — no issues will be modified ===" + echo +fi + +migrate_label() { + local old_label="$1" + local new_label="$2" + local note="${3:-}" + + echo "--- $old_label → $new_label" + if [[ -n "$note" ]]; then + echo " Note: $note" + fi + + # Get all open and closed issues/PRs with the old label + local numbers + numbers=$(gh issue list \ + --repo "$REPO" \ + --label "$old_label" \ + --state all \ + --json number \ + --jq '.[].number' 2>/dev/null || true) + + if [[ -z "$numbers" ]]; then + echo " No issues found with label '$old_label'" + echo + return + fi + + local count + count=$(echo "$numbers" | wc -l | tr -d ' ') + echo " Found $count issue(s)" + + for num in $numbers; do + if $DRY_RUN; then + echo " Would add '$new_label' to #$num" + else + if gh issue edit "$num" \ + --repo "$REPO" \ + --add-label "$new_label" 2>/dev/null; then + echo " ✓ #$num" + else + echo " ✗ #$num (failed)" + fi + fi + done + echo +} + +# Flag issues that need manual review instead of automatic migration +flag_for_review() { + local old_label="$1" + local reason="$2" + + echo "--- ⚠ $old_label — NEEDS MANUAL REVIEW" + echo " Reason: $reason" + + local numbers + numbers=$(gh issue list \ + --repo "$REPO" \ + --label "$old_label" \ + --state all \ + --json number,title \ + --jq '.[] | "#\(.number) \(.title)"' 2>/dev/null || true) + + if [[ -z "$numbers" ]]; then + echo " No issues found" + else + echo "$numbers" | while IFS= read -r line; do + echo " $line" + done + fi + echo +} + +echo "Repository: $REPO" + +migrate_label "alerts" "product:v2" +migrate_label "InfluxDB v2" "product:v2" +migrate_label "InfluxDB 3 Core and Enterprise" "product:v3-monolith" + +echo "=== Done ===" +echo +echo "Next steps:" +echo " 1. Review any issues flagged above" +echo " 2. Verify a sample of migrated issues in the GitHub UI" +echo " 3. Once satisfied, run delete-labels.sh to remove old labels" From 8dd60bf9b8aa909cd9cc2814f325ac8fe43eb83b Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 10 Mar 2026 10:10:09 -0500 Subject: [PATCH 06/27] chore(deps): bump dompurify from 3.3.1 to 3.3.2 (#6905) Bumps [dompurify](https://github.com/cure53/DOMPurify) from 3.3.1 to 3.3.2. - [Release notes](https://github.com/cure53/DOMPurify/releases) - [Commits](https://github.com/cure53/DOMPurify/compare/3.3.1...3.3.2) --- updated-dependencies: - dependency-name: dompurify dependency-version: 3.3.2 dependency-type: indirect ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Jason Stirnaman --- yarn.lock | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/yarn.lock b/yarn.lock index 56c52b105..3b8d8d78e 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2055,9 +2055,9 @@ doctrine@^2.1.0: esutils "^2.0.2" dompurify@^3.2.5: - version "3.3.1" - resolved "https://registry.yarnpkg.com/dompurify/-/dompurify-3.3.1.tgz#c7e1ddebfe3301eacd6c0c12a4af284936dbbb86" - integrity sha512-qkdCKzLNtrgPFP1Vo+98FRzJnBRGe4ffyCea9IwHB1fyxPOeNTHpLKYGd4Uk9xvNoH0ZoOjwZxNptyMwqrId1Q== + version "3.3.2" + resolved "https://registry.yarnpkg.com/dompurify/-/dompurify-3.3.2.tgz#58c515d0f8508b8749452a028aa589ad80b36325" + integrity sha512-6obghkliLdmKa56xdbLOpUZ43pAR6xFy1uOrxBaIDjT+yaRuuybLjGS9eVBoSR/UPU5fq3OXClEHLJNGvbxKpQ== optionalDependencies: "@types/trusted-types" "^2.0.7" From ef6f12410f0cef0ed4df87717b4b7524328456c3 Mon Sep 17 00:00:00 2001 From: Sven Rebhan <36194019+srebhan@users.noreply.github.com> Date: Tue, 10 Mar 2026 16:17:22 +0100 Subject: [PATCH 07/27] Telegraf v1.38.0 (#6911) * Updating changelog * Updating plugin list * Updating product version * Updating plugins --------- Co-authored-by: Jason Stirnaman --- .../aggregator-plugins/basicstats/_index.md | 2 +- .../aggregator-plugins/derivative/_index.md | 2 +- .../v1/aggregator-plugins/final/_index.md | 2 +- .../v1/aggregator-plugins/histogram/_index.md | 2 +- .../v1/aggregator-plugins/merge/_index.md | 2 +- .../v1/aggregator-plugins/minmax/_index.md | 2 +- .../v1/aggregator-plugins/quantile/_index.md | 2 +- .../v1/aggregator-plugins/starlark/_index.md | 2 +- .../aggregator-plugins/valuecounter/_index.md | 2 +- .../v1/input-plugins/activemq/_index.md | 2 +- .../v1/input-plugins/aerospike/_index.md | 2 +- .../v1/input-plugins/aliyuncms/_index.md | 2 +- .../v1/input-plugins/amd_rocm_smi/_index.md | 2 +- .../v1/input-plugins/amqp_consumer/_index.md | 2 +- .../v1/input-plugins/apache/_index.md | 2 +- .../v1/input-plugins/apcupsd/_index.md | 2 +- .../v1/input-plugins/aurora/_index.md | 2 +- .../v1/input-plugins/azure_monitor/_index.md | 2 +- .../azure_storage_queue/_index.md | 2 +- .../v1/input-plugins/bcache/_index.md | 2 +- .../v1/input-plugins/beanstalkd/_index.md | 2 +- .../telegraf/v1/input-plugins/beat/_index.md | 2 +- .../telegraf/v1/input-plugins/bind/_index.md | 2 +- .../telegraf/v1/input-plugins/bond/_index.md | 2 +- .../v1/input-plugins/burrow/_index.md | 2 +- .../telegraf/v1/input-plugins/ceph/_index.md | 2 +- .../v1/input-plugins/cgroup/_index.md | 2 +- .../v1/input-plugins/chrony/_index.md | 2 +- .../cisco_telemetry_mdt/_index.md | 2 +- .../v1/input-plugins/clickhouse/_index.md | 2 +- .../v1/input-plugins/cloud_pubsub/_index.md | 2 +- .../input-plugins/cloud_pubsub_push/_index.md | 2 +- .../v1/input-plugins/cloudwatch/_index.md | 2 +- .../cloudwatch_metric_streams/_index.md | 2 +- .../v1/input-plugins/conntrack/_index.md | 2 +- .../v1/input-plugins/consul/_index.md | 2 +- .../v1/input-plugins/consul_agent/_index.md | 2 +- .../v1/input-plugins/couchbase/_index.md | 2 +- .../v1/input-plugins/couchdb/_index.md | 2 +- .../telegraf/v1/input-plugins/cpu/_index.md | 2 +- .../telegraf/v1/input-plugins/csgo/_index.md | 2 +- .../input-plugins/ctrlx_datalayer/_index.md | 2 +- .../telegraf/v1/input-plugins/dcos/_index.md | 2 +- .../input-plugins/directory_monitor/_index.md | 2 +- .../telegraf/v1/input-plugins/disk/_index.md | 2 +- .../v1/input-plugins/diskio/_index.md | 2 +- .../v1/input-plugins/disque/_index.md | 2 +- .../v1/input-plugins/dmcache/_index.md | 2 +- .../v1/input-plugins/dns_query/_index.md | 2 +- .../v1/input-plugins/docker/_index.md | 2 +- .../v1/input-plugins/docker_log/_index.md | 2 +- .../v1/input-plugins/dovecot/_index.md | 2 +- .../telegraf/v1/input-plugins/dpdk/_index.md | 2 +- .../telegraf/v1/input-plugins/ecs/_index.md | 2 +- .../v1/input-plugins/elasticsearch/_index.md | 2 +- .../elasticsearch_query/_index.md | 2 +- .../v1/input-plugins/ethtool/_index.md | 2 +- .../input-plugins/eventhub_consumer/_index.md | 2 +- .../telegraf/v1/input-plugins/exec/_index.md | 2 +- .../telegraf/v1/input-plugins/execd/_index.md | 2 +- .../v1/input-plugins/fail2ban/_index.md | 2 +- .../v1/input-plugins/fibaro/_index.md | 2 +- .../telegraf/v1/input-plugins/file/_index.md | 2 +- .../v1/input-plugins/filecount/_index.md | 2 +- .../v1/input-plugins/filestat/_index.md | 2 +- .../v1/input-plugins/fireboard/_index.md | 2 +- .../v1/input-plugins/firehose/_index.md | 2 +- .../v1/input-plugins/fluentd/_index.md | 2 +- .../v1/input-plugins/fritzbox/_index.md | 2 +- .../v1/input-plugins/github/_index.md | 2 +- .../telegraf/v1/input-plugins/gnmi/_index.md | 5 +- .../google_cloud_storage/_index.md | 2 +- .../v1/input-plugins/graylog/_index.md | 2 +- .../v1/input-plugins/haproxy/_index.md | 2 +- .../v1/input-plugins/hddtemp/_index.md | 2 +- .../telegraf/v1/input-plugins/http/_index.md | 5 +- .../input-plugins/http_listener_v2/_index.md | 2 +- .../v1/input-plugins/http_response/_index.md | 2 +- .../v1/input-plugins/huebridge/_index.md | 2 +- .../v1/input-plugins/hugepages/_index.md | 2 +- .../v1/input-plugins/icinga2/_index.md | 2 +- .../v1/input-plugins/infiniband/_index.md | 2 +- .../v1/input-plugins/influxdb/_index.md | 2 +- .../input-plugins/influxdb_listener/_index.md | 2 +- .../influxdb_v2_listener/_index.md | 2 +- .../v1/input-plugins/intel_baseband/_index.md | 2 +- .../v1/input-plugins/intel_dlb/_index.md | 2 +- .../v1/input-plugins/intel_pmt/_index.md | 2 +- .../v1/input-plugins/intel_pmu/_index.md | 2 +- .../input-plugins/intel_powerstat/_index.md | 2 +- .../v1/input-plugins/intel_rdt/_index.md | 2 +- .../v1/input-plugins/internal/_index.md | 2 +- .../v1/input-plugins/internet_speed/_index.md | 2 +- .../v1/input-plugins/interrupts/_index.md | 2 +- .../v1/input-plugins/ipmi_sensor/_index.md | 2 +- .../telegraf/v1/input-plugins/ipset/_index.md | 2 +- .../v1/input-plugins/iptables/_index.md | 2 +- .../telegraf/v1/input-plugins/ipvs/_index.md | 2 +- .../v1/input-plugins/jenkins/_index.md | 2 +- .../v1/input-plugins/jolokia2_agent/_index.md | 2 +- .../v1/input-plugins/jolokia2_proxy/_index.md | 2 +- .../jti_openconfig_telemetry/_index.md | 2 +- .../v1/input-plugins/kafka_consumer/_index.md | 2 +- .../v1/input-plugins/kapacitor/_index.md | 2 +- .../v1/input-plugins/kernel/_index.md | 2 +- .../v1/input-plugins/kernel_vmstat/_index.md | 2 +- .../v1/input-plugins/kibana/_index.md | 2 +- .../input-plugins/kinesis_consumer/_index.md | 2 +- .../v1/input-plugins/knx_listener/_index.md | 2 +- .../v1/input-plugins/kube_inventory/_index.md | 2 +- .../v1/input-plugins/kubernetes/_index.md | 2 +- .../telegraf/v1/input-plugins/lanz/_index.md | 2 +- .../telegraf/v1/input-plugins/ldap/_index.md | 2 +- .../telegraf/v1/input-plugins/leofs/_index.md | 2 +- .../v1/input-plugins/libvirt/_index.md | 2 +- .../v1/input-plugins/linux_cpu/_index.md | 2 +- .../input-plugins/linux_sysctl_fs/_index.md | 2 +- .../telegraf/v1/input-plugins/logql/_index.md | 5 +- .../v1/input-plugins/logstash/_index.md | 2 +- .../v1/input-plugins/lustre2/_index.md | 2 +- .../telegraf/v1/input-plugins/lvm/_index.md | 2 +- .../v1/input-plugins/mailchimp/_index.md | 2 +- .../v1/input-plugins/marklogic/_index.md | 2 +- .../v1/input-plugins/mavlink/_index.md | 2 +- .../v1/input-plugins/mcrouter/_index.md | 2 +- .../v1/input-plugins/mdstat/_index.md | 2 +- .../telegraf/v1/input-plugins/mem/_index.md | 2 +- .../v1/input-plugins/memcached/_index.md | 2 +- .../telegraf/v1/input-plugins/mesos/_index.md | 2 +- .../v1/input-plugins/minecraft/_index.md | 2 +- .../telegraf/v1/input-plugins/mock/_index.md | 2 +- .../v1/input-plugins/modbus/_index.md | 2 +- .../v1/input-plugins/mongodb/_index.md | 2 +- .../telegraf/v1/input-plugins/monit/_index.md | 2 +- .../v1/input-plugins/mqtt_consumer/_index.md | 8 +- .../v1/input-plugins/multifile/_index.md | 2 +- .../telegraf/v1/input-plugins/mysql/_index.md | 12 +- .../telegraf/v1/input-plugins/nats/_index.md | 2 +- .../v1/input-plugins/nats_consumer/_index.md | 2 +- .../v1/input-plugins/neoom_beaam/_index.md | 2 +- .../v1/input-plugins/neptune_apex/_index.md | 2 +- .../telegraf/v1/input-plugins/net/_index.md | 2 +- .../v1/input-plugins/net_response/_index.md | 2 +- .../v1/input-plugins/netflow/_index.md | 2 +- .../v1/input-plugins/netstat/_index.md | 2 +- .../v1/input-plugins/nfsclient/_index.md | 2 +- .../v1/input-plugins/nftables/_index.md | 44 ++++- .../telegraf/v1/input-plugins/nginx/_index.md | 2 +- .../v1/input-plugins/nginx_plus/_index.md | 2 +- .../v1/input-plugins/nginx_plus_api/_index.md | 2 +- .../v1/input-plugins/nginx_sts/_index.md | 2 +- .../nginx_upstream_check/_index.md | 2 +- .../v1/input-plugins/nginx_vts/_index.md | 2 +- .../telegraf/v1/input-plugins/nomad/_index.md | 2 +- .../telegraf/v1/input-plugins/nsd/_index.md | 2 +- .../telegraf/v1/input-plugins/nsdp/_index.md | 2 +- .../telegraf/v1/input-plugins/nsq/_index.md | 2 +- .../v1/input-plugins/nsq_consumer/_index.md | 2 +- .../telegraf/v1/input-plugins/nstat/_index.md | 2 +- .../telegraf/v1/input-plugins/ntpq/_index.md | 2 +- .../v1/input-plugins/nvidia_smi/_index.md | 2 +- .../telegraf/v1/input-plugins/opcua/_index.md | 46 ++++- .../v1/input-plugins/opcua_listener/_index.md | 66 +++++-- .../v1/input-plugins/openldap/_index.md | 2 +- .../v1/input-plugins/openntpd/_index.md | 2 +- .../input-plugins/opensearch_query/_index.md | 2 +- .../v1/input-plugins/opensmtpd/_index.md | 2 +- .../v1/input-plugins/openstack/_index.md | 2 +- .../v1/input-plugins/opentelemetry/_index.md | 2 +- .../v1/input-plugins/openweathermap/_index.md | 2 +- .../v1/input-plugins/p4runtime/_index.md | 2 +- .../v1/input-plugins/passenger/_index.md | 2 +- .../telegraf/v1/input-plugins/pf/_index.md | 2 +- .../v1/input-plugins/pgbouncer/_index.md | 2 +- .../v1/input-plugins/phpfpm/_index.md | 2 +- .../telegraf/v1/input-plugins/ping/_index.md | 2 +- .../v1/input-plugins/postfix/_index.md | 2 +- .../v1/input-plugins/postgresql/_index.md | 2 +- .../postgresql_extensible/_index.md | 2 +- .../v1/input-plugins/powerdns/_index.md | 2 +- .../input-plugins/powerdns_recursor/_index.md | 2 +- .../v1/input-plugins/processes/_index.md | 2 +- .../v1/input-plugins/procstat/_index.md | 2 +- .../v1/input-plugins/prometheus/_index.md | 2 +- .../v1/input-plugins/promql/_index.md | 5 +- .../v1/input-plugins/proxmox/_index.md | 2 +- .../v1/input-plugins/puppetagent/_index.md | 2 +- .../v1/input-plugins/rabbitmq/_index.md | 2 +- .../v1/input-plugins/radius/_index.md | 2 +- .../v1/input-plugins/raindrops/_index.md | 2 +- .../telegraf/v1/input-plugins/ras/_index.md | 2 +- .../v1/input-plugins/ravendb/_index.md | 2 +- .../v1/input-plugins/redfish/_index.md | 2 +- .../telegraf/v1/input-plugins/redis/_index.md | 2 +- .../v1/input-plugins/redis_sentinel/_index.md | 2 +- .../v1/input-plugins/rethinkdb/_index.md | 2 +- .../telegraf/v1/input-plugins/riak/_index.md | 2 +- .../input-plugins/riemann_listener/_index.md | 2 +- .../v1/input-plugins/s7comm/_index.md | 2 +- .../v1/input-plugins/salesforce/_index.md | 2 +- .../v1/input-plugins/sensors/_index.md | 2 +- .../telegraf/v1/input-plugins/sflow/_index.md | 2 +- .../telegraf/v1/input-plugins/sip/_index.md | 182 ++++++++++++++++++ .../telegraf/v1/input-plugins/slab/_index.md | 2 +- .../telegraf/v1/input-plugins/slurm/_index.md | 2 +- .../telegraf/v1/input-plugins/smart/_index.md | 15 +- .../v1/input-plugins/smartctl/_index.md | 2 +- .../telegraf/v1/input-plugins/snmp/_index.md | 2 +- .../v1/input-plugins/snmp_trap/_index.md | 2 +- .../input-plugins/socket_listener/_index.md | 2 +- .../v1/input-plugins/socketstat/_index.md | 2 +- .../telegraf/v1/input-plugins/solr/_index.md | 2 +- .../telegraf/v1/input-plugins/sql/_index.md | 2 +- .../v1/input-plugins/sqlserver/_index.md | 2 +- .../v1/input-plugins/stackdriver/_index.md | 2 +- .../v1/input-plugins/statsd/_index.md | 40 +++- .../v1/input-plugins/supervisor/_index.md | 2 +- .../v1/input-plugins/suricata/_index.md | 2 +- .../telegraf/v1/input-plugins/swap/_index.md | 2 +- .../v1/input-plugins/synproxy/_index.md | 2 +- .../v1/input-plugins/syslog/_index.md | 2 +- .../v1/input-plugins/sysstat/_index.md | 2 +- .../v1/input-plugins/system/_index.md | 2 +- .../v1/input-plugins/systemd_units/_index.md | 2 +- .../v1/input-plugins/tacacs/_index.md | 2 +- .../telegraf/v1/input-plugins/tail/_index.md | 2 +- .../v1/input-plugins/teamspeak/_index.md | 2 +- .../telegraf/v1/input-plugins/temp/_index.md | 2 +- .../v1/input-plugins/tengine/_index.md | 2 +- .../telegraf/v1/input-plugins/timex/_index.md | 2 +- .../v1/input-plugins/tomcat/_index.md | 2 +- .../telegraf/v1/input-plugins/trig/_index.md | 2 +- .../v1/input-plugins/turbostat/_index.md | 2 +- .../v1/input-plugins/twemproxy/_index.md | 2 +- .../v1/input-plugins/unbound/_index.md | 2 +- .../telegraf/v1/input-plugins/upsd/_index.md | 2 +- .../telegraf/v1/input-plugins/uwsgi/_index.md | 2 +- .../v1/input-plugins/varnish/_index.md | 2 +- .../telegraf/v1/input-plugins/vault/_index.md | 2 +- .../v1/input-plugins/vsphere/_index.md | 2 +- .../v1/input-plugins/webhooks/_index.md | 2 +- .../telegraf/v1/input-plugins/whois/_index.md | 2 +- .../v1/input-plugins/win_eventlog/_index.md | 2 +- .../input-plugins/win_perf_counters/_index.md | 2 +- .../v1/input-plugins/win_services/_index.md | 2 +- .../v1/input-plugins/win_wmi/_index.md | 2 +- .../v1/input-plugins/wireguard/_index.md | 2 +- .../v1/input-plugins/wireless/_index.md | 2 +- .../v1/input-plugins/x509_cert/_index.md | 2 +- .../v1/input-plugins/xtremio/_index.md | 2 +- .../telegraf/v1/input-plugins/zfs/_index.md | 2 +- .../v1/input-plugins/zipkin/_index.md | 2 +- .../v1/input-plugins/zookeeper/_index.md | 2 +- .../telegraf/v1/output-plugins/amon/_index.md | 2 +- .../telegraf/v1/output-plugins/amqp/_index.md | 2 +- .../application_insights/_index.md | 2 +- .../telegraf/v1/output-plugins/arc/_index.md | 2 +- .../azure_data_explorer/_index.md | 2 +- .../v1/output-plugins/azure_monitor/_index.md | 2 +- .../v1/output-plugins/bigquery/_index.md | 2 +- .../v1/output-plugins/clarify/_index.md | 2 +- .../v1/output-plugins/cloud_pubsub/_index.md | 2 +- .../v1/output-plugins/cloudwatch/_index.md | 2 +- .../output-plugins/cloudwatch_logs/_index.md | 2 +- .../v1/output-plugins/cratedb/_index.md | 2 +- .../v1/output-plugins/datadog/_index.md | 2 +- .../v1/output-plugins/discard/_index.md | 2 +- .../v1/output-plugins/dynatrace/_index.md | 2 +- .../v1/output-plugins/elasticsearch/_index.md | 2 +- .../v1/output-plugins/event_hubs/_index.md | 2 +- .../telegraf/v1/output-plugins/exec/_index.md | 2 +- .../v1/output-plugins/execd/_index.md | 2 +- .../telegraf/v1/output-plugins/file/_index.md | 2 +- .../v1/output-plugins/graphite/_index.md | 2 +- .../v1/output-plugins/graylog/_index.md | 2 +- .../v1/output-plugins/groundwork/_index.md | 2 +- .../v1/output-plugins/health/_index.md | 5 +- .../v1/output-plugins/heartbeat/_index.md | 175 ++++++++++++++++- .../telegraf/v1/output-plugins/http/_index.md | 5 +- .../v1/output-plugins/influxdb/_index.md | 2 +- .../v1/output-plugins/influxdb_v2/_index.md | 4 +- .../v1/output-plugins/influxdb_v3/_index.md | 146 ++++++++++++++ .../v1/output-plugins/inlong/_index.md | 2 +- .../v1/output-plugins/instrumental/_index.md | 2 +- .../v1/output-plugins/iotdb/_index.md | 2 +- .../v1/output-plugins/kafka/_index.md | 2 +- .../v1/output-plugins/kinesis/_index.md | 2 +- .../v1/output-plugins/librato/_index.md | 2 +- .../v1/output-plugins/logzio/_index.md | 2 +- .../telegraf/v1/output-plugins/loki/_index.md | 2 +- .../output-plugins/microsoft_fabric/_index.md | 2 +- .../v1/output-plugins/mongodb/_index.md | 56 +++--- .../telegraf/v1/output-plugins/mqtt/_index.md | 2 +- .../telegraf/v1/output-plugins/nats/_index.md | 2 +- .../nebius_cloud_monitoring/_index.md | 2 +- .../v1/output-plugins/newrelic/_index.md | 2 +- .../telegraf/v1/output-plugins/nsq/_index.md | 2 +- .../v1/output-plugins/opensearch/_index.md | 2 +- .../v1/output-plugins/opentelemetry/_index.md | 10 +- .../v1/output-plugins/opentsdb/_index.md | 2 +- .../v1/output-plugins/parquet/_index.md | 2 +- .../v1/output-plugins/postgresql/_index.md | 2 +- .../prometheus_client/_index.md | 8 +- .../telegraf/v1/output-plugins/quix/_index.md | 2 +- .../output-plugins/redistimeseries/_index.md | 9 +- .../v1/output-plugins/remotefile/_index.md | 2 +- .../v1/output-plugins/riemann/_index.md | 2 +- .../v1/output-plugins/sensu/_index.md | 2 +- .../v1/output-plugins/signalfx/_index.md | 2 +- .../v1/output-plugins/socket_writer/_index.md | 2 +- .../telegraf/v1/output-plugins/sql/_index.md | 2 +- .../v1/output-plugins/stackdriver/_index.md | 13 +- .../v1/output-plugins/stomp/_index.md | 2 +- .../v1/output-plugins/sumologic/_index.md | 2 +- .../v1/output-plugins/syslog/_index.md | 2 +- .../v1/output-plugins/timestream/_index.md | 2 +- .../v1/output-plugins/warp10/_index.md | 2 +- .../v1/output-plugins/wavefront/_index.md | 2 +- .../v1/output-plugins/websocket/_index.md | 2 +- .../yandex_cloud_monitoring/_index.md | 2 +- .../v1/output-plugins/zabbix/_index.md | 2 +- .../v1/processor-plugins/aws_ec2/_index.md | 2 +- .../v1/processor-plugins/batch/_index.md | 2 +- .../v1/processor-plugins/clone/_index.md | 2 +- .../v1/processor-plugins/converter/_index.md | 2 +- .../cumulative_sum/_index.md | 2 +- .../v1/processor-plugins/date/_index.md | 2 +- .../v1/processor-plugins/dedup/_index.md | 2 +- .../v1/processor-plugins/defaults/_index.md | 2 +- .../v1/processor-plugins/enum/_index.md | 2 +- .../v1/processor-plugins/execd/_index.md | 2 +- .../v1/processor-plugins/filepath/_index.md | 2 +- .../v1/processor-plugins/filter/_index.md | 2 +- .../v1/processor-plugins/ifname/_index.md | 2 +- .../v1/processor-plugins/lookup/_index.md | 2 +- .../v1/processor-plugins/noise/_index.md | 2 +- .../v1/processor-plugins/override/_index.md | 2 +- .../v1/processor-plugins/parser/_index.md | 2 +- .../v1/processor-plugins/pivot/_index.md | 2 +- .../v1/processor-plugins/port_name/_index.md | 2 +- .../v1/processor-plugins/printer/_index.md | 2 +- .../v1/processor-plugins/regex/_index.md | 2 +- .../v1/processor-plugins/rename/_index.md | 2 +- .../processor-plugins/reverse_dns/_index.md | 2 +- .../v1/processor-plugins/round/_index.md | 2 +- .../v1/processor-plugins/s2geo/_index.md | 2 +- .../v1/processor-plugins/scale/_index.md | 2 +- .../processor-plugins/snmp_lookup/_index.md | 2 +- .../v1/processor-plugins/split/_index.md | 2 +- .../v1/processor-plugins/starlark/_index.md | 2 +- .../v1/processor-plugins/strings/_index.md | 2 +- .../v1/processor-plugins/tag_limit/_index.md | 2 +- .../v1/processor-plugins/template/_index.md | 2 +- .../v1/processor-plugins/timestamp/_index.md | 2 +- .../v1/processor-plugins/topk/_index.md | 2 +- .../v1/processor-plugins/unpivot/_index.md | 2 +- content/telegraf/v1/release-notes.md | 75 ++++++++ data/products.yml | 4 +- data/telegraf_plugins.yml | 29 ++- 359 files changed, 1217 insertions(+), 423 deletions(-) create mode 100644 content/telegraf/v1/input-plugins/sip/_index.md create mode 100644 content/telegraf/v1/output-plugins/influxdb_v3/_index.md diff --git a/content/telegraf/v1/aggregator-plugins/basicstats/_index.md b/content/telegraf/v1/aggregator-plugins/basicstats/_index.md index da433ed00..761316c00 100644 --- a/content/telegraf/v1/aggregator-plugins/basicstats/_index.md +++ b/content/telegraf/v1/aggregator-plugins/basicstats/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/aggregators/basicstats/README.md, Basic Statistics Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/aggregators/basicstats/README.md, Basic Statistics Plugin Source --- # Basic Statistics Aggregator Plugin diff --git a/content/telegraf/v1/aggregator-plugins/derivative/_index.md b/content/telegraf/v1/aggregator-plugins/derivative/_index.md index 17ae10369..ac8c7622c 100644 --- a/content/telegraf/v1/aggregator-plugins/derivative/_index.md +++ b/content/telegraf/v1/aggregator-plugins/derivative/_index.md @@ -10,7 +10,7 @@ introduced: "v1.18.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/aggregators/derivative/README.md, Derivative Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/aggregators/derivative/README.md, Derivative Plugin Source --- # Derivative Aggregator Plugin diff --git a/content/telegraf/v1/aggregator-plugins/final/_index.md b/content/telegraf/v1/aggregator-plugins/final/_index.md index e0b5b692b..50c244777 100644 --- a/content/telegraf/v1/aggregator-plugins/final/_index.md +++ b/content/telegraf/v1/aggregator-plugins/final/_index.md @@ -10,7 +10,7 @@ introduced: "v1.11.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/aggregators/final/README.md, Final Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/aggregators/final/README.md, Final Plugin Source --- # Final Aggregator Plugin diff --git a/content/telegraf/v1/aggregator-plugins/histogram/_index.md b/content/telegraf/v1/aggregator-plugins/histogram/_index.md index 2506c5921..9e679991c 100644 --- a/content/telegraf/v1/aggregator-plugins/histogram/_index.md +++ b/content/telegraf/v1/aggregator-plugins/histogram/_index.md @@ -10,7 +10,7 @@ introduced: "v1.4.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/aggregators/histogram/README.md, Histogram Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/aggregators/histogram/README.md, Histogram Plugin Source --- # Histogram Aggregator Plugin diff --git a/content/telegraf/v1/aggregator-plugins/merge/_index.md b/content/telegraf/v1/aggregator-plugins/merge/_index.md index 1d9d594c9..46d645c45 100644 --- a/content/telegraf/v1/aggregator-plugins/merge/_index.md +++ b/content/telegraf/v1/aggregator-plugins/merge/_index.md @@ -10,7 +10,7 @@ introduced: "v1.13.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/aggregators/merge/README.md, Merge Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/aggregators/merge/README.md, Merge Plugin Source --- # Merge Aggregator Plugin diff --git a/content/telegraf/v1/aggregator-plugins/minmax/_index.md b/content/telegraf/v1/aggregator-plugins/minmax/_index.md index da6a71a6f..70c4bfd1b 100644 --- a/content/telegraf/v1/aggregator-plugins/minmax/_index.md +++ b/content/telegraf/v1/aggregator-plugins/minmax/_index.md @@ -10,7 +10,7 @@ introduced: "v1.1.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/aggregators/minmax/README.md, Minimum-Maximum Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/aggregators/minmax/README.md, Minimum-Maximum Plugin Source --- # Minimum-Maximum Aggregator Plugin diff --git a/content/telegraf/v1/aggregator-plugins/quantile/_index.md b/content/telegraf/v1/aggregator-plugins/quantile/_index.md index 9b9776f5c..b46d45cbb 100644 --- a/content/telegraf/v1/aggregator-plugins/quantile/_index.md +++ b/content/telegraf/v1/aggregator-plugins/quantile/_index.md @@ -10,7 +10,7 @@ introduced: "v1.18.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/aggregators/quantile/README.md, Quantile Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/aggregators/quantile/README.md, Quantile Plugin Source --- # Quantile Aggregator Plugin diff --git a/content/telegraf/v1/aggregator-plugins/starlark/_index.md b/content/telegraf/v1/aggregator-plugins/starlark/_index.md index ab6eaf7d8..98a47d683 100644 --- a/content/telegraf/v1/aggregator-plugins/starlark/_index.md +++ b/content/telegraf/v1/aggregator-plugins/starlark/_index.md @@ -10,7 +10,7 @@ introduced: "v1.21.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/aggregators/starlark/README.md, Starlark Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/aggregators/starlark/README.md, Starlark Plugin Source --- # Starlark Aggregator Plugin diff --git a/content/telegraf/v1/aggregator-plugins/valuecounter/_index.md b/content/telegraf/v1/aggregator-plugins/valuecounter/_index.md index 1218ca7d1..9877f44bb 100644 --- a/content/telegraf/v1/aggregator-plugins/valuecounter/_index.md +++ b/content/telegraf/v1/aggregator-plugins/valuecounter/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/aggregators/valuecounter/README.md, Value Counter Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/aggregators/valuecounter/README.md, Value Counter Plugin Source --- # Value Counter Aggregator Plugin diff --git a/content/telegraf/v1/input-plugins/activemq/_index.md b/content/telegraf/v1/input-plugins/activemq/_index.md index 3498a4d23..eb3db060e 100644 --- a/content/telegraf/v1/input-plugins/activemq/_index.md +++ b/content/telegraf/v1/input-plugins/activemq/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/activemq/README.md, ActiveMQ Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/activemq/README.md, ActiveMQ Plugin Source --- # ActiveMQ Input Plugin diff --git a/content/telegraf/v1/input-plugins/aerospike/_index.md b/content/telegraf/v1/input-plugins/aerospike/_index.md index da98a802f..377fdcacb 100644 --- a/content/telegraf/v1/input-plugins/aerospike/_index.md +++ b/content/telegraf/v1/input-plugins/aerospike/_index.md @@ -12,7 +12,7 @@ removal: v1.40.0 os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/aerospike/README.md, Aerospike Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/aerospike/README.md, Aerospike Plugin Source --- # Aerospike Input Plugin diff --git a/content/telegraf/v1/input-plugins/aliyuncms/_index.md b/content/telegraf/v1/input-plugins/aliyuncms/_index.md index d948a4a70..7d1430371 100644 --- a/content/telegraf/v1/input-plugins/aliyuncms/_index.md +++ b/content/telegraf/v1/input-plugins/aliyuncms/_index.md @@ -10,7 +10,7 @@ introduced: "v1.19.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/aliyuncms/README.md, Alibaba Cloud Monitor Service (Aliyun) Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/aliyuncms/README.md, Alibaba Cloud Monitor Service (Aliyun) Plugin Source --- # Alibaba Cloud Monitor Service (Aliyun) Input Plugin diff --git a/content/telegraf/v1/input-plugins/amd_rocm_smi/_index.md b/content/telegraf/v1/input-plugins/amd_rocm_smi/_index.md index c875d9e6f..fa47fb0ff 100644 --- a/content/telegraf/v1/input-plugins/amd_rocm_smi/_index.md +++ b/content/telegraf/v1/input-plugins/amd_rocm_smi/_index.md @@ -10,7 +10,7 @@ introduced: "v1.20.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/amd_rocm_smi/README.md, AMD ROCm System Management Interface (SMI) Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/amd_rocm_smi/README.md, AMD ROCm System Management Interface (SMI) Plugin Source --- # AMD ROCm System Management Interface (SMI) Input Plugin diff --git a/content/telegraf/v1/input-plugins/amqp_consumer/_index.md b/content/telegraf/v1/input-plugins/amqp_consumer/_index.md index 1a049529a..cf55e8315 100644 --- a/content/telegraf/v1/input-plugins/amqp_consumer/_index.md +++ b/content/telegraf/v1/input-plugins/amqp_consumer/_index.md @@ -10,7 +10,7 @@ introduced: "v1.3.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/amqp_consumer/README.md, AMQP Consumer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/amqp_consumer/README.md, AMQP Consumer Plugin Source --- # AMQP Consumer Input Plugin diff --git a/content/telegraf/v1/input-plugins/apache/_index.md b/content/telegraf/v1/input-plugins/apache/_index.md index 16f9df9b2..5352b30b8 100644 --- a/content/telegraf/v1/input-plugins/apache/_index.md +++ b/content/telegraf/v1/input-plugins/apache/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/apache/README.md, Apache Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/apache/README.md, Apache Plugin Source --- # Apache Input Plugin diff --git a/content/telegraf/v1/input-plugins/apcupsd/_index.md b/content/telegraf/v1/input-plugins/apcupsd/_index.md index 49eabfd48..1f081d193 100644 --- a/content/telegraf/v1/input-plugins/apcupsd/_index.md +++ b/content/telegraf/v1/input-plugins/apcupsd/_index.md @@ -10,7 +10,7 @@ introduced: "v1.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/apcupsd/README.md, APC UPSD Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/apcupsd/README.md, APC UPSD Plugin Source --- # APC UPSD Input Plugin diff --git a/content/telegraf/v1/input-plugins/aurora/_index.md b/content/telegraf/v1/input-plugins/aurora/_index.md index 2aa80d69d..d56c935f8 100644 --- a/content/telegraf/v1/input-plugins/aurora/_index.md +++ b/content/telegraf/v1/input-plugins/aurora/_index.md @@ -10,7 +10,7 @@ introduced: "v1.7.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/aurora/README.md, Apache Aurora Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/aurora/README.md, Apache Aurora Plugin Source --- # Apache Aurora Input Plugin diff --git a/content/telegraf/v1/input-plugins/azure_monitor/_index.md b/content/telegraf/v1/input-plugins/azure_monitor/_index.md index 525b66cdb..47a1bbbfe 100644 --- a/content/telegraf/v1/input-plugins/azure_monitor/_index.md +++ b/content/telegraf/v1/input-plugins/azure_monitor/_index.md @@ -10,7 +10,7 @@ introduced: "v1.25.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/azure_monitor/README.md, Azure Monitor Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/azure_monitor/README.md, Azure Monitor Plugin Source --- # Azure Monitor Input Plugin diff --git a/content/telegraf/v1/input-plugins/azure_storage_queue/_index.md b/content/telegraf/v1/input-plugins/azure_storage_queue/_index.md index 2da4ddb3c..0fdf846ca 100644 --- a/content/telegraf/v1/input-plugins/azure_storage_queue/_index.md +++ b/content/telegraf/v1/input-plugins/azure_storage_queue/_index.md @@ -10,7 +10,7 @@ introduced: "v1.13.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/azure_storage_queue/README.md, Azure Queue Storage Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/azure_storage_queue/README.md, Azure Queue Storage Plugin Source --- # Azure Queue Storage Input Plugin diff --git a/content/telegraf/v1/input-plugins/bcache/_index.md b/content/telegraf/v1/input-plugins/bcache/_index.md index ae2006ed7..04d998e4e 100644 --- a/content/telegraf/v1/input-plugins/bcache/_index.md +++ b/content/telegraf/v1/input-plugins/bcache/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/bcache/README.md, Bcache Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/bcache/README.md, Bcache Plugin Source --- # Bcache Input Plugin diff --git a/content/telegraf/v1/input-plugins/beanstalkd/_index.md b/content/telegraf/v1/input-plugins/beanstalkd/_index.md index adbcf0201..66aa0f22a 100644 --- a/content/telegraf/v1/input-plugins/beanstalkd/_index.md +++ b/content/telegraf/v1/input-plugins/beanstalkd/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/beanstalkd/README.md, Beanstalkd Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/beanstalkd/README.md, Beanstalkd Plugin Source --- # Beanstalkd Input Plugin diff --git a/content/telegraf/v1/input-plugins/beat/_index.md b/content/telegraf/v1/input-plugins/beat/_index.md index 54594f521..98d42d9ca 100644 --- a/content/telegraf/v1/input-plugins/beat/_index.md +++ b/content/telegraf/v1/input-plugins/beat/_index.md @@ -10,7 +10,7 @@ introduced: "v1.18.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/beat/README.md, Beat Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/beat/README.md, Beat Plugin Source --- # Beat Input Plugin diff --git a/content/telegraf/v1/input-plugins/bind/_index.md b/content/telegraf/v1/input-plugins/bind/_index.md index 5a7e2ec2f..8bb23bbd6 100644 --- a/content/telegraf/v1/input-plugins/bind/_index.md +++ b/content/telegraf/v1/input-plugins/bind/_index.md @@ -10,7 +10,7 @@ introduced: "v1.11.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/bind/README.md, BIND 9 Nameserver Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/bind/README.md, BIND 9 Nameserver Plugin Source --- # BIND 9 Nameserver Input Plugin diff --git a/content/telegraf/v1/input-plugins/bond/_index.md b/content/telegraf/v1/input-plugins/bond/_index.md index e97304b7a..f4af68588 100644 --- a/content/telegraf/v1/input-plugins/bond/_index.md +++ b/content/telegraf/v1/input-plugins/bond/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/bond/README.md, Bond Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/bond/README.md, Bond Plugin Source --- # Bond Input Plugin diff --git a/content/telegraf/v1/input-plugins/burrow/_index.md b/content/telegraf/v1/input-plugins/burrow/_index.md index 79c6fa9cd..8cdf5715a 100644 --- a/content/telegraf/v1/input-plugins/burrow/_index.md +++ b/content/telegraf/v1/input-plugins/burrow/_index.md @@ -10,7 +10,7 @@ introduced: "v1.7.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/burrow/README.md, Burrow Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/burrow/README.md, Burrow Plugin Source --- # Burrow Input Plugin diff --git a/content/telegraf/v1/input-plugins/ceph/_index.md b/content/telegraf/v1/input-plugins/ceph/_index.md index 7b0a4054f..4e2457853 100644 --- a/content/telegraf/v1/input-plugins/ceph/_index.md +++ b/content/telegraf/v1/input-plugins/ceph/_index.md @@ -10,7 +10,7 @@ introduced: "v0.13.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/ceph/README.md, Ceph Storage Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/ceph/README.md, Ceph Storage Plugin Source --- # Ceph Storage Input Plugin diff --git a/content/telegraf/v1/input-plugins/cgroup/_index.md b/content/telegraf/v1/input-plugins/cgroup/_index.md index cedbcf519..e18fb7861 100644 --- a/content/telegraf/v1/input-plugins/cgroup/_index.md +++ b/content/telegraf/v1/input-plugins/cgroup/_index.md @@ -10,7 +10,7 @@ introduced: "v1.0.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/cgroup/README.md, Control Group Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/cgroup/README.md, Control Group Plugin Source --- # Control Group Input Plugin diff --git a/content/telegraf/v1/input-plugins/chrony/_index.md b/content/telegraf/v1/input-plugins/chrony/_index.md index 47e700b85..dde05fefe 100644 --- a/content/telegraf/v1/input-plugins/chrony/_index.md +++ b/content/telegraf/v1/input-plugins/chrony/_index.md @@ -10,7 +10,7 @@ introduced: "v0.13.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/chrony/README.md, chrony Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/chrony/README.md, chrony Plugin Source --- # chrony Input Plugin diff --git a/content/telegraf/v1/input-plugins/cisco_telemetry_mdt/_index.md b/content/telegraf/v1/input-plugins/cisco_telemetry_mdt/_index.md index 9428d0897..dfde41571 100644 --- a/content/telegraf/v1/input-plugins/cisco_telemetry_mdt/_index.md +++ b/content/telegraf/v1/input-plugins/cisco_telemetry_mdt/_index.md @@ -10,7 +10,7 @@ introduced: "v1.11.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/cisco_telemetry_mdt/README.md, Cisco Model-Driven Telemetry (MDT) Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/cisco_telemetry_mdt/README.md, Cisco Model-Driven Telemetry (MDT) Plugin Source --- # Cisco Model-Driven Telemetry (MDT) Input Plugin diff --git a/content/telegraf/v1/input-plugins/clickhouse/_index.md b/content/telegraf/v1/input-plugins/clickhouse/_index.md index 78db381bb..720a87aec 100644 --- a/content/telegraf/v1/input-plugins/clickhouse/_index.md +++ b/content/telegraf/v1/input-plugins/clickhouse/_index.md @@ -10,7 +10,7 @@ introduced: "v1.14.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/clickhouse/README.md, ClickHouse Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/clickhouse/README.md, ClickHouse Plugin Source --- # ClickHouse Input Plugin diff --git a/content/telegraf/v1/input-plugins/cloud_pubsub/_index.md b/content/telegraf/v1/input-plugins/cloud_pubsub/_index.md index acc51346a..85b9f8d22 100644 --- a/content/telegraf/v1/input-plugins/cloud_pubsub/_index.md +++ b/content/telegraf/v1/input-plugins/cloud_pubsub/_index.md @@ -10,7 +10,7 @@ introduced: "v1.10.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/cloud_pubsub/README.md, Google Cloud PubSub Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/cloud_pubsub/README.md, Google Cloud PubSub Plugin Source --- # Google Cloud PubSub Input Plugin diff --git a/content/telegraf/v1/input-plugins/cloud_pubsub_push/_index.md b/content/telegraf/v1/input-plugins/cloud_pubsub_push/_index.md index 29da06e3c..cb8c8fdbe 100644 --- a/content/telegraf/v1/input-plugins/cloud_pubsub_push/_index.md +++ b/content/telegraf/v1/input-plugins/cloud_pubsub_push/_index.md @@ -10,7 +10,7 @@ introduced: "v1.10.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/cloud_pubsub_push/README.md, Google Cloud PubSub Push Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/cloud_pubsub_push/README.md, Google Cloud PubSub Push Plugin Source --- # Google Cloud PubSub Push Input Plugin diff --git a/content/telegraf/v1/input-plugins/cloudwatch/_index.md b/content/telegraf/v1/input-plugins/cloudwatch/_index.md index 47d54ab4e..dbb171736 100644 --- a/content/telegraf/v1/input-plugins/cloudwatch/_index.md +++ b/content/telegraf/v1/input-plugins/cloudwatch/_index.md @@ -10,7 +10,7 @@ introduced: "v0.12.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/cloudwatch/README.md, Amazon CloudWatch Statistics Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/cloudwatch/README.md, Amazon CloudWatch Statistics Plugin Source --- # Amazon CloudWatch Statistics Input Plugin diff --git a/content/telegraf/v1/input-plugins/cloudwatch_metric_streams/_index.md b/content/telegraf/v1/input-plugins/cloudwatch_metric_streams/_index.md index 975e1d740..3bea44860 100644 --- a/content/telegraf/v1/input-plugins/cloudwatch_metric_streams/_index.md +++ b/content/telegraf/v1/input-plugins/cloudwatch_metric_streams/_index.md @@ -10,7 +10,7 @@ introduced: "v1.24.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/cloudwatch_metric_streams/README.md, Amazon CloudWatch Metric Streams Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/cloudwatch_metric_streams/README.md, Amazon CloudWatch Metric Streams Plugin Source --- # Amazon CloudWatch Metric Streams Input Plugin diff --git a/content/telegraf/v1/input-plugins/conntrack/_index.md b/content/telegraf/v1/input-plugins/conntrack/_index.md index fbf5ab027..b2c919063 100644 --- a/content/telegraf/v1/input-plugins/conntrack/_index.md +++ b/content/telegraf/v1/input-plugins/conntrack/_index.md @@ -10,7 +10,7 @@ introduced: "v1.0.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/conntrack/README.md, Netfilter Conntrack Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/conntrack/README.md, Netfilter Conntrack Plugin Source --- # Netfilter Conntrack Input Plugin diff --git a/content/telegraf/v1/input-plugins/consul/_index.md b/content/telegraf/v1/input-plugins/consul/_index.md index ab45b41fe..c96d4a6a3 100644 --- a/content/telegraf/v1/input-plugins/consul/_index.md +++ b/content/telegraf/v1/input-plugins/consul/_index.md @@ -10,7 +10,7 @@ introduced: "v1.0.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/consul/README.md, Hashicorp Consul Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/consul/README.md, Hashicorp Consul Plugin Source --- # Hashicorp Consul Input Plugin diff --git a/content/telegraf/v1/input-plugins/consul_agent/_index.md b/content/telegraf/v1/input-plugins/consul_agent/_index.md index 1364562cf..916e39818 100644 --- a/content/telegraf/v1/input-plugins/consul_agent/_index.md +++ b/content/telegraf/v1/input-plugins/consul_agent/_index.md @@ -10,7 +10,7 @@ introduced: "v1.22.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/consul_agent/README.md, Hashicorp Consul Agent Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/consul_agent/README.md, Hashicorp Consul Agent Plugin Source --- # Hashicorp Consul Agent Input Plugin diff --git a/content/telegraf/v1/input-plugins/couchbase/_index.md b/content/telegraf/v1/input-plugins/couchbase/_index.md index 6ae00773c..b6cccd27e 100644 --- a/content/telegraf/v1/input-plugins/couchbase/_index.md +++ b/content/telegraf/v1/input-plugins/couchbase/_index.md @@ -10,7 +10,7 @@ introduced: "v0.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/couchbase/README.md, Couchbase Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/couchbase/README.md, Couchbase Plugin Source --- # Couchbase Input Plugin diff --git a/content/telegraf/v1/input-plugins/couchdb/_index.md b/content/telegraf/v1/input-plugins/couchdb/_index.md index 5a84c73b8..d5fe0e4b1 100644 --- a/content/telegraf/v1/input-plugins/couchdb/_index.md +++ b/content/telegraf/v1/input-plugins/couchdb/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.3" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/couchdb/README.md, Apache CouchDB Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/couchdb/README.md, Apache CouchDB Plugin Source --- # Apache CouchDB Input Plugin diff --git a/content/telegraf/v1/input-plugins/cpu/_index.md b/content/telegraf/v1/input-plugins/cpu/_index.md index 290d53430..9cfd0a595 100644 --- a/content/telegraf/v1/input-plugins/cpu/_index.md +++ b/content/telegraf/v1/input-plugins/cpu/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.5" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/cpu/README.md, CPU Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/cpu/README.md, CPU Plugin Source --- # CPU Input Plugin diff --git a/content/telegraf/v1/input-plugins/csgo/_index.md b/content/telegraf/v1/input-plugins/csgo/_index.md index 4670882d3..4adffe244 100644 --- a/content/telegraf/v1/input-plugins/csgo/_index.md +++ b/content/telegraf/v1/input-plugins/csgo/_index.md @@ -10,7 +10,7 @@ introduced: "v1.18.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/csgo/README.md, Counter-Strike Global Offensive (CSGO) Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/csgo/README.md, Counter-Strike Global Offensive (CSGO) Plugin Source --- # Counter-Strike: Global Offensive (CSGO) Input Plugin diff --git a/content/telegraf/v1/input-plugins/ctrlx_datalayer/_index.md b/content/telegraf/v1/input-plugins/ctrlx_datalayer/_index.md index af43240e5..8cf6feff3 100644 --- a/content/telegraf/v1/input-plugins/ctrlx_datalayer/_index.md +++ b/content/telegraf/v1/input-plugins/ctrlx_datalayer/_index.md @@ -10,7 +10,7 @@ introduced: "v1.27.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/ctrlx_datalayer/README.md, Bosch Rexroth ctrlX Data Layer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/ctrlx_datalayer/README.md, Bosch Rexroth ctrlX Data Layer Plugin Source --- # Bosch Rexroth ctrlX Data Layer Input Plugin diff --git a/content/telegraf/v1/input-plugins/dcos/_index.md b/content/telegraf/v1/input-plugins/dcos/_index.md index 38f7dc000..6340b5d0d 100644 --- a/content/telegraf/v1/input-plugins/dcos/_index.md +++ b/content/telegraf/v1/input-plugins/dcos/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/dcos/README.md, Mesosphere Distributed Cloud OS Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/dcos/README.md, Mesosphere Distributed Cloud OS Plugin Source --- # Mesosphere Distributed Cloud OS Input Plugin diff --git a/content/telegraf/v1/input-plugins/directory_monitor/_index.md b/content/telegraf/v1/input-plugins/directory_monitor/_index.md index 83b1b8073..4a131d4a3 100644 --- a/content/telegraf/v1/input-plugins/directory_monitor/_index.md +++ b/content/telegraf/v1/input-plugins/directory_monitor/_index.md @@ -10,7 +10,7 @@ introduced: "v1.18.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/directory_monitor/README.md, Directory Monitor Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/directory_monitor/README.md, Directory Monitor Plugin Source --- # Directory Monitor Input Plugin diff --git a/content/telegraf/v1/input-plugins/disk/_index.md b/content/telegraf/v1/input-plugins/disk/_index.md index 49e88c18d..2f61daf2f 100644 --- a/content/telegraf/v1/input-plugins/disk/_index.md +++ b/content/telegraf/v1/input-plugins/disk/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/disk/README.md, Disk Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/disk/README.md, Disk Plugin Source --- # Disk Input Plugin diff --git a/content/telegraf/v1/input-plugins/diskio/_index.md b/content/telegraf/v1/input-plugins/diskio/_index.md index b6e8e2da1..7a3ba1888 100644 --- a/content/telegraf/v1/input-plugins/diskio/_index.md +++ b/content/telegraf/v1/input-plugins/diskio/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/diskio/README.md, DiskIO Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/diskio/README.md, DiskIO Plugin Source --- # DiskIO Input Plugin diff --git a/content/telegraf/v1/input-plugins/disque/_index.md b/content/telegraf/v1/input-plugins/disque/_index.md index 6c9538d15..f42f62937 100644 --- a/content/telegraf/v1/input-plugins/disque/_index.md +++ b/content/telegraf/v1/input-plugins/disque/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/disque/README.md, Disque Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/disque/README.md, Disque Plugin Source --- # Disque Input Plugin diff --git a/content/telegraf/v1/input-plugins/dmcache/_index.md b/content/telegraf/v1/input-plugins/dmcache/_index.md index a84585440..3768a54cf 100644 --- a/content/telegraf/v1/input-plugins/dmcache/_index.md +++ b/content/telegraf/v1/input-plugins/dmcache/_index.md @@ -10,7 +10,7 @@ introduced: "v1.3.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/dmcache/README.md, Device Mapper Cache Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/dmcache/README.md, Device Mapper Cache Plugin Source --- # Device Mapper Cache Input Plugin diff --git a/content/telegraf/v1/input-plugins/dns_query/_index.md b/content/telegraf/v1/input-plugins/dns_query/_index.md index 06d960353..dba08d1a2 100644 --- a/content/telegraf/v1/input-plugins/dns_query/_index.md +++ b/content/telegraf/v1/input-plugins/dns_query/_index.md @@ -10,7 +10,7 @@ introduced: "v1.4.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/dns_query/README.md, DNS Query Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/dns_query/README.md, DNS Query Plugin Source --- # DNS Query Input Plugin diff --git a/content/telegraf/v1/input-plugins/docker/_index.md b/content/telegraf/v1/input-plugins/docker/_index.md index 2d5154f6c..9493c7e13 100644 --- a/content/telegraf/v1/input-plugins/docker/_index.md +++ b/content/telegraf/v1/input-plugins/docker/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.9" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/docker/README.md, Docker Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/docker/README.md, Docker Plugin Source --- # Docker Input Plugin diff --git a/content/telegraf/v1/input-plugins/docker_log/_index.md b/content/telegraf/v1/input-plugins/docker_log/_index.md index 16f41026a..155cddee7 100644 --- a/content/telegraf/v1/input-plugins/docker_log/_index.md +++ b/content/telegraf/v1/input-plugins/docker_log/_index.md @@ -10,7 +10,7 @@ introduced: "v1.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/docker_log/README.md, Docker Log Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/docker_log/README.md, Docker Log Plugin Source --- # Docker Log Input Plugin diff --git a/content/telegraf/v1/input-plugins/dovecot/_index.md b/content/telegraf/v1/input-plugins/dovecot/_index.md index cf90b6be9..595f35fb3 100644 --- a/content/telegraf/v1/input-plugins/dovecot/_index.md +++ b/content/telegraf/v1/input-plugins/dovecot/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.3" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/dovecot/README.md, Dovecot Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/dovecot/README.md, Dovecot Plugin Source --- # Dovecot Input Plugin diff --git a/content/telegraf/v1/input-plugins/dpdk/_index.md b/content/telegraf/v1/input-plugins/dpdk/_index.md index 8eb6440e1..f23988ea4 100644 --- a/content/telegraf/v1/input-plugins/dpdk/_index.md +++ b/content/telegraf/v1/input-plugins/dpdk/_index.md @@ -10,7 +10,7 @@ introduced: "v1.19.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/dpdk/README.md, Data Plane Development Kit (DPDK) Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/dpdk/README.md, Data Plane Development Kit (DPDK) Plugin Source --- # Data Plane Development Kit (DPDK) Input Plugin diff --git a/content/telegraf/v1/input-plugins/ecs/_index.md b/content/telegraf/v1/input-plugins/ecs/_index.md index 750223b42..b209580f7 100644 --- a/content/telegraf/v1/input-plugins/ecs/_index.md +++ b/content/telegraf/v1/input-plugins/ecs/_index.md @@ -10,7 +10,7 @@ introduced: "v1.11.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/ecs/README.md, Amazon Elastic Container Service Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/ecs/README.md, Amazon Elastic Container Service Plugin Source --- # Amazon Elastic Container Service Input Plugin diff --git a/content/telegraf/v1/input-plugins/elasticsearch/_index.md b/content/telegraf/v1/input-plugins/elasticsearch/_index.md index 43f0fc08b..9720200e4 100644 --- a/content/telegraf/v1/input-plugins/elasticsearch/_index.md +++ b/content/telegraf/v1/input-plugins/elasticsearch/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.5" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/elasticsearch/README.md, Elasticsearch Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/elasticsearch/README.md, Elasticsearch Plugin Source --- # Elasticsearch Input Plugin diff --git a/content/telegraf/v1/input-plugins/elasticsearch_query/_index.md b/content/telegraf/v1/input-plugins/elasticsearch_query/_index.md index aec2c4425..5a2958dbf 100644 --- a/content/telegraf/v1/input-plugins/elasticsearch_query/_index.md +++ b/content/telegraf/v1/input-plugins/elasticsearch_query/_index.md @@ -10,7 +10,7 @@ introduced: "v1.20.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/elasticsearch_query/README.md, Elasticsearch Query Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/elasticsearch_query/README.md, Elasticsearch Query Plugin Source --- # Elasticsearch Query Input Plugin diff --git a/content/telegraf/v1/input-plugins/ethtool/_index.md b/content/telegraf/v1/input-plugins/ethtool/_index.md index 39c46f503..876c5b753 100644 --- a/content/telegraf/v1/input-plugins/ethtool/_index.md +++ b/content/telegraf/v1/input-plugins/ethtool/_index.md @@ -10,7 +10,7 @@ introduced: "v1.13.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/ethtool/README.md, Ethtool Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/ethtool/README.md, Ethtool Plugin Source --- # Ethtool Input Plugin diff --git a/content/telegraf/v1/input-plugins/eventhub_consumer/_index.md b/content/telegraf/v1/input-plugins/eventhub_consumer/_index.md index 249402bed..95e073e6f 100644 --- a/content/telegraf/v1/input-plugins/eventhub_consumer/_index.md +++ b/content/telegraf/v1/input-plugins/eventhub_consumer/_index.md @@ -10,7 +10,7 @@ introduced: "v1.14.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/eventhub_consumer/README.md, Azure Event Hub Consumer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/eventhub_consumer/README.md, Azure Event Hub Consumer Plugin Source --- # Azure Event Hub Consumer Input Plugin diff --git a/content/telegraf/v1/input-plugins/exec/_index.md b/content/telegraf/v1/input-plugins/exec/_index.md index b584b9034..c542d6d0b 100644 --- a/content/telegraf/v1/input-plugins/exec/_index.md +++ b/content/telegraf/v1/input-plugins/exec/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.5" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/exec/README.md, Exec Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/exec/README.md, Exec Plugin Source --- # Exec Input Plugin diff --git a/content/telegraf/v1/input-plugins/execd/_index.md b/content/telegraf/v1/input-plugins/execd/_index.md index 2b24f995d..3202d578c 100644 --- a/content/telegraf/v1/input-plugins/execd/_index.md +++ b/content/telegraf/v1/input-plugins/execd/_index.md @@ -10,7 +10,7 @@ introduced: "v1.14.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/execd/README.md, Execd Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/execd/README.md, Execd Plugin Source --- # Execd Input Plugin diff --git a/content/telegraf/v1/input-plugins/fail2ban/_index.md b/content/telegraf/v1/input-plugins/fail2ban/_index.md index b7fa98241..7d355b038 100644 --- a/content/telegraf/v1/input-plugins/fail2ban/_index.md +++ b/content/telegraf/v1/input-plugins/fail2ban/_index.md @@ -10,7 +10,7 @@ introduced: "v1.4.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/fail2ban/README.md, Fail2ban Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/fail2ban/README.md, Fail2ban Plugin Source --- # Fail2ban Input Plugin diff --git a/content/telegraf/v1/input-plugins/fibaro/_index.md b/content/telegraf/v1/input-plugins/fibaro/_index.md index 98f35fbff..7e48c3801 100644 --- a/content/telegraf/v1/input-plugins/fibaro/_index.md +++ b/content/telegraf/v1/input-plugins/fibaro/_index.md @@ -10,7 +10,7 @@ introduced: "v1.7.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/fibaro/README.md, Fibaro Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/fibaro/README.md, Fibaro Plugin Source --- # Fibaro Input Plugin diff --git a/content/telegraf/v1/input-plugins/file/_index.md b/content/telegraf/v1/input-plugins/file/_index.md index 1900fe150..570bf0c16 100644 --- a/content/telegraf/v1/input-plugins/file/_index.md +++ b/content/telegraf/v1/input-plugins/file/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/file/README.md, File Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/file/README.md, File Plugin Source --- # File Input Plugin diff --git a/content/telegraf/v1/input-plugins/filecount/_index.md b/content/telegraf/v1/input-plugins/filecount/_index.md index d38360423..e3ab21c98 100644 --- a/content/telegraf/v1/input-plugins/filecount/_index.md +++ b/content/telegraf/v1/input-plugins/filecount/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/filecount/README.md, Filecount Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/filecount/README.md, Filecount Plugin Source --- # Filecount Input Plugin diff --git a/content/telegraf/v1/input-plugins/filestat/_index.md b/content/telegraf/v1/input-plugins/filestat/_index.md index 53e55d55f..445959fd4 100644 --- a/content/telegraf/v1/input-plugins/filestat/_index.md +++ b/content/telegraf/v1/input-plugins/filestat/_index.md @@ -10,7 +10,7 @@ introduced: "v0.13.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/filestat/README.md, File statistics Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/filestat/README.md, File statistics Plugin Source --- # File statistics Input Plugin diff --git a/content/telegraf/v1/input-plugins/fireboard/_index.md b/content/telegraf/v1/input-plugins/fireboard/_index.md index ae0f0b3d4..324508952 100644 --- a/content/telegraf/v1/input-plugins/fireboard/_index.md +++ b/content/telegraf/v1/input-plugins/fireboard/_index.md @@ -10,7 +10,7 @@ introduced: "v1.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/fireboard/README.md, Fireboard Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/fireboard/README.md, Fireboard Plugin Source --- # Fireboard Input Plugin diff --git a/content/telegraf/v1/input-plugins/firehose/_index.md b/content/telegraf/v1/input-plugins/firehose/_index.md index b8551bdc8..b7c7a20c4 100644 --- a/content/telegraf/v1/input-plugins/firehose/_index.md +++ b/content/telegraf/v1/input-plugins/firehose/_index.md @@ -10,7 +10,7 @@ introduced: "v1.34.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/firehose/README.md, AWS Data Firehose Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/firehose/README.md, AWS Data Firehose Plugin Source --- # AWS Data Firehose Input Plugin diff --git a/content/telegraf/v1/input-plugins/fluentd/_index.md b/content/telegraf/v1/input-plugins/fluentd/_index.md index 1a27d3b32..4d8b89e73 100644 --- a/content/telegraf/v1/input-plugins/fluentd/_index.md +++ b/content/telegraf/v1/input-plugins/fluentd/_index.md @@ -10,7 +10,7 @@ introduced: "v1.4.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/fluentd/README.md, Fluentd Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/fluentd/README.md, Fluentd Plugin Source --- # Fluentd Input Plugin diff --git a/content/telegraf/v1/input-plugins/fritzbox/_index.md b/content/telegraf/v1/input-plugins/fritzbox/_index.md index 710ad6e38..0c55e106d 100644 --- a/content/telegraf/v1/input-plugins/fritzbox/_index.md +++ b/content/telegraf/v1/input-plugins/fritzbox/_index.md @@ -10,7 +10,7 @@ introduced: "v1.35.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/fritzbox/README.md, Fritzbox Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/fritzbox/README.md, Fritzbox Plugin Source --- # Fritzbox Input Plugin diff --git a/content/telegraf/v1/input-plugins/github/_index.md b/content/telegraf/v1/input-plugins/github/_index.md index 68a54e067..6f2e64af1 100644 --- a/content/telegraf/v1/input-plugins/github/_index.md +++ b/content/telegraf/v1/input-plugins/github/_index.md @@ -10,7 +10,7 @@ introduced: "v1.11.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/github/README.md, GitHub Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/github/README.md, GitHub Plugin Source --- # GitHub Input Plugin diff --git a/content/telegraf/v1/input-plugins/gnmi/_index.md b/content/telegraf/v1/input-plugins/gnmi/_index.md index f1ba5f124..ff455b9d8 100644 --- a/content/telegraf/v1/input-plugins/gnmi/_index.md +++ b/content/telegraf/v1/input-plugins/gnmi/_index.md @@ -10,7 +10,7 @@ introduced: "v1.15.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/gnmi/README.md, gNMI (gRPC Network Management Interface) Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/gnmi/README.md, gNMI (gRPC Network Management Interface) Plugin Source --- # gNMI (gRPC Network Management Interface) Input Plugin @@ -102,6 +102,9 @@ details on how to use them. ## Only receive updates for the state, also suppresses receiving the initial state # updates_only = false + ## Emit a metric for "delete" messages + # emit_delete_metrics = false + ## Enforces the namespace of the first element as origin for aliases and ## response paths, required for backward compatibility. ## NOTE: Set to 'false' if possible but be aware that this might change the path tag! diff --git a/content/telegraf/v1/input-plugins/google_cloud_storage/_index.md b/content/telegraf/v1/input-plugins/google_cloud_storage/_index.md index cabb07537..83c26d2fb 100644 --- a/content/telegraf/v1/input-plugins/google_cloud_storage/_index.md +++ b/content/telegraf/v1/input-plugins/google_cloud_storage/_index.md @@ -10,7 +10,7 @@ introduced: "v1.25.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/google_cloud_storage/README.md, Google Cloud Storage Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/google_cloud_storage/README.md, Google Cloud Storage Plugin Source --- # Google Cloud Storage Input Plugin diff --git a/content/telegraf/v1/input-plugins/graylog/_index.md b/content/telegraf/v1/input-plugins/graylog/_index.md index c5fb9e72b..2ce54eb3f 100644 --- a/content/telegraf/v1/input-plugins/graylog/_index.md +++ b/content/telegraf/v1/input-plugins/graylog/_index.md @@ -10,7 +10,7 @@ introduced: "v1.0.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/graylog/README.md, GrayLog Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/graylog/README.md, GrayLog Plugin Source --- # GrayLog Input Plugin diff --git a/content/telegraf/v1/input-plugins/haproxy/_index.md b/content/telegraf/v1/input-plugins/haproxy/_index.md index 1a45a15a6..6a033ac83 100644 --- a/content/telegraf/v1/input-plugins/haproxy/_index.md +++ b/content/telegraf/v1/input-plugins/haproxy/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.5" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/haproxy/README.md, HAProxy Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/haproxy/README.md, HAProxy Plugin Source --- # HAProxy Input Plugin diff --git a/content/telegraf/v1/input-plugins/hddtemp/_index.md b/content/telegraf/v1/input-plugins/hddtemp/_index.md index 693d64582..a81942c1b 100644 --- a/content/telegraf/v1/input-plugins/hddtemp/_index.md +++ b/content/telegraf/v1/input-plugins/hddtemp/_index.md @@ -10,7 +10,7 @@ introduced: "v1.0.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/hddtemp/README.md, HDDtemp Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/hddtemp/README.md, HDDtemp Plugin Source --- # HDDtemp Input Plugin diff --git a/content/telegraf/v1/input-plugins/http/_index.md b/content/telegraf/v1/input-plugins/http/_index.md index 11aed2206..f83815209 100644 --- a/content/telegraf/v1/input-plugins/http/_index.md +++ b/content/telegraf/v1/input-plugins/http/_index.md @@ -10,7 +10,7 @@ introduced: "v1.6.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/http/README.md, HTTP Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/http/README.md, HTTP Plugin Source --- # HTTP Input Plugin @@ -83,6 +83,9 @@ to use them. # max_idle_conn_per_host = 0 # response_timeout = "0s" + ## Use the local address for connecting, assigned by the OS by default + # local_address = "" + ## Optional proxy settings # use_system_proxy = false # http_proxy_url = "" diff --git a/content/telegraf/v1/input-plugins/http_listener_v2/_index.md b/content/telegraf/v1/input-plugins/http_listener_v2/_index.md index 49f2eacb4..dac3a1ff7 100644 --- a/content/telegraf/v1/input-plugins/http_listener_v2/_index.md +++ b/content/telegraf/v1/input-plugins/http_listener_v2/_index.md @@ -10,7 +10,7 @@ introduced: "v1.9.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/http_listener_v2/README.md, HTTP Listener v2 Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/http_listener_v2/README.md, HTTP Listener v2 Plugin Source --- # HTTP Listener v2 Input Plugin diff --git a/content/telegraf/v1/input-plugins/http_response/_index.md b/content/telegraf/v1/input-plugins/http_response/_index.md index 5178a9a5e..d1b1c14db 100644 --- a/content/telegraf/v1/input-plugins/http_response/_index.md +++ b/content/telegraf/v1/input-plugins/http_response/_index.md @@ -10,7 +10,7 @@ introduced: "v0.12.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/http_response/README.md, HTTP Response Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/http_response/README.md, HTTP Response Plugin Source --- # HTTP Response Input Plugin diff --git a/content/telegraf/v1/input-plugins/huebridge/_index.md b/content/telegraf/v1/input-plugins/huebridge/_index.md index eccdcbfca..a161383e2 100644 --- a/content/telegraf/v1/input-plugins/huebridge/_index.md +++ b/content/telegraf/v1/input-plugins/huebridge/_index.md @@ -10,7 +10,7 @@ introduced: "v1.34.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/huebridge/README.md, HueBridge Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/huebridge/README.md, HueBridge Plugin Source --- # HueBridge Input Plugin diff --git a/content/telegraf/v1/input-plugins/hugepages/_index.md b/content/telegraf/v1/input-plugins/hugepages/_index.md index dbc738ce2..9c5d18482 100644 --- a/content/telegraf/v1/input-plugins/hugepages/_index.md +++ b/content/telegraf/v1/input-plugins/hugepages/_index.md @@ -10,7 +10,7 @@ introduced: "v1.22.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/hugepages/README.md, Hugepages Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/hugepages/README.md, Hugepages Plugin Source --- # Hugepages Input Plugin diff --git a/content/telegraf/v1/input-plugins/icinga2/_index.md b/content/telegraf/v1/input-plugins/icinga2/_index.md index ccb5c7009..5731b4edb 100644 --- a/content/telegraf/v1/input-plugins/icinga2/_index.md +++ b/content/telegraf/v1/input-plugins/icinga2/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/icinga2/README.md, Icinga2 Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/icinga2/README.md, Icinga2 Plugin Source --- # Icinga2 Input Plugin diff --git a/content/telegraf/v1/input-plugins/infiniband/_index.md b/content/telegraf/v1/input-plugins/infiniband/_index.md index 30801ba3d..e49548c6b 100644 --- a/content/telegraf/v1/input-plugins/infiniband/_index.md +++ b/content/telegraf/v1/input-plugins/infiniband/_index.md @@ -10,7 +10,7 @@ introduced: "v1.14.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/infiniband/README.md, InfiniBand Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/infiniband/README.md, InfiniBand Plugin Source --- # InfiniBand Input Plugin diff --git a/content/telegraf/v1/input-plugins/influxdb/_index.md b/content/telegraf/v1/input-plugins/influxdb/_index.md index 083b0f6db..7f4aea245 100644 --- a/content/telegraf/v1/input-plugins/influxdb/_index.md +++ b/content/telegraf/v1/input-plugins/influxdb/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.5" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/influxdb/README.md, InfluxDB Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/influxdb/README.md, InfluxDB Plugin Source --- # InfluxDB Input Plugin diff --git a/content/telegraf/v1/input-plugins/influxdb_listener/_index.md b/content/telegraf/v1/input-plugins/influxdb_listener/_index.md index 4dad0abca..7ee64afc3 100644 --- a/content/telegraf/v1/input-plugins/influxdb_listener/_index.md +++ b/content/telegraf/v1/input-plugins/influxdb_listener/_index.md @@ -10,7 +10,7 @@ introduced: "v1.9.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/influxdb_listener/README.md, InfluxDB Listener Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/influxdb_listener/README.md, InfluxDB Listener Plugin Source --- # InfluxDB Listener Input Plugin diff --git a/content/telegraf/v1/input-plugins/influxdb_v2_listener/_index.md b/content/telegraf/v1/input-plugins/influxdb_v2_listener/_index.md index dbd52f76c..acf23499f 100644 --- a/content/telegraf/v1/input-plugins/influxdb_v2_listener/_index.md +++ b/content/telegraf/v1/input-plugins/influxdb_v2_listener/_index.md @@ -10,7 +10,7 @@ introduced: "v1.16.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/influxdb_v2_listener/README.md, InfluxDB V2 Listener Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/influxdb_v2_listener/README.md, InfluxDB V2 Listener Plugin Source --- # InfluxDB V2 Listener Input Plugin diff --git a/content/telegraf/v1/input-plugins/intel_baseband/_index.md b/content/telegraf/v1/input-plugins/intel_baseband/_index.md index 85c531768..bec0e9128 100644 --- a/content/telegraf/v1/input-plugins/intel_baseband/_index.md +++ b/content/telegraf/v1/input-plugins/intel_baseband/_index.md @@ -10,7 +10,7 @@ introduced: "v1.27.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/intel_baseband/README.md, Intel Baseband Accelerator Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/intel_baseband/README.md, Intel Baseband Accelerator Plugin Source --- # Intel Baseband Accelerator Input Plugin diff --git a/content/telegraf/v1/input-plugins/intel_dlb/_index.md b/content/telegraf/v1/input-plugins/intel_dlb/_index.md index 91f126c89..b8413787e 100644 --- a/content/telegraf/v1/input-plugins/intel_dlb/_index.md +++ b/content/telegraf/v1/input-plugins/intel_dlb/_index.md @@ -10,7 +10,7 @@ introduced: "v1.25.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/intel_dlb/README.md, Intel® Dynamic Load Balancer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/intel_dlb/README.md, Intel® Dynamic Load Balancer Plugin Source --- # Intel® Dynamic Load Balancer Input Plugin diff --git a/content/telegraf/v1/input-plugins/intel_pmt/_index.md b/content/telegraf/v1/input-plugins/intel_pmt/_index.md index dfb76375c..5ee77cf4f 100644 --- a/content/telegraf/v1/input-plugins/intel_pmt/_index.md +++ b/content/telegraf/v1/input-plugins/intel_pmt/_index.md @@ -10,7 +10,7 @@ introduced: "v1.28.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/intel_pmt/README.md, Intel® Platform Monitoring Technology Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/intel_pmt/README.md, Intel® Platform Monitoring Technology Plugin Source --- # Intel® Platform Monitoring Technology Input Plugin diff --git a/content/telegraf/v1/input-plugins/intel_pmu/_index.md b/content/telegraf/v1/input-plugins/intel_pmu/_index.md index 9d8a39fef..c52e3aace 100644 --- a/content/telegraf/v1/input-plugins/intel_pmu/_index.md +++ b/content/telegraf/v1/input-plugins/intel_pmu/_index.md @@ -10,7 +10,7 @@ introduced: "v1.21.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/intel_pmu/README.md, Intel Performance Monitoring Unit Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/intel_pmu/README.md, Intel Performance Monitoring Unit Plugin Source --- # Intel Performance Monitoring Unit Plugin diff --git a/content/telegraf/v1/input-plugins/intel_powerstat/_index.md b/content/telegraf/v1/input-plugins/intel_powerstat/_index.md index 36d8a5f3b..f1c45121b 100644 --- a/content/telegraf/v1/input-plugins/intel_powerstat/_index.md +++ b/content/telegraf/v1/input-plugins/intel_powerstat/_index.md @@ -10,7 +10,7 @@ introduced: "v1.17.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/intel_powerstat/README.md, Intel PowerStat Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/intel_powerstat/README.md, Intel PowerStat Plugin Source --- # Intel PowerStat Input Plugin diff --git a/content/telegraf/v1/input-plugins/intel_rdt/_index.md b/content/telegraf/v1/input-plugins/intel_rdt/_index.md index 979618b31..c39039552 100644 --- a/content/telegraf/v1/input-plugins/intel_rdt/_index.md +++ b/content/telegraf/v1/input-plugins/intel_rdt/_index.md @@ -10,7 +10,7 @@ introduced: "v1.16.0" os_support: "freebsd, linux, macos" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/intel_rdt/README.md, Intel RDT Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/intel_rdt/README.md, Intel RDT Plugin Source --- # Intel RDT Input Plugin diff --git a/content/telegraf/v1/input-plugins/internal/_index.md b/content/telegraf/v1/input-plugins/internal/_index.md index 86a9048fa..b60595fc2 100644 --- a/content/telegraf/v1/input-plugins/internal/_index.md +++ b/content/telegraf/v1/input-plugins/internal/_index.md @@ -10,7 +10,7 @@ introduced: "v1.2.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/internal/README.md, Telegraf Internal Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/internal/README.md, Telegraf Internal Plugin Source --- # Telegraf Internal Input Plugin diff --git a/content/telegraf/v1/input-plugins/internet_speed/_index.md b/content/telegraf/v1/input-plugins/internet_speed/_index.md index 34b13ba04..a22e8f7d8 100644 --- a/content/telegraf/v1/input-plugins/internet_speed/_index.md +++ b/content/telegraf/v1/input-plugins/internet_speed/_index.md @@ -10,7 +10,7 @@ introduced: "v1.20.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/internet_speed/README.md, Internet Speed Monitor Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/internet_speed/README.md, Internet Speed Monitor Plugin Source --- # Internet Speed Monitor Input Plugin diff --git a/content/telegraf/v1/input-plugins/interrupts/_index.md b/content/telegraf/v1/input-plugins/interrupts/_index.md index a49e96b49..3b20515cb 100644 --- a/content/telegraf/v1/input-plugins/interrupts/_index.md +++ b/content/telegraf/v1/input-plugins/interrupts/_index.md @@ -10,7 +10,7 @@ introduced: "v1.3.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/interrupts/README.md, Interrupts Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/interrupts/README.md, Interrupts Plugin Source --- # Interrupts Input Plugin diff --git a/content/telegraf/v1/input-plugins/ipmi_sensor/_index.md b/content/telegraf/v1/input-plugins/ipmi_sensor/_index.md index 916bacf3a..efba924e5 100644 --- a/content/telegraf/v1/input-plugins/ipmi_sensor/_index.md +++ b/content/telegraf/v1/input-plugins/ipmi_sensor/_index.md @@ -10,7 +10,7 @@ introduced: "v0.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/ipmi_sensor/README.md, IPMI Sensor Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/ipmi_sensor/README.md, IPMI Sensor Plugin Source --- # IPMI Sensor Input Plugin diff --git a/content/telegraf/v1/input-plugins/ipset/_index.md b/content/telegraf/v1/input-plugins/ipset/_index.md index 526813c12..dc649f4df 100644 --- a/content/telegraf/v1/input-plugins/ipset/_index.md +++ b/content/telegraf/v1/input-plugins/ipset/_index.md @@ -10,7 +10,7 @@ introduced: "v1.6.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/ipset/README.md, Ipset Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/ipset/README.md, Ipset Plugin Source --- # Ipset Input Plugin diff --git a/content/telegraf/v1/input-plugins/iptables/_index.md b/content/telegraf/v1/input-plugins/iptables/_index.md index 36efd03fa..ebad367e7 100644 --- a/content/telegraf/v1/input-plugins/iptables/_index.md +++ b/content/telegraf/v1/input-plugins/iptables/_index.md @@ -10,7 +10,7 @@ introduced: "v1.1.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/iptables/README.md, Iptables Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/iptables/README.md, Iptables Plugin Source --- # Iptables Input Plugin diff --git a/content/telegraf/v1/input-plugins/ipvs/_index.md b/content/telegraf/v1/input-plugins/ipvs/_index.md index 52809fee5..af3bcb998 100644 --- a/content/telegraf/v1/input-plugins/ipvs/_index.md +++ b/content/telegraf/v1/input-plugins/ipvs/_index.md @@ -10,7 +10,7 @@ introduced: "v1.9.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/ipvs/README.md, IPVS Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/ipvs/README.md, IPVS Plugin Source --- # IPVS Input Plugin diff --git a/content/telegraf/v1/input-plugins/jenkins/_index.md b/content/telegraf/v1/input-plugins/jenkins/_index.md index 26ec6e26b..18a8b1814 100644 --- a/content/telegraf/v1/input-plugins/jenkins/_index.md +++ b/content/telegraf/v1/input-plugins/jenkins/_index.md @@ -10,7 +10,7 @@ introduced: "v1.9.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/jenkins/README.md, Jenkins Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/jenkins/README.md, Jenkins Plugin Source --- # Jenkins Input Plugin diff --git a/content/telegraf/v1/input-plugins/jolokia2_agent/_index.md b/content/telegraf/v1/input-plugins/jolokia2_agent/_index.md index 467d74043..d9abc046d 100644 --- a/content/telegraf/v1/input-plugins/jolokia2_agent/_index.md +++ b/content/telegraf/v1/input-plugins/jolokia2_agent/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/jolokia2_agent/README.md, Jolokia2 Agent Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/jolokia2_agent/README.md, Jolokia2 Agent Plugin Source --- # Jolokia2 Agent Input Plugin diff --git a/content/telegraf/v1/input-plugins/jolokia2_proxy/_index.md b/content/telegraf/v1/input-plugins/jolokia2_proxy/_index.md index 816f1e761..f0b842deb 100644 --- a/content/telegraf/v1/input-plugins/jolokia2_proxy/_index.md +++ b/content/telegraf/v1/input-plugins/jolokia2_proxy/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/jolokia2_proxy/README.md, Jolokia2 Proxy Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/jolokia2_proxy/README.md, Jolokia2 Proxy Plugin Source --- # Jolokia2 Proxy Input Plugin diff --git a/content/telegraf/v1/input-plugins/jti_openconfig_telemetry/_index.md b/content/telegraf/v1/input-plugins/jti_openconfig_telemetry/_index.md index 2a15f8462..1a42ea301 100644 --- a/content/telegraf/v1/input-plugins/jti_openconfig_telemetry/_index.md +++ b/content/telegraf/v1/input-plugins/jti_openconfig_telemetry/_index.md @@ -10,7 +10,7 @@ introduced: "v1.7.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/jti_openconfig_telemetry/README.md, Juniper Telemetry Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/jti_openconfig_telemetry/README.md, Juniper Telemetry Plugin Source --- # Juniper Telemetry Input Plugin diff --git a/content/telegraf/v1/input-plugins/kafka_consumer/_index.md b/content/telegraf/v1/input-plugins/kafka_consumer/_index.md index 344cc8c44..0ce0ddef7 100644 --- a/content/telegraf/v1/input-plugins/kafka_consumer/_index.md +++ b/content/telegraf/v1/input-plugins/kafka_consumer/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.3" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/kafka_consumer/README.md, Apache Kafka Consumer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/kafka_consumer/README.md, Apache Kafka Consumer Plugin Source --- # Apache Kafka Consumer Input Plugin diff --git a/content/telegraf/v1/input-plugins/kapacitor/_index.md b/content/telegraf/v1/input-plugins/kapacitor/_index.md index dd7e69389..96ec47145 100644 --- a/content/telegraf/v1/input-plugins/kapacitor/_index.md +++ b/content/telegraf/v1/input-plugins/kapacitor/_index.md @@ -10,7 +10,7 @@ introduced: "v1.3.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/kapacitor/README.md, Kapacitor Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/kapacitor/README.md, Kapacitor Plugin Source --- # Kapacitor Input Plugin diff --git a/content/telegraf/v1/input-plugins/kernel/_index.md b/content/telegraf/v1/input-plugins/kernel/_index.md index 885f3b581..99ae68478 100644 --- a/content/telegraf/v1/input-plugins/kernel/_index.md +++ b/content/telegraf/v1/input-plugins/kernel/_index.md @@ -10,7 +10,7 @@ introduced: "v0.11.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/kernel/README.md, Kernel Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/kernel/README.md, Kernel Plugin Source --- # Kernel Input Plugin diff --git a/content/telegraf/v1/input-plugins/kernel_vmstat/_index.md b/content/telegraf/v1/input-plugins/kernel_vmstat/_index.md index c60667001..91c30e94b 100644 --- a/content/telegraf/v1/input-plugins/kernel_vmstat/_index.md +++ b/content/telegraf/v1/input-plugins/kernel_vmstat/_index.md @@ -10,7 +10,7 @@ introduced: "v1.0.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/kernel_vmstat/README.md, Kernel VM Statistics Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/kernel_vmstat/README.md, Kernel VM Statistics Plugin Source --- # Kernel VM Statistics Input Plugin diff --git a/content/telegraf/v1/input-plugins/kibana/_index.md b/content/telegraf/v1/input-plugins/kibana/_index.md index 51b2370f7..81aba85e6 100644 --- a/content/telegraf/v1/input-plugins/kibana/_index.md +++ b/content/telegraf/v1/input-plugins/kibana/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/kibana/README.md, Kibana Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/kibana/README.md, Kibana Plugin Source --- # Kibana Input Plugin diff --git a/content/telegraf/v1/input-plugins/kinesis_consumer/_index.md b/content/telegraf/v1/input-plugins/kinesis_consumer/_index.md index bcedef758..fd5ae57af 100644 --- a/content/telegraf/v1/input-plugins/kinesis_consumer/_index.md +++ b/content/telegraf/v1/input-plugins/kinesis_consumer/_index.md @@ -10,7 +10,7 @@ introduced: "v1.10.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/kinesis_consumer/README.md, Kinesis Consumer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/kinesis_consumer/README.md, Kinesis Consumer Plugin Source --- # Kinesis Consumer Input Plugin diff --git a/content/telegraf/v1/input-plugins/knx_listener/_index.md b/content/telegraf/v1/input-plugins/knx_listener/_index.md index d570e2285..f8e3b64c1 100644 --- a/content/telegraf/v1/input-plugins/knx_listener/_index.md +++ b/content/telegraf/v1/input-plugins/knx_listener/_index.md @@ -10,7 +10,7 @@ introduced: "v1.19.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/knx_listener/README.md, KNX Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/knx_listener/README.md, KNX Plugin Source --- # KNX Input Plugin diff --git a/content/telegraf/v1/input-plugins/kube_inventory/_index.md b/content/telegraf/v1/input-plugins/kube_inventory/_index.md index 509a3c0e5..109a1f4a9 100644 --- a/content/telegraf/v1/input-plugins/kube_inventory/_index.md +++ b/content/telegraf/v1/input-plugins/kube_inventory/_index.md @@ -10,7 +10,7 @@ introduced: "v1.10.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/kube_inventory/README.md, Kubernetes Inventory Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/kube_inventory/README.md, Kubernetes Inventory Plugin Source --- # Kubernetes Inventory Input Plugin diff --git a/content/telegraf/v1/input-plugins/kubernetes/_index.md b/content/telegraf/v1/input-plugins/kubernetes/_index.md index ab57f0864..ca819f3cd 100644 --- a/content/telegraf/v1/input-plugins/kubernetes/_index.md +++ b/content/telegraf/v1/input-plugins/kubernetes/_index.md @@ -10,7 +10,7 @@ introduced: "v1.1.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/kubernetes/README.md, Kubernetes Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/kubernetes/README.md, Kubernetes Plugin Source --- # Kubernetes Input Plugin diff --git a/content/telegraf/v1/input-plugins/lanz/_index.md b/content/telegraf/v1/input-plugins/lanz/_index.md index 4b36f6597..142a6d4ac 100644 --- a/content/telegraf/v1/input-plugins/lanz/_index.md +++ b/content/telegraf/v1/input-plugins/lanz/_index.md @@ -10,7 +10,7 @@ introduced: "v1.14.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/lanz/README.md, Arista LANZ Consumer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/lanz/README.md, Arista LANZ Consumer Plugin Source --- # Arista LANZ Consumer Input Plugin diff --git a/content/telegraf/v1/input-plugins/ldap/_index.md b/content/telegraf/v1/input-plugins/ldap/_index.md index 5ff26f8f4..e21452871 100644 --- a/content/telegraf/v1/input-plugins/ldap/_index.md +++ b/content/telegraf/v1/input-plugins/ldap/_index.md @@ -10,7 +10,7 @@ introduced: "v1.29.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/ldap/README.md, LDAP Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/ldap/README.md, LDAP Plugin Source --- # LDAP Input Plugin diff --git a/content/telegraf/v1/input-plugins/leofs/_index.md b/content/telegraf/v1/input-plugins/leofs/_index.md index 2755a1882..79aa4366f 100644 --- a/content/telegraf/v1/input-plugins/leofs/_index.md +++ b/content/telegraf/v1/input-plugins/leofs/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.5" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/leofs/README.md, LeoFS Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/leofs/README.md, LeoFS Plugin Source --- # LeoFS Input Plugin diff --git a/content/telegraf/v1/input-plugins/libvirt/_index.md b/content/telegraf/v1/input-plugins/libvirt/_index.md index 642cad657..e751aced3 100644 --- a/content/telegraf/v1/input-plugins/libvirt/_index.md +++ b/content/telegraf/v1/input-plugins/libvirt/_index.md @@ -10,7 +10,7 @@ introduced: "v1.25.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/libvirt/README.md, Libvirt Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/libvirt/README.md, Libvirt Plugin Source --- # Libvirt Input Plugin diff --git a/content/telegraf/v1/input-plugins/linux_cpu/_index.md b/content/telegraf/v1/input-plugins/linux_cpu/_index.md index ce032c4bb..74a2d13f5 100644 --- a/content/telegraf/v1/input-plugins/linux_cpu/_index.md +++ b/content/telegraf/v1/input-plugins/linux_cpu/_index.md @@ -10,7 +10,7 @@ introduced: "v1.24.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/linux_cpu/README.md, Linux CPU Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/linux_cpu/README.md, Linux CPU Plugin Source --- # Linux CPU Input Plugin diff --git a/content/telegraf/v1/input-plugins/linux_sysctl_fs/_index.md b/content/telegraf/v1/input-plugins/linux_sysctl_fs/_index.md index 3caf08b81..01c498cce 100644 --- a/content/telegraf/v1/input-plugins/linux_sysctl_fs/_index.md +++ b/content/telegraf/v1/input-plugins/linux_sysctl_fs/_index.md @@ -10,7 +10,7 @@ introduced: "v1.24.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/linux_sysctl_fs/README.md, Linux Sysctl Filesystem Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/linux_sysctl_fs/README.md, Linux Sysctl Filesystem Plugin Source --- # Linux Sysctl Filesystem Input Plugin diff --git a/content/telegraf/v1/input-plugins/logql/_index.md b/content/telegraf/v1/input-plugins/logql/_index.md index f75b79c5f..d612a27a9 100644 --- a/content/telegraf/v1/input-plugins/logql/_index.md +++ b/content/telegraf/v1/input-plugins/logql/_index.md @@ -10,7 +10,7 @@ introduced: "v1.37.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/logql/README.md, LogQL Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/logql/README.md, LogQL Plugin Source --- # LogQL Input Plugin @@ -69,6 +69,9 @@ more details on how to use them. # max_idle_conn_per_host = 0 # response_timeout = "0s" + ## Use the local address for connecting, assigned by the OS by default + # local_address = "" + ## Optional proxy settings # use_system_proxy = false # http_proxy_url = "" diff --git a/content/telegraf/v1/input-plugins/logstash/_index.md b/content/telegraf/v1/input-plugins/logstash/_index.md index 9833ac5f8..c9340e768 100644 --- a/content/telegraf/v1/input-plugins/logstash/_index.md +++ b/content/telegraf/v1/input-plugins/logstash/_index.md @@ -10,7 +10,7 @@ introduced: "v1.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/logstash/README.md, Logstash Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/logstash/README.md, Logstash Plugin Source --- # Logstash Input Plugin diff --git a/content/telegraf/v1/input-plugins/lustre2/_index.md b/content/telegraf/v1/input-plugins/lustre2/_index.md index e33ff9b63..718ffa91d 100644 --- a/content/telegraf/v1/input-plugins/lustre2/_index.md +++ b/content/telegraf/v1/input-plugins/lustre2/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.5" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/lustre2/README.md, Lustre Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/lustre2/README.md, Lustre Plugin Source --- # Lustre Input Plugin diff --git a/content/telegraf/v1/input-plugins/lvm/_index.md b/content/telegraf/v1/input-plugins/lvm/_index.md index 878fbd368..8cab33dd5 100644 --- a/content/telegraf/v1/input-plugins/lvm/_index.md +++ b/content/telegraf/v1/input-plugins/lvm/_index.md @@ -10,7 +10,7 @@ introduced: "v1.21.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/lvm/README.md, Logical Volume Manager Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/lvm/README.md, Logical Volume Manager Plugin Source --- # Logical Volume Manager Input Plugin diff --git a/content/telegraf/v1/input-plugins/mailchimp/_index.md b/content/telegraf/v1/input-plugins/mailchimp/_index.md index 41b2884dd..6fcee3432 100644 --- a/content/telegraf/v1/input-plugins/mailchimp/_index.md +++ b/content/telegraf/v1/input-plugins/mailchimp/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.4" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/mailchimp/README.md, Mailchimp Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/mailchimp/README.md, Mailchimp Plugin Source --- # Mailchimp Input Plugin diff --git a/content/telegraf/v1/input-plugins/marklogic/_index.md b/content/telegraf/v1/input-plugins/marklogic/_index.md index 3d6a54838..96cf441bc 100644 --- a/content/telegraf/v1/input-plugins/marklogic/_index.md +++ b/content/telegraf/v1/input-plugins/marklogic/_index.md @@ -10,7 +10,7 @@ introduced: "v1.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/marklogic/README.md, MarkLogic Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/marklogic/README.md, MarkLogic Plugin Source --- # MarkLogic Input Plugin diff --git a/content/telegraf/v1/input-plugins/mavlink/_index.md b/content/telegraf/v1/input-plugins/mavlink/_index.md index e196a3125..19a4f24b8 100644 --- a/content/telegraf/v1/input-plugins/mavlink/_index.md +++ b/content/telegraf/v1/input-plugins/mavlink/_index.md @@ -10,7 +10,7 @@ introduced: "v1.35.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/mavlink/README.md, MavLink Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/mavlink/README.md, MavLink Plugin Source --- # MavLink Input Plugin diff --git a/content/telegraf/v1/input-plugins/mcrouter/_index.md b/content/telegraf/v1/input-plugins/mcrouter/_index.md index f99c44faa..6f6832498 100644 --- a/content/telegraf/v1/input-plugins/mcrouter/_index.md +++ b/content/telegraf/v1/input-plugins/mcrouter/_index.md @@ -10,7 +10,7 @@ introduced: "v1.7.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/mcrouter/README.md, Mcrouter Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/mcrouter/README.md, Mcrouter Plugin Source --- # Mcrouter Input Plugin diff --git a/content/telegraf/v1/input-plugins/mdstat/_index.md b/content/telegraf/v1/input-plugins/mdstat/_index.md index 885960c94..6317b5d78 100644 --- a/content/telegraf/v1/input-plugins/mdstat/_index.md +++ b/content/telegraf/v1/input-plugins/mdstat/_index.md @@ -10,7 +10,7 @@ introduced: "v1.20.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/mdstat/README.md, MD RAID Statistics Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/mdstat/README.md, MD RAID Statistics Plugin Source --- # MD RAID Statistics Input Plugin diff --git a/content/telegraf/v1/input-plugins/mem/_index.md b/content/telegraf/v1/input-plugins/mem/_index.md index 5b457d5f0..d8cc65783 100644 --- a/content/telegraf/v1/input-plugins/mem/_index.md +++ b/content/telegraf/v1/input-plugins/mem/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.5" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/mem/README.md, Memory Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/mem/README.md, Memory Plugin Source --- # Memory Input Plugin diff --git a/content/telegraf/v1/input-plugins/memcached/_index.md b/content/telegraf/v1/input-plugins/memcached/_index.md index 15d6ca950..1653714fb 100644 --- a/content/telegraf/v1/input-plugins/memcached/_index.md +++ b/content/telegraf/v1/input-plugins/memcached/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.2" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/memcached/README.md, Memcached Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/memcached/README.md, Memcached Plugin Source --- # Memcached Input Plugin diff --git a/content/telegraf/v1/input-plugins/mesos/_index.md b/content/telegraf/v1/input-plugins/mesos/_index.md index 270ffa288..f1b2c504d 100644 --- a/content/telegraf/v1/input-plugins/mesos/_index.md +++ b/content/telegraf/v1/input-plugins/mesos/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.3" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/mesos/README.md, Apache Mesos Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/mesos/README.md, Apache Mesos Plugin Source --- # Apache Mesos Input Plugin diff --git a/content/telegraf/v1/input-plugins/minecraft/_index.md b/content/telegraf/v1/input-plugins/minecraft/_index.md index 412c8aaa4..3909fa361 100644 --- a/content/telegraf/v1/input-plugins/minecraft/_index.md +++ b/content/telegraf/v1/input-plugins/minecraft/_index.md @@ -10,7 +10,7 @@ introduced: "v1.4.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/minecraft/README.md, Minecraft Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/minecraft/README.md, Minecraft Plugin Source --- # Minecraft Input Plugin diff --git a/content/telegraf/v1/input-plugins/mock/_index.md b/content/telegraf/v1/input-plugins/mock/_index.md index 54399ab98..97d7c726a 100644 --- a/content/telegraf/v1/input-plugins/mock/_index.md +++ b/content/telegraf/v1/input-plugins/mock/_index.md @@ -10,7 +10,7 @@ introduced: "v1.22.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/mock/README.md, Mock Data Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/mock/README.md, Mock Data Plugin Source --- # Mock Data Input Plugin diff --git a/content/telegraf/v1/input-plugins/modbus/_index.md b/content/telegraf/v1/input-plugins/modbus/_index.md index 82f6191c1..02291a350 100644 --- a/content/telegraf/v1/input-plugins/modbus/_index.md +++ b/content/telegraf/v1/input-plugins/modbus/_index.md @@ -10,7 +10,7 @@ introduced: "v1.14.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/modbus/README.md, Modbus Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/modbus/README.md, Modbus Plugin Source --- diff --git a/content/telegraf/v1/input-plugins/mongodb/_index.md b/content/telegraf/v1/input-plugins/mongodb/_index.md index 19c83f65f..6083e33c5 100644 --- a/content/telegraf/v1/input-plugins/mongodb/_index.md +++ b/content/telegraf/v1/input-plugins/mongodb/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.5" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/mongodb/README.md, MongoDB Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/mongodb/README.md, MongoDB Plugin Source --- # MongoDB Input Plugin diff --git a/content/telegraf/v1/input-plugins/monit/_index.md b/content/telegraf/v1/input-plugins/monit/_index.md index 49be217a6..7b24ecc47 100644 --- a/content/telegraf/v1/input-plugins/monit/_index.md +++ b/content/telegraf/v1/input-plugins/monit/_index.md @@ -10,7 +10,7 @@ introduced: "v1.14.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/monit/README.md, Monit Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/monit/README.md, Monit Plugin Source --- # Monit Input Plugin diff --git a/content/telegraf/v1/input-plugins/mqtt_consumer/_index.md b/content/telegraf/v1/input-plugins/mqtt_consumer/_index.md index cccb517f3..310bde179 100644 --- a/content/telegraf/v1/input-plugins/mqtt_consumer/_index.md +++ b/content/telegraf/v1/input-plugins/mqtt_consumer/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.3" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/mqtt_consumer/README.md, MQTT Consumer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/mqtt_consumer/README.md, MQTT Consumer Plugin Source --- # MQTT Consumer Input Plugin @@ -105,6 +105,12 @@ to use them. ## Connection timeout for initial connection in seconds # connection_timeout = "30s" + ## Maximum interval between reconnection attempts after a connection loss. + ## The MQTT library uses exponential backoff starting at 1 second up to this + ## ceiling. The library default is 10 minutes, which can cause long delays + ## before message flow resumes after a network outage. + # max_reconnect_interval = "30s" + ## Interval and ping timeout for keep-alive messages ## The sum of those options defines when a connection loss is detected. ## Note: The keep-alive interval needs to be greater or equal one second and diff --git a/content/telegraf/v1/input-plugins/multifile/_index.md b/content/telegraf/v1/input-plugins/multifile/_index.md index 0d84a5361..fd3581f29 100644 --- a/content/telegraf/v1/input-plugins/multifile/_index.md +++ b/content/telegraf/v1/input-plugins/multifile/_index.md @@ -10,7 +10,7 @@ introduced: "v1.10.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/multifile/README.md, Multifile Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/multifile/README.md, Multifile Plugin Source --- # Multifile Input Plugin diff --git a/content/telegraf/v1/input-plugins/mysql/_index.md b/content/telegraf/v1/input-plugins/mysql/_index.md index 5ffac0505..3b35d5f10 100644 --- a/content/telegraf/v1/input-plugins/mysql/_index.md +++ b/content/telegraf/v1/input-plugins/mysql/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/mysql/README.md, MySQL Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/mysql/README.md, MySQL Plugin Source --- # MySQL Input Plugin @@ -262,7 +262,17 @@ measurement name. ## Metrics * Global statuses - all numeric and boolean values of `SHOW GLOBAL STATUSES` + * wsrep_evs_repl_latency - a complex field containing multiple values is split + into separate fields + * wsrep_evs_repl_latency_min(float, seconds) + * wsrep_evs_repl_latency_avg(float, seconds) + * wsrep_evs_repl_latency_max(float, seconds) + * wsrep_evs_repl_latency_stdev(float, seconds) + * wsrep_evs_repl_latency_sample_size(float, number) * Global variables - all numeric and boolean values of `SHOW GLOBAL VARIABLES` + * wsrep_provider_options - a complex field containing multiple values is split + into separate fields + * gcache_size(int, bytes) * Slave status - metrics from `SHOW SLAVE STATUS` the metrics are gathered when the single-source replication is on. If the multi-source replication is set, then everything works differently, this metric does not work with multi-source diff --git a/content/telegraf/v1/input-plugins/nats/_index.md b/content/telegraf/v1/input-plugins/nats/_index.md index 9732b8caa..5bb210653 100644 --- a/content/telegraf/v1/input-plugins/nats/_index.md +++ b/content/telegraf/v1/input-plugins/nats/_index.md @@ -10,7 +10,7 @@ introduced: "v1.6.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/nats/README.md, NATS Server Monitoring Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nats/README.md, NATS Server Monitoring Plugin Source --- # NATS Server Monitoring Input Plugin diff --git a/content/telegraf/v1/input-plugins/nats_consumer/_index.md b/content/telegraf/v1/input-plugins/nats_consumer/_index.md index 400c43a54..f3fc6c680 100644 --- a/content/telegraf/v1/input-plugins/nats_consumer/_index.md +++ b/content/telegraf/v1/input-plugins/nats_consumer/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.3" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/nats_consumer/README.md, NATS Consumer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nats_consumer/README.md, NATS Consumer Plugin Source --- # NATS Consumer Input Plugin diff --git a/content/telegraf/v1/input-plugins/neoom_beaam/_index.md b/content/telegraf/v1/input-plugins/neoom_beaam/_index.md index 6a817c629..601fe0054 100644 --- a/content/telegraf/v1/input-plugins/neoom_beaam/_index.md +++ b/content/telegraf/v1/input-plugins/neoom_beaam/_index.md @@ -10,7 +10,7 @@ introduced: "v1.33.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/neoom_beaam/README.md, Neoom Beaam Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/neoom_beaam/README.md, Neoom Beaam Plugin Source --- # Neoom Beaam Input Plugin diff --git a/content/telegraf/v1/input-plugins/neptune_apex/_index.md b/content/telegraf/v1/input-plugins/neptune_apex/_index.md index 0ad9cb2da..9362837fc 100644 --- a/content/telegraf/v1/input-plugins/neptune_apex/_index.md +++ b/content/telegraf/v1/input-plugins/neptune_apex/_index.md @@ -10,7 +10,7 @@ introduced: "v1.10.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/neptune_apex/README.md, Neptune Apex Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/neptune_apex/README.md, Neptune Apex Plugin Source --- # Neptune Apex Input Plugin diff --git a/content/telegraf/v1/input-plugins/net/_index.md b/content/telegraf/v1/input-plugins/net/_index.md index 0292ac5f2..22490b185 100644 --- a/content/telegraf/v1/input-plugins/net/_index.md +++ b/content/telegraf/v1/input-plugins/net/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/net/README.md, Network Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/net/README.md, Network Plugin Source --- # Network Input Plugin diff --git a/content/telegraf/v1/input-plugins/net_response/_index.md b/content/telegraf/v1/input-plugins/net_response/_index.md index c0cae121a..29bdaf294 100644 --- a/content/telegraf/v1/input-plugins/net_response/_index.md +++ b/content/telegraf/v1/input-plugins/net_response/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.3" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/net_response/README.md, Network Response Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/net_response/README.md, Network Response Plugin Source --- # Network Response Input Plugin diff --git a/content/telegraf/v1/input-plugins/netflow/_index.md b/content/telegraf/v1/input-plugins/netflow/_index.md index c116ace4b..95ff91fd4 100644 --- a/content/telegraf/v1/input-plugins/netflow/_index.md +++ b/content/telegraf/v1/input-plugins/netflow/_index.md @@ -10,7 +10,7 @@ introduced: "v1.25.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/netflow/README.md, Netflow Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/netflow/README.md, Netflow Plugin Source --- # Netflow Input Plugin diff --git a/content/telegraf/v1/input-plugins/netstat/_index.md b/content/telegraf/v1/input-plugins/netstat/_index.md index 982e2aa6e..6a338a4cd 100644 --- a/content/telegraf/v1/input-plugins/netstat/_index.md +++ b/content/telegraf/v1/input-plugins/netstat/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/netstat/README.md, Network Connection Statistics Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/netstat/README.md, Network Connection Statistics Plugin Source --- # Network Connection Statistics Input Plugin diff --git a/content/telegraf/v1/input-plugins/nfsclient/_index.md b/content/telegraf/v1/input-plugins/nfsclient/_index.md index a55540f63..c2881bfa3 100644 --- a/content/telegraf/v1/input-plugins/nfsclient/_index.md +++ b/content/telegraf/v1/input-plugins/nfsclient/_index.md @@ -10,7 +10,7 @@ introduced: "v1.18.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/nfsclient/README.md, Network Filesystem Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nfsclient/README.md, Network Filesystem Plugin Source --- # Network Filesystem Input Plugin diff --git a/content/telegraf/v1/input-plugins/nftables/_index.md b/content/telegraf/v1/input-plugins/nftables/_index.md index 4c44121ee..aa8cb9a4e 100644 --- a/content/telegraf/v1/input-plugins/nftables/_index.md +++ b/content/telegraf/v1/input-plugins/nftables/_index.md @@ -10,17 +10,13 @@ introduced: "v1.37.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/nftables/README.md, Nftables Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nftables/README.md, Nftables Plugin Source --- # Nftables Plugin This plugin gathers packets and bytes counters for rules within -Linux's [nftables](https://wiki.nftables.org/wiki-nftables/index.php/Main_Page) firewall. - -> [!IMPORTANT] -> Rules are identified by the associated comment so those **comments have to be unique**! -> Rules without comment are ignored. +Linux's [nftables](https://wiki.nftables.org/wiki-nftables/index.php/Main_Page) firewall, as well as set element counts. **Introduced in:** Telegraf v1.37.0 **Tags:** network, system @@ -43,11 +39,16 @@ plugin ordering. See [CONFIGURATION.md](/telegraf/v1/configuration/#plugins) for ## Use the specified binary which will be looked-up in PATH # binary = "nft" - ## Use sudo for command execution, can be restricted to "nft --json list table" + ## Use sudo for command execution, can be restricted to + ## "nft --json list table" # use_sudo = false - ## Tables to monitor containing both a counter and comment declaration + ## Tables to monitor (may use "family table" format, e.g., "inet filter") # tables = [ "filter" ] + + ## Kinds of objects to monitor: "counters" (named counters), "sets", + ## (named sets), "anonymous-counters" (on commented rules). + # include = ["anonymous-counters"] ``` Since telegraf will fork a process to run nftables, `AmbientCapabilities` is @@ -58,11 +59,32 @@ required to transmit the capabilities bounding set to the forked process. You may edit your sudo configuration with the following: ```sudo -telegraf ALL=(root) NOPASSWD: /usr/bin/nft * +telegraf ALL=(root) NOPASSWD: /usr/bin/nft --json list table * ``` ## Metrics +Counters (when `counters` included): + +* nftables + * tags: + * table + * counter + * fields: + * pkts (integer, count) + * bytes (integer, bytes) + +Sets (when `sets` included): + +* nftables + * tags: + * table + * set + * field: + * count (integer, count) + +Anonymous counters on commented rules (when `anonymous-counters` included): + * nftables * tags: * table @@ -75,6 +97,8 @@ telegraf ALL=(root) NOPASSWD: /usr/bin/nft * ## Example Output ```text +> nftables,host=my_hostname,counter=my_counter,table=filter bytes=48968i,pkts=48i 1757367516000000000 +> nftables,host=my_hostname,set=my_set,table=filter count=10i 1757367516000000000 > nftables,chain=incoming,host=my_hostname,rule=comment_val_1,table=filter bytes=66435845i,pkts=133882i 1757367516000000000 -> nftables,chain=outgoing,host=my_hostname,rule=comment_val2,table=filter bytes=25596512i,pkts=145129i 1757367516000000000 +> nftables,chain=outgoing,host=my_hostname,rule=comment_val_2,table=filter bytes=25596512i,pkts=145129i 1757367516000000000 ``` diff --git a/content/telegraf/v1/input-plugins/nginx/_index.md b/content/telegraf/v1/input-plugins/nginx/_index.md index 8f11618bc..a856f1f41 100644 --- a/content/telegraf/v1/input-plugins/nginx/_index.md +++ b/content/telegraf/v1/input-plugins/nginx/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.5" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/nginx/README.md, Nginx Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nginx/README.md, Nginx Plugin Source --- # Nginx Input Plugin diff --git a/content/telegraf/v1/input-plugins/nginx_plus/_index.md b/content/telegraf/v1/input-plugins/nginx_plus/_index.md index 1c5cd2ca4..19039c2ad 100644 --- a/content/telegraf/v1/input-plugins/nginx_plus/_index.md +++ b/content/telegraf/v1/input-plugins/nginx_plus/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/nginx_plus/README.md, Nginx Plus Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nginx_plus/README.md, Nginx Plus Plugin Source --- # Nginx Plus Input Plugin diff --git a/content/telegraf/v1/input-plugins/nginx_plus_api/_index.md b/content/telegraf/v1/input-plugins/nginx_plus_api/_index.md index 01e79f626..219e7dad2 100644 --- a/content/telegraf/v1/input-plugins/nginx_plus_api/_index.md +++ b/content/telegraf/v1/input-plugins/nginx_plus_api/_index.md @@ -10,7 +10,7 @@ introduced: "v1.9.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/nginx_plus_api/README.md, Nginx Plus API Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nginx_plus_api/README.md, Nginx Plus API Plugin Source --- # Nginx Plus API Input Plugin diff --git a/content/telegraf/v1/input-plugins/nginx_sts/_index.md b/content/telegraf/v1/input-plugins/nginx_sts/_index.md index 76ea47a8f..8cedbcc79 100644 --- a/content/telegraf/v1/input-plugins/nginx_sts/_index.md +++ b/content/telegraf/v1/input-plugins/nginx_sts/_index.md @@ -10,7 +10,7 @@ introduced: "v1.15.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/nginx_sts/README.md, Nginx Stream Server Traffic Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nginx_sts/README.md, Nginx Stream Server Traffic Plugin Source --- # Nginx Stream Server Traffic Input Plugin diff --git a/content/telegraf/v1/input-plugins/nginx_upstream_check/_index.md b/content/telegraf/v1/input-plugins/nginx_upstream_check/_index.md index 3d4d56fed..a03f93b09 100644 --- a/content/telegraf/v1/input-plugins/nginx_upstream_check/_index.md +++ b/content/telegraf/v1/input-plugins/nginx_upstream_check/_index.md @@ -10,7 +10,7 @@ introduced: "v1.10.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/nginx_upstream_check/README.md, Nginx Upstream Check Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nginx_upstream_check/README.md, Nginx Upstream Check Plugin Source --- # Nginx Upstream Check Input Plugin diff --git a/content/telegraf/v1/input-plugins/nginx_vts/_index.md b/content/telegraf/v1/input-plugins/nginx_vts/_index.md index 4836ad4e9..4542d2f7e 100644 --- a/content/telegraf/v1/input-plugins/nginx_vts/_index.md +++ b/content/telegraf/v1/input-plugins/nginx_vts/_index.md @@ -10,7 +10,7 @@ introduced: "v1.9.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/nginx_vts/README.md, Nginx Virtual Host Traffic Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nginx_vts/README.md, Nginx Virtual Host Traffic Plugin Source --- # Nginx Virtual Host Traffic Input Plugin diff --git a/content/telegraf/v1/input-plugins/nomad/_index.md b/content/telegraf/v1/input-plugins/nomad/_index.md index 09b15b6bd..c657b90a7 100644 --- a/content/telegraf/v1/input-plugins/nomad/_index.md +++ b/content/telegraf/v1/input-plugins/nomad/_index.md @@ -10,7 +10,7 @@ introduced: "v1.22.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/nomad/README.md, Hashicorp Nomad Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nomad/README.md, Hashicorp Nomad Plugin Source --- # Hashicorp Nomad Input Plugin diff --git a/content/telegraf/v1/input-plugins/nsd/_index.md b/content/telegraf/v1/input-plugins/nsd/_index.md index 77ae15cce..fb0917056 100644 --- a/content/telegraf/v1/input-plugins/nsd/_index.md +++ b/content/telegraf/v1/input-plugins/nsd/_index.md @@ -10,7 +10,7 @@ introduced: "v1.0.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/nsd/README.md, NLnet Labs Name Server Daemon Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nsd/README.md, NLnet Labs Name Server Daemon Plugin Source --- # NLnet Labs Name Server Daemon Input Plugin diff --git a/content/telegraf/v1/input-plugins/nsdp/_index.md b/content/telegraf/v1/input-plugins/nsdp/_index.md index 25ce409d4..c2de1c995 100644 --- a/content/telegraf/v1/input-plugins/nsdp/_index.md +++ b/content/telegraf/v1/input-plugins/nsdp/_index.md @@ -10,7 +10,7 @@ introduced: "v1.34.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/nsdp/README.md, Netgear Switch Discovery Protocol Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nsdp/README.md, Netgear Switch Discovery Protocol Plugin Source --- # Netgear Switch Discovery Protocol Input Plugin diff --git a/content/telegraf/v1/input-plugins/nsq/_index.md b/content/telegraf/v1/input-plugins/nsq/_index.md index 7c0213c16..549983ba0 100644 --- a/content/telegraf/v1/input-plugins/nsq/_index.md +++ b/content/telegraf/v1/input-plugins/nsq/_index.md @@ -10,7 +10,7 @@ introduced: "v1.16.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/nsq/README.md, NSQ Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nsq/README.md, NSQ Plugin Source --- # NSQ Input Plugin diff --git a/content/telegraf/v1/input-plugins/nsq_consumer/_index.md b/content/telegraf/v1/input-plugins/nsq_consumer/_index.md index 6edb934d1..a87436ea2 100644 --- a/content/telegraf/v1/input-plugins/nsq_consumer/_index.md +++ b/content/telegraf/v1/input-plugins/nsq_consumer/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/nsq_consumer/README.md, NSQ Consumer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nsq_consumer/README.md, NSQ Consumer Plugin Source --- # NSQ Consumer Input Plugin diff --git a/content/telegraf/v1/input-plugins/nstat/_index.md b/content/telegraf/v1/input-plugins/nstat/_index.md index 3d026d204..3e74a8a81 100644 --- a/content/telegraf/v1/input-plugins/nstat/_index.md +++ b/content/telegraf/v1/input-plugins/nstat/_index.md @@ -10,7 +10,7 @@ introduced: "v0.13.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/nstat/README.md, Kernel Network Statistics Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nstat/README.md, Kernel Network Statistics Plugin Source --- # Kernel Network Statistics Input Plugin diff --git a/content/telegraf/v1/input-plugins/ntpq/_index.md b/content/telegraf/v1/input-plugins/ntpq/_index.md index a530c1ced..ac1115ce8 100644 --- a/content/telegraf/v1/input-plugins/ntpq/_index.md +++ b/content/telegraf/v1/input-plugins/ntpq/_index.md @@ -10,7 +10,7 @@ introduced: "v0.11.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/ntpq/README.md, Network Time Protocol Query Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/ntpq/README.md, Network Time Protocol Query Plugin Source --- # Network Time Protocol Query Input Plugin diff --git a/content/telegraf/v1/input-plugins/nvidia_smi/_index.md b/content/telegraf/v1/input-plugins/nvidia_smi/_index.md index b7eccd9df..d35bdbbfe 100644 --- a/content/telegraf/v1/input-plugins/nvidia_smi/_index.md +++ b/content/telegraf/v1/input-plugins/nvidia_smi/_index.md @@ -10,7 +10,7 @@ introduced: "v1.7.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/nvidia_smi/README.md, Nvidia System Management Interface (SMI) Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nvidia_smi/README.md, Nvidia System Management Interface (SMI) Plugin Source --- # Nvidia System Management Interface (SMI) Input Plugin diff --git a/content/telegraf/v1/input-plugins/opcua/_index.md b/content/telegraf/v1/input-plugins/opcua/_index.md index feb631d02..6100b0eaf 100644 --- a/content/telegraf/v1/input-plugins/opcua/_index.md +++ b/content/telegraf/v1/input-plugins/opcua/_index.md @@ -10,7 +10,7 @@ introduced: "v1.16.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/opcua/README.md, OPC UA Client Reader Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/opcua/README.md, OPC UA Client Reader Plugin Source --- # OPC UA Client Reader Input Plugin @@ -115,21 +115,34 @@ to use them. ## Node ID configuration ## name - field name to use in the output + ## id - OPC UA node ID string (e.g., "ns=0;i=2262" or "nsu=http://...;s=Name") ## namespace - OPC UA namespace of the node (integer value 0 thru 3) ## namespace_uri - OPC UA namespace URI (alternative to namespace for stable references) ## identifier_type - OPC UA ID type (s=string, i=numeric, g=guid, b=opaque) ## identifier - OPC UA ID (tag as shown in opcua browser) ## default_tags - extra tags to be added to the output metric (optional) ## - ## Note: Specify either 'namespace' or 'namespace_uri', not both. + ## Use EITHER 'id' OR the combination of 'namespace/namespace_uri' + 'identifier_type' + 'identifier' ## Use either the inline notation or the bracketed notation, not both. - ## Inline notation (default_tags not supported yet) + ## Inline notation using id string (recommended for simplicity) + # nodes = [ + # {name="ProductUri", id="ns=0;i=2262"}, + # {name="ServerState", id="ns=0;i=2259"}, + # ] + + ## Inline notation using individual fields (default_tags not supported yet) # nodes = [ # {name="", namespace="", identifier_type="", identifier=""}, # ] - ## Bracketed notation + ## Bracketed notation using id string + # [[inputs.opcua.nodes]] + # name = "ProductUri" + # id = "ns=0;i=2262" + # default_tags = { tag1 = "value1", tag2 = "value2" } + + ## Bracketed notation using individual fields # [[inputs.opcua.nodes]] # name = "node1" # namespace = "" @@ -264,13 +277,29 @@ An OPC UA node ID may resemble: "ns=3;s=Temperature". In this example: `identifier` value is 'Temperature' - This example temperature node has a value of 79.0 -To gather data from this node enter the following line into the 'nodes' -property above: +### Using `id` String (Recommended) + +You can specify nodes using the standard OPC UA node ID string format directly: ```text -{field_name="temp", namespace="3", identifier_type="s", identifier="Temperature"}, +{name="temp", id="ns=3;s=Temperature"}, ``` +This is simpler and matches the format shown in OPC UA browsers. + +### Using Individual Fields + +Alternatively, you can specify each component separately: + +```text +{name="temp", namespace="3", identifier_type="s", identifier="Temperature"}, +``` + +> [!NOTE] +> Use either `id` OR the combination of +> `namespace`/`namespace_uri` + `identifier_type` + `identifier`. +> Do not mix both formats for the same node. + This node configuration produces a metric like this: ```text @@ -301,7 +330,8 @@ OPC UA supports two ways to specify namespaces: 2. **Namespace URI** (`namespace_uri`): A string URI that uniquely identifies the namespace. This is more stable across server restarts but requires the - plugin to fetch the namespace array from the server to resolve the URI to an index. + plugin to fetch the namespace array from the server to resolve the URI to an + index. **When to use namespace index:** diff --git a/content/telegraf/v1/input-plugins/opcua_listener/_index.md b/content/telegraf/v1/input-plugins/opcua_listener/_index.md index 184cd8459..043f03a55 100644 --- a/content/telegraf/v1/input-plugins/opcua_listener/_index.md +++ b/content/telegraf/v1/input-plugins/opcua_listener/_index.md @@ -10,7 +10,7 @@ introduced: "v1.25.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/opcua_listener/README.md, OPC UA Client Listener Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/opcua_listener/README.md, OPC UA Client Listener Plugin Source --- # OPC UA Client Listener Input Plugin @@ -137,6 +137,7 @@ to use them. # ## Node ID configuration ## name - field name to use in the output + ## id - OPC UA node ID string (e.g., "ns=0;i=2262" or "nsu=http://...;s=Name") ## namespace - OPC UA namespace of the node (integer value 0 thru 3) ## namespace_uri - OPC UA namespace URI (alternative to namespace for stable references) ## identifier_type - OPC UA ID type (s=string, i=numeric, g=guid, b=opaque) @@ -144,7 +145,7 @@ to use them. ## default_tags - extra tags to be added to the output metric (optional) ## monitoring_params - additional settings for the monitored node (optional) ## - ## Note: Specify either 'namespace' or 'namespace_uri', not both. + ## Use EITHER 'id' OR the combination of 'namespace/namespace_uri' + 'identifier_type' + 'identifier' ## ## Monitoring parameters ## sampling_interval - interval at which the server should check for data @@ -178,13 +179,25 @@ to use them. ## ## Use either the inline notation or the bracketed notation, not both. # - ## Inline notation (default_tags and monitoring_params not supported yet) + ## Inline notation using id string (recommended for simplicity) + # nodes = [ + # {name="ProductUri", id="ns=0;i=2262"}, + # {name="ServerState", id="ns=0;i=2259"} + # ] + # + ## Inline notation using individual fields (default_tags and monitoring_params not supported yet) # nodes = [ # {name="node1", namespace="", identifier_type="", identifier=""}, # {name="node2", namespace="", identifier_type="", identifier=""} # ] # - ## Bracketed notation + ## Bracketed notation using id string + # [[inputs.opcua_listener.nodes]] + # name = "ProductUri" + # id = "ns=0;i=2262" + # default_tags = { tag1 = "value1", tag2 = "value2" } + + ## Bracketed notation using individual fields # [[inputs.opcua_listener.nodes]] # name = "node1" # namespace = "" @@ -285,12 +298,13 @@ to use them. # ## Multiple event groups are allowed. + ## Event nodes support both 'id' string format and individual fields. # [[inputs.opcua_listener.events]] # ## Polling interval for data collection # # sampling_interval = "10s" # ## Size of the notification queue # # queue_size = 10 - # ## Node parameter defaults for node definitions below + # ## Node parameter defaults for node definitions below (used when id is not specified) # # namespace = "" # # identifier_type = "" # ## Specifies OPCUA Event sources to filter on @@ -299,17 +313,22 @@ to use them. # fields = ["Severity", "Message", "Time"] # # ## Type or level of events to capture from the monitored nodes. + # ## Use 'id' string OR individual fields (namespace/identifier_type/identifier) # [inputs.opcua_listener.events.event_type_node] - # namespace = "" - # identifier_type = "" - # identifier = "" + # id = "ns=0;i=2041" + # # Or use individual fields: + # # namespace = "" + # # identifier_type = "" + # # identifier = "" # # ## Nodes to monitor for event notifications associated with the defined - # ## event type + # ## event type. Use 'id' string OR individual fields. # [[inputs.opcua_listener.events.node_ids]] - # namespace = "" - # identifier_type = "" - # identifier = "" + # id = "ns=2;s=EventSource1" + # # Or use individual fields: + # # namespace = "" + # # identifier_type = "" + # # identifier = "" ## Enable workarounds required by some devices to work correctly # [inputs.opcua_listener.workarounds] @@ -328,13 +347,29 @@ An OPC UA node ID may resemble: "ns=3;s=Temperature". In this example: `identifier` value is 'Temperature' - This example temperature node has a value of 79.0 -To gather data from this node enter the following line into the 'nodes' -property above: +#### Using `id` String (Recommended) + +You can specify nodes using the standard OPC UA node ID string format directly: + +```text +{name="temp", id="ns=3;s=Temperature"}, +``` + +This is simpler and matches the format shown in OPC UA browsers. + +#### Using Individual Fields + +Alternatively, you can specify each component separately: ```text {name="temp", namespace="3", identifier_type="s", identifier="Temperature"}, ``` +> [!NOTE] +> Use either `id` OR the combination of +> `namespace`/`namespace_uri` + `identifier_type` + `identifier`. +> Do not mix both formats for the same node. + This node configuration produces a metric like this: ```text @@ -365,7 +400,8 @@ OPC UA supports two ways to specify namespaces: 2. **Namespace URI** (`namespace_uri`): A string URI that uniquely identifies the namespace. This is more stable across server restarts but requires the - plugin to fetch the namespace array from the server to resolve the URI to an index. + plugin to fetch the namespace array from the server to resolve the URI to an + index. **When to use namespace index:** diff --git a/content/telegraf/v1/input-plugins/openldap/_index.md b/content/telegraf/v1/input-plugins/openldap/_index.md index 8c9250aa7..1dc9a64b4 100644 --- a/content/telegraf/v1/input-plugins/openldap/_index.md +++ b/content/telegraf/v1/input-plugins/openldap/_index.md @@ -10,7 +10,7 @@ introduced: "v1.4.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/openldap/README.md, OpenLDAP Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/openldap/README.md, OpenLDAP Plugin Source --- # OpenLDAP Input Plugin diff --git a/content/telegraf/v1/input-plugins/openntpd/_index.md b/content/telegraf/v1/input-plugins/openntpd/_index.md index ac3c75055..180ca5a46 100644 --- a/content/telegraf/v1/input-plugins/openntpd/_index.md +++ b/content/telegraf/v1/input-plugins/openntpd/_index.md @@ -10,7 +10,7 @@ introduced: "v1.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/openntpd/README.md, OpenNTPD Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/openntpd/README.md, OpenNTPD Plugin Source --- # OpenNTPD Input Plugin diff --git a/content/telegraf/v1/input-plugins/opensearch_query/_index.md b/content/telegraf/v1/input-plugins/opensearch_query/_index.md index 52f21aee0..19c6d994c 100644 --- a/content/telegraf/v1/input-plugins/opensearch_query/_index.md +++ b/content/telegraf/v1/input-plugins/opensearch_query/_index.md @@ -10,7 +10,7 @@ introduced: "v1.26.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/opensearch_query/README.md, OpenSearch Query Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/opensearch_query/README.md, OpenSearch Query Plugin Source --- # OpenSearch Query Input Plugin diff --git a/content/telegraf/v1/input-plugins/opensmtpd/_index.md b/content/telegraf/v1/input-plugins/opensmtpd/_index.md index aaae6b520..954840396 100644 --- a/content/telegraf/v1/input-plugins/opensmtpd/_index.md +++ b/content/telegraf/v1/input-plugins/opensmtpd/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/opensmtpd/README.md, OpenSMTPD Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/opensmtpd/README.md, OpenSMTPD Plugin Source --- # OpenSMTPD Input Plugin diff --git a/content/telegraf/v1/input-plugins/openstack/_index.md b/content/telegraf/v1/input-plugins/openstack/_index.md index 32bc6d5fc..b98b8f152 100644 --- a/content/telegraf/v1/input-plugins/openstack/_index.md +++ b/content/telegraf/v1/input-plugins/openstack/_index.md @@ -10,7 +10,7 @@ introduced: "v1.21.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/openstack/README.md, OpenStack Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/openstack/README.md, OpenStack Plugin Source --- # OpenStack Input Plugin diff --git a/content/telegraf/v1/input-plugins/opentelemetry/_index.md b/content/telegraf/v1/input-plugins/opentelemetry/_index.md index b6e8f1031..4b2cafc7f 100644 --- a/content/telegraf/v1/input-plugins/opentelemetry/_index.md +++ b/content/telegraf/v1/input-plugins/opentelemetry/_index.md @@ -10,7 +10,7 @@ introduced: "v1.19.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/opentelemetry/README.md, OpenTelemetry Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/opentelemetry/README.md, OpenTelemetry Plugin Source --- # OpenTelemetry Input Plugin diff --git a/content/telegraf/v1/input-plugins/openweathermap/_index.md b/content/telegraf/v1/input-plugins/openweathermap/_index.md index 7d46b6649..88e7eaf72 100644 --- a/content/telegraf/v1/input-plugins/openweathermap/_index.md +++ b/content/telegraf/v1/input-plugins/openweathermap/_index.md @@ -10,7 +10,7 @@ introduced: "v1.11.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/openweathermap/README.md, OpenWeatherMap Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/openweathermap/README.md, OpenWeatherMap Plugin Source --- # OpenWeatherMap Input Plugin diff --git a/content/telegraf/v1/input-plugins/p4runtime/_index.md b/content/telegraf/v1/input-plugins/p4runtime/_index.md index 7069ad147..f0b79c03f 100644 --- a/content/telegraf/v1/input-plugins/p4runtime/_index.md +++ b/content/telegraf/v1/input-plugins/p4runtime/_index.md @@ -10,7 +10,7 @@ introduced: "v1.26.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/p4runtime/README.md, P4 Runtime Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/p4runtime/README.md, P4 Runtime Plugin Source --- # P4 Runtime Input Plugin diff --git a/content/telegraf/v1/input-plugins/passenger/_index.md b/content/telegraf/v1/input-plugins/passenger/_index.md index 91113aa6c..eec567344 100644 --- a/content/telegraf/v1/input-plugins/passenger/_index.md +++ b/content/telegraf/v1/input-plugins/passenger/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/passenger/README.md, Passenger Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/passenger/README.md, Passenger Plugin Source --- # Passenger Input Plugin diff --git a/content/telegraf/v1/input-plugins/pf/_index.md b/content/telegraf/v1/input-plugins/pf/_index.md index 36ef96c81..1c4918994 100644 --- a/content/telegraf/v1/input-plugins/pf/_index.md +++ b/content/telegraf/v1/input-plugins/pf/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/pf/README.md, PF Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/pf/README.md, PF Plugin Source --- # PF Input Plugin diff --git a/content/telegraf/v1/input-plugins/pgbouncer/_index.md b/content/telegraf/v1/input-plugins/pgbouncer/_index.md index ae370ba51..802117955 100644 --- a/content/telegraf/v1/input-plugins/pgbouncer/_index.md +++ b/content/telegraf/v1/input-plugins/pgbouncer/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/pgbouncer/README.md, PgBouncer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/pgbouncer/README.md, PgBouncer Plugin Source --- # PgBouncer Input Plugin diff --git a/content/telegraf/v1/input-plugins/phpfpm/_index.md b/content/telegraf/v1/input-plugins/phpfpm/_index.md index 627d72de8..20673fe7c 100644 --- a/content/telegraf/v1/input-plugins/phpfpm/_index.md +++ b/content/telegraf/v1/input-plugins/phpfpm/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.10" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/phpfpm/README.md, PHP-FPM Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/phpfpm/README.md, PHP-FPM Plugin Source --- # PHP-FPM Input Plugin diff --git a/content/telegraf/v1/input-plugins/ping/_index.md b/content/telegraf/v1/input-plugins/ping/_index.md index cd53f7175..040760f29 100644 --- a/content/telegraf/v1/input-plugins/ping/_index.md +++ b/content/telegraf/v1/input-plugins/ping/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.8" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/ping/README.md, Ping Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/ping/README.md, Ping Plugin Source --- # Ping Input Plugin diff --git a/content/telegraf/v1/input-plugins/postfix/_index.md b/content/telegraf/v1/input-plugins/postfix/_index.md index ad19afa87..9b62f7702 100644 --- a/content/telegraf/v1/input-plugins/postfix/_index.md +++ b/content/telegraf/v1/input-plugins/postfix/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd, linux, macos, solaris" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/postfix/README.md, Postfix Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/postfix/README.md, Postfix Plugin Source --- # Postfix Input Plugin diff --git a/content/telegraf/v1/input-plugins/postgresql/_index.md b/content/telegraf/v1/input-plugins/postgresql/_index.md index ae1746d5c..13647079a 100644 --- a/content/telegraf/v1/input-plugins/postgresql/_index.md +++ b/content/telegraf/v1/input-plugins/postgresql/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.3" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/postgresql/README.md, PostgreSQL Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/postgresql/README.md, PostgreSQL Plugin Source --- # PostgreSQL Input Plugin diff --git a/content/telegraf/v1/input-plugins/postgresql_extensible/_index.md b/content/telegraf/v1/input-plugins/postgresql_extensible/_index.md index 647cfea00..8d0975b8a 100644 --- a/content/telegraf/v1/input-plugins/postgresql_extensible/_index.md +++ b/content/telegraf/v1/input-plugins/postgresql_extensible/_index.md @@ -10,7 +10,7 @@ introduced: "v0.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/postgresql_extensible/README.md, PostgreSQL Extensible Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/postgresql_extensible/README.md, PostgreSQL Extensible Plugin Source --- # PostgreSQL Extensible Input Plugin diff --git a/content/telegraf/v1/input-plugins/powerdns/_index.md b/content/telegraf/v1/input-plugins/powerdns/_index.md index a749f1f63..2f6e7357a 100644 --- a/content/telegraf/v1/input-plugins/powerdns/_index.md +++ b/content/telegraf/v1/input-plugins/powerdns/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.2" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/powerdns/README.md, PowerDNS Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/powerdns/README.md, PowerDNS Plugin Source --- # PowerDNS Input Plugin diff --git a/content/telegraf/v1/input-plugins/powerdns_recursor/_index.md b/content/telegraf/v1/input-plugins/powerdns_recursor/_index.md index f1236b748..1f40df3aa 100644 --- a/content/telegraf/v1/input-plugins/powerdns_recursor/_index.md +++ b/content/telegraf/v1/input-plugins/powerdns_recursor/_index.md @@ -10,7 +10,7 @@ introduced: "v1.11.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/powerdns_recursor/README.md, PowerDNS Recursor Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/powerdns_recursor/README.md, PowerDNS Recursor Plugin Source --- # PowerDNS Recursor Input Plugin diff --git a/content/telegraf/v1/input-plugins/processes/_index.md b/content/telegraf/v1/input-plugins/processes/_index.md index da0f0b600..4cfd56d60 100644 --- a/content/telegraf/v1/input-plugins/processes/_index.md +++ b/content/telegraf/v1/input-plugins/processes/_index.md @@ -10,7 +10,7 @@ introduced: "v0.11.0" os_support: "freebsd, linux, macos" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/processes/README.md, Processes Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/processes/README.md, Processes Plugin Source --- # Processes Input Plugin diff --git a/content/telegraf/v1/input-plugins/procstat/_index.md b/content/telegraf/v1/input-plugins/procstat/_index.md index 92abefd33..6c053924a 100644 --- a/content/telegraf/v1/input-plugins/procstat/_index.md +++ b/content/telegraf/v1/input-plugins/procstat/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/procstat/README.md, Procstat Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/procstat/README.md, Procstat Plugin Source --- # Procstat Input Plugin diff --git a/content/telegraf/v1/input-plugins/prometheus/_index.md b/content/telegraf/v1/input-plugins/prometheus/_index.md index f7fd966e5..b50c5041e 100644 --- a/content/telegraf/v1/input-plugins/prometheus/_index.md +++ b/content/telegraf/v1/input-plugins/prometheus/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.5" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/prometheus/README.md, Prometheus Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/prometheus/README.md, Prometheus Plugin Source --- # Prometheus Input Plugin diff --git a/content/telegraf/v1/input-plugins/promql/_index.md b/content/telegraf/v1/input-plugins/promql/_index.md index 73a9b52dc..b1170b421 100644 --- a/content/telegraf/v1/input-plugins/promql/_index.md +++ b/content/telegraf/v1/input-plugins/promql/_index.md @@ -10,7 +10,7 @@ introduced: "v1.37.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/promql/README.md, PromQL Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/promql/README.md, PromQL Plugin Source --- # PromQL Input Plugin @@ -66,6 +66,9 @@ more details on how to use them. # max_idle_conn_per_host = 0 # response_timeout = "0s" + ## Use the local address for connecting, assigned by the OS by default + # local_address = "" + ## Optional proxy settings # use_system_proxy = false # http_proxy_url = "" diff --git a/content/telegraf/v1/input-plugins/proxmox/_index.md b/content/telegraf/v1/input-plugins/proxmox/_index.md index b299a9458..c8c0e2276 100644 --- a/content/telegraf/v1/input-plugins/proxmox/_index.md +++ b/content/telegraf/v1/input-plugins/proxmox/_index.md @@ -10,7 +10,7 @@ introduced: "v1.16.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/proxmox/README.md, Proxmox Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/proxmox/README.md, Proxmox Plugin Source --- # Proxmox Input Plugin diff --git a/content/telegraf/v1/input-plugins/puppetagent/_index.md b/content/telegraf/v1/input-plugins/puppetagent/_index.md index b8e55563e..89f732da6 100644 --- a/content/telegraf/v1/input-plugins/puppetagent/_index.md +++ b/content/telegraf/v1/input-plugins/puppetagent/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/puppetagent/README.md, Puppet Agent Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/puppetagent/README.md, Puppet Agent Plugin Source --- # Puppet Agent Input Plugin diff --git a/content/telegraf/v1/input-plugins/rabbitmq/_index.md b/content/telegraf/v1/input-plugins/rabbitmq/_index.md index fe5adcd70..f6ed7c171 100644 --- a/content/telegraf/v1/input-plugins/rabbitmq/_index.md +++ b/content/telegraf/v1/input-plugins/rabbitmq/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.5" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/rabbitmq/README.md, RabbitMQ Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/rabbitmq/README.md, RabbitMQ Plugin Source --- # RabbitMQ Input Plugin diff --git a/content/telegraf/v1/input-plugins/radius/_index.md b/content/telegraf/v1/input-plugins/radius/_index.md index 2209af5a8..1850d08ae 100644 --- a/content/telegraf/v1/input-plugins/radius/_index.md +++ b/content/telegraf/v1/input-plugins/radius/_index.md @@ -10,7 +10,7 @@ introduced: "v1.26.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/radius/README.md, Radius Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/radius/README.md, Radius Plugin Source --- # Radius Input Plugin diff --git a/content/telegraf/v1/input-plugins/raindrops/_index.md b/content/telegraf/v1/input-plugins/raindrops/_index.md index 9afb8c9dc..a31e3bf26 100644 --- a/content/telegraf/v1/input-plugins/raindrops/_index.md +++ b/content/telegraf/v1/input-plugins/raindrops/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.3" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/raindrops/README.md, Raindrops Middleware Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/raindrops/README.md, Raindrops Middleware Plugin Source --- # Raindrops Middleware Input Plugin diff --git a/content/telegraf/v1/input-plugins/ras/_index.md b/content/telegraf/v1/input-plugins/ras/_index.md index abfc63847..a13cdfaf5 100644 --- a/content/telegraf/v1/input-plugins/ras/_index.md +++ b/content/telegraf/v1/input-plugins/ras/_index.md @@ -10,7 +10,7 @@ introduced: "v1.16.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/ras/README.md, RAS Daemon Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/ras/README.md, RAS Daemon Plugin Source --- # RAS Daemon Input Plugin diff --git a/content/telegraf/v1/input-plugins/ravendb/_index.md b/content/telegraf/v1/input-plugins/ravendb/_index.md index 6d1e98f1d..a2ec18ced 100644 --- a/content/telegraf/v1/input-plugins/ravendb/_index.md +++ b/content/telegraf/v1/input-plugins/ravendb/_index.md @@ -10,7 +10,7 @@ introduced: "v1.18.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/ravendb/README.md, RavenDB Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/ravendb/README.md, RavenDB Plugin Source --- # RavenDB Input Plugin diff --git a/content/telegraf/v1/input-plugins/redfish/_index.md b/content/telegraf/v1/input-plugins/redfish/_index.md index 31685bb8f..069fbacd8 100644 --- a/content/telegraf/v1/input-plugins/redfish/_index.md +++ b/content/telegraf/v1/input-plugins/redfish/_index.md @@ -10,7 +10,7 @@ introduced: "v1.15.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/redfish/README.md, Redfish Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/redfish/README.md, Redfish Plugin Source --- # Redfish Input Plugin diff --git a/content/telegraf/v1/input-plugins/redis/_index.md b/content/telegraf/v1/input-plugins/redis/_index.md index fc322e18b..9472c4ae3 100644 --- a/content/telegraf/v1/input-plugins/redis/_index.md +++ b/content/telegraf/v1/input-plugins/redis/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/redis/README.md, Redis Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/redis/README.md, Redis Plugin Source --- # Redis Input Plugin diff --git a/content/telegraf/v1/input-plugins/redis_sentinel/_index.md b/content/telegraf/v1/input-plugins/redis_sentinel/_index.md index 5d36437b6..ef77c13a0 100644 --- a/content/telegraf/v1/input-plugins/redis_sentinel/_index.md +++ b/content/telegraf/v1/input-plugins/redis_sentinel/_index.md @@ -10,7 +10,7 @@ introduced: "v1.22.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/redis_sentinel/README.md, Redis Sentinel Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/redis_sentinel/README.md, Redis Sentinel Plugin Source --- # Redis Sentinel Input Plugin diff --git a/content/telegraf/v1/input-plugins/rethinkdb/_index.md b/content/telegraf/v1/input-plugins/rethinkdb/_index.md index d7cf4bb9f..3d9881c4d 100644 --- a/content/telegraf/v1/input-plugins/rethinkdb/_index.md +++ b/content/telegraf/v1/input-plugins/rethinkdb/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.3" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/rethinkdb/README.md, RethinkDB Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/rethinkdb/README.md, RethinkDB Plugin Source --- # RethinkDB Input Plugin diff --git a/content/telegraf/v1/input-plugins/riak/_index.md b/content/telegraf/v1/input-plugins/riak/_index.md index 0de9f5285..0531a8c98 100644 --- a/content/telegraf/v1/input-plugins/riak/_index.md +++ b/content/telegraf/v1/input-plugins/riak/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.4" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/riak/README.md, Riak Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/riak/README.md, Riak Plugin Source --- # Riak Input Plugin diff --git a/content/telegraf/v1/input-plugins/riemann_listener/_index.md b/content/telegraf/v1/input-plugins/riemann_listener/_index.md index 806bb1dc9..62929360e 100644 --- a/content/telegraf/v1/input-plugins/riemann_listener/_index.md +++ b/content/telegraf/v1/input-plugins/riemann_listener/_index.md @@ -10,7 +10,7 @@ introduced: "v1.17.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/riemann_listener/README.md, Riemann Listener Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/riemann_listener/README.md, Riemann Listener Plugin Source --- # Riemann Listener Input Plugin diff --git a/content/telegraf/v1/input-plugins/s7comm/_index.md b/content/telegraf/v1/input-plugins/s7comm/_index.md index 1e3daa8e4..11776766a 100644 --- a/content/telegraf/v1/input-plugins/s7comm/_index.md +++ b/content/telegraf/v1/input-plugins/s7comm/_index.md @@ -10,7 +10,7 @@ introduced: "v1.28.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/s7comm/README.md, Siemens S7 Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/s7comm/README.md, Siemens S7 Plugin Source --- # Siemens S7 Input Plugin diff --git a/content/telegraf/v1/input-plugins/salesforce/_index.md b/content/telegraf/v1/input-plugins/salesforce/_index.md index 2fd239403..990a58193 100644 --- a/content/telegraf/v1/input-plugins/salesforce/_index.md +++ b/content/telegraf/v1/input-plugins/salesforce/_index.md @@ -10,7 +10,7 @@ introduced: "v1.4.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/salesforce/README.md, Salesforce Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/salesforce/README.md, Salesforce Plugin Source --- # Salesforce Input Plugin diff --git a/content/telegraf/v1/input-plugins/sensors/_index.md b/content/telegraf/v1/input-plugins/sensors/_index.md index 41c6aa27e..f2da8bc24 100644 --- a/content/telegraf/v1/input-plugins/sensors/_index.md +++ b/content/telegraf/v1/input-plugins/sensors/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.1" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/sensors/README.md, LM Sensors Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/sensors/README.md, LM Sensors Plugin Source --- # LM Sensors Input Plugin diff --git a/content/telegraf/v1/input-plugins/sflow/_index.md b/content/telegraf/v1/input-plugins/sflow/_index.md index 867e44d41..36de6d5de 100644 --- a/content/telegraf/v1/input-plugins/sflow/_index.md +++ b/content/telegraf/v1/input-plugins/sflow/_index.md @@ -10,7 +10,7 @@ introduced: "v1.14.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/sflow/README.md, SFlow Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/sflow/README.md, SFlow Plugin Source --- # SFlow Input Plugin diff --git a/content/telegraf/v1/input-plugins/sip/_index.md b/content/telegraf/v1/input-plugins/sip/_index.md new file mode 100644 index 000000000..9cabab6c7 --- /dev/null +++ b/content/telegraf/v1/input-plugins/sip/_index.md @@ -0,0 +1,182 @@ +--- +description: "Telegraf plugin for collecting metrics from SIP" +menu: + telegraf_v1_ref: + parent: input_plugins_reference + name: SIP + identifier: input-sip +tags: [SIP, "input-plugins", "configuration", "network"] +introduced: "v1.38.0" +os_support: "freebsd, linux, macos, solaris, windows" +related: + - /telegraf/v1/configure_plugins/ + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/sip/README.md, SIP Plugin Source +--- + +# SIP Input Plugin + +This plugin gathers metrics about the health and availability of +[SIP (Session Initiation Protocol)](https://datatracker.ietf.org/doc/html/rfc3261) servers such as PBX systems, SIP +proxies, registrars, and VoIP service providers. It sends SIP requests +(typically OPTIONS) and measures response times and status codes. + +**Introduced in:** Telegraf v1.38.0 +**Tags:** network +**OS support:** all + +[sip]: https://datatracker.ietf.org/doc/html/rfc3261 + +## Global configuration options + +Plugins support additional global and plugin configuration settings for tasks +such as modifying metrics, tags, and fields, creating aliases, and configuring +plugin ordering. See [CONFIGURATION.md](/telegraf/v1/configuration/#plugins) for more details. + +[CONFIGURATION.md]: ../../../docs/CONFIGURATION.md#plugins + +## Secret-store support + +This plugin supports secrets from secret-stores for the `username` and +`password` option. +See the [secret-store documentation](/telegraf/v1/configuration/#secret-store-secrets) for more details on how +to use them. + +[SECRETSTORE]: ../../../docs/CONFIGURATION.md#secret-store-secrets + +## Configuration + +```toml @sample.conf +# SIP (Session Initiation Protocol) health check plugin +[[inputs.sip]] + ## SIP server address to monitor + ## Format: sip://host[:port] or sips://host[:port] + ## sip:// - Standard SIP (default port 5060) + ## sips:// - Secure SIP with TLS (default port 5061) + server = "sip://sip.example.com:5060" + + ## Transport protocol + ## Valid values: udp, tcp, ws, wss + # transport = "udp" + + ## SIP method to use for health checks + ## Valid values: OPTIONS, INVITE, MESSAGE + # method = "OPTIONS" + + ## Request timeout + # timeout = "5s" + + ## From user as it appears in SIP header + # from_user = "telegraf" + + ## From domain (domain part of From header) + ## If not specified, uses the server hostname + # from_domain = "" + + ## To user as it appears in SIP header + ## If not specified, uses the same value as from_user + # to_user = "" + + ## Local address to use for outgoing requests + # local_address = "" + + ## SIP digest authentication credentials + ## Leave empty to use no authentication + # username = "" + # password = "" + + ## Optional TLS Config (only used for sips:// URLs or transport=tls/wss) + ## Set to true/false to enforce TLS being enabled/disabled. If not set, + ## enable TLS only if any of the other options are specified. + # tls_enable = + ## Trusted root certificates for server + # tls_ca = "/path/to/cafile" + ## Used for TLS client certificate authentication + # tls_cert = "/path/to/certfile" + ## Used for TLS client certificate authentication + # tls_key = "/path/to/keyfile" + ## Password for the key file if it is encrypted + # tls_key_pwd = "" + ## Send the specified TLS server name via SNI + # tls_server_name = "kubernetes.example.com" + ## Minimal TLS version to accept by the client + # tls_min_version = "TLS12" + ## List of ciphers to accept, by default all secure ciphers will be accepted + ## See https://pkg.go.dev/crypto/tls#pkg-constants for supported values. + ## Use "all", "secure" and "insecure" to add all support ciphers, secure + ## suites or insecure suites respectively. + # tls_cipher_suites = ["secure"] + ## Renegotiation method, "never", "once" or "freely" + # tls_renegotiation_method = "never" + ## Use TLS but skip chain & host verification + # insecure_skip_verify = false +``` + +### SIP Methods + +The plugin supports the following SIP methods: + +- **OPTIONS** (recommended): Standard SIP method for health checks. Queries + server capabilities without establishing a session. +- **INVITE**: Initiates a session. Use with caution as it may create call + records. +- **MESSAGE**: Sends an instant message. Useful for testing messaging + infrastructure. + +## Troubleshooting + +### Permission Issues + +Some SIP implementations may require specific network permissions. If you +encounter permission errors, ensure Telegraf has appropriate network access. + +### Firewall Configuration + +Ensure that: + +- Outbound connections to SIP ports (typically 5060/5061) are allowed +- If using UDP, firewall allows UDP packets +- Return traffic is permitted for the transaction + +### Timeout Issues + +If experiencing frequent timeouts: + +- Increase the `timeout` value +- Verify network connectivity to the SIP server +- Check if the SIP server is configured to respond to the chosen method +- Ensure the correct transport protocol is selected + +### Response Codes + +Different SIP servers may respond with different status codes to OPTIONS requests: + +- `200 OK` - Server is operational and responding +- `404 Not Found` - User or resource doesn't exist (may still indicate healthy server) +- `401 Unauthorized` / `407 Proxy Authentication Required` - Authentication required + +## Metrics + +- sip + - tags: + - source (the SIP server address) + - method (the SIP method used, lowercase: options, invite, message) + - transport (the transport protocol: udp, tcp, ws, wss) + - status_code (the SIP response status code, e.g., "200", "404"; not always present, e.g. on timeout) + - fields: + - response_time_s (float, seconds) - Time taken to receive response + (for timeouts, this equals the configured timeout value) + - result (string) - The outcome of the request: the SIP reason phrase when + a response is received (e.g. "OK", "Not Found", "Unauthorized"), or a + sentinel value when no valid response is received (`Timeout`, `Error`, + `No Response`) + - server_agent (string, optional) - Value of the `Server` header from the + SIP response, identifying the remote server software + +## Example Output + +```text +sip,host=telegraf-host,method=options,source=sip://sip.example.com:5060,status_code=200,transport=udp response_time_s=0.023,result="OK" 1640000000000000000 +sip,host=telegraf-host,method=options,source=sip://unreachable.example.com:5060,transport=udp response_time_s=5.0,result="Timeout" 1640000000000000000 +sip,host=telegraf-host,method=options,source=sip://sip.provider.com:5060,status_code=404,transport=udp response_time_s=0.045,result="Not Found" 1640000000000000000 +sip,host=telegraf-host,method=options,source=sips://secure.voip.example.com:5061,status_code=200,transport=tcp response_time_s=0.067,result="OK",server_agent="Asterisk PBX 18.15.0" 1640000000000000000 +``` diff --git a/content/telegraf/v1/input-plugins/slab/_index.md b/content/telegraf/v1/input-plugins/slab/_index.md index 4d4c4fbc4..8e699cb75 100644 --- a/content/telegraf/v1/input-plugins/slab/_index.md +++ b/content/telegraf/v1/input-plugins/slab/_index.md @@ -10,7 +10,7 @@ introduced: "v1.23.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/slab/README.md, Slab Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/slab/README.md, Slab Plugin Source --- # Slab Input Plugin diff --git a/content/telegraf/v1/input-plugins/slurm/_index.md b/content/telegraf/v1/input-plugins/slurm/_index.md index ea6b981db..7b3d6a352 100644 --- a/content/telegraf/v1/input-plugins/slurm/_index.md +++ b/content/telegraf/v1/input-plugins/slurm/_index.md @@ -10,7 +10,7 @@ introduced: "v1.32.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/slurm/README.md, SLURM Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/slurm/README.md, SLURM Plugin Source --- # SLURM Input Plugin diff --git a/content/telegraf/v1/input-plugins/smart/_index.md b/content/telegraf/v1/input-plugins/smart/_index.md index 65f776c90..2eff62373 100644 --- a/content/telegraf/v1/input-plugins/smart/_index.md +++ b/content/telegraf/v1/input-plugins/smart/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/smart/README.md, S.M.A.R.T. Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/smart/README.md, S.M.A.R.T. Plugin Source --- # S.M.A.R.T. Input Plugin @@ -225,14 +225,25 @@ smartctl --scan -d nvme - serial_no - wwn - fields: + - available_spare (NVMe) + - available_spare_threshold (NVMe) + - critical_temperature_time (NVMe) + - critical_warning (NVMe) + - error_log_entries (NVMe) - exit_status - health_ok + - media_errors (NVMe) - media_wearout_indicator - percent_lifetime_remain + - percentage_used (NVMe) + - power_cycle_count + - power_on_hours - read_error_rate - - seek_error + - seek_error_rate - temp_c - udma_crc_errors + - unsafe_shutdowns (NVMe) + - warning_temperature_time (NVMe) - wear_leveling_count - smart_attribute: diff --git a/content/telegraf/v1/input-plugins/smartctl/_index.md b/content/telegraf/v1/input-plugins/smartctl/_index.md index 36f6a3082..36c1a65b5 100644 --- a/content/telegraf/v1/input-plugins/smartctl/_index.md +++ b/content/telegraf/v1/input-plugins/smartctl/_index.md @@ -10,7 +10,7 @@ introduced: "v1.31.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/smartctl/README.md, smartctl JSON Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/smartctl/README.md, smartctl JSON Plugin Source --- # smartctl JSON Input Plugin diff --git a/content/telegraf/v1/input-plugins/snmp/_index.md b/content/telegraf/v1/input-plugins/snmp/_index.md index 7c3c6d8dc..5e7f7433a 100644 --- a/content/telegraf/v1/input-plugins/snmp/_index.md +++ b/content/telegraf/v1/input-plugins/snmp/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/snmp/README.md, SNMP Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/snmp/README.md, SNMP Plugin Source --- # SNMP Input Plugin diff --git a/content/telegraf/v1/input-plugins/snmp_trap/_index.md b/content/telegraf/v1/input-plugins/snmp_trap/_index.md index 527317f4b..0c785bae6 100644 --- a/content/telegraf/v1/input-plugins/snmp_trap/_index.md +++ b/content/telegraf/v1/input-plugins/snmp_trap/_index.md @@ -10,7 +10,7 @@ introduced: "v1.13.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/snmp_trap/README.md, SNMP Trap Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/snmp_trap/README.md, SNMP Trap Plugin Source --- # SNMP Trap Input Plugin diff --git a/content/telegraf/v1/input-plugins/socket_listener/_index.md b/content/telegraf/v1/input-plugins/socket_listener/_index.md index f3886afe0..18c9a3bcc 100644 --- a/content/telegraf/v1/input-plugins/socket_listener/_index.md +++ b/content/telegraf/v1/input-plugins/socket_listener/_index.md @@ -10,7 +10,7 @@ introduced: "v1.3.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/socket_listener/README.md, Socket Listener Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/socket_listener/README.md, Socket Listener Plugin Source --- # Socket Listener Input Plugin diff --git a/content/telegraf/v1/input-plugins/socketstat/_index.md b/content/telegraf/v1/input-plugins/socketstat/_index.md index 74cafe45a..eb978f037 100644 --- a/content/telegraf/v1/input-plugins/socketstat/_index.md +++ b/content/telegraf/v1/input-plugins/socketstat/_index.md @@ -10,7 +10,7 @@ introduced: "v1.22.0" os_support: "freebsd, linux, macos" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/socketstat/README.md, Socket Statistics Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/socketstat/README.md, Socket Statistics Plugin Source --- # Socket Statistics Input Plugin diff --git a/content/telegraf/v1/input-plugins/solr/_index.md b/content/telegraf/v1/input-plugins/solr/_index.md index c2e13acc4..7bba310ee 100644 --- a/content/telegraf/v1/input-plugins/solr/_index.md +++ b/content/telegraf/v1/input-plugins/solr/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/solr/README.md, Apache Solr Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/solr/README.md, Apache Solr Plugin Source --- # Apache Solr Input Plugin diff --git a/content/telegraf/v1/input-plugins/sql/_index.md b/content/telegraf/v1/input-plugins/sql/_index.md index dca95f682..0d4919ebd 100644 --- a/content/telegraf/v1/input-plugins/sql/_index.md +++ b/content/telegraf/v1/input-plugins/sql/_index.md @@ -10,7 +10,7 @@ introduced: "v1.19.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/sql/README.md, SQL Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/sql/README.md, SQL Plugin Source --- # SQL Input Plugin diff --git a/content/telegraf/v1/input-plugins/sqlserver/_index.md b/content/telegraf/v1/input-plugins/sqlserver/_index.md index 8248ab213..848d689e0 100644 --- a/content/telegraf/v1/input-plugins/sqlserver/_index.md +++ b/content/telegraf/v1/input-plugins/sqlserver/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/sqlserver/README.md, Microsoft SQL Server Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/sqlserver/README.md, Microsoft SQL Server Plugin Source --- # Microsoft SQL Server Input Plugin diff --git a/content/telegraf/v1/input-plugins/stackdriver/_index.md b/content/telegraf/v1/input-plugins/stackdriver/_index.md index f3171a4b0..e4dd9dfa1 100644 --- a/content/telegraf/v1/input-plugins/stackdriver/_index.md +++ b/content/telegraf/v1/input-plugins/stackdriver/_index.md @@ -10,7 +10,7 @@ introduced: "v1.10.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/stackdriver/README.md, Stackdriver Google Cloud Monitoring Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/stackdriver/README.md, Stackdriver Google Cloud Monitoring Plugin Source --- # Stackdriver Google Cloud Monitoring Input Plugin diff --git a/content/telegraf/v1/input-plugins/statsd/_index.md b/content/telegraf/v1/input-plugins/statsd/_index.md index 66fc89784..7bb86749a 100644 --- a/content/telegraf/v1/input-plugins/statsd/_index.md +++ b/content/telegraf/v1/input-plugins/statsd/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/statsd/README.md, StatsD Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/statsd/README.md, StatsD Plugin Source --- # StatsD Input Plugin @@ -88,7 +88,7 @@ plugin ordering. See [CONFIGURATION.md](/telegraf/v1/configuration/#plugins) for metric_separator = "_" ## Parses extensions to statsd in the datadog statsd format - ## currently supports metrics and datadog tags. + ## currently supports metrics, datadog tags, events, and service checks. ## http://docs.datadoghq.com/guides/dogstatsd/ datadog_extensions = false @@ -268,6 +268,39 @@ metric type: given time interval, a Distribution metric sends all the raw data during a time interval. +### Datadog Service Checks + +When `datadog_extensions` is enabled, the plugin also supports +[Datadog service checks](https://docs.datadoghq.com/developers/service_checks/dogstatsd_service_checks_submission/) in the format: + +```text +_sc|||d:|h:|#:|m: +``` + +- `` - service check name (required) +- `` - 0=OK, 1=Warning, 2=Critical, 3=Unknown (required) +- `d:` - optional Unix timestamp +- `h:` - optional hostname override +- `#` - optional tags (same format as metrics) +- `m:` - optional message + +Example: + +```shell +echo "_sc|my.service.check|0|#env:prod|m:Service is healthy" | nc -u -w1 127.0.0.1 8125 +``` + +Service checks produce a metric with measurement name `statsd_service_check`: + +- **Tags:** + - `check_name`: The service check name + - `source`: Hostname (from `h:` field or default) + - Plus any custom tags from the `#` section +- **Fields:** + - `status` (int): Status code (0-3) + - `status_text` (string): "ok", "warning", "critical", or "unknown" + - `message` (string): Optional message from `m:` field + ## Plugin arguments - **protocol** string: Protocol used in listener - tcp or udp options @@ -293,7 +326,7 @@ measurements and tags. [dogstatsd format](http://docs.datadoghq.com/guides/dogstatsd/) - **datadog_extensions** boolean: Enable parsing of DataDog's extensions to [dogstatsd format](http://docs.datadoghq.com/guides/dogstatsd/) - and more + including events and service checks - **datadog_distributions** boolean: Enable parsing of the Distribution metric in [DataDog's distribution format](https://docs.datadoghq.com/developers/metrics/types/?tab=distribution#definition) - **datadog_keep_container_tag** boolean: Keep or drop the container id as tag. @@ -305,6 +338,7 @@ measurements and tags. [dogstatsd_format]: http://docs.datadoghq.com/guides/dogstatsd/ [dogstatsd_distri_format]: https://docs.datadoghq.com/developers/metrics/types/?tab=distribution#definition +[dogstatsd_service_checks]: https://docs.datadoghq.com/developers/service_checks/dogstatsd_service_checks_submission/ ## Statsd bucket -> InfluxDB line-protocol Templates diff --git a/content/telegraf/v1/input-plugins/supervisor/_index.md b/content/telegraf/v1/input-plugins/supervisor/_index.md index 6e6fb1b6a..0308383d9 100644 --- a/content/telegraf/v1/input-plugins/supervisor/_index.md +++ b/content/telegraf/v1/input-plugins/supervisor/_index.md @@ -10,7 +10,7 @@ introduced: "v1.24.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/supervisor/README.md, Supervisor Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/supervisor/README.md, Supervisor Plugin Source --- # Supervisor Input Plugin diff --git a/content/telegraf/v1/input-plugins/suricata/_index.md b/content/telegraf/v1/input-plugins/suricata/_index.md index be8e55b8e..00db0d451 100644 --- a/content/telegraf/v1/input-plugins/suricata/_index.md +++ b/content/telegraf/v1/input-plugins/suricata/_index.md @@ -10,7 +10,7 @@ introduced: "v1.13.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/suricata/README.md, Suricata Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/suricata/README.md, Suricata Plugin Source --- # Suricata Input Plugin diff --git a/content/telegraf/v1/input-plugins/swap/_index.md b/content/telegraf/v1/input-plugins/swap/_index.md index 057c20d26..6316dac31 100644 --- a/content/telegraf/v1/input-plugins/swap/_index.md +++ b/content/telegraf/v1/input-plugins/swap/_index.md @@ -10,7 +10,7 @@ introduced: "v1.7.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/swap/README.md, Swap Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/swap/README.md, Swap Plugin Source --- # Swap Input Plugin diff --git a/content/telegraf/v1/input-plugins/synproxy/_index.md b/content/telegraf/v1/input-plugins/synproxy/_index.md index 7293550a4..b958653fa 100644 --- a/content/telegraf/v1/input-plugins/synproxy/_index.md +++ b/content/telegraf/v1/input-plugins/synproxy/_index.md @@ -10,7 +10,7 @@ introduced: "v1.13.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/synproxy/README.md, Synproxy Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/synproxy/README.md, Synproxy Plugin Source --- # Synproxy Input Plugin diff --git a/content/telegraf/v1/input-plugins/syslog/_index.md b/content/telegraf/v1/input-plugins/syslog/_index.md index 77fc71a6c..fa16c2085 100644 --- a/content/telegraf/v1/input-plugins/syslog/_index.md +++ b/content/telegraf/v1/input-plugins/syslog/_index.md @@ -10,7 +10,7 @@ introduced: "v1.7.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/syslog/README.md, Syslog Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/syslog/README.md, Syslog Plugin Source --- # Syslog Input Plugin diff --git a/content/telegraf/v1/input-plugins/sysstat/_index.md b/content/telegraf/v1/input-plugins/sysstat/_index.md index b61176ef9..5dc88528f 100644 --- a/content/telegraf/v1/input-plugins/sysstat/_index.md +++ b/content/telegraf/v1/input-plugins/sysstat/_index.md @@ -10,7 +10,7 @@ introduced: "v0.12.1" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/sysstat/README.md, System Performance Statistics Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/sysstat/README.md, System Performance Statistics Plugin Source --- # System Performance Statistics Input Plugin diff --git a/content/telegraf/v1/input-plugins/system/_index.md b/content/telegraf/v1/input-plugins/system/_index.md index 1f221504a..e8f6ddac2 100644 --- a/content/telegraf/v1/input-plugins/system/_index.md +++ b/content/telegraf/v1/input-plugins/system/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.6" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/system/README.md, System Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/system/README.md, System Plugin Source --- # System Input Plugin diff --git a/content/telegraf/v1/input-plugins/systemd_units/_index.md b/content/telegraf/v1/input-plugins/systemd_units/_index.md index f873708c5..d68b0d64c 100644 --- a/content/telegraf/v1/input-plugins/systemd_units/_index.md +++ b/content/telegraf/v1/input-plugins/systemd_units/_index.md @@ -10,7 +10,7 @@ introduced: "v1.13.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/systemd_units/README.md, Systemd-Units Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/systemd_units/README.md, Systemd-Units Plugin Source --- # Systemd-Units Input Plugin diff --git a/content/telegraf/v1/input-plugins/tacacs/_index.md b/content/telegraf/v1/input-plugins/tacacs/_index.md index 5a74c92a8..085b3de27 100644 --- a/content/telegraf/v1/input-plugins/tacacs/_index.md +++ b/content/telegraf/v1/input-plugins/tacacs/_index.md @@ -10,7 +10,7 @@ introduced: "v1.28.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/tacacs/README.md, Tacacs Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/tacacs/README.md, Tacacs Plugin Source --- # Tacacs Input Plugin diff --git a/content/telegraf/v1/input-plugins/tail/_index.md b/content/telegraf/v1/input-plugins/tail/_index.md index f98ecd8c2..1c358c692 100644 --- a/content/telegraf/v1/input-plugins/tail/_index.md +++ b/content/telegraf/v1/input-plugins/tail/_index.md @@ -10,7 +10,7 @@ introduced: "v1.1.2" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/tail/README.md, Tail Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/tail/README.md, Tail Plugin Source --- # Tail Input Plugin diff --git a/content/telegraf/v1/input-plugins/teamspeak/_index.md b/content/telegraf/v1/input-plugins/teamspeak/_index.md index d266fb446..3834d03e1 100644 --- a/content/telegraf/v1/input-plugins/teamspeak/_index.md +++ b/content/telegraf/v1/input-plugins/teamspeak/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/teamspeak/README.md, Teamspeak Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/teamspeak/README.md, Teamspeak Plugin Source --- # Teamspeak Input Plugin diff --git a/content/telegraf/v1/input-plugins/temp/_index.md b/content/telegraf/v1/input-plugins/temp/_index.md index 38c22bdde..e0708cdff 100644 --- a/content/telegraf/v1/input-plugins/temp/_index.md +++ b/content/telegraf/v1/input-plugins/temp/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "linux, macos, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/temp/README.md, Temperature Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/temp/README.md, Temperature Plugin Source --- # Temperature Input Plugin diff --git a/content/telegraf/v1/input-plugins/tengine/_index.md b/content/telegraf/v1/input-plugins/tengine/_index.md index a96613537..773aa9b61 100644 --- a/content/telegraf/v1/input-plugins/tengine/_index.md +++ b/content/telegraf/v1/input-plugins/tengine/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/tengine/README.md, Tengine Web Server Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/tengine/README.md, Tengine Web Server Plugin Source --- # Tengine Web Server Input Plugin diff --git a/content/telegraf/v1/input-plugins/timex/_index.md b/content/telegraf/v1/input-plugins/timex/_index.md index 919bb051e..2e8c68d74 100644 --- a/content/telegraf/v1/input-plugins/timex/_index.md +++ b/content/telegraf/v1/input-plugins/timex/_index.md @@ -10,7 +10,7 @@ introduced: "v1.37.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/timex/README.md, Timex Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/timex/README.md, Timex Plugin Source --- # Timex Input Plugin diff --git a/content/telegraf/v1/input-plugins/tomcat/_index.md b/content/telegraf/v1/input-plugins/tomcat/_index.md index 202aba94e..fd55d5ca4 100644 --- a/content/telegraf/v1/input-plugins/tomcat/_index.md +++ b/content/telegraf/v1/input-plugins/tomcat/_index.md @@ -10,7 +10,7 @@ introduced: "v1.4.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/tomcat/README.md, Apache Tomcat Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/tomcat/README.md, Apache Tomcat Plugin Source --- # Apache Tomcat Input Plugin diff --git a/content/telegraf/v1/input-plugins/trig/_index.md b/content/telegraf/v1/input-plugins/trig/_index.md index e193a3a74..aaadc3279 100644 --- a/content/telegraf/v1/input-plugins/trig/_index.md +++ b/content/telegraf/v1/input-plugins/trig/_index.md @@ -10,7 +10,7 @@ introduced: "v0.3.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/trig/README.md, Trig Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/trig/README.md, Trig Plugin Source --- # Trig Input Plugin diff --git a/content/telegraf/v1/input-plugins/turbostat/_index.md b/content/telegraf/v1/input-plugins/turbostat/_index.md index 1184c74f8..b3d9a9e50 100644 --- a/content/telegraf/v1/input-plugins/turbostat/_index.md +++ b/content/telegraf/v1/input-plugins/turbostat/_index.md @@ -10,7 +10,7 @@ introduced: "v1.36.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/turbostat/README.md, Turbostat Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/turbostat/README.md, Turbostat Plugin Source --- # Turbostat Input Plugin diff --git a/content/telegraf/v1/input-plugins/twemproxy/_index.md b/content/telegraf/v1/input-plugins/twemproxy/_index.md index 6ef031b45..d1d1d4710 100644 --- a/content/telegraf/v1/input-plugins/twemproxy/_index.md +++ b/content/telegraf/v1/input-plugins/twemproxy/_index.md @@ -10,7 +10,7 @@ introduced: "v0.3.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/twemproxy/README.md, Twemproxy Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/twemproxy/README.md, Twemproxy Plugin Source --- # Twemproxy Input Plugin diff --git a/content/telegraf/v1/input-plugins/unbound/_index.md b/content/telegraf/v1/input-plugins/unbound/_index.md index 426dbee02..cbcc346bd 100644 --- a/content/telegraf/v1/input-plugins/unbound/_index.md +++ b/content/telegraf/v1/input-plugins/unbound/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/unbound/README.md, Unbound Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/unbound/README.md, Unbound Plugin Source --- # Unbound Input Plugin diff --git a/content/telegraf/v1/input-plugins/upsd/_index.md b/content/telegraf/v1/input-plugins/upsd/_index.md index a5a573957..0de57dba9 100644 --- a/content/telegraf/v1/input-plugins/upsd/_index.md +++ b/content/telegraf/v1/input-plugins/upsd/_index.md @@ -10,7 +10,7 @@ introduced: "v1.24.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/upsd/README.md, UPSD Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/upsd/README.md, UPSD Plugin Source --- # UPSD Input Plugin diff --git a/content/telegraf/v1/input-plugins/uwsgi/_index.md b/content/telegraf/v1/input-plugins/uwsgi/_index.md index d6ed91769..0aac387b4 100644 --- a/content/telegraf/v1/input-plugins/uwsgi/_index.md +++ b/content/telegraf/v1/input-plugins/uwsgi/_index.md @@ -10,7 +10,7 @@ introduced: "v1.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/uwsgi/README.md, uWSGI Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/uwsgi/README.md, uWSGI Plugin Source --- # uWSGI Input Plugin diff --git a/content/telegraf/v1/input-plugins/varnish/_index.md b/content/telegraf/v1/input-plugins/varnish/_index.md index e5b415b6e..0eeeed248 100644 --- a/content/telegraf/v1/input-plugins/varnish/_index.md +++ b/content/telegraf/v1/input-plugins/varnish/_index.md @@ -10,7 +10,7 @@ introduced: "v0.13.1" os_support: "freebsd, linux, macos" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/varnish/README.md, Varnish Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/varnish/README.md, Varnish Plugin Source --- # Varnish Input Plugin diff --git a/content/telegraf/v1/input-plugins/vault/_index.md b/content/telegraf/v1/input-plugins/vault/_index.md index 06e495e6a..7ba6462ec 100644 --- a/content/telegraf/v1/input-plugins/vault/_index.md +++ b/content/telegraf/v1/input-plugins/vault/_index.md @@ -10,7 +10,7 @@ introduced: "v1.22.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/vault/README.md, Hashicorp Vault Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/vault/README.md, Hashicorp Vault Plugin Source --- # Hashicorp Vault Input Plugin diff --git a/content/telegraf/v1/input-plugins/vsphere/_index.md b/content/telegraf/v1/input-plugins/vsphere/_index.md index 49cee3388..9913b6f84 100644 --- a/content/telegraf/v1/input-plugins/vsphere/_index.md +++ b/content/telegraf/v1/input-plugins/vsphere/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/vsphere/README.md, VMware vSphere Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/vsphere/README.md, VMware vSphere Plugin Source --- # VMware vSphere Input Plugin diff --git a/content/telegraf/v1/input-plugins/webhooks/_index.md b/content/telegraf/v1/input-plugins/webhooks/_index.md index 17799c32b..e653be2f0 100644 --- a/content/telegraf/v1/input-plugins/webhooks/_index.md +++ b/content/telegraf/v1/input-plugins/webhooks/_index.md @@ -10,7 +10,7 @@ introduced: "v1.0.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/webhooks/README.md, Webhooks Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/webhooks/README.md, Webhooks Plugin Source --- # Webhooks Input Plugin diff --git a/content/telegraf/v1/input-plugins/whois/_index.md b/content/telegraf/v1/input-plugins/whois/_index.md index 637d9b1f8..cdaea29eb 100644 --- a/content/telegraf/v1/input-plugins/whois/_index.md +++ b/content/telegraf/v1/input-plugins/whois/_index.md @@ -10,7 +10,7 @@ introduced: "v1.35.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/whois/README.md, WHOIS Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/whois/README.md, WHOIS Plugin Source --- # WHOIS Input Plugin diff --git a/content/telegraf/v1/input-plugins/win_eventlog/_index.md b/content/telegraf/v1/input-plugins/win_eventlog/_index.md index d35eff5e8..7c7cfb820 100644 --- a/content/telegraf/v1/input-plugins/win_eventlog/_index.md +++ b/content/telegraf/v1/input-plugins/win_eventlog/_index.md @@ -10,7 +10,7 @@ introduced: "v1.16.0" os_support: "windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/win_eventlog/README.md, Windows Eventlog Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/win_eventlog/README.md, Windows Eventlog Plugin Source --- # Windows Eventlog Input Plugin diff --git a/content/telegraf/v1/input-plugins/win_perf_counters/_index.md b/content/telegraf/v1/input-plugins/win_perf_counters/_index.md index da5128b3b..425519318 100644 --- a/content/telegraf/v1/input-plugins/win_perf_counters/_index.md +++ b/content/telegraf/v1/input-plugins/win_perf_counters/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.2" os_support: "windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/win_perf_counters/README.md, Windows Performance Counters Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/win_perf_counters/README.md, Windows Performance Counters Plugin Source --- # Windows Performance Counters Input Plugin diff --git a/content/telegraf/v1/input-plugins/win_services/_index.md b/content/telegraf/v1/input-plugins/win_services/_index.md index 230c4eb38..1360ba626 100644 --- a/content/telegraf/v1/input-plugins/win_services/_index.md +++ b/content/telegraf/v1/input-plugins/win_services/_index.md @@ -10,7 +10,7 @@ introduced: "v1.4.0" os_support: "windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/win_services/README.md, Windows Services Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/win_services/README.md, Windows Services Plugin Source --- # Windows Services Input Plugin diff --git a/content/telegraf/v1/input-plugins/win_wmi/_index.md b/content/telegraf/v1/input-plugins/win_wmi/_index.md index 5570241ef..509fcdb91 100644 --- a/content/telegraf/v1/input-plugins/win_wmi/_index.md +++ b/content/telegraf/v1/input-plugins/win_wmi/_index.md @@ -10,7 +10,7 @@ introduced: "v1.26.0" os_support: "windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/win_wmi/README.md, Windows Management Instrumentation Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/win_wmi/README.md, Windows Management Instrumentation Plugin Source --- # Windows Management Instrumentation Input Plugin diff --git a/content/telegraf/v1/input-plugins/wireguard/_index.md b/content/telegraf/v1/input-plugins/wireguard/_index.md index 56a81facd..2b4cf5b31 100644 --- a/content/telegraf/v1/input-plugins/wireguard/_index.md +++ b/content/telegraf/v1/input-plugins/wireguard/_index.md @@ -10,7 +10,7 @@ introduced: "v1.14.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/wireguard/README.md, Wireguard Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/wireguard/README.md, Wireguard Plugin Source --- # Wireguard Input Plugin diff --git a/content/telegraf/v1/input-plugins/wireless/_index.md b/content/telegraf/v1/input-plugins/wireless/_index.md index e4004b99e..5d4035ea8 100644 --- a/content/telegraf/v1/input-plugins/wireless/_index.md +++ b/content/telegraf/v1/input-plugins/wireless/_index.md @@ -10,7 +10,7 @@ introduced: "v1.9.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/wireless/README.md, Wireless Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/wireless/README.md, Wireless Plugin Source --- # Wireless Input Plugin diff --git a/content/telegraf/v1/input-plugins/x509_cert/_index.md b/content/telegraf/v1/input-plugins/x509_cert/_index.md index 2ba100c2b..71476f6c9 100644 --- a/content/telegraf/v1/input-plugins/x509_cert/_index.md +++ b/content/telegraf/v1/input-plugins/x509_cert/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/x509_cert/README.md, x509 Certificate Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/x509_cert/README.md, x509 Certificate Plugin Source --- # x509 Certificate Input Plugin diff --git a/content/telegraf/v1/input-plugins/xtremio/_index.md b/content/telegraf/v1/input-plugins/xtremio/_index.md index 820b40f84..9a7ce75f9 100644 --- a/content/telegraf/v1/input-plugins/xtremio/_index.md +++ b/content/telegraf/v1/input-plugins/xtremio/_index.md @@ -10,7 +10,7 @@ introduced: "v1.22.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/xtremio/README.md, Dell EMC XtremIO Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/xtremio/README.md, Dell EMC XtremIO Plugin Source --- # Dell EMC XtremIO Input Plugin diff --git a/content/telegraf/v1/input-plugins/zfs/_index.md b/content/telegraf/v1/input-plugins/zfs/_index.md index 7c0db823e..d054658c8 100644 --- a/content/telegraf/v1/input-plugins/zfs/_index.md +++ b/content/telegraf/v1/input-plugins/zfs/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.1" os_support: "freebsd, linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/zfs/README.md, ZFS Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/zfs/README.md, ZFS Plugin Source --- # ZFS Input Plugin diff --git a/content/telegraf/v1/input-plugins/zipkin/_index.md b/content/telegraf/v1/input-plugins/zipkin/_index.md index 416597381..43c8473f9 100644 --- a/content/telegraf/v1/input-plugins/zipkin/_index.md +++ b/content/telegraf/v1/input-plugins/zipkin/_index.md @@ -10,7 +10,7 @@ introduced: "v1.4.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/zipkin/README.md, Zipkin Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/zipkin/README.md, Zipkin Plugin Source --- # Zipkin Input Plugin diff --git a/content/telegraf/v1/input-plugins/zookeeper/_index.md b/content/telegraf/v1/input-plugins/zookeeper/_index.md index 6b6995a65..847a88b3e 100644 --- a/content/telegraf/v1/input-plugins/zookeeper/_index.md +++ b/content/telegraf/v1/input-plugins/zookeeper/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/inputs/zookeeper/README.md, Apache Zookeeper Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/zookeeper/README.md, Apache Zookeeper Plugin Source --- # Apache Zookeeper Input Plugin diff --git a/content/telegraf/v1/output-plugins/amon/_index.md b/content/telegraf/v1/output-plugins/amon/_index.md index 24c5f09e9..30fb0b5e4 100644 --- a/content/telegraf/v1/output-plugins/amon/_index.md +++ b/content/telegraf/v1/output-plugins/amon/_index.md @@ -12,7 +12,7 @@ removal: v1.40.0 os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/amon/README.md, Amon Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/amon/README.md, Amon Plugin Source --- # Amon Output Plugin diff --git a/content/telegraf/v1/output-plugins/amqp/_index.md b/content/telegraf/v1/output-plugins/amqp/_index.md index 11b2b54d6..007cff3f8 100644 --- a/content/telegraf/v1/output-plugins/amqp/_index.md +++ b/content/telegraf/v1/output-plugins/amqp/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.9" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/amqp/README.md, AMQP Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/amqp/README.md, AMQP Plugin Source --- # AMQP Output Plugin diff --git a/content/telegraf/v1/output-plugins/application_insights/_index.md b/content/telegraf/v1/output-plugins/application_insights/_index.md index 206dca975..b00a7af99 100644 --- a/content/telegraf/v1/output-plugins/application_insights/_index.md +++ b/content/telegraf/v1/output-plugins/application_insights/_index.md @@ -10,7 +10,7 @@ introduced: "v1.7.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/application_insights/README.md, Azure Application Insights Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/application_insights/README.md, Azure Application Insights Plugin Source --- # Azure Application Insights Output Plugin diff --git a/content/telegraf/v1/output-plugins/arc/_index.md b/content/telegraf/v1/output-plugins/arc/_index.md index 231a332f8..0d3ef9d2b 100644 --- a/content/telegraf/v1/output-plugins/arc/_index.md +++ b/content/telegraf/v1/output-plugins/arc/_index.md @@ -10,7 +10,7 @@ introduced: "v1.37.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/arc/README.md, Arc Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/arc/README.md, Arc Plugin Source --- # Arc Output Plugin diff --git a/content/telegraf/v1/output-plugins/azure_data_explorer/_index.md b/content/telegraf/v1/output-plugins/azure_data_explorer/_index.md index 06c44c911..04647c41e 100644 --- a/content/telegraf/v1/output-plugins/azure_data_explorer/_index.md +++ b/content/telegraf/v1/output-plugins/azure_data_explorer/_index.md @@ -10,7 +10,7 @@ introduced: "v1.20.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/azure_data_explorer/README.md, Azure Data Explorer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/azure_data_explorer/README.md, Azure Data Explorer Plugin Source --- # Azure Data Explorer Output Plugin diff --git a/content/telegraf/v1/output-plugins/azure_monitor/_index.md b/content/telegraf/v1/output-plugins/azure_monitor/_index.md index 7484cef9a..6c2c587bf 100644 --- a/content/telegraf/v1/output-plugins/azure_monitor/_index.md +++ b/content/telegraf/v1/output-plugins/azure_monitor/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/azure_monitor/README.md, Azure Monitor Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/azure_monitor/README.md, Azure Monitor Plugin Source --- # Azure Monitor Output Plugin diff --git a/content/telegraf/v1/output-plugins/bigquery/_index.md b/content/telegraf/v1/output-plugins/bigquery/_index.md index ddf55e6cc..81e032ce8 100644 --- a/content/telegraf/v1/output-plugins/bigquery/_index.md +++ b/content/telegraf/v1/output-plugins/bigquery/_index.md @@ -10,7 +10,7 @@ introduced: "v1.18.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/bigquery/README.md, Google BigQuery Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/bigquery/README.md, Google BigQuery Plugin Source --- # Google BigQuery Output Plugin diff --git a/content/telegraf/v1/output-plugins/clarify/_index.md b/content/telegraf/v1/output-plugins/clarify/_index.md index 359e9799d..03a277e44 100644 --- a/content/telegraf/v1/output-plugins/clarify/_index.md +++ b/content/telegraf/v1/output-plugins/clarify/_index.md @@ -10,7 +10,7 @@ introduced: "v1.27.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/clarify/README.md, Clarify Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/clarify/README.md, Clarify Plugin Source --- # Clarify Output Plugin diff --git a/content/telegraf/v1/output-plugins/cloud_pubsub/_index.md b/content/telegraf/v1/output-plugins/cloud_pubsub/_index.md index 193e4fbc4..1bfe0bccc 100644 --- a/content/telegraf/v1/output-plugins/cloud_pubsub/_index.md +++ b/content/telegraf/v1/output-plugins/cloud_pubsub/_index.md @@ -10,7 +10,7 @@ introduced: "v1.10.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/cloud_pubsub/README.md, Google Cloud PubSub Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/cloud_pubsub/README.md, Google Cloud PubSub Plugin Source --- # Google Cloud PubSub Output Plugin diff --git a/content/telegraf/v1/output-plugins/cloudwatch/_index.md b/content/telegraf/v1/output-plugins/cloudwatch/_index.md index 5ae20f45f..0b956edea 100644 --- a/content/telegraf/v1/output-plugins/cloudwatch/_index.md +++ b/content/telegraf/v1/output-plugins/cloudwatch/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/cloudwatch/README.md, Amazon CloudWatch Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/cloudwatch/README.md, Amazon CloudWatch Plugin Source --- # Amazon CloudWatch Output Plugin diff --git a/content/telegraf/v1/output-plugins/cloudwatch_logs/_index.md b/content/telegraf/v1/output-plugins/cloudwatch_logs/_index.md index 2e11a5175..007c3cd87 100644 --- a/content/telegraf/v1/output-plugins/cloudwatch_logs/_index.md +++ b/content/telegraf/v1/output-plugins/cloudwatch_logs/_index.md @@ -10,7 +10,7 @@ introduced: "v1.19.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/cloudwatch_logs/README.md, Amazon CloudWatch Logs Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/cloudwatch_logs/README.md, Amazon CloudWatch Logs Plugin Source --- # Amazon CloudWatch Logs Output Plugin diff --git a/content/telegraf/v1/output-plugins/cratedb/_index.md b/content/telegraf/v1/output-plugins/cratedb/_index.md index 1a724ff00..145464efd 100644 --- a/content/telegraf/v1/output-plugins/cratedb/_index.md +++ b/content/telegraf/v1/output-plugins/cratedb/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/cratedb/README.md, CrateDB Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/cratedb/README.md, CrateDB Plugin Source --- # CrateDB Output Plugin diff --git a/content/telegraf/v1/output-plugins/datadog/_index.md b/content/telegraf/v1/output-plugins/datadog/_index.md index 8eabf235f..2574e9340 100644 --- a/content/telegraf/v1/output-plugins/datadog/_index.md +++ b/content/telegraf/v1/output-plugins/datadog/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.6" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/datadog/README.md, Datadog Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/datadog/README.md, Datadog Plugin Source --- # Datadog Output Plugin diff --git a/content/telegraf/v1/output-plugins/discard/_index.md b/content/telegraf/v1/output-plugins/discard/_index.md index 8eba9fdc9..b587e37d9 100644 --- a/content/telegraf/v1/output-plugins/discard/_index.md +++ b/content/telegraf/v1/output-plugins/discard/_index.md @@ -10,7 +10,7 @@ introduced: "v1.2.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/discard/README.md, Discard Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/discard/README.md, Discard Plugin Source --- # Discard Output Plugin diff --git a/content/telegraf/v1/output-plugins/dynatrace/_index.md b/content/telegraf/v1/output-plugins/dynatrace/_index.md index eafe072bb..17dd1fa96 100644 --- a/content/telegraf/v1/output-plugins/dynatrace/_index.md +++ b/content/telegraf/v1/output-plugins/dynatrace/_index.md @@ -10,7 +10,7 @@ introduced: "v1.16.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/dynatrace/README.md, Dynatrace Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/dynatrace/README.md, Dynatrace Plugin Source --- # Dynatrace Output Plugin diff --git a/content/telegraf/v1/output-plugins/elasticsearch/_index.md b/content/telegraf/v1/output-plugins/elasticsearch/_index.md index f1108f349..c8f39f92d 100644 --- a/content/telegraf/v1/output-plugins/elasticsearch/_index.md +++ b/content/telegraf/v1/output-plugins/elasticsearch/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.5" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/elasticsearch/README.md, Elasticsearch Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/elasticsearch/README.md, Elasticsearch Plugin Source --- # Elasticsearch Output Plugin diff --git a/content/telegraf/v1/output-plugins/event_hubs/_index.md b/content/telegraf/v1/output-plugins/event_hubs/_index.md index 36df6804e..d8cfa9cb8 100644 --- a/content/telegraf/v1/output-plugins/event_hubs/_index.md +++ b/content/telegraf/v1/output-plugins/event_hubs/_index.md @@ -10,7 +10,7 @@ introduced: "v1.21.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/event_hubs/README.md, Azure Event Hubs Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/event_hubs/README.md, Azure Event Hubs Plugin Source --- # Azure Event Hubs Output Plugin diff --git a/content/telegraf/v1/output-plugins/exec/_index.md b/content/telegraf/v1/output-plugins/exec/_index.md index b5bd947a2..6b9fc2a95 100644 --- a/content/telegraf/v1/output-plugins/exec/_index.md +++ b/content/telegraf/v1/output-plugins/exec/_index.md @@ -10,7 +10,7 @@ introduced: "v1.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/exec/README.md, Executable Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/exec/README.md, Executable Plugin Source --- # Executable Output Plugin diff --git a/content/telegraf/v1/output-plugins/execd/_index.md b/content/telegraf/v1/output-plugins/execd/_index.md index 3a49d678a..0958fd4b1 100644 --- a/content/telegraf/v1/output-plugins/execd/_index.md +++ b/content/telegraf/v1/output-plugins/execd/_index.md @@ -10,7 +10,7 @@ introduced: "v1.15.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/execd/README.md, Executable Daemon Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/execd/README.md, Executable Daemon Plugin Source --- # Executable Daemon Output Plugin diff --git a/content/telegraf/v1/output-plugins/file/_index.md b/content/telegraf/v1/output-plugins/file/_index.md index 3145396de..38ce613c9 100644 --- a/content/telegraf/v1/output-plugins/file/_index.md +++ b/content/telegraf/v1/output-plugins/file/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.3" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/file/README.md, File Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/file/README.md, File Plugin Source --- # File Output Plugin diff --git a/content/telegraf/v1/output-plugins/graphite/_index.md b/content/telegraf/v1/output-plugins/graphite/_index.md index 2261e32cb..ec2cb6558 100644 --- a/content/telegraf/v1/output-plugins/graphite/_index.md +++ b/content/telegraf/v1/output-plugins/graphite/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/graphite/README.md, Graphite Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/graphite/README.md, Graphite Plugin Source --- # Graphite Output Plugin diff --git a/content/telegraf/v1/output-plugins/graylog/_index.md b/content/telegraf/v1/output-plugins/graylog/_index.md index f94fe15a6..98e2c1b3f 100644 --- a/content/telegraf/v1/output-plugins/graylog/_index.md +++ b/content/telegraf/v1/output-plugins/graylog/_index.md @@ -10,7 +10,7 @@ introduced: "v1.0.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/graylog/README.md, Graylog Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/graylog/README.md, Graylog Plugin Source --- # Graylog Output Plugin diff --git a/content/telegraf/v1/output-plugins/groundwork/_index.md b/content/telegraf/v1/output-plugins/groundwork/_index.md index 1fb8abd09..1308320bb 100644 --- a/content/telegraf/v1/output-plugins/groundwork/_index.md +++ b/content/telegraf/v1/output-plugins/groundwork/_index.md @@ -10,7 +10,7 @@ introduced: "v1.21.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/groundwork/README.md, GroundWork Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/groundwork/README.md, GroundWork Plugin Source --- # GroundWork Output Plugin diff --git a/content/telegraf/v1/output-plugins/health/_index.md b/content/telegraf/v1/output-plugins/health/_index.md index c31764230..66890f70d 100644 --- a/content/telegraf/v1/output-plugins/health/_index.md +++ b/content/telegraf/v1/output-plugins/health/_index.md @@ -10,7 +10,7 @@ introduced: "v1.11.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/health/README.md, Health Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/health/README.md, Health Plugin Source --- # Health Output Plugin @@ -60,6 +60,9 @@ plugin ordering. See [CONFIGURATION.md](/telegraf/v1/configuration/#plugins) for # tls_cert = "/etc/telegraf/cert.pem" # tls_key = "/etc/telegraf/key.pem" + ## HTTP status code reported during startup i.e. before any write was called + # default_status = 200 + ## Maximum expected time between metrics being written ## Enforces an unhealthy state if there was no new metric seen for at least ## the specified time. The check is disabled by default and only used if a diff --git a/content/telegraf/v1/output-plugins/heartbeat/_index.md b/content/telegraf/v1/output-plugins/heartbeat/_index.md index c93d4b6f5..f507c8c17 100644 --- a/content/telegraf/v1/output-plugins/heartbeat/_index.md +++ b/content/telegraf/v1/output-plugins/heartbeat/_index.md @@ -10,7 +10,7 @@ introduced: "v1.37.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/heartbeat/README.md, Heartbeat Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/heartbeat/README.md, Heartbeat Plugin Source --- # Heartbeat Output Plugin @@ -61,8 +61,42 @@ to use them. ## hostname -- hostname of the instance running Telegraf ## statistics -- number of metrics, logged errors and warnings, etc ## configs -- redacted list of configs loaded by this instance + ## logs -- detailed log-entries for this instance + ## status -- result of the status condition evaluation # include = ["hostname"] + ## Logging information filtering, only applies if "logs" is added to "include" + # [outputs.heartbeat.logs] + # ## Number of log entries to send (unlimited by default) + # ## In case more log-entries are available entries with higher log levels + # ## and more recent entries are preferred. + # # limit = 0 + # + # ## Minimum log-level for sending the entry + # # level = "error" + + ## Logical conditions to determine the agent status, only applies if "status" + ## is included in the message + # [outputs.heartbeat.status] + # ## Conditions to signal the given status as CEL programs returning a + # ## boolean. Conditions are evaluated in the order below until a program + # ## evaluates to "true". + # # ok = "false" + # # warn = "false" + # # fail = "false" + # + # ## Evaluation order of the conditions above; available: "ok", "warn", "fail" + # # order = ["ok", "warn", "fail"] + # + # ## Default status used if none of the conditions above matches + # ## available: "ok", "warn", "fail", "undefined" + # # default = "ok" + # + # ## If set, send this initial status before the first write, otherwise + # ## compute the status from the conditions and default above. + # ## available: "ok", "warn", "fail", "undefined", "" + # # initial = "" + ## Additional HTTP headers # [outputs.heartbeat.headers] # User-Agent = "telegraf" @@ -103,4 +137,143 @@ configuration directory while a new configuration is added or removed. > information. However, sensitive information might still be contained in the > URL or the path sent. Use with care! +### Logging information + +When including `logs` in the message the actual log _messages_ are included. +This comprises the log messages of _all_ plugins _and_ the agent itself being +logged _after_ the `Connect` function of this plugin was called, i.e. you will +not see any initialization or configuration errors in the heartbeat messages! +You can limit the messages sent within the optional `outputs.heartbeat.logs` +section where you can limit the messages by log-`level` or limit the number +of messages included using the `limit` setting. + +> [!WARNING] +> As the amount of log messages can be high, especially when configuring a low +> level such as `info` the resulting heartbeat messages might be large. Restrict +> the included messages by choosing a higher log-level and/or by using a limit! +When including `logs` in the message the number of errors and warnings logged +in this Telegraf instance are included in the heartbeat message. This comprises +_all_ log messages of all plugins and the agent itself logged _after_ the +`Connect` function of this plugin was called, i.e. you will not see any +initialization or configuration errors in the heartbeat messages! + +For getting the actual log _messages_ you can include `log-details`. Via the +optional `outputs.heartbeat.status` you can limit the messages by log-`level` +or limit the number included using the `limit` setting. + +> [!WARNING] +> As the amount of log messages can be high, especially when configuring low +> level such as `info` the resulting heartbeat messages might be large. Use the +> `log-details` option with care if network traffic is a limiting factor and +> restrict the included messages to high levels and use a limit! + +When setting the `level` option only messages with this or more severe levels +are included. + +The `limit` setting allows to specify the maximum number of log-messages +included in the heartbeat message. If the number of log-messages exceeds the +given limit they are selected by the most severe level and most recent messages +first. +given limit they are selected by most severe and most recent messages first. + +### Status information + +By including `status` the message will contain the status of the Telegraf +instance as configured via the `outputs.heartbeat.status` section. + +This section allows to set an `initial` state used as long as no flush was +performed by Telegraf. If `initial` is not configured or empty, the status +expressions are evaluated also before the first flush. + +The `ok`, `warn` and `fail` settings allow to specify [CEL expressions](https://cel.dev) +evaluating to a boolean value. Available information for the expressions are +listed below. The first expression evaluating to `true` defines the status. +The `order` parameter allows to customize the evaluation order. + +> [!NOTE] +> If an expression is omitted in the `order` setting it will __not__ be +> evaluated! + +The status defined via `default` is used in case none of the status expressions +evaluate to true. + +For defining expressions you can use the following variables + +- `metrics` (int) -- number of metrics arriving at this plugin +- `log_errors` (int) -- number of errors logged +- `log_warnings` (int) -- number of warnings logged +- `last_update` (time) -- time of last successful heartbeat message, can be used + to e.g. calculate rates +- `agent` (map) -- agent statistics, see below +- `inputs` (map) -- input plugin statistics, see below +- `outputs` (map) -- output plugin statistics, see below + +The `agent` statistics variable is a `map` with information matching the +`internal_agent` metric of the [internal input plugin](/telegraf/v1/plugins/#input-internal): + +- `metrics_written` (int) -- number of metrics written in total by all outputs +- `metrics_rejected` (int) -- number of metrics rejected in total by all outputs +- `metrics_dropped` (int) -- number of metrics dropped in total by all outputs +- `metrics_gathered` (int) -- number of metrics collected in total by all inputs +- `gather_errors` (int) -- number of errors during collection by all inputs +- `gather_timeouts` (int) -- number of collection timeouts by all inputs + +The `inputs` statistics variable is a `map` with the key denoting the plugin +type (e.g. `cpu` for `inputs.cpu`) and the value being list of plugin +statistics. Each entry in the list corresponds to an input plugin instance with +information matching the `internal_gather` metric of the +[internal input plugin](/telegraf/v1/plugins/#input-internal): + +- `id` (string) -- unique plugin identifier +- `alias` (string) -- alias set for the plugin; only exists if alias + is defined +- `errors` (int) -- collection errors for this plugin instance +- `metrics_gathered` (int) -- number of metrics collected +- `gather_time_ns` (int) -- time used to gather the metrics in nanoseconds +- `gather_timeouts` (int) -- number of timeouts during metric collection +- `startup_errors` (int) -- number of times the plugin failed to start + +The `outputs` statistics variable is a `map` with the key denoting the plugin +type (e.g. `influxdb` for `outputs.influxdb`) and the value being list of plugin +statistics. Each entry in the list corresponds to an output plugin instance with +information matching the `internal_write` metric of the +[internal input plugin](/telegraf/v1/plugins/#input-internal): + +- `id` (string) -- unique plugin identifier +- `alias` (string) -- alias set for the plugin; only exists if alias + is defined +- `errors` (int) -- write errors for this plugin instance +- `metrics_filtered` (int) -- number of metrics filtered by the output +- `write_time_ns` (int) -- time used to write the metrics in nanoseconds +- `startup_errors` (int) -- number of times the plugin failed to start +- `metrics_added` (int) -- number of metrics added to the output buffer +- `metrics_written` (int) -- number of metrics written to the output +- `metrics_rejected` (int) -- number of metrics rejected by the service or + serialization +- `metrics_dropped` (int) -- number of metrics dropped e.g. due to buffer + fullness +- `buffer_size` (int) -- current number of metrics currently in the output + buffer for the plugin instance +- `buffer_limit` (int) -- capacity of the output buffer; irrelevant for + disk-based buffers +- `buffer_fullness` (float) -- current ratio of metrics in the buffer to + capacity; can be greater than one (i.e. `> 100%`) + for disk-based buffers + +If not stated otherwise, all variables are accumulated since the last successful +heartbeat message. + +The following functions are available: + +- `encoding` functions of the [CEL encoder library](https://github.com/google/cel-go/blob/master/ext/README.md#encoders) +- `math` functions of the [CEL math library](https://github.com/google/cel-go/blob/master/ext/README.md#math) +- `string` functions of the [CEL strings library](https://github.com/google/cel-go/blob/master/ext/README.md#strings) +- `now` function for getting the current time + [schema]: /plugins/outputs/heartbeat/schema_v1.json +[internal_plugin]: /plugins/inputs/internal/README.md + +[cel]: https://cel.dev +[cel_encoder]: https://github.com/google/cel-go/blob/master/ext/README.md#encoders +[cel_math]: https://github.com/google/cel-go/blob/master/ext/README.md#math +[cel_strings]: https://github.com/google/cel-go/blob/master/ext/README.md#strings diff --git a/content/telegraf/v1/output-plugins/http/_index.md b/content/telegraf/v1/output-plugins/http/_index.md index 4d5c5d68a..c39dd87b1 100644 --- a/content/telegraf/v1/output-plugins/http/_index.md +++ b/content/telegraf/v1/output-plugins/http/_index.md @@ -10,7 +10,7 @@ introduced: "v1.7.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/http/README.md, HTTP Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/http/README.md, HTTP Plugin Source --- # HTTP Output Plugin @@ -69,6 +69,9 @@ to use them. # max_idle_conn_per_host = 0 # response_timeout = "0s" + ## Use the local address for connecting, assigned by the OS by default + # local_address = "" + ## Optional proxy settings # use_system_proxy = false # http_proxy_url = "" diff --git a/content/telegraf/v1/output-plugins/influxdb/_index.md b/content/telegraf/v1/output-plugins/influxdb/_index.md index 27d66099f..b574679c6 100644 --- a/content/telegraf/v1/output-plugins/influxdb/_index.md +++ b/content/telegraf/v1/output-plugins/influxdb/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/influxdb/README.md, InfluxDB v1.x Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/influxdb/README.md, InfluxDB v1.x Plugin Source --- # InfluxDB v1.x Output Plugin diff --git a/content/telegraf/v1/output-plugins/influxdb_v2/_index.md b/content/telegraf/v1/output-plugins/influxdb_v2/_index.md index be5f1e062..dfbec8759 100644 --- a/content/telegraf/v1/output-plugins/influxdb_v2/_index.md +++ b/content/telegraf/v1/output-plugins/influxdb_v2/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/influxdb_v2/README.md, InfluxDB v2.x Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/influxdb_v2/README.md, InfluxDB v2.x Plugin Source --- # InfluxDB v2.x Output Plugin @@ -42,7 +42,7 @@ more details on how to use them. ## Configuration ```toml @sample.conf -# Configuration for sending metrics to InfluxDB 2.0 +# Configuration for sending metrics to InfluxDB 2.x [[outputs.influxdb_v2]] ## The URLs of the InfluxDB cluster nodes. ## diff --git a/content/telegraf/v1/output-plugins/influxdb_v3/_index.md b/content/telegraf/v1/output-plugins/influxdb_v3/_index.md new file mode 100644 index 000000000..3ba99085d --- /dev/null +++ b/content/telegraf/v1/output-plugins/influxdb_v3/_index.md @@ -0,0 +1,146 @@ +--- +description: "Telegraf plugin for sending metrics to InfluxDB v3.x" +menu: + telegraf_v1_ref: + parent: output_plugins_reference + name: InfluxDB v3.x + identifier: output-influxdb_v3 +tags: [InfluxDB v3.x, "output-plugins", "configuration", "datastore"] +introduced: "v1.38.0" +os_support: "freebsd, linux, macos, solaris, windows" +related: + - /telegraf/v1/configure_plugins/ + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/influxdb_v3/README.md, InfluxDB v3.x Plugin Source +--- + +# InfluxDB v3.x Output Plugin + +This plugin writes metrics to a [InfluxDB v3.x](https://docs.influxdata.com) Core or Enterprise +instance via the HTTP API. + +**Introduced in:** Telegraf v1.38.0 +**Tags:** datastore +**OS support:** all + +[influxdb_v3]: https://docs.influxdata.com + +## Global configuration options + +Plugins support additional global and plugin configuration settings for tasks +such as modifying metrics, tags, and fields, creating aliases, and configuring +plugin ordering. See [CONFIGURATION.md](/telegraf/v1/configuration/#plugins) for more details. + +[CONFIGURATION.md]: ../../../docs/CONFIGURATION.md#plugins + +## Secret-store support + +This plugin supports secrets from secret-stores for the `token` option. +See the [secret-store documentation](/telegraf/v1/configuration/#secret-store-secrets) for more details on how +to use them. + +[SECRETSTORE]: ../../../docs/CONFIGURATION.md#secret-store-secrets + +## Configuration + +```toml @sample.conf +# Configuration for sending metrics to InfluxDB 3.x Core and Enterprise +[[outputs.influxdb_v3]] + ## Multiple URLs can be specified but only ONE of them will be selected + ## randomly in each interval for writing. If endpoints are unavailable another + ## one will be used until all are exhausted or the write succeeds. + urls = ["http://127.0.0.1:8181"] + + ## Token for authentication + token = "" + + ## Destination database to write into + database = "" + + ## The value of this tag will be used to determine the database. If this + ## tag is not set the 'database' option is used as the default. + # database_tag = "" + + ## If true, the database tag will not be added to the metric + # exclude_database_tag = false + + ## Wait for WAL persistence to complete synchronization + ## Setting this to false reduces latency but increases the risk of data loss. + ## See https://docs.influxdata.com/influxdb3/enterprise/write-data/http-api/v3-write-lp/#use-no_sync-for-immediate-write-responses + # sync = true + + ## Enable or disable conversion of unsigned integer fields to signed integers + ## This is useful if existing data exist as signed integers e.g. from previous + ## versions of InfluxDB. + # convert_uint_to_int = false + + ## Omit the timestamp of the metrics when sending to allow InfluxDB to set the + ## timestamp of the data during ingestion. You likely want this to be false + ## to submit the metric timestamp + # omit_timestamp = false + + ## HTTP User-Agent + # user_agent = "telegraf" + + ## Content-Encoding for write request body, available values are "gzip", + ## "none" and "identity" + # content_encoding = "gzip" + + ## Amount of time allowed to complete the HTTP request + # timeout = "5s" + + ## HTTP connection settings + # idle_conn_timeout = "0s" + # max_idle_conn = 0 + # max_idle_conn_per_host = 0 + # response_timeout = "0s" + + ## Use the local address for connecting, assigned by the OS by default + # local_address = "" + + ## Optional proxy settings + # use_system_proxy = false + # http_proxy_url = "" + + ## Optional TLS settings + ## Set to true/false to enforce TLS being enabled/disabled. If not set, + ## enable TLS only if any of the other options are specified. + # tls_enable = + ## Trusted root certificates for server + # tls_ca = "/path/to/cafile" + ## Used for TLS client certificate authentication + # tls_cert = "/path/to/certfile" + ## Used for TLS client certificate authentication + # tls_key = "/path/to/keyfile" + ## Password for the key file if it is encrypted + # tls_key_pwd = "" + ## Send the specified TLS server name via SNI + # tls_server_name = "kubernetes.example.com" + ## Minimal TLS version to accept by the client + # tls_min_version = "TLS12" + ## List of ciphers to accept, by default all secure ciphers will be accepted + ## See https://pkg.go.dev/crypto/tls#pkg-constants for supported values. + ## Use "all", "secure" and "insecure" to add all support ciphers, secure + ## suites or insecure suites respectively. + # tls_cipher_suites = ["secure"] + ## Renegotiation method, "never", "once" or "freely" + # tls_renegotiation_method = "never" + ## Use TLS but skip chain & host verification + # insecure_skip_verify = false + + ## OAuth2 Client Credentials. The options 'client_id', 'client_secret', and 'token_url' are required to use OAuth2. + # client_id = "clientid" + # client_secret = "secret" + # token_url = "https://indentityprovider/oauth2/v1/token" + # audience = "" + # scopes = ["urn:opc:idm:__myscopes__"] + + ## Optional Cookie authentication + # cookie_auth_url = "https://localhost/authMe" + # cookie_auth_method = "POST" + # cookie_auth_username = "username" + # cookie_auth_password = "pa$$word" + # cookie_auth_headers = { Content-Type = "application/json", X-MY-HEADER = "hello" } + # cookie_auth_body = '{"username": "user", "password": "pa$$word", "authenticate": "me"}' + ## cookie_auth_renewal not set or set to "0" will auth once and never renew the cookie + # cookie_auth_renewal = "0s" +``` diff --git a/content/telegraf/v1/output-plugins/inlong/_index.md b/content/telegraf/v1/output-plugins/inlong/_index.md index 139eb9130..1568c504b 100644 --- a/content/telegraf/v1/output-plugins/inlong/_index.md +++ b/content/telegraf/v1/output-plugins/inlong/_index.md @@ -10,7 +10,7 @@ introduced: "v1.35.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/inlong/README.md, Inlong Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/inlong/README.md, Inlong Plugin Source --- # Inlong Output Plugin diff --git a/content/telegraf/v1/output-plugins/instrumental/_index.md b/content/telegraf/v1/output-plugins/instrumental/_index.md index 285ab02c9..ebc6fdb2a 100644 --- a/content/telegraf/v1/output-plugins/instrumental/_index.md +++ b/content/telegraf/v1/output-plugins/instrumental/_index.md @@ -10,7 +10,7 @@ introduced: "v0.13.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/instrumental/README.md, Instrumental Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/instrumental/README.md, Instrumental Plugin Source --- # Instrumental Output Plugin diff --git a/content/telegraf/v1/output-plugins/iotdb/_index.md b/content/telegraf/v1/output-plugins/iotdb/_index.md index e617d99b8..45776967e 100644 --- a/content/telegraf/v1/output-plugins/iotdb/_index.md +++ b/content/telegraf/v1/output-plugins/iotdb/_index.md @@ -10,7 +10,7 @@ introduced: "v1.24.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/iotdb/README.md, Apache IoTDB Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/iotdb/README.md, Apache IoTDB Plugin Source --- # Apache IoTDB Output Plugin diff --git a/content/telegraf/v1/output-plugins/kafka/_index.md b/content/telegraf/v1/output-plugins/kafka/_index.md index 88c5a7974..d04a67847 100644 --- a/content/telegraf/v1/output-plugins/kafka/_index.md +++ b/content/telegraf/v1/output-plugins/kafka/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.7" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/kafka/README.md, Kafka Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/kafka/README.md, Kafka Plugin Source --- # Kafka Output Plugin diff --git a/content/telegraf/v1/output-plugins/kinesis/_index.md b/content/telegraf/v1/output-plugins/kinesis/_index.md index 43f0c87c2..53526180e 100644 --- a/content/telegraf/v1/output-plugins/kinesis/_index.md +++ b/content/telegraf/v1/output-plugins/kinesis/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.5" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/kinesis/README.md, Amazon Kinesis Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/kinesis/README.md, Amazon Kinesis Plugin Source --- # Amazon Kinesis Output Plugin diff --git a/content/telegraf/v1/output-plugins/librato/_index.md b/content/telegraf/v1/output-plugins/librato/_index.md index 5743b3848..a77ad163b 100644 --- a/content/telegraf/v1/output-plugins/librato/_index.md +++ b/content/telegraf/v1/output-plugins/librato/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/librato/README.md, Librato Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/librato/README.md, Librato Plugin Source --- # Librato Output Plugin diff --git a/content/telegraf/v1/output-plugins/logzio/_index.md b/content/telegraf/v1/output-plugins/logzio/_index.md index 66bcc79f8..9f7e4044c 100644 --- a/content/telegraf/v1/output-plugins/logzio/_index.md +++ b/content/telegraf/v1/output-plugins/logzio/_index.md @@ -10,7 +10,7 @@ introduced: "v1.17.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/logzio/README.md, Logz.io Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/logzio/README.md, Logz.io Plugin Source --- # Logz.io Output Plugin diff --git a/content/telegraf/v1/output-plugins/loki/_index.md b/content/telegraf/v1/output-plugins/loki/_index.md index fa99386f7..2d1b16ddb 100644 --- a/content/telegraf/v1/output-plugins/loki/_index.md +++ b/content/telegraf/v1/output-plugins/loki/_index.md @@ -10,7 +10,7 @@ introduced: "v1.18.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/loki/README.md, Grafana Loki Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/loki/README.md, Grafana Loki Plugin Source --- # Grafana Loki Output Plugin diff --git a/content/telegraf/v1/output-plugins/microsoft_fabric/_index.md b/content/telegraf/v1/output-plugins/microsoft_fabric/_index.md index 4607efbda..54a32c47c 100644 --- a/content/telegraf/v1/output-plugins/microsoft_fabric/_index.md +++ b/content/telegraf/v1/output-plugins/microsoft_fabric/_index.md @@ -10,7 +10,7 @@ introduced: "v1.35.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/microsoft_fabric/README.md, Microsoft Fabric Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/microsoft_fabric/README.md, Microsoft Fabric Plugin Source --- # Microsoft Fabric Output Plugin diff --git a/content/telegraf/v1/output-plugins/mongodb/_index.md b/content/telegraf/v1/output-plugins/mongodb/_index.md index 412701a0b..58f485a76 100644 --- a/content/telegraf/v1/output-plugins/mongodb/_index.md +++ b/content/telegraf/v1/output-plugins/mongodb/_index.md @@ -10,7 +10,7 @@ introduced: "v1.21.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/mongodb/README.md, MongoDB Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/mongodb/README.md, MongoDB Plugin Source --- # MongoDB Output Plugin @@ -49,43 +49,47 @@ to use them. ```toml @sample.conf # A plugin that can transmit logs to mongodb [[outputs.mongodb]] - # connection string examples for mongodb + ## Connection string + ## example: dsn = "mongodb://mongod1:27017,mongod2:27017,mongod3:27017/admin&replicaSet=myReplSet&w=1" dsn = "mongodb://localhost:27017" - # dsn = "mongodb://mongod1:27017,mongod2:27017,mongod3:27017/admin&replicaSet=myReplSet&w=1" - # overrides serverSelectionTimeoutMS in dsn if set + ## Overrides serverSelectionTimeoutMS in DSN if set # timeout = "30s" - # default authentication, optional + ## Authentication method, available options are NONE, PLAIN, SCRAM, X509 # authentication = "NONE" - # for SCRAM-SHA-256 authentication - # authentication = "SCRAM" - # username = "root" - # password = "***" + # ## for SCRAM-SHA-256 authentication + # # authentication = "SCRAM" + # # username = "root" + # # password = "***" - ## for PLAIN authentication (e.g., LDAP) - ## IMPORTANT: PLAIN authentication sends credentials in plaintext during the - ## authentication handshake. Always use TLS to encrypt credentials in transit. - # authentication = "PLAIN" - # username = "myuser" - # password = "***" + # ## for PLAIN authentication (e.g., LDAP) + # ## IMPORTANT: PLAIN authentication sends credentials in plaintext during the + # ## authentication handshake. Always use TLS to encrypt credentials in transit. + # # authentication = "PLAIN" + # # username = "myuser" + # # password = "***" - # for x509 certificate authentication - # authentication = "X509" - # tls_ca = "ca.pem" - # tls_key = "client.pem" - # # tls_key_pwd = "changeme" # required for encrypted tls_key - # insecure_skip_verify = false + # ## X509 based certificate authentication + # # authentication = "X509" + # # tls_ca = "ca.pem" + # # tls_key = "client.pem" + # # # tls_key_pwd = "changeme" # required for encrypted tls_key + # # insecure_skip_verify = false - # database to store measurements and time series collections + ## Database to store measurements and time series collections # database = "telegraf" - # granularity can be seconds, minutes, or hours. - # configuring this value will be based on your input collection frequency. - # see https://docs.mongodb.com/manual/core/timeseries-collections/#create-a-time-series-collection + ## Granularity can be seconds, minutes, or hours. + ## Configuring this value will be based on your input collection frequency + ## see https://docs.mongodb.com/manual/core/timeseries-collections/#create-a-time-series-collection # granularity = "seconds" - # optionally set a TTL to automatically expire documents from the measurement collections. + ## TTL to automatically expire documents from the measurement collections. # ttl = "360h" + + ## If true, write multiple metrics for the same collection in a batched + ## fashion. Otherwise, write each metric individually. + # write_batch = false ``` diff --git a/content/telegraf/v1/output-plugins/mqtt/_index.md b/content/telegraf/v1/output-plugins/mqtt/_index.md index 90a55b3a5..66ec6f64e 100644 --- a/content/telegraf/v1/output-plugins/mqtt/_index.md +++ b/content/telegraf/v1/output-plugins/mqtt/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/mqtt/README.md, MQTT Producer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/mqtt/README.md, MQTT Producer Plugin Source --- # MQTT Producer Output Plugin diff --git a/content/telegraf/v1/output-plugins/nats/_index.md b/content/telegraf/v1/output-plugins/nats/_index.md index a58f54476..546b1f3c3 100644 --- a/content/telegraf/v1/output-plugins/nats/_index.md +++ b/content/telegraf/v1/output-plugins/nats/_index.md @@ -10,7 +10,7 @@ introduced: "v1.1.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/nats/README.md, NATS Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/nats/README.md, NATS Plugin Source --- # NATS Output Plugin diff --git a/content/telegraf/v1/output-plugins/nebius_cloud_monitoring/_index.md b/content/telegraf/v1/output-plugins/nebius_cloud_monitoring/_index.md index 8e55aad07..290f93b83 100644 --- a/content/telegraf/v1/output-plugins/nebius_cloud_monitoring/_index.md +++ b/content/telegraf/v1/output-plugins/nebius_cloud_monitoring/_index.md @@ -10,7 +10,7 @@ introduced: "v1.27.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/nebius_cloud_monitoring/README.md, Nebius Cloud Monitoring Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/nebius_cloud_monitoring/README.md, Nebius Cloud Monitoring Plugin Source --- # Nebius Cloud Monitoring Output Plugin diff --git a/content/telegraf/v1/output-plugins/newrelic/_index.md b/content/telegraf/v1/output-plugins/newrelic/_index.md index f0df09e5d..9b35ab3be 100644 --- a/content/telegraf/v1/output-plugins/newrelic/_index.md +++ b/content/telegraf/v1/output-plugins/newrelic/_index.md @@ -10,7 +10,7 @@ introduced: "v1.15.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/newrelic/README.md, New Relic Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/newrelic/README.md, New Relic Plugin Source --- # New Relic Output Plugin diff --git a/content/telegraf/v1/output-plugins/nsq/_index.md b/content/telegraf/v1/output-plugins/nsq/_index.md index 5dbb9bf6e..239fd7fa4 100644 --- a/content/telegraf/v1/output-plugins/nsq/_index.md +++ b/content/telegraf/v1/output-plugins/nsq/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/nsq/README.md, NSQ Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/nsq/README.md, NSQ Plugin Source --- # NSQ Output Plugin diff --git a/content/telegraf/v1/output-plugins/opensearch/_index.md b/content/telegraf/v1/output-plugins/opensearch/_index.md index 273d6c951..eb4415856 100644 --- a/content/telegraf/v1/output-plugins/opensearch/_index.md +++ b/content/telegraf/v1/output-plugins/opensearch/_index.md @@ -10,7 +10,7 @@ introduced: "v1.29.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/opensearch/README.md, OpenSearch Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/opensearch/README.md, OpenSearch Plugin Source --- # OpenSearch Output Plugin diff --git a/content/telegraf/v1/output-plugins/opentelemetry/_index.md b/content/telegraf/v1/output-plugins/opentelemetry/_index.md index 9828b7f89..263057124 100644 --- a/content/telegraf/v1/output-plugins/opentelemetry/_index.md +++ b/content/telegraf/v1/output-plugins/opentelemetry/_index.md @@ -10,13 +10,13 @@ introduced: "v1.20.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/opentelemetry/README.md, OpenTelemetry Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/opentelemetry/README.md, OpenTelemetry Plugin Source --- # OpenTelemetry Output Plugin This plugin writes metrics to [OpenTelemetry](https://opentelemetry.io) servers and agents -via gRPC. +via gRPC or HTTP. **Introduced in:** Telegraf v1.20.0 **Tags:** logging, messaging @@ -38,8 +38,12 @@ plugin ordering. See [CONFIGURATION.md](/telegraf/v1/configuration/#plugins) for # Send OpenTelemetry metrics over gRPC [[outputs.opentelemetry]] ## Override the default (localhost:4317) OpenTelemetry gRPC service - ## address:port + ## When the protocol is grpc, address:port + ## When the protocol is http, http(s)://address:port/path # service_address = "localhost:4317" + ## Override the default (protobuf) encodingType when Protocol is http + ## protobuf, json + # encoding_type = "protobuf" ## Override the default (5s) request timeout # timeout = "5s" diff --git a/content/telegraf/v1/output-plugins/opentsdb/_index.md b/content/telegraf/v1/output-plugins/opentsdb/_index.md index c6ca28884..c4c0803ff 100644 --- a/content/telegraf/v1/output-plugins/opentsdb/_index.md +++ b/content/telegraf/v1/output-plugins/opentsdb/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.9" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/opentsdb/README.md, OpenTSDB Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/opentsdb/README.md, OpenTSDB Plugin Source --- # OpenTSDB Output Plugin diff --git a/content/telegraf/v1/output-plugins/parquet/_index.md b/content/telegraf/v1/output-plugins/parquet/_index.md index 54a93686e..361eb01aa 100644 --- a/content/telegraf/v1/output-plugins/parquet/_index.md +++ b/content/telegraf/v1/output-plugins/parquet/_index.md @@ -10,7 +10,7 @@ introduced: "v1.32.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/parquet/README.md, Parquet Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/parquet/README.md, Parquet Plugin Source --- # Parquet Output Plugin diff --git a/content/telegraf/v1/output-plugins/postgresql/_index.md b/content/telegraf/v1/output-plugins/postgresql/_index.md index e3d0fb8dc..cf227560d 100644 --- a/content/telegraf/v1/output-plugins/postgresql/_index.md +++ b/content/telegraf/v1/output-plugins/postgresql/_index.md @@ -10,7 +10,7 @@ introduced: "v1.24.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/postgresql/README.md, PostgreSQL Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/postgresql/README.md, PostgreSQL Plugin Source --- # PostgreSQL Output Plugin diff --git a/content/telegraf/v1/output-plugins/prometheus_client/_index.md b/content/telegraf/v1/output-plugins/prometheus_client/_index.md index 453807386..f1c6bcdee 100644 --- a/content/telegraf/v1/output-plugins/prometheus_client/_index.md +++ b/content/telegraf/v1/output-plugins/prometheus_client/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/prometheus_client/README.md, Prometheus Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/prometheus_client/README.md, Prometheus Plugin Source --- # Prometheus Output Plugin @@ -84,6 +84,12 @@ to use them. ## Unless set to false all string metrics will be sent as labels. # string_as_label = true + ## Control how metric names and label names are sanitized. + ## The default "legacy" keeps ASCII-only Prometheus name rules. + ## Set to "utf8" to allow UTF-8 metric and label names. + ## Valid options: "legacy", "utf8" + # name_sanitization = "legacy" + ## If set, enable TLS with the given certificate. # tls_cert = "/etc/ssl/telegraf.crt" # tls_key = "/etc/ssl/telegraf.key" diff --git a/content/telegraf/v1/output-plugins/quix/_index.md b/content/telegraf/v1/output-plugins/quix/_index.md index 06b3c9db0..15bfdde24 100644 --- a/content/telegraf/v1/output-plugins/quix/_index.md +++ b/content/telegraf/v1/output-plugins/quix/_index.md @@ -10,7 +10,7 @@ introduced: "v1.33.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/quix/README.md, Quix Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/quix/README.md, Quix Plugin Source --- # Quix Output Plugin diff --git a/content/telegraf/v1/output-plugins/redistimeseries/_index.md b/content/telegraf/v1/output-plugins/redistimeseries/_index.md index b53fdcd48..66b7b1a30 100644 --- a/content/telegraf/v1/output-plugins/redistimeseries/_index.md +++ b/content/telegraf/v1/output-plugins/redistimeseries/_index.md @@ -10,7 +10,7 @@ introduced: "v1.0.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/redistimeseries/README.md, Redis Time Series Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/redistimeseries/README.md, Redis Time Series Plugin Source --- # Redis Time Series Output Plugin @@ -56,6 +56,13 @@ to use them. ## Timeout for operations such as ping or sending metrics # timeout = "10s" + ## Set a time-to-live (TTL) on each Redis key + ## If set, Redis will expire the key after the specified duration + ## The TTL is refreshed on every write, so the key only expires + ## if no new data arrives within the configured period + ## Disabled by default (no expiry) + # expire = "" + ## Enable attempt to convert string fields to numeric values ## If "false" or in case the string value cannot be converted the string ## field will be dropped. diff --git a/content/telegraf/v1/output-plugins/remotefile/_index.md b/content/telegraf/v1/output-plugins/remotefile/_index.md index 6474bc1dd..00c444a6e 100644 --- a/content/telegraf/v1/output-plugins/remotefile/_index.md +++ b/content/telegraf/v1/output-plugins/remotefile/_index.md @@ -10,7 +10,7 @@ introduced: "v1.32.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/remotefile/README.md, Remote File Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/remotefile/README.md, Remote File Plugin Source --- # Remote File Output Plugin diff --git a/content/telegraf/v1/output-plugins/riemann/_index.md b/content/telegraf/v1/output-plugins/riemann/_index.md index 2d1d3e6a4..2a3a3a714 100644 --- a/content/telegraf/v1/output-plugins/riemann/_index.md +++ b/content/telegraf/v1/output-plugins/riemann/_index.md @@ -10,7 +10,7 @@ introduced: "v1.3.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/riemann/README.md, Riemann Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/riemann/README.md, Riemann Plugin Source --- # Riemann Output Plugin diff --git a/content/telegraf/v1/output-plugins/sensu/_index.md b/content/telegraf/v1/output-plugins/sensu/_index.md index 28c9d31bc..8b8168239 100644 --- a/content/telegraf/v1/output-plugins/sensu/_index.md +++ b/content/telegraf/v1/output-plugins/sensu/_index.md @@ -10,7 +10,7 @@ introduced: "v1.18.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/sensu/README.md, Sensu Go Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/sensu/README.md, Sensu Go Plugin Source --- # Sensu Go Output Plugin diff --git a/content/telegraf/v1/output-plugins/signalfx/_index.md b/content/telegraf/v1/output-plugins/signalfx/_index.md index 6bc09f840..4b581611c 100644 --- a/content/telegraf/v1/output-plugins/signalfx/_index.md +++ b/content/telegraf/v1/output-plugins/signalfx/_index.md @@ -10,7 +10,7 @@ introduced: "v1.18.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/signalfx/README.md, SignalFx Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/signalfx/README.md, SignalFx Plugin Source --- # SignalFx Output Plugin diff --git a/content/telegraf/v1/output-plugins/socket_writer/_index.md b/content/telegraf/v1/output-plugins/socket_writer/_index.md index 317126475..ba29532a9 100644 --- a/content/telegraf/v1/output-plugins/socket_writer/_index.md +++ b/content/telegraf/v1/output-plugins/socket_writer/_index.md @@ -10,7 +10,7 @@ introduced: "v1.3.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/socket_writer/README.md, Socket Writer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/socket_writer/README.md, Socket Writer Plugin Source --- # Socket Writer Output Plugin diff --git a/content/telegraf/v1/output-plugins/sql/_index.md b/content/telegraf/v1/output-plugins/sql/_index.md index 5359dbf73..bd7851586 100644 --- a/content/telegraf/v1/output-plugins/sql/_index.md +++ b/content/telegraf/v1/output-plugins/sql/_index.md @@ -10,7 +10,7 @@ introduced: "v1.19.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/sql/README.md, SQL Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/sql/README.md, SQL Plugin Source --- # SQL Output Plugin diff --git a/content/telegraf/v1/output-plugins/stackdriver/_index.md b/content/telegraf/v1/output-plugins/stackdriver/_index.md index 9945f4a36..c3e4c7d5d 100644 --- a/content/telegraf/v1/output-plugins/stackdriver/_index.md +++ b/content/telegraf/v1/output-plugins/stackdriver/_index.md @@ -10,7 +10,7 @@ introduced: "v1.9.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/stackdriver/README.md, Google Cloud Monitoring Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/stackdriver/README.md, Google Cloud Monitoring Plugin Source --- # Google Cloud Monitoring Output Plugin @@ -42,6 +42,14 @@ plugin ordering. See [CONFIGURATION.md](/telegraf/v1/configuration/#plugins) for [CONFIGURATION.md]: ../../../docs/CONFIGURATION.md#plugins +## Secret-store support + +This plugin supports secrets from secret-stores for the `token` option. +See the [secret-store documentation](/telegraf/v1/configuration/#secret-store-secrets) for more details on how +to use them. + +[SECRETSTORE]: ../../../docs/CONFIGURATION.md#secret-store-secrets + ## Configuration ```toml @sample.conf @@ -50,6 +58,9 @@ plugin ordering. See [CONFIGURATION.md](/telegraf/v1/configuration/#plugins) for ## GCP Project project = "erudite-bloom-151019" + ## GCP access token for authorizing calls to Cloud Monitoring APIs + # token = "@{gcp_auth:token}" + ## Quota Project ## Specifies the Google Cloud project that should be billed for metric ingestion. ## If omitted, the quota is charged to the service account’s default project. diff --git a/content/telegraf/v1/output-plugins/stomp/_index.md b/content/telegraf/v1/output-plugins/stomp/_index.md index 9f1b5bffa..6a7bcdd35 100644 --- a/content/telegraf/v1/output-plugins/stomp/_index.md +++ b/content/telegraf/v1/output-plugins/stomp/_index.md @@ -10,7 +10,7 @@ introduced: "v1.24.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/stomp/README.md, ActiveMQ STOMP Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/stomp/README.md, ActiveMQ STOMP Plugin Source --- # ActiveMQ STOMP Output Plugin diff --git a/content/telegraf/v1/output-plugins/sumologic/_index.md b/content/telegraf/v1/output-plugins/sumologic/_index.md index 9535aa1d7..83b4434e4 100644 --- a/content/telegraf/v1/output-plugins/sumologic/_index.md +++ b/content/telegraf/v1/output-plugins/sumologic/_index.md @@ -10,7 +10,7 @@ introduced: "v1.16.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/sumologic/README.md, Sumo Logic Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/sumologic/README.md, Sumo Logic Plugin Source --- # Sumo Logic Output Plugin diff --git a/content/telegraf/v1/output-plugins/syslog/_index.md b/content/telegraf/v1/output-plugins/syslog/_index.md index d67879247..7d748fcb4 100644 --- a/content/telegraf/v1/output-plugins/syslog/_index.md +++ b/content/telegraf/v1/output-plugins/syslog/_index.md @@ -10,7 +10,7 @@ introduced: "v1.11.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/syslog/README.md, Syslog Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/syslog/README.md, Syslog Plugin Source --- # Syslog Output Plugin diff --git a/content/telegraf/v1/output-plugins/timestream/_index.md b/content/telegraf/v1/output-plugins/timestream/_index.md index 76a739153..845caaa8c 100644 --- a/content/telegraf/v1/output-plugins/timestream/_index.md +++ b/content/telegraf/v1/output-plugins/timestream/_index.md @@ -10,7 +10,7 @@ introduced: "v1.16.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/timestream/README.md, Amazon Timestream Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/timestream/README.md, Amazon Timestream Plugin Source --- # Amazon Timestream Output Plugin diff --git a/content/telegraf/v1/output-plugins/warp10/_index.md b/content/telegraf/v1/output-plugins/warp10/_index.md index 9abc0635c..11eafbe5e 100644 --- a/content/telegraf/v1/output-plugins/warp10/_index.md +++ b/content/telegraf/v1/output-plugins/warp10/_index.md @@ -10,7 +10,7 @@ introduced: "v1.14.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/warp10/README.md, Warp10 Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/warp10/README.md, Warp10 Plugin Source --- # Warp10 Output Plugin diff --git a/content/telegraf/v1/output-plugins/wavefront/_index.md b/content/telegraf/v1/output-plugins/wavefront/_index.md index 5354bbc07..bb1632b05 100644 --- a/content/telegraf/v1/output-plugins/wavefront/_index.md +++ b/content/telegraf/v1/output-plugins/wavefront/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/wavefront/README.md, Wavefront Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/wavefront/README.md, Wavefront Plugin Source --- # Wavefront Output Plugin diff --git a/content/telegraf/v1/output-plugins/websocket/_index.md b/content/telegraf/v1/output-plugins/websocket/_index.md index 2cf7d56e7..f39c5a93a 100644 --- a/content/telegraf/v1/output-plugins/websocket/_index.md +++ b/content/telegraf/v1/output-plugins/websocket/_index.md @@ -10,7 +10,7 @@ introduced: "v1.19.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/websocket/README.md, Websocket Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/websocket/README.md, Websocket Plugin Source --- # Websocket Output Plugin diff --git a/content/telegraf/v1/output-plugins/yandex_cloud_monitoring/_index.md b/content/telegraf/v1/output-plugins/yandex_cloud_monitoring/_index.md index 32e86d1d9..26bf629ed 100644 --- a/content/telegraf/v1/output-plugins/yandex_cloud_monitoring/_index.md +++ b/content/telegraf/v1/output-plugins/yandex_cloud_monitoring/_index.md @@ -10,7 +10,7 @@ introduced: "v1.17.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/yandex_cloud_monitoring/README.md, Yandex Cloud Monitoring Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/yandex_cloud_monitoring/README.md, Yandex Cloud Monitoring Plugin Source --- # Yandex Cloud Monitoring Output Plugin diff --git a/content/telegraf/v1/output-plugins/zabbix/_index.md b/content/telegraf/v1/output-plugins/zabbix/_index.md index b1cbac242..5bc8888fe 100644 --- a/content/telegraf/v1/output-plugins/zabbix/_index.md +++ b/content/telegraf/v1/output-plugins/zabbix/_index.md @@ -10,7 +10,7 @@ introduced: "v1.30.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/outputs/zabbix/README.md, Zabbix Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/zabbix/README.md, Zabbix Plugin Source --- # Zabbix Output Plugin diff --git a/content/telegraf/v1/processor-plugins/aws_ec2/_index.md b/content/telegraf/v1/processor-plugins/aws_ec2/_index.md index 002487e2a..ca824176e 100644 --- a/content/telegraf/v1/processor-plugins/aws_ec2/_index.md +++ b/content/telegraf/v1/processor-plugins/aws_ec2/_index.md @@ -10,7 +10,7 @@ introduced: "v1.18.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/aws_ec2/README.md, AWS EC2 Metadata Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/aws_ec2/README.md, AWS EC2 Metadata Plugin Source --- # AWS EC2 Metadata Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/batch/_index.md b/content/telegraf/v1/processor-plugins/batch/_index.md index 73ff3f788..3f8d0392f 100644 --- a/content/telegraf/v1/processor-plugins/batch/_index.md +++ b/content/telegraf/v1/processor-plugins/batch/_index.md @@ -10,7 +10,7 @@ introduced: "v1.33.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/batch/README.md, Batch Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/batch/README.md, Batch Plugin Source --- # Batch Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/clone/_index.md b/content/telegraf/v1/processor-plugins/clone/_index.md index 32519a7e2..a3f1bed7b 100644 --- a/content/telegraf/v1/processor-plugins/clone/_index.md +++ b/content/telegraf/v1/processor-plugins/clone/_index.md @@ -10,7 +10,7 @@ introduced: "v1.13.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/clone/README.md, Clone Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/clone/README.md, Clone Plugin Source --- # Clone Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/converter/_index.md b/content/telegraf/v1/processor-plugins/converter/_index.md index 70a2f831d..cd5dc402a 100644 --- a/content/telegraf/v1/processor-plugins/converter/_index.md +++ b/content/telegraf/v1/processor-plugins/converter/_index.md @@ -10,7 +10,7 @@ introduced: "v1.7.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/converter/README.md, Converter Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/converter/README.md, Converter Plugin Source --- # Converter Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/cumulative_sum/_index.md b/content/telegraf/v1/processor-plugins/cumulative_sum/_index.md index b00022072..09807da97 100644 --- a/content/telegraf/v1/processor-plugins/cumulative_sum/_index.md +++ b/content/telegraf/v1/processor-plugins/cumulative_sum/_index.md @@ -10,7 +10,7 @@ introduced: "v1.35.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/cumulative_sum/README.md, Cumulative Sum Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/cumulative_sum/README.md, Cumulative Sum Plugin Source --- # Cumulative Sum Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/date/_index.md b/content/telegraf/v1/processor-plugins/date/_index.md index 6aae7d255..2ce955e9e 100644 --- a/content/telegraf/v1/processor-plugins/date/_index.md +++ b/content/telegraf/v1/processor-plugins/date/_index.md @@ -10,7 +10,7 @@ introduced: "v1.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/date/README.md, Date Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/date/README.md, Date Plugin Source --- # Date Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/dedup/_index.md b/content/telegraf/v1/processor-plugins/dedup/_index.md index 93de9b711..9691aba84 100644 --- a/content/telegraf/v1/processor-plugins/dedup/_index.md +++ b/content/telegraf/v1/processor-plugins/dedup/_index.md @@ -10,7 +10,7 @@ introduced: "v1.14.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/dedup/README.md, Dedup Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/dedup/README.md, Dedup Plugin Source --- # Dedup Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/defaults/_index.md b/content/telegraf/v1/processor-plugins/defaults/_index.md index 1547879b2..d4ebb1c82 100644 --- a/content/telegraf/v1/processor-plugins/defaults/_index.md +++ b/content/telegraf/v1/processor-plugins/defaults/_index.md @@ -10,7 +10,7 @@ introduced: "v1.15.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/defaults/README.md, Defaults Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/defaults/README.md, Defaults Plugin Source --- # Defaults Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/enum/_index.md b/content/telegraf/v1/processor-plugins/enum/_index.md index 1bdababff..d180f7105 100644 --- a/content/telegraf/v1/processor-plugins/enum/_index.md +++ b/content/telegraf/v1/processor-plugins/enum/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/enum/README.md, Enum Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/enum/README.md, Enum Plugin Source --- # Enum Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/execd/_index.md b/content/telegraf/v1/processor-plugins/execd/_index.md index 20eadfdfc..2270dbb3f 100644 --- a/content/telegraf/v1/processor-plugins/execd/_index.md +++ b/content/telegraf/v1/processor-plugins/execd/_index.md @@ -10,7 +10,7 @@ introduced: "v1.15.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/execd/README.md, Execd Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/execd/README.md, Execd Plugin Source --- # Execd Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/filepath/_index.md b/content/telegraf/v1/processor-plugins/filepath/_index.md index f210ae661..f31d1ff25 100644 --- a/content/telegraf/v1/processor-plugins/filepath/_index.md +++ b/content/telegraf/v1/processor-plugins/filepath/_index.md @@ -10,7 +10,7 @@ introduced: "v1.15.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/filepath/README.md, Filepath Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/filepath/README.md, Filepath Plugin Source --- # Filepath Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/filter/_index.md b/content/telegraf/v1/processor-plugins/filter/_index.md index f49fca7ce..fb8dbfdbd 100644 --- a/content/telegraf/v1/processor-plugins/filter/_index.md +++ b/content/telegraf/v1/processor-plugins/filter/_index.md @@ -10,7 +10,7 @@ introduced: "v1.29.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/filter/README.md, Filter Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/filter/README.md, Filter Plugin Source --- # Filter Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/ifname/_index.md b/content/telegraf/v1/processor-plugins/ifname/_index.md index 09ae56720..feb994de5 100644 --- a/content/telegraf/v1/processor-plugins/ifname/_index.md +++ b/content/telegraf/v1/processor-plugins/ifname/_index.md @@ -10,7 +10,7 @@ introduced: "v1.15.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/ifname/README.md, Network Interface Name Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/ifname/README.md, Network Interface Name Plugin Source --- # Network Interface Name Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/lookup/_index.md b/content/telegraf/v1/processor-plugins/lookup/_index.md index 61615c084..271ab8484 100644 --- a/content/telegraf/v1/processor-plugins/lookup/_index.md +++ b/content/telegraf/v1/processor-plugins/lookup/_index.md @@ -10,7 +10,7 @@ introduced: "v1.15.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/lookup/README.md, Lookup Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/lookup/README.md, Lookup Plugin Source --- # Lookup Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/noise/_index.md b/content/telegraf/v1/processor-plugins/noise/_index.md index 327940fda..6a451438f 100644 --- a/content/telegraf/v1/processor-plugins/noise/_index.md +++ b/content/telegraf/v1/processor-plugins/noise/_index.md @@ -10,7 +10,7 @@ introduced: "v1.22.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/noise/README.md, Noise Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/noise/README.md, Noise Plugin Source --- # Noise Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/override/_index.md b/content/telegraf/v1/processor-plugins/override/_index.md index 8dd104865..42ee0f52d 100644 --- a/content/telegraf/v1/processor-plugins/override/_index.md +++ b/content/telegraf/v1/processor-plugins/override/_index.md @@ -10,7 +10,7 @@ introduced: "v1.6.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/override/README.md, Override Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/override/README.md, Override Plugin Source --- # Override Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/parser/_index.md b/content/telegraf/v1/processor-plugins/parser/_index.md index f4afb64ee..5dca40d7d 100644 --- a/content/telegraf/v1/processor-plugins/parser/_index.md +++ b/content/telegraf/v1/processor-plugins/parser/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/parser/README.md, Parser Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/parser/README.md, Parser Plugin Source --- # Parser Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/pivot/_index.md b/content/telegraf/v1/processor-plugins/pivot/_index.md index 8e4855d9e..6e6e4f65f 100644 --- a/content/telegraf/v1/processor-plugins/pivot/_index.md +++ b/content/telegraf/v1/processor-plugins/pivot/_index.md @@ -10,7 +10,7 @@ introduced: "v1.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/pivot/README.md, Pivot Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/pivot/README.md, Pivot Plugin Source --- # Pivot Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/port_name/_index.md b/content/telegraf/v1/processor-plugins/port_name/_index.md index f74cf9677..3e6244797 100644 --- a/content/telegraf/v1/processor-plugins/port_name/_index.md +++ b/content/telegraf/v1/processor-plugins/port_name/_index.md @@ -10,7 +10,7 @@ introduced: "v1.15.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/port_name/README.md, Port Name Lookup Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/port_name/README.md, Port Name Lookup Plugin Source --- # Port Name Lookup Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/printer/_index.md b/content/telegraf/v1/processor-plugins/printer/_index.md index f42278c06..5cda8275f 100644 --- a/content/telegraf/v1/processor-plugins/printer/_index.md +++ b/content/telegraf/v1/processor-plugins/printer/_index.md @@ -10,7 +10,7 @@ introduced: "v1.1.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/printer/README.md, Printer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/printer/README.md, Printer Plugin Source --- # Printer Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/regex/_index.md b/content/telegraf/v1/processor-plugins/regex/_index.md index ad91a5703..f2d13c045 100644 --- a/content/telegraf/v1/processor-plugins/regex/_index.md +++ b/content/telegraf/v1/processor-plugins/regex/_index.md @@ -10,7 +10,7 @@ introduced: "v1.7.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/regex/README.md, Regex Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/regex/README.md, Regex Plugin Source --- # Regex Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/rename/_index.md b/content/telegraf/v1/processor-plugins/rename/_index.md index b479855cb..b0becb81b 100644 --- a/content/telegraf/v1/processor-plugins/rename/_index.md +++ b/content/telegraf/v1/processor-plugins/rename/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/rename/README.md, Rename Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/rename/README.md, Rename Plugin Source --- # Rename Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/reverse_dns/_index.md b/content/telegraf/v1/processor-plugins/reverse_dns/_index.md index 0c10608c4..6130a66d2 100644 --- a/content/telegraf/v1/processor-plugins/reverse_dns/_index.md +++ b/content/telegraf/v1/processor-plugins/reverse_dns/_index.md @@ -10,7 +10,7 @@ introduced: "v1.15.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/reverse_dns/README.md, Reverse DNS Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/reverse_dns/README.md, Reverse DNS Plugin Source --- # Reverse DNS Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/round/_index.md b/content/telegraf/v1/processor-plugins/round/_index.md index 1f8ef2287..24a97f4b8 100644 --- a/content/telegraf/v1/processor-plugins/round/_index.md +++ b/content/telegraf/v1/processor-plugins/round/_index.md @@ -10,7 +10,7 @@ introduced: "v1.36.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/round/README.md, Round Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/round/README.md, Round Plugin Source --- # Round Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/s2geo/_index.md b/content/telegraf/v1/processor-plugins/s2geo/_index.md index 0acfdb7f8..7b4d50bd6 100644 --- a/content/telegraf/v1/processor-plugins/s2geo/_index.md +++ b/content/telegraf/v1/processor-plugins/s2geo/_index.md @@ -10,7 +10,7 @@ introduced: "v1.14.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/s2geo/README.md, S2 Geo Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/s2geo/README.md, S2 Geo Plugin Source --- # S2 Geo Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/scale/_index.md b/content/telegraf/v1/processor-plugins/scale/_index.md index 18fb212f5..8b47950c4 100644 --- a/content/telegraf/v1/processor-plugins/scale/_index.md +++ b/content/telegraf/v1/processor-plugins/scale/_index.md @@ -10,7 +10,7 @@ introduced: "v1.27.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/scale/README.md, Scale Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/scale/README.md, Scale Plugin Source --- # Scale Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/snmp_lookup/_index.md b/content/telegraf/v1/processor-plugins/snmp_lookup/_index.md index 8f67100fb..b32a1e3ac 100644 --- a/content/telegraf/v1/processor-plugins/snmp_lookup/_index.md +++ b/content/telegraf/v1/processor-plugins/snmp_lookup/_index.md @@ -10,7 +10,7 @@ introduced: "v1.30.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/snmp_lookup/README.md, SNMP Lookup Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/snmp_lookup/README.md, SNMP Lookup Plugin Source --- # SNMP Lookup Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/split/_index.md b/content/telegraf/v1/processor-plugins/split/_index.md index 7cde5f967..2407f23a9 100644 --- a/content/telegraf/v1/processor-plugins/split/_index.md +++ b/content/telegraf/v1/processor-plugins/split/_index.md @@ -10,7 +10,7 @@ introduced: "v1.28.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/split/README.md, Split Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/split/README.md, Split Plugin Source --- # Split Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/starlark/_index.md b/content/telegraf/v1/processor-plugins/starlark/_index.md index 6bfade8f8..3647123ca 100644 --- a/content/telegraf/v1/processor-plugins/starlark/_index.md +++ b/content/telegraf/v1/processor-plugins/starlark/_index.md @@ -10,7 +10,7 @@ introduced: "v1.15.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/starlark/README.md, Starlark Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/starlark/README.md, Starlark Plugin Source --- # Starlark Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/strings/_index.md b/content/telegraf/v1/processor-plugins/strings/_index.md index 45ce80ad7..b5b59e9c8 100644 --- a/content/telegraf/v1/processor-plugins/strings/_index.md +++ b/content/telegraf/v1/processor-plugins/strings/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/strings/README.md, Strings Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/strings/README.md, Strings Plugin Source --- # Strings Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/tag_limit/_index.md b/content/telegraf/v1/processor-plugins/tag_limit/_index.md index 1b5c76f2b..cb1773c46 100644 --- a/content/telegraf/v1/processor-plugins/tag_limit/_index.md +++ b/content/telegraf/v1/processor-plugins/tag_limit/_index.md @@ -10,7 +10,7 @@ introduced: "v1.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/tag_limit/README.md, Tag Limit Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/tag_limit/README.md, Tag Limit Plugin Source --- # Tag Limit Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/template/_index.md b/content/telegraf/v1/processor-plugins/template/_index.md index 27bc28d99..2fe864e7c 100644 --- a/content/telegraf/v1/processor-plugins/template/_index.md +++ b/content/telegraf/v1/processor-plugins/template/_index.md @@ -10,7 +10,7 @@ introduced: "v1.14.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/template/README.md, Template Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/template/README.md, Template Plugin Source --- # Template Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/timestamp/_index.md b/content/telegraf/v1/processor-plugins/timestamp/_index.md index e0fe60723..ef3a1b872 100644 --- a/content/telegraf/v1/processor-plugins/timestamp/_index.md +++ b/content/telegraf/v1/processor-plugins/timestamp/_index.md @@ -10,7 +10,7 @@ introduced: "v1.31.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/timestamp/README.md, Timestamp Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/timestamp/README.md, Timestamp Plugin Source --- # Timestamp Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/topk/_index.md b/content/telegraf/v1/processor-plugins/topk/_index.md index 8b2a003bf..14a1d3290 100644 --- a/content/telegraf/v1/processor-plugins/topk/_index.md +++ b/content/telegraf/v1/processor-plugins/topk/_index.md @@ -10,7 +10,7 @@ introduced: "v1.7.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/topk/README.md, TopK Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/topk/README.md, TopK Plugin Source --- # TopK Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/unpivot/_index.md b/content/telegraf/v1/processor-plugins/unpivot/_index.md index a09c12d28..a56eab141 100644 --- a/content/telegraf/v1/processor-plugins/unpivot/_index.md +++ b/content/telegraf/v1/processor-plugins/unpivot/_index.md @@ -10,7 +10,7 @@ introduced: "v1.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.37.3/plugins/processors/unpivot/README.md, Unpivot Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/unpivot/README.md, Unpivot Plugin Source --- # Unpivot Processor Plugin diff --git a/content/telegraf/v1/release-notes.md b/content/telegraf/v1/release-notes.md index 96094f5e1..f5ae49a89 100644 --- a/content/telegraf/v1/release-notes.md +++ b/content/telegraf/v1/release-notes.md @@ -11,6 +11,81 @@ menu: weight: 60 --- +## v1.38.0 {date="2026-03-09"} + +### Important Changes + +- PR [#17961](https://github.com/influxdata/telegraf/pull/17961) makes the + **strict environment variable handling the default**! In case you need the old + behavior you can opt-out using the `--non-strict-env-handling` flag. + +### New Plugins + +- [#18183](https://github.com/influxdata/telegraf/pull/18183) `inputs.sip` Add plugin +- [#18223](https://github.com/influxdata/telegraf/pull/18223) `outputs.influxdb_v3` Add plugin + +### Features + +- [#18086](https://github.com/influxdata/telegraf/pull/18086) `agent` Optimise disk buffer strategy +- [#18232](https://github.com/influxdata/telegraf/pull/18232) `common.opcua` Add string configuration option for node ID +- [#18411](https://github.com/influxdata/telegraf/pull/18411) `common.opcua` Add support for datetime arrays +- [#18181](https://github.com/influxdata/telegraf/pull/18181) `inputs.docker` Implement startup error behavior options +- [#18425](https://github.com/influxdata/telegraf/pull/18425) `inputs.gnmi` Allow to emit delete metrics +- [#18466](https://github.com/influxdata/telegraf/pull/18466) `inputs.mqtt_consumer` Add option for maximum reconnect interval +- [#18063](https://github.com/influxdata/telegraf/pull/18063) `inputs.mysql` Add replication latency fields +- [#18117](https://github.com/influxdata/telegraf/pull/18117) `inputs.mysql` Add wsrep provider options fields +- [#18272](https://github.com/influxdata/telegraf/pull/18272) `inputs.mysql` Support encryption algorithm statistics if present +- [#18134](https://github.com/influxdata/telegraf/pull/18134) `inputs.nftables` Monitor set element counts +- [#18246](https://github.com/influxdata/telegraf/pull/18246) `inputs.nftables` Support named counters +- [#18259](https://github.com/influxdata/telegraf/pull/18259) `inputs.statsd` Add support for Datadog service checks +- [#18393](https://github.com/influxdata/telegraf/pull/18393) `outputs.health` Add option for setting default status +- [#18415](https://github.com/influxdata/telegraf/pull/18415) `outputs.heartbeat` Add logging information +- [#17577](https://github.com/influxdata/telegraf/pull/17577) `outputs.heartbeat` Add status evaluation +- [#18305](https://github.com/influxdata/telegraf/pull/18305) `outputs.influxdb_v2` Add trace logging for write request timing +- [#18422](https://github.com/influxdata/telegraf/pull/18422) `outputs.mongodb` Allow writing metrics in batches +- [#17997](https://github.com/influxdata/telegraf/pull/17997) `outputs.opentelemetry` Support http protocol +- [#18337](https://github.com/influxdata/telegraf/pull/18337) `outputs.redistimeseries` Add option to expire values +- [#18339](https://github.com/influxdata/telegraf/pull/18339) `outputs.stackdriver` Add credentials file support for stackdriver output plugin +- [#18341](https://github.com/influxdata/telegraf/pull/18341) `prometheus` Add UTF-8 metric and label name sanitization + +### Bugfixes + +- [#18429](https://github.com/influxdata/telegraf/pull/18429) `common.opcua` Use configured timestamp format for datetime arrays +- [#18381](https://github.com/influxdata/telegraf/pull/18381) `inputs.fibaro` Handle numeric value2 field from HC3 devices +- [#18424](https://github.com/influxdata/telegraf/pull/18424) `inputs.http` Close gzip request body on early failures +- [#18412](https://github.com/influxdata/telegraf/pull/18412) `inputs.internet_speed` Fix server_id_include filter logic +- [#18452](https://github.com/influxdata/telegraf/pull/18452) `inputs.mqtt_consumer` Rely on paho auto-reconnect to restore message flow after network disruption +- [#18392](https://github.com/influxdata/telegraf/pull/18392) `inputs.opcua_listener` Prevent panic on events with empty fields +- [#18387](https://github.com/influxdata/telegraf/pull/18387) `inputs.smart` Include NVMe SMART data in smart_device measurement +- [#18416](https://github.com/influxdata/telegraf/pull/18416) `outputs.influxdb` Prevent goroutine leak on gzip write failure +- [#18418](https://github.com/influxdata/telegraf/pull/18418) `outputs.opentelemetry` Prevent goroutine leak on gzip write failure + +### Dependency Updates + +- [#18436](https://github.com/influxdata/telegraf/pull/18436) `deps` Bump cloud.google.com/go/bigquery from 1.73.1 to 1.74.0 +- [#18444](https://github.com/influxdata/telegraf/pull/18444) `deps` Bump github.com/IBM/sarama from 1.46.3 to 1.47.0 +- [#18449](https://github.com/influxdata/telegraf/pull/18449) `deps` Bump github.com/SAP/go-hdb from 1.15.0 to 1.15.1 +- [#18398](https://github.com/influxdata/telegraf/pull/18398) `deps` Bump github.com/antchfx/xpath from 1.3.5 to 1.3.6 +- [#18442](https://github.com/influxdata/telegraf/pull/18442) `deps` Bump github.com/aws/smithy-go from 1.24.1 to 1.24.2 +- [#18400](https://github.com/influxdata/telegraf/pull/18400) `deps` Bump github.com/hashicorp/consul/api from 1.33.2 to 1.33.3 +- [#18438](https://github.com/influxdata/telegraf/pull/18438) `deps` Bump github.com/hashicorp/consul/api from 1.33.3 to 1.33.4 +- [#18446](https://github.com/influxdata/telegraf/pull/18446) `deps` Bump github.com/lxc/incus/v6 from 6.21.0 to 6.22.0 +- [#18441](https://github.com/influxdata/telegraf/pull/18441) `deps` Bump github.com/microsoft/go-mssqldb from 1.9.6 to 1.9.8 +- [#18404](https://github.com/influxdata/telegraf/pull/18404) `deps` Bump github.com/nats-io/nats.go from 1.48.0 to 1.49.0 +- [#18439](https://github.com/influxdata/telegraf/pull/18439) `deps` Bump github.com/prometheus/procfs from 0.19.2 to 0.20.1 +- [#18440](https://github.com/influxdata/telegraf/pull/18440) `deps` Bump github.com/shirou/gopsutil/v4 from 4.26.1 to 4.26.2 +- [#18402](https://github.com/influxdata/telegraf/pull/18402) `deps` Bump github.com/vmware/govmomi from 0.52.0 to 0.53.0 +- [#18399](https://github.com/influxdata/telegraf/pull/18399) `deps` Bump go.step.sm/crypto from 0.76.0 to 0.76.2 +- [#18450](https://github.com/influxdata/telegraf/pull/18450) `deps` Bump golang.org/x/net from 0.50.0 to 0.51.0 +- [#18437](https://github.com/influxdata/telegraf/pull/18437) `deps` Bump google.golang.org/api from 0.266.0 to 0.269.0 +- [#18448](https://github.com/influxdata/telegraf/pull/18448) `deps` Bump k8s.io/api from 0.35.1 to 0.35.2 +- [#18447](https://github.com/influxdata/telegraf/pull/18447) `deps` Bump k8s.io/apimachinery from 0.35.1 to 0.35.2 +- [#18443](https://github.com/influxdata/telegraf/pull/18443) `deps` Bump k8s.io/client-go from 0.35.1 to 0.35.2 +- [#18403](https://github.com/influxdata/telegraf/pull/18403) `deps` Bump modernc.org/sqlite from 1.45.0 to 1.46.1 +- [#18397](https://github.com/influxdata/telegraf/pull/18397) `deps` Bump the aws-sdk-go-v2 group with 11 updates +- [#18435](https://github.com/influxdata/telegraf/pull/18435) `deps` Bump the aws-sdk-go-v2 group with 2 updates +- [#18396](https://github.com/influxdata/telegraf/pull/18396) `deps` Bump tj-actions/changed-files from 47.0.2 to 47.0.4 + ## v1.37.3 {date="2026-02-23"} ### Bugfixes diff --git a/data/products.yml b/data/products.yml index 90d37e054..1662a618f 100644 --- a/data/products.yml +++ b/data/products.yml @@ -287,9 +287,9 @@ telegraf: menu_category: other list_order: 6 versions: [v1] - latest: v1.37 + latest: v1.38 latest_patches: - v1: 1.37.3 + v1: 1.38.0 ai_sample_questions: - How do I configure Telegraf for InfluxDB 3? - How do I write a custom Telegraf plugin? diff --git a/data/telegraf_plugins.yml b/data/telegraf_plugins.yml index 8fe1b7ab6..7498cfc93 100644 --- a/data/telegraf_plugins.yml +++ b/data/telegraf_plugins.yml @@ -1740,11 +1740,7 @@ input: description: | This plugin gathers packets and bytes counters for rules within Linux's [nftables](https://wiki.nftables.org/wiki-nftables/index.php/Main_Page) - firewall. - - > [!IMPORTANT] - > Rules are identified by the associated comment so those **comments have - > to be unique**! Rules without comment are ignored. + firewall, as well as set element counts. introduced: v1.37.0 os_support: [linux] tags: [network, system] @@ -2369,6 +2365,18 @@ input: introduced: v1.14.0 os_support: [freebsd, linux, macos, solaris, windows] tags: [network] + - name: SIP + id: sip + description: | + This plugin gathers metrics about the health and availability of [SIP + (Session Initiation + Protocol)](https://datatracker.ietf.org/doc/html/rfc3261) servers such as + PBX systems, SIP proxies, registrars, and VoIP service providers. It + sends SIP requests (typically OPTIONS) and measures response times and + status codes. + introduced: v1.38.0 + os_support: [freebsd, linux, macos, solaris, windows] + tags: [network] - name: Slab id: slab description: | @@ -3303,6 +3311,15 @@ output: introduced: v1.8.0 os_support: [freebsd, linux, macos, solaris, windows] tags: [datastore] + - name: InfluxDB v3.x + id: influxdb_v3 + description: | + This plugin writes metrics to a [InfluxDB + v3.x](https://docs.influxdata.com) Core or Enterprise instance via the + HTTP API. + introduced: v1.38.0 + os_support: [freebsd, linux, macos, solaris, windows] + tags: [datastore] - name: Inlong id: inlong description: | @@ -3494,7 +3511,7 @@ output: id: opentelemetry description: | This plugin writes metrics to [OpenTelemetry](https://opentelemetry.io) - servers and agents via gRPC. + servers and agents via gRPC or HTTP. introduced: v1.20.0 os_support: [freebsd, linux, macos, solaris, windows] tags: [logging, messaging] From 731179fc838a0c79a073f84c9dbd299496fe5b4a Mon Sep 17 00:00:00 2001 From: peterbarnett03 Date: Tue, 10 Mar 2026 12:46:46 -0400 Subject: [PATCH 08/27] chore: update release notes to 3.8.4 (#6915) * chore: update to 3.8.4 * chore: lint * Apply suggestions from code review * Update content/shared/v3-core-enterprise-release-notes/_index.md --------- Co-authored-by: Jason Stirnaman --- .../_index.md | 25 +++++++++++++++++-- data/products.yml | 2 +- 2 files changed, 24 insertions(+), 3 deletions(-) diff --git a/content/shared/v3-core-enterprise-release-notes/_index.md b/content/shared/v3-core-enterprise-release-notes/_index.md index 07503f63c..2530ed0cd 100644 --- a/content/shared/v3-core-enterprise-release-notes/_index.md +++ b/content/shared/v3-core-enterprise-release-notes/_index.md @@ -6,6 +6,27 @@ > All updates to Core are automatically included in Enterprise. > The Enterprise sections below only list updates exclusive to Enterprise. +## v3.8.4 {date="2026-03-10"} + +### Core + +No adjustments in this release. +Core remains on v3.8.3. + +### Enterprise + +#### Security + +- **Read and write tokens can no longer delete databases**: Authorization now evaluates both the HTTP method and the request path. Previously, tokens with read or write access to a database could also issue delete requests. + +#### Bug fixes + +- **Stale compactor blocking startup**: Fixed an issue where stopped (stale) compactor entries in the catalog prevented new compactor nodes from starting. Enterprise now only considers currently running compactor nodes for conflict checks. + +- **WAL replay**: Fixed an issue where combined-mode deployments silently ignored the `--wal-replay-concurrency-limit` flag and always used serial replay (concurrency of 1). The flag is now respected. + +- Other bug fixes and performance improvements. + ## v3.8.3 {date="2026-02-24"} ### Core @@ -428,9 +449,9 @@ All Core updates are included in Enterprise. Additional Enterprise-specific feat ## v3.1.0 {date="2025-05-29"} -**Core**: revision 482dd8aac580c04f37e8713a8fffae89ae8bc264 +**Core**: revision `482dd8aac580c04f37e8713a8fffae89ae8bc264` -**Enterprise**: revision 2cb23cf32b67f9f0d0803e31b356813a1a151b00 +**Enterprise**: revision `2cb23cf32b67f9f0d0803e31b356813a1a151b00` ### Core diff --git a/data/products.yml b/data/products.yml index 1662a618f..9693cb96d 100644 --- a/data/products.yml +++ b/data/products.yml @@ -46,7 +46,7 @@ influxdb3_enterprise: versions: [enterprise] list_order: 2 latest: enterprise - latest_patch: 3.8.3 + latest_patch: 3.8.4 placeholder_host: localhost:8181 limits: database: 100 From 478a0ff6fc41ca8fd8ed65da434c46e13371368a Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Tue, 10 Mar 2026 11:55:14 -0500 Subject: [PATCH 09/27] Harden PR preview workflow against transient deploy/comment failures (#6919) * Initial plan * chore: add preview deployment validation Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> Co-authored-by: Jason Stirnaman --- .github/workflows/pr-preview.yml | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/.github/workflows/pr-preview.yml b/.github/workflows/pr-preview.yml index 18c8ca378..85aaf11d1 100644 --- a/.github/workflows/pr-preview.yml +++ b/.github/workflows/pr-preview.yml @@ -139,6 +139,8 @@ jobs: - name: Deploy preview if: steps.detect.outputs.pages-to-deploy != '[]' + id: deploy-preview + continue-on-error: true uses: rossjrw/pr-preview-action@v1.4.8 with: source-dir: ./preview-staging @@ -146,8 +148,27 @@ jobs: umbrella-dir: pr-preview action: deploy - - name: Post success comment + - name: Validate preview deployment if: steps.detect.outputs.pages-to-deploy != '[]' + id: validate-deploy + run: | + DEPLOY_OUTCOME="${{ steps.deploy-preview.outcome }}" + DEPLOY_URL="${{ steps.deploy-preview.outputs.deployment-url }}" + + if [ -z "$DEPLOY_URL" ]; then + echo "Deployment step did not produce a preview URL. Failing preview job." + exit 1 + fi + + if [ "$DEPLOY_OUTCOME" != "success" ]; then + echo "Deployment reported outcome: $DEPLOY_OUTCOME" + echo "Preview URL exists; treating as transient post-deploy comment error." + fi + + echo "status=ok" >> "$GITHUB_OUTPUT" + + - name: Post success comment + if: steps.detect.outputs.pages-to-deploy != '[]' && steps.validate-deploy.outputs.status == 'ok' uses: actions/github-script@v7 with: script: | From 507ec68cf7054074ee3d460151dbca73e518c19d Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Tue, 10 Mar 2026 12:16:19 -0500 Subject: [PATCH 10/27] fix: resolve high-severity dependency vulnerabilities (#6916) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Update tar resolution 7.5.7 → 7.5.11 (CVE-2026-26960, CVE-2026-29786) - Remove unused copilot optional dependency (CVE-2026-29783) --- package.json | 6 ++---- yarn.lock | 57 ++++------------------------------------------------ 2 files changed, 6 insertions(+), 57 deletions(-) diff --git a/package.json b/package.json index f05c1202b..9eb534436 100644 --- a/package.json +++ b/package.json @@ -13,7 +13,7 @@ }, "resolutions": { "serialize-javascript": "^6.0.2", - "tar": "7.5.7", + "tar": "7.5.11", "lodash-es": "^4.17.23" }, "devDependencies": { @@ -115,7 +115,5 @@ }, "keywords": [], "author": "", - "optionalDependencies": { - "copilot": "^0.0.2" - } + "optionalDependencies": {} } diff --git a/yarn.lock b/yarn.lock index 3b8d8d78e..49b022d29 100644 --- a/yarn.lock +++ b/yarn.lock @@ -246,48 +246,6 @@ resolved "https://registry.yarnpkg.com/@exodus/bytes/-/bytes-1.14.1.tgz#9b5c29077162a35f1bd25613e0cd3c239f6e7ad8" integrity sha512-OhkBFWI6GcRMUroChZiopRiSp2iAMvEBK47NhJooDqz1RERO4QuZIZnjP63TXX8GAiLABkYmX+fuQsdJ1dd2QQ== -"@github/copilot-darwin-arm64@0.0.420": - version "0.0.420" - resolved "https://registry.yarnpkg.com/@github/copilot-darwin-arm64/-/copilot-darwin-arm64-0.0.420.tgz#560ca002fa491c04fdb6f74f84fee87e52575c53" - integrity sha512-sj8Oxcf3oKDbeUotm2gtq5YU1lwCt3QIzbMZioFD/PMLOeqSX/wrecI+c0DDYXKofFhALb0+DxxnWgbEs0mnkQ== - -"@github/copilot-darwin-x64@0.0.420": - version "0.0.420" - resolved "https://registry.yarnpkg.com/@github/copilot-darwin-x64/-/copilot-darwin-x64-0.0.420.tgz#1d5cf40ac4e04bbd69fb0a79abf3743897c5f795" - integrity sha512-2acA93IqXz1uuz3TVUm0Y7BVrBr0MySh1kQa8LqMILhTsG0YHRMm8ybzTp2HA7Mi1tl5CjqMSk163kkS7OzfUA== - -"@github/copilot-linux-arm64@0.0.420": - version "0.0.420" - resolved "https://registry.yarnpkg.com/@github/copilot-linux-arm64/-/copilot-linux-arm64-0.0.420.tgz#e247517854927a14f5c076bfa99309160afec2d7" - integrity sha512-h/IvEryTOYm1HzR2GNq8s2aDtN4lvT4MxldfZuS42CtWJDOfVG2jLLsoHWU1T3QV8j1++PmDgE//HX0JLpLMww== - -"@github/copilot-linux-x64@0.0.420": - version "0.0.420" - resolved "https://registry.yarnpkg.com/@github/copilot-linux-x64/-/copilot-linux-x64-0.0.420.tgz#00d22974499f0fab6354fe4e22f6be59b800ab98" - integrity sha512-iL2NpZvXIDZ+3lw7sO2fo5T0nKmP5dZbU2gdYcv+SFBm/ONhCxIY5VRX4yN/9VkFaa9ePv5JzCnsl3vZINiDxg== - -"@github/copilot-win32-arm64@0.0.420": - version "0.0.420" - resolved "https://registry.yarnpkg.com/@github/copilot-win32-arm64/-/copilot-win32-arm64-0.0.420.tgz#733c45aced1e42c2877ae44012074abbcce3d55d" - integrity sha512-Njlc2j9vYSBAL+lC6FIEhQ3C+VxO3xavwKnw0ecVRiNLcGLyPrTdzPfPQOmEjC63gpVCqLabikoDGv8fuLPA2w== - -"@github/copilot-win32-x64@0.0.420": - version "0.0.420" - resolved "https://registry.yarnpkg.com/@github/copilot-win32-x64/-/copilot-win32-x64-0.0.420.tgz#d45f47f2f08d4bba87760b8afb21af19d1988780" - integrity sha512-rZlH35oNehAP2DvQbu4vQFVNeCh/1p3rUjafBYaEY0Nkhx7RmdrYBileL5U3PtRPPRsBPaq3Qp+pVIrGoCDLzQ== - -"@github/copilot@latest": - version "0.0.420" - resolved "https://registry.yarnpkg.com/@github/copilot/-/copilot-0.0.420.tgz#596349de076566a310836a7e06e6807b87ea6bfe" - integrity sha512-UpPuSjxUxQ+j02WjZEFffWf0scLb23LvuGHzMFtaSsweR+P/BdbtDUI5ZDIA6T0tVyyt6+X1/vgfsJiRqd6jig== - optionalDependencies: - "@github/copilot-darwin-arm64" "0.0.420" - "@github/copilot-darwin-x64" "0.0.420" - "@github/copilot-linux-arm64" "0.0.420" - "@github/copilot-linux-x64" "0.0.420" - "@github/copilot-win32-arm64" "0.0.420" - "@github/copilot-win32-x64" "0.0.420" - "@humanfs/core@^0.19.1": version "0.19.1" resolved "https://registry.yarnpkg.com/@humanfs/core/-/core-0.19.1.tgz#17c55ca7d426733fe3c561906b8173c336b40a77" @@ -1482,13 +1440,6 @@ confbox@^0.1.8: resolved "https://registry.yarnpkg.com/confbox/-/confbox-0.1.8.tgz#820d73d3b3c82d9bd910652c5d4d599ef8ff8b06" integrity sha512-RMtmw0iFkeR4YV+fUOSucriAQNb9g8zFR52MWCtl+cCZOFRNL6zeB395vPzFhEjjn4fMxXudmELnl/KF/WrK6w== -copilot@^0.0.2: - version "0.0.2" - resolved "https://registry.yarnpkg.com/copilot/-/copilot-0.0.2.tgz#4712810c9182cd784820ed44627bedd32dd377f9" - integrity sha512-nedf34AaYj9JnFhRmiJEZemAno2WDXMypq6FW5aCVR0N+QdpQ6viukP1JpvJDChpaMEVvbUkMjmjMifJbO/AgQ== - dependencies: - "@github/copilot" latest - core-util-is@1.0.2: version "1.0.2" resolved "https://registry.yarnpkg.com/core-util-is/-/core-util-is-1.0.2.tgz#b5fd54220aa2bc5ab57aab7140c940754503c1a7" @@ -5386,10 +5337,10 @@ tar-stream@^3.1.5: fast-fifo "^1.2.0" streamx "^2.15.0" -tar@7.5.7, tar@^7.5.9: - version "7.5.7" - resolved "https://registry.yarnpkg.com/tar/-/tar-7.5.7.tgz#adf99774008ba1c89819f15dbd6019c630539405" - integrity sha512-fov56fJiRuThVFXD6o6/Q354S7pnWMJIVlDBYijsTNx6jKSE4pvrDTs6lUnmGvNyfJwFQQwWy3owKz1ucIhveQ== +tar@7.5.11, tar@^7.5.9: + version "7.5.11" + resolved "https://registry.yarnpkg.com/tar/-/tar-7.5.11.tgz#1250fae45d98806b36d703b30973fa8e0a6d8868" + integrity sha512-ChjMH33/KetonMTAtpYdgUFr0tbz69Fp2v7zWxQfYZX4g5ZN2nOBXm1R2xyA+lMIKrLKIoKAwFj93jE/avX9cQ== dependencies: "@isaacs/fs-minipass" "^4.0.0" chownr "^3.0.0" From 3952e3b65baba8fca1c6aa2d1a7ad74ddb0e5181 Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Tue, 10 Mar 2026 12:22:58 -0500 Subject: [PATCH 11/27] fix: use correct API to invoke Copilot code review in doc-review workflow (#6918) * Initial plan * fix: use correct API to request Copilot code review in doc-review workflow Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> Co-authored-by: Jason Stirnaman --- .github/workflows/doc-review.yml | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/.github/workflows/doc-review.yml b/.github/workflows/doc-review.yml index 9ccf81b2a..b6f79cffa 100644 --- a/.github/workflows/doc-review.yml +++ b/.github/workflows/doc-review.yml @@ -89,11 +89,27 @@ jobs: !contains(github.event.pull_request.labels.*.name, 'skip-review')) steps: - name: Request Copilot review + uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b # v7.1.0 env: - GH_TOKEN: ${{ github.token }} PR_NUMBER: ${{ github.event.pull_request.number || inputs.pr_number }} - REPO: ${{ github.repository }} - run: gh pr edit "$PR_NUMBER" --repo "$REPO" --add-reviewer "copilot-reviews" + with: + script: | + const prNumber = context.issue.number || Number(process.env.PR_NUMBER); + try { + await github.rest.pulls.requestReviewers({ + owner: context.repo.owner, + repo: context.repo.repo, + pull_number: prNumber, + reviewers: ['copilot-pull-request-reviewer'], + }); + core.info('Copilot code review requested successfully'); + } catch (error) { + core.warning(`Could not request Copilot review: ${error.message}`); + core.warning( + 'To enable automatic Copilot reviews, configure a repository ruleset: ' + + 'Settings → Rules → Rulesets → "Automatically request Copilot code review"' + ); + } # ----------------------------------------------------------------- # Job 3: Copilot visual review (depends on Job 1 for URLs) @@ -187,7 +203,7 @@ jobs: '', '---', '', - `@copilot please review the preview pages listed above using the template below:`, + `@github-copilot please review the preview pages listed above using the template below:`, '', template.trim(), '', From 8a6143d5d14a08d6c42f79d80e3c2a4f9110e1c2 Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Tue, 10 Mar 2026 12:27:35 -0500 Subject: [PATCH 12/27] fix(vale): propagate Google.Units=NO to product-specific Vale configs (#6917) * Initial plan * fix(vale): add missing Google.Units=NO to product-specific .vale.ini files Duration literals like 7d, 24h, 30d were being flagged as errors when running Vale with product-specific configs because those configs were missing Google.Units = NO. Also adds Vale.Terms = NO, write-good.TooWordy = NO, and TokenIgnores to match the root .vale.ini. Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> Co-authored-by: Jason Stirnaman --- .claude/skills/vale-linting/SKILL.md | 29 +++++++++++++++++++- content/influxdb/v2/.vale.ini | 20 +++++++++++++- content/influxdb3/cloud-dedicated/.vale.ini | 20 +++++++++++++- content/influxdb3/cloud-serverless/.vale.ini | 20 +++++++++++++- content/influxdb3/clustered/.vale.ini | 20 +++++++++++++- content/influxdb3/core/.vale.ini | 20 +++++++++++++- 6 files changed, 123 insertions(+), 6 deletions(-) diff --git a/.claude/skills/vale-linting/SKILL.md b/.claude/skills/vale-linting/SKILL.md index aa324981c..760487d52 100644 --- a/.claude/skills/vale-linting/SKILL.md +++ b/.claude/skills/vale-linting/SKILL.md @@ -299,15 +299,42 @@ echo "systemd" >> .ci/vale/styles/config/vocabularies/InfluxDataDocs/accept.txt ### Creating a Product-Specific Override +> [!Important] +> Product-specific `.vale.ini` files must include the same disabled rules as the +> root `.vale.ini`. Rules disabled in the root config are **not** inherited by +> product-specific configs. Omitting them re-enables the rules for those products. +> For example, omitting `Google.Units = NO` causes duration literals like `7d`, +> `24h` to be flagged as errors in product-specific linting runs. + ```bash # 1. Create product-specific .vale.ini cat > content/influxdb3/cloud-dedicated/.vale.ini << 'EOF' StylesPath = ../../../.ci/vale/styles -MinAlertLevel = error +MinAlertLevel = warning Vocab = InfluxDataDocs +Packages = Google, write-good, Hugo + [*.md] BasedOnStyles = Vale, InfluxDataDocs, Google, write-good + +# These rules must be disabled in every product .vale.ini, same as the root .vale.ini. +Google.Acronyms = NO +Google.DateFormat = NO +Google.Ellipses = NO +Google.Headings = NO +Google.WordList = NO +# Disable Google.Units in favor of InfluxDataDocs.Units which only checks byte +# units (GB, TB, etc). Duration literals (30d, 24h, 1h) are valid InfluxDB syntax. +Google.Units = NO +Vale.Spelling = NO +Vale.Terms = NO +write-good.TooWordy = NO + +TokenIgnores = /[a-zA-Z0-9/_\-\.]+, \ + https?://[^\s\)\]>"]+, \ + `[^`]+` + # Product-specific overrides InfluxDataDocs.Branding = YES EOF diff --git a/content/influxdb/v2/.vale.ini b/content/influxdb/v2/.vale.ini index 06147959c..3538a1d80 100644 --- a/content/influxdb/v2/.vale.ini +++ b/content/influxdb/v2/.vale.ini @@ -14,4 +14,22 @@ Google.DateFormat = NO Google.Ellipses = NO Google.Headings = NO Google.WordList = NO -Vale.Spelling = NO \ No newline at end of file +# Disable Google.Units in favor of InfluxDataDocs.Units which only checks byte +# units (GB, TB, etc). Duration literals (30d, 24h, 1h) are valid InfluxDB syntax. +Google.Units = NO +Vale.Spelling = NO +# Disable Vale.Terms - the vocabulary-based substitution rule creates too many +# false positives from URLs, file paths, and code. The accepted terms in +# accept.txt still work for spelling checks via InfluxDataDocs.Spelling. +Vale.Terms = NO +# Disable write-good.TooWordy - flags legitimate technical terms like +# "aggregate", "expiration", "multiple", "However" that are standard in +# database documentation. +write-good.TooWordy = NO + +# Ignore URL paths like /api/v3/..., /cli/..., /influxdb3/... +# Ignore full URLs like https://example.com/... +# Ignore inline code in frontmatter (description fields, etc.) +TokenIgnores = /[a-zA-Z0-9/_\-\.]+, \ + https?://[^\s\)\]>"]+, \ + `[^`]+` \ No newline at end of file diff --git a/content/influxdb3/cloud-dedicated/.vale.ini b/content/influxdb3/cloud-dedicated/.vale.ini index c2ca4cb2f..35dfc38e5 100644 --- a/content/influxdb3/cloud-dedicated/.vale.ini +++ b/content/influxdb3/cloud-dedicated/.vale.ini @@ -14,4 +14,22 @@ Google.DateFormat = NO Google.Ellipses = NO Google.Headings = NO Google.WordList = NO -Vale.Spelling = NO \ No newline at end of file +# Disable Google.Units in favor of InfluxDataDocs.Units which only checks byte +# units (GB, TB, etc). Duration literals (30d, 24h, 1h) are valid InfluxDB syntax. +Google.Units = NO +Vale.Spelling = NO +# Disable Vale.Terms - the vocabulary-based substitution rule creates too many +# false positives from URLs, file paths, and code. The accepted terms in +# accept.txt still work for spelling checks via InfluxDataDocs.Spelling. +Vale.Terms = NO +# Disable write-good.TooWordy - flags legitimate technical terms like +# "aggregate", "expiration", "multiple", "However" that are standard in +# database documentation. +write-good.TooWordy = NO + +# Ignore URL paths like /api/v3/..., /cli/..., /influxdb3/... +# Ignore full URLs like https://example.com/... +# Ignore inline code in frontmatter (description fields, etc.) +TokenIgnores = /[a-zA-Z0-9/_\-\.]+, \ + https?://[^\s\)\]>"]+, \ + `[^`]+` \ No newline at end of file diff --git a/content/influxdb3/cloud-serverless/.vale.ini b/content/influxdb3/cloud-serverless/.vale.ini index 4472fd3c1..9ebc431b7 100644 --- a/content/influxdb3/cloud-serverless/.vale.ini +++ b/content/influxdb3/cloud-serverless/.vale.ini @@ -14,4 +14,22 @@ Google.DateFormat = NO Google.Ellipses = NO Google.Headings = NO Google.WordList = NO -Vale.Spelling = NO \ No newline at end of file +# Disable Google.Units in favor of InfluxDataDocs.Units which only checks byte +# units (GB, TB, etc). Duration literals (30d, 24h, 1h) are valid InfluxDB syntax. +Google.Units = NO +Vale.Spelling = NO +# Disable Vale.Terms - the vocabulary-based substitution rule creates too many +# false positives from URLs, file paths, and code. The accepted terms in +# accept.txt still work for spelling checks via InfluxDataDocs.Spelling. +Vale.Terms = NO +# Disable write-good.TooWordy - flags legitimate technical terms like +# "aggregate", "expiration", "multiple", "However" that are standard in +# database documentation. +write-good.TooWordy = NO + +# Ignore URL paths like /api/v3/..., /cli/..., /influxdb3/... +# Ignore full URLs like https://example.com/... +# Ignore inline code in frontmatter (description fields, etc.) +TokenIgnores = /[a-zA-Z0-9/_\-\.]+, \ + https?://[^\s\)\]>"]+, \ + `[^`]+` \ No newline at end of file diff --git a/content/influxdb3/clustered/.vale.ini b/content/influxdb3/clustered/.vale.ini index c381f0cde..2ae7567c0 100644 --- a/content/influxdb3/clustered/.vale.ini +++ b/content/influxdb3/clustered/.vale.ini @@ -14,4 +14,22 @@ Google.DateFormat = NO Google.Ellipses = NO Google.Headings = NO Google.WordList = NO -Vale.Spelling = NO \ No newline at end of file +# Disable Google.Units in favor of InfluxDataDocs.Units which only checks byte +# units (GB, TB, etc). Duration literals (30d, 24h, 1h) are valid InfluxDB syntax. +Google.Units = NO +Vale.Spelling = NO +# Disable Vale.Terms - the vocabulary-based substitution rule creates too many +# false positives from URLs, file paths, and code. The accepted terms in +# accept.txt still work for spelling checks via InfluxDataDocs.Spelling. +Vale.Terms = NO +# Disable write-good.TooWordy - flags legitimate technical terms like +# "aggregate", "expiration", "multiple", "However" that are standard in +# database documentation. +write-good.TooWordy = NO + +# Ignore URL paths like /api/v3/..., /cli/..., /influxdb3/... +# Ignore full URLs like https://example.com/... +# Ignore inline code in frontmatter (description fields, etc.) +TokenIgnores = /[a-zA-Z0-9/_\-\.]+, \ + https?://[^\s\)\]>"]+, \ + `[^`]+` \ No newline at end of file diff --git a/content/influxdb3/core/.vale.ini b/content/influxdb3/core/.vale.ini index 86731aebf..03f6d282a 100644 --- a/content/influxdb3/core/.vale.ini +++ b/content/influxdb3/core/.vale.ini @@ -19,4 +19,22 @@ Google.DateFormat = NO Google.Ellipses = NO Google.Headings = NO Google.WordList = NO -Vale.Spelling = NO \ No newline at end of file +# Disable Google.Units in favor of InfluxDataDocs.Units which only checks byte +# units (GB, TB, etc). Duration literals (30d, 24h, 1h) are valid InfluxDB syntax. +Google.Units = NO +Vale.Spelling = NO +# Disable Vale.Terms - the vocabulary-based substitution rule creates too many +# false positives from URLs, file paths, and code. The accepted terms in +# accept.txt still work for spelling checks via InfluxDataDocs.Spelling. +Vale.Terms = NO +# Disable write-good.TooWordy - flags legitimate technical terms like +# "aggregate", "expiration", "multiple", "However" that are standard in +# database documentation. +write-good.TooWordy = NO + +# Ignore URL paths like /api/v3/..., /cli/..., /influxdb3/... +# Ignore full URLs like https://example.com/... +# Ignore inline code in frontmatter (description fields, etc.) +TokenIgnores = /[a-zA-Z0-9/_\-\.]+, \ + https?://[^\s\)\]>"]+, \ + `[^`]+` \ No newline at end of file From 6d5f88c9e028a35ea28002b7fb160c06375e787a Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Tue, 10 Mar 2026 14:08:33 -0500 Subject: [PATCH 13/27] chore: add hosted influxdb-docs MCP server to .mcp.json (#6914) * chore: add hosted influxdb-docs MCP server to .mcp.json Add the hosted InfluxDB documentation search MCP server (influxdb-docs.mcp.kapa.ai) as the primary MCP server using SSE transport. Keep the local server with a note that it uses deprecated endpoints. https://claude.ai/code/session_01SURpmrJ2sxzBtp4euiAxpc * chore: add API key auth option for hosted influxdb-docs MCP server Make the API key-authenticated server the primary entry (influxdb-docs) using Bearer token from DOCS_KAPA_API_KEY env var. Keep the OAuth fallback as influxdb-docs-oauth for users without an API key. https://claude.ai/code/session_01SURpmrJ2sxzBtp4euiAxpc * chore: rename env vars to INFLUXDATA_DOCS_ namespace Rename DOCS_KAPA_API_KEY, DOCS_API_KEY_FILE, DOCS_MODE, and MCP_LOG_LEVEL to use the INFLUXDATA_DOCS_ prefix for consistency. https://claude.ai/code/session_01SURpmrJ2sxzBtp4euiAxpc * docs: add MCP server setup docs for contributors and AI agents Update CLAUDE.md, AGENTS.md, and content-editing SKILL.md with concise documentation for the hosted influxdb-docs MCP server, covering both API key and OAuth authentication options. https://claude.ai/code/session_01SURpmrJ2sxzBtp4euiAxpc * fix: remove cross-agent references from .claude files and AGENTS.md Keep .claude/ files focused on Claude Code. Link AGENTS.md to the published MCP server docs page instead of mentioning tool-specific setup. https://claude.ai/code/session_01SURpmrJ2sxzBtp4euiAxpc --------- Co-authored-by: Claude --- .claude/skills/content-editing/SKILL.md | 42 +++---------- .mcp.json | 25 ++++++-- AGENTS.md | 78 +++++++++++++++++++++++++ CLAUDE.md | 10 ++++ 4 files changed, 115 insertions(+), 40 deletions(-) diff --git a/.claude/skills/content-editing/SKILL.md b/.claude/skills/content-editing/SKILL.md index eb35f23e6..863b5c101 100644 --- a/.claude/skills/content-editing/SKILL.md +++ b/.claude/skills/content-editing/SKILL.md @@ -359,33 +359,12 @@ Use the Documentation MCP Server when the information here is inconclusive, when ### Setup -The documentation MCP server is hosted—no local installation required. Add the server URL to your AI assistant's MCP configuration. +The documentation MCP server is hosted at `https://influxdb-docs.mcp.kapa.ai`—no local installation required. -**MCP server URL:** +Already configured in [`.mcp.json`](/.mcp.json). Two server entries are available: -```text -https://influxdb-docs.mcp.kapa.ai -``` - -**Claude Desktop configuration** (Settings > Developer): - -```json -{ - "mcpServers": { - "influxdb-docs": { - "url": "https://influxdb-docs.mcp.kapa.ai" - } - } -} -``` - -For other AI assistants see the [InfluxDB documentation MCP server guide](/influxdb3/core/admin/mcp-server/) -and verify the MCP configuration options and syntax for a specific AI assistant. - -**Rate limits** (per Google OAuth user): - -- 40 requests per hour -- 200 requests per day +- **`influxdb-docs`** (API key) — Set `INFLUXDATA_DOCS_KAPA_API_KEY` env var. 60 req/min. +- **`influxdb-docs-oauth`** (OAuth) — No setup. Authenticates via Google on first use. 40 req/hr, 200 req/day. ### Available Tool @@ -552,17 +531,12 @@ touch content/influxdb3/enterprise/path/to/file.md ### MCP Server Not Responding -The hosted MCP server (`https://influxdb-docs.mcp.kapa.ai`) requires: - -1. **Google OAuth authentication** - On first use, sign in with Google -2. **Rate limits** - 40 requests/hour, 200 requests/day per user - **Troubleshooting steps:** -- Verify your AI assistant has the MCP server URL configured correctly -- Check if you've exceeded rate limits (wait an hour or until the next day) -- Try re-authenticating by clearing your OAuth session -- Ensure your network allows connections to `*.kapa.ai` +- **API key auth** (`influxdb-docs`): Verify `INFLUXDATA_DOCS_KAPA_API_KEY` is set. Rate limit: 60 req/min. +- **OAuth auth** (`influxdb-docs-oauth`): Sign in with Google on first use. Rate limits: 40 req/hr, 200 req/day. +- Verify your network allows connections to `*.kapa.ai` +- Check if you've exceeded rate limits (wait and retry) ### Cypress Tests Fail diff --git a/.mcp.json b/.mcp.json index f600dfa67..f53854090 100644 --- a/.mcp.json +++ b/.mcp.json @@ -1,20 +1,33 @@ { "$schema": "https://raw.githubusercontent.com/modelcontextprotocol/modelcontextprotocol/refs/heads/main/schema/2025-06-18/schema.json", - "description": "InfluxData documentation assistance via MCP server - Node.js execution", + "description": "InfluxData documentation assistance via MCP servers", "mcpServers": { + "influxdb-docs": { + "comment": "Hosted InfluxDB documentation search. Uses API key auth (set INFLUXDATA_DOCS_KAPA_API_KEY env var). Get your key from the Kapa dashboard. Rate limits: 60 req/min.", + "type": "sse", + "url": "https://influxdb-docs.mcp.kapa.ai", + "headers": { + "Authorization": "Bearer ${INFLUXDATA_DOCS_KAPA_API_KEY}" + } + }, + "influxdb-docs-oauth": { + "comment": "Hosted InfluxDB documentation search (OAuth). No API key needed--authenticates via Google OAuth on first use. Rate limits: 40 req/hr, 200 req/day.", + "type": "sse", + "url": "https://influxdb-docs.mcp.kapa.ai" + }, "influxdata": { - "comment": "Use Node to run Docs MCP. To install and setup, see https://github.com/influxdata/docs-mcp-server", + "comment": "Local Docs MCP server (optional). To install and setup, see https://github.com/influxdata/docs-mcp-server. NOTE: uses deprecated endpoints--pending update.", "type": "stdio", "command": "node", "args": [ "${DOCS_MCP_SERVER_PATH}/dist/index.js" ], "env": { - "DOCS_API_KEY_FILE": "${DOCS_API_KEY_FILE:-$HOME/.env.docs-kapa-api-key}", - "DOCS_MODE": "external-only", - "MCP_LOG_LEVEL": "${MCP_LOG_LEVEL:-info}", + "INFLUXDATA_DOCS_API_KEY_FILE": "${INFLUXDATA_DOCS_API_KEY_FILE:-$HOME/.env.docs-kapa-api-key}", + "INFLUXDATA_DOCS_MODE": "external-only", + "INFLUXDATA_DOCS_LOG_LEVEL": "${INFLUXDATA_DOCS_LOG_LEVEL:-info}", "NODE_ENV": "${NODE_ENV:-production}" } } } -} \ No newline at end of file +} diff --git a/AGENTS.md b/AGENTS.md index c05d86e2b..bd27e9efa 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -18,6 +18,84 @@ | Test code blocks | `yarn test:codeblocks:all` | 15-45m — **NEVER CANCEL** | | Lint | `yarn lint` | ~1m | +## Repository Structure + +``` +docs-v2/ +├── content/ # Documentation content +│ ├── influxdb3/ # InfluxDB 3 (core, enterprise, cloud-*) +│ ├── influxdb/ # InfluxDB v2 and v1 +│ ├── enterprise_influxdb/ # InfluxDB Enterprise v1 +│ ├── telegraf/ # Telegraf docs +│ ├── shared/ # Shared content across products +│ └── example.md # Shortcode testing playground +├── layouts/ # Hugo templates and shortcodes +├── assets/ # JS, CSS, TypeScript +├── api-docs/ # InfluxDB OpenAPI specifications, API reference documentation generation scripts +├── data/ # YAML/JSON data files +├── public/ # Build output (gitignored, ~529MB) +└── .github/ + └── copilot-instructions.md # Primary AI instructions +``` + +**Content Paths**: See [copilot-instructions.md](.github/copilot-instructions.md#content-organization) + +## Documentation MCP Server + +A hosted MCP server provides semantic search over all InfluxDB documentation. +Use it to verify technical accuracy, check API syntax, and find related docs. + +See the [InfluxDB documentation MCP server guide](https://docs.influxdata.com/influxdb3/core/admin/mcp-server/) for setup instructions. + +## Common Workflows + +### Creating/Editing Content + +**Frontmatter** (page metadata): +```yaml +title: Page Title # Required - becomes h1 +description: Brief desc # Required - for SEO +menu: + influxdb_2_0: + name: Nav Label # Optional - nav display name + parent: Parent Node # Optional - for nesting +weight: 1 # Required - sort order +``` + +**Shared Content** (avoid duplication): +```yaml +source: /shared/path/to/content.md +``` + +Shared content files (`/shared/path/to/content.md`): +- Don't store frontmatter +- Can use `{{% show-in %}}`, `{{% hide-in %}}`, and the `version` keyword (`/influxdb3/version/content.md`) + +**Common Shortcodes**: +- Callouts: `> [!Note]`, `> [!Warning]`, `> [!Important]`, `> [!Tip]` +- Tabs: `{{< tabs-wrapper >}}` + `{{% tabs %}}` + `{{% tab-content %}}` +- Required: `{{< req >}}` or `{{< req type="key" >}}` +- Code placeholders: `{ placeholders="" }` + +**📖 Complete Reference**: [DOCS-SHORTCODES.md](DOCS-SHORTCODES.md) | [DOCS-FRONTMATTER.md](DOCS-FRONTMATTER.md) + +### Testing Changes + +**Always test before committing**: +```bash +# Verify server renders (check 200 status) +curl -s -o /dev/null -w "%{http_code}" http://localhost:1313/influxdb3/core/ + +# Test specific content +yarn test:links content/influxdb3/core/**/*.md + +# Run style linting +.ci/vale/vale.sh content/**/*.md +``` + +**📖 Complete Reference**: [DOCS-TESTING.md](DOCS-TESTING.md) + + ## Constraints - **NEVER cancel** Hugo builds (~75s) or test runs (15-45m) — the site has 5,359+ pages diff --git a/CLAUDE.md b/CLAUDE.md index a549ac075..dc8350d2b 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -13,6 +13,16 @@ > - Specialized agents in `.claude/agents/` > - Custom skills in `.claude/skills/` +## Documentation MCP server + +This repo includes [`.mcp.json`](.mcp.json) with a hosted InfluxDB documentation search server. +Use it to verify technical accuracy, check API syntax, and find related docs. + +- **`influxdb-docs`** — API key auth. Set `INFLUXDATA_DOCS_KAPA_API_KEY` env var before launching Claude Code. +- **`influxdb-docs-oauth`** — OAuth fallback. No setup needed. + +See [content-editing skill](.claude/skills/content-editing/SKILL.md#part-4-fact-checking-with-the-documentation-mcp-server) for usage details. + ## Purpose and scope Claude should help document InfluxData products by creating clear, accurate technical content with proper code examples, frontmatter, and formatting. From bf79e613b012d8ef3ab1711136e127c0a02a5e38 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Tue, 10 Mar 2026 13:50:18 -0600 Subject: [PATCH 14/27] hotfix: Change date for InfluxDB Docker latest tag Update the date for InfluxDB Docker latest tag change. --- data/notifications.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/notifications.yaml b/data/notifications.yaml index 5c513b0ff..e0fde317a 100644 --- a/data/notifications.yaml +++ b/data/notifications.yaml @@ -76,7 +76,7 @@ - /influxdb/cloud title: InfluxDB Docker latest tag changing to InfluxDB 3 Core slug: | - On **April 7, 2026**, the `latest` tag for InfluxDB Docker images will + On **May 27, 2026**, the `latest` tag for InfluxDB Docker images will point to InfluxDB 3 Core. To avoid unexpected upgrades, use specific version tags in your Docker deployments. message: | From c600dda272a2265304ebf448af75936adc10f5e1 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Wed, 11 Mar 2026 15:39:20 -0500 Subject: [PATCH 15/27] fix: upgrade glob to v13 and pin dompurify resolution (#6925) - Upgrade glob from ^10.3.10 to ^13.0.6 to resolve dependency vulnerability warnings. API is unchanged, no code changes needed. - Add dompurify >=3.3.2 to resolutions to prevent regression. The prior lockfile-only fix (8dd60bf) regressed when yarn add regenerated the lockfile. --- package.json | 5 +- yarn.lock | 169 ++++++--------------------------------------------- 2 files changed, 22 insertions(+), 152 deletions(-) diff --git a/package.json b/package.json index 9eb534436..54667ff8a 100644 --- a/package.json +++ b/package.json @@ -14,7 +14,8 @@ "resolutions": { "serialize-javascript": "^6.0.2", "tar": "7.5.11", - "lodash-es": "^4.17.23" + "lodash-es": "^4.17.23", + "dompurify": ">=3.3.2" }, "devDependencies": { "@eslint/js": "^10.0.1", @@ -48,7 +49,7 @@ "dependencies": { "@types/turndown": "^5.0.6", "axios": "^1.13.5", - "glob": "^10.3.10", + "glob": "^13.0.6", "gray-matter": "^4.0.3", "jquery": "^3.7.1", "js-cookie": "^3.0.5", diff --git a/yarn.lock b/yarn.lock index 49b022d29..5b45f7c84 100644 --- a/yarn.lock +++ b/yarn.lock @@ -283,18 +283,6 @@ "@iconify/types" "^2.0.0" mlly "^1.8.0" -"@isaacs/cliui@^8.0.2": - version "8.0.2" - resolved "https://registry.yarnpkg.com/@isaacs/cliui/-/cliui-8.0.2.tgz#b37667b7bc181c168782259bab42474fbf52b550" - integrity sha512-O8jcjabXaleOG9DQ0+ARXWZBTfnP4WNAqzuiJK7ll44AmxGKv/J2M4TPjxjY3znBCfvBXFzucm1twdyFybFqEA== - dependencies: - string-width "^5.1.2" - string-width-cjs "npm:string-width@^4.2.0" - strip-ansi "^7.0.1" - strip-ansi-cjs "npm:strip-ansi@^6.0.1" - wrap-ansi "^8.1.0" - wrap-ansi-cjs "npm:wrap-ansi@^7.0.0" - "@isaacs/fs-minipass@^4.0.0": version "4.0.1" resolved "https://registry.yarnpkg.com/@isaacs/fs-minipass/-/fs-minipass-4.0.1.tgz#2d59ae3ab4b38fb4270bfa23d30f8e2e86c7fe32" @@ -314,11 +302,6 @@ resolved "https://registry.yarnpkg.com/@mixmark-io/domino/-/domino-2.2.0.tgz#4e8ec69bf1afeb7a14f0628b7e2c0f35bdb336c3" integrity sha512-Y28PR25bHXUg88kCV7nivXrP2Nj2RueZ3/l/jdx6J9f8J4nsEGcgX0Qe6lt7Pa+J79+kPiJU3LguR6O/6zrLOw== -"@pkgjs/parseargs@^0.11.0": - version "0.11.0" - resolved "https://registry.yarnpkg.com/@pkgjs/parseargs/-/parseargs-0.11.0.tgz#a77ea742fab25775145434eb1d2328cf5013ac33" - integrity sha512-+1VkjdD0QBLPodGrJUeqarH8VAIvQODIbwh9XpP5Syisf7YoQgsJKPNFoqqLQlu+VQ/tVSshMR6loPMn8U+dPg== - "@puppeteer/browsers@2.13.0": version "2.13.0" resolved "https://registry.yarnpkg.com/@puppeteer/browsers/-/browsers-2.13.0.tgz#10f980c6d65efeff77f8a3cac6e1a7ac10604500" @@ -804,11 +787,6 @@ ansi-regex@^5.0.1: resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-5.0.1.tgz#082cb2c89c9fe8659a311a53bd6a4dc5301db304" integrity sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ== -ansi-regex@^6.2.2: - version "6.2.2" - resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-6.2.2.tgz#60216eea464d864597ce2832000738a0589650c1" - integrity sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg== - ansi-styles@^4.0.0, ansi-styles@^4.1.0: version "4.3.0" resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-4.3.0.tgz#edd803628ae71c04c85ae7a0906edad34b648937" @@ -816,11 +794,6 @@ ansi-styles@^4.0.0, ansi-styles@^4.1.0: dependencies: color-convert "^2.0.1" -ansi-styles@^6.1.0: - version "6.2.3" - resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-6.2.3.tgz#c044d5dcc521a076413472597a1acb1f103c4041" - integrity sha512-4Dj6M28JB+oAH8kFkTLUo+a2jwOFkuqb3yucU0CANcRRUbxS0cP0nZYCGjcc3BNXwRIsUVmDGgzawme7zvJHvg== - anymatch@~3.1.2: version "3.1.3" resolved "https://registry.yarnpkg.com/anymatch/-/anymatch-3.1.3.tgz#790c58b19ba1720a84205b57c618d5ad8524973e" @@ -1140,13 +1113,6 @@ brace-expansion@^1.1.7: balanced-match "^1.0.0" concat-map "0.0.1" -brace-expansion@^2.0.2: - version "2.0.2" - resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-2.0.2.tgz#54fc53237a613d854c7bd37463aad17df87214e7" - integrity sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ== - dependencies: - balanced-match "^1.0.0" - brace-expansion@^5.0.2: version "5.0.4" resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-5.0.4.tgz#614daaecd0a688f660bbbc909a8748c3d80d4336" @@ -2005,10 +1971,10 @@ doctrine@^2.1.0: dependencies: esutils "^2.0.2" -dompurify@^3.2.5: - version "3.3.2" - resolved "https://registry.yarnpkg.com/dompurify/-/dompurify-3.3.2.tgz#58c515d0f8508b8749452a028aa589ad80b36325" - integrity sha512-6obghkliLdmKa56xdbLOpUZ43pAR6xFy1uOrxBaIDjT+yaRuuybLjGS9eVBoSR/UPU5fq3OXClEHLJNGvbxKpQ== +dompurify@>=3.3.2, dompurify@^3.2.5: + version "3.3.3" + resolved "https://registry.yarnpkg.com/dompurify/-/dompurify-3.3.3.tgz#680cae8af3e61320ddf3666a3bc843f7b291b2b6" + integrity sha512-Oj6pzI2+RqBfFG+qOaOLbFXLQ90ARpcGG6UePL82bJLtdsa6CYJD7nmiU8MW9nQNOtCHV3lZ/Bzq1X0QYbBZCA== optionalDependencies: "@types/trusted-types" "^2.0.7" @@ -2021,11 +1987,6 @@ dunder-proto@^1.0.0, dunder-proto@^1.0.1: es-errors "^1.3.0" gopd "^1.2.0" -eastasianwidth@^0.2.0: - version "0.2.0" - resolved "https://registry.yarnpkg.com/eastasianwidth/-/eastasianwidth-0.2.0.tgz#696ce2ec0aa0e6ea93a397ffcf24aa7840c827cb" - integrity sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA== - ecc-jsbn@~0.1.1: version "0.1.2" resolved "https://registry.yarnpkg.com/ecc-jsbn/-/ecc-jsbn-0.1.2.tgz#3a83a904e54353287874c564b7549386849a98c9" @@ -2581,14 +2542,6 @@ for-each@^0.3.3, for-each@^0.3.5: dependencies: is-callable "^1.2.7" -foreground-child@^3.1.0: - version "3.3.1" - resolved "https://registry.yarnpkg.com/foreground-child/-/foreground-child-3.3.1.tgz#32e8e9ed1b68a3497befb9ac2b6adf92a638576f" - integrity sha512-gIXjKqtFuWEgzFRJA9WCQeSJLZDjgJUOMCMzxtvFq/37KojM1BFGufqsCy0r4qSQmYLsZYMeyRqzIWOMup03sw== - dependencies: - cross-spawn "^7.0.6" - signal-exit "^4.0.1" - forever-agent@~0.6.1: version "0.6.1" resolved "https://registry.yarnpkg.com/forever-agent/-/forever-agent-0.6.1.tgz#fbc71f0c41adeb37f96c577ad1ed42d8fdacca91" @@ -2753,17 +2706,14 @@ glob-parent@~5.1.2: dependencies: is-glob "^4.0.1" -glob@^10.3.10: - version "10.5.0" - resolved "https://registry.yarnpkg.com/glob/-/glob-10.5.0.tgz#8ec0355919cd3338c28428a23d4f24ecc5fe738c" - integrity sha512-DfXN8DfhJ7NH3Oe7cFmu3NCu1wKbkReJ8TorzSAFbSKrlNaQSKfIzqYqVY8zlbs2NLBbWpRiU52GX2PbaBVNkg== +glob@^13.0.6: + version "13.0.6" + resolved "https://registry.yarnpkg.com/glob/-/glob-13.0.6.tgz#078666566a425147ccacfbd2e332deb66a2be71d" + integrity sha512-Wjlyrolmm8uDpm/ogGyXZXb1Z+Ca2B8NbJwqBVg0axK9GbBeoS7yGV6vjXnYdGm6X53iehEuxxbyiKp8QmN4Vw== dependencies: - foreground-child "^3.1.0" - jackspeak "^3.1.2" - minimatch "^9.0.4" - minipass "^7.1.2" - package-json-from-dist "^1.0.0" - path-scurry "^1.11.1" + minimatch "^10.2.2" + minipass "^7.1.3" + path-scurry "^2.0.2" global-dirs@^3.0.0: version "3.0.1" @@ -3238,15 +3188,6 @@ isstream@~0.1.2: resolved "https://registry.yarnpkg.com/isstream/-/isstream-0.1.2.tgz#47e63f7af55afa6f92e1500e690eb8b8529c099a" integrity sha512-Yljz7ffyPbrLpLngrMtZ7NduUgVvi6wG9RJ9IUcyCd59YQ911PBJphODUcbOVbqYfxe1wuYf/LJ8PauMRwsM/g== -jackspeak@^3.1.2: - version "3.4.3" - resolved "https://registry.yarnpkg.com/jackspeak/-/jackspeak-3.4.3.tgz#8833a9d89ab4acde6188942bd1c53b6390ed5a8a" - integrity sha512-OGlZQpz2yfahA/Rd1Y8Cd9SIEsqvXkLVoSw/cgwhnhFMDbsQFeZYoJJ7bIZBS9BcamUW96asq/npPWugM+RQBw== - dependencies: - "@isaacs/cliui" "^8.0.2" - optionalDependencies: - "@pkgjs/parseargs" "^0.11.0" - jquery@^3.7.1: version "3.7.1" resolved "https://registry.yarnpkg.com/jquery/-/jquery-3.7.1.tgz#083ef98927c9a6a74d05a6af02806566d16274de" @@ -3606,12 +3547,7 @@ longest-streak@^3.0.0: resolved "https://registry.yarnpkg.com/longest-streak/-/longest-streak-3.1.0.tgz#62fa67cd958742a1574af9f39866364102d90cd4" integrity sha512-9Ri+o0JYgehTaVBBDoMqIl8GXtbWg711O3srftcHhZ0dqnETqLaoIK0x17fUw9rFSlK/0NlsKe0Ahhyl5pXE2g== -lru-cache@^10.2.0: - version "10.4.3" - resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-10.4.3.tgz#410fc8a17b70e598013df257c2446b7f3383f119" - integrity sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ== - -lru-cache@^11.2.4, lru-cache@^11.2.5, lru-cache@^11.2.6: +lru-cache@^11.0.0, lru-cache@^11.2.4, lru-cache@^11.2.5, lru-cache@^11.2.6: version "11.2.6" resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-11.2.6.tgz#356bf8a29e88a7a2945507b31f6429a65a192c58" integrity sha512-ESL2CrkS/2wTPfuend7Zhkzo2u0daGJ/A2VucJOgQ/C48S/zB8MMeMHSGKYpXhIjbPxfuezITkaBH1wqv00DDQ== @@ -4126,19 +4062,12 @@ minimatch@^3.1.2: dependencies: brace-expansion "^1.1.7" -minimatch@^9.0.4: - version "9.0.9" - resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-9.0.9.tgz#9b0cb9fcb78087f6fd7eababe2511c4d3d60574e" - integrity sha512-OBwBN9AL4dqmETlpS2zasx+vTeWclWzkblfZk7KTA5j3jeOONz/tRCnZomUyvNg83wL5Zv9Ss6HMJXAgL8R2Yg== - dependencies: - brace-expansion "^2.0.2" - minimist@^1.2.0, minimist@^1.2.6, minimist@^1.2.8: version "1.2.8" resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.8.tgz#c1a464e7693302e082a075cee0c057741ac4772c" integrity sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA== -"minipass@^5.0.0 || ^6.0.2 || ^7.0.0", minipass@^7.0.4, minipass@^7.1.2: +minipass@^7.0.4, minipass@^7.1.2, minipass@^7.1.3: version "7.1.3" resolved "https://registry.yarnpkg.com/minipass/-/minipass-7.1.3.tgz#79389b4eb1bb2d003a9bba87d492f2bd37bdc65b" integrity sha512-tEBHqDnIoM/1rXME1zgka9g6Q2lcoCkxHLuc7ODJ5BxbP5d4c2Z5cGgtXAku59200Cx7diuHTOYfSBD8n6mm8A== @@ -4372,11 +4301,6 @@ pac-resolver@^7.0.1: degenerator "^5.0.0" netmask "^2.0.2" -package-json-from-dist@^1.0.0: - version "1.0.1" - resolved "https://registry.yarnpkg.com/package-json-from-dist/-/package-json-from-dist-1.0.1.tgz#4f1471a010827a86f94cfd9b0727e36d267de505" - integrity sha512-UEZIS3/by4OC8vL3P2dTXRETpebLI2NiI5vIrjaD/5UtrkFX/tNbwjTSRAGC/+7CAo2pIcBaRgWmcBBHcsaCIw== - package-manager-detector@^1.3.0: version "1.6.0" resolved "https://registry.yarnpkg.com/package-manager-detector/-/package-manager-detector-1.6.0.tgz#70d0cf0aa02c877eeaf66c4d984ede0be9130734" @@ -4438,13 +4362,13 @@ path-parse@^1.0.7: resolved "https://registry.yarnpkg.com/path-parse/-/path-parse-1.0.7.tgz#fbc114b60ca42b30d9daf5858e4bd68bbedb6735" integrity sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw== -path-scurry@^1.11.1: - version "1.11.1" - resolved "https://registry.yarnpkg.com/path-scurry/-/path-scurry-1.11.1.tgz#7960a668888594a0720b12a911d1a742ab9f11d2" - integrity sha512-Xa4Nw17FS9ApQFJ9umLiJS4orGjm7ZzwUrwamcGQuHSzDyth9boKDaycYdDcZDuqYATXw4HFXgaqWTctW/v1HA== +path-scurry@^2.0.2: + version "2.0.2" + resolved "https://registry.yarnpkg.com/path-scurry/-/path-scurry-2.0.2.tgz#6be0d0ee02a10d9e0de7a98bae65e182c9061f85" + integrity sha512-3O/iVVsJAPsOnpwWIeD+d6z/7PmqApyQePUtCndjatj/9I5LylHvt5qluFaBT3I5h3r1ejfR056c+FCv+NnNXg== dependencies: - lru-cache "^10.2.0" - minipass "^5.0.0 || ^6.0.2 || ^7.0.0" + lru-cache "^11.0.0" + minipass "^7.1.2" pathe@^2.0.1, pathe@^2.0.3: version "2.0.3" @@ -5049,11 +4973,6 @@ signal-exit@^3.0.2: resolved "https://registry.yarnpkg.com/signal-exit/-/signal-exit-3.0.7.tgz#a9a1767f8af84155114eaabd73f99273c8f59ad9" integrity sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ== -signal-exit@^4.0.1: - version "4.1.0" - resolved "https://registry.yarnpkg.com/signal-exit/-/signal-exit-4.1.0.tgz#952188c1cbd546070e2dd20d0f41c0ae0530cb04" - integrity sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw== - slash@^5.0.0: version "5.1.0" resolved "https://registry.yarnpkg.com/slash/-/slash-5.1.0.tgz#be3adddcdf09ac38eebe8dcdc7b1a57a75b095ce" @@ -5177,15 +5096,6 @@ streamx@^2.12.5, streamx@^2.15.0, streamx@^2.21.0: fast-fifo "^1.3.2" text-decoder "^1.1.0" -"string-width-cjs@npm:string-width@^4.2.0": - version "4.2.3" - resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010" - integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g== - dependencies: - emoji-regex "^8.0.0" - is-fullwidth-code-point "^3.0.0" - strip-ansi "^6.0.1" - string-width@^4.1.0, string-width@^4.2.0, string-width@^4.2.3: version "4.2.3" resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010" @@ -5195,15 +5105,6 @@ string-width@^4.1.0, string-width@^4.2.0, string-width@^4.2.3: is-fullwidth-code-point "^3.0.0" strip-ansi "^6.0.1" -string-width@^5.0.1, string-width@^5.1.2: - version "5.1.2" - resolved "https://registry.yarnpkg.com/string-width/-/string-width-5.1.2.tgz#14f8daec6d81e7221d2a357e668cab73bdbca794" - integrity sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA== - dependencies: - eastasianwidth "^0.2.0" - emoji-regex "^9.2.2" - strip-ansi "^7.0.1" - string.prototype.includes@^2.0.1: version "2.0.1" resolved "https://registry.yarnpkg.com/string.prototype.includes/-/string.prototype.includes-2.0.1.tgz#eceef21283640761a81dbe16d6c7171a4edf7d92" @@ -5252,13 +5153,6 @@ string_decoder@^1.1.1: dependencies: safe-buffer "~5.2.0" -"strip-ansi-cjs@npm:strip-ansi@^6.0.1": - version "6.0.1" - resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9" - integrity sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A== - dependencies: - ansi-regex "^5.0.1" - strip-ansi@^6.0.0, strip-ansi@^6.0.1: version "6.0.1" resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9" @@ -5266,13 +5160,6 @@ strip-ansi@^6.0.0, strip-ansi@^6.0.1: dependencies: ansi-regex "^5.0.1" -strip-ansi@^7.0.1: - version "7.2.0" - resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-7.2.0.tgz#d22a269522836a627af8d04b5c3fd2c7fa3e32e3" - integrity sha512-yDPMNjp4WyfYBkHnjIRLfca1i6KMyGCtsVgoKe/z1+6vukgaENdgGBZt+ZmKPc4gavvEZ5OgHfHdrazhgNyG7w== - dependencies: - ansi-regex "^6.2.2" - strip-bom-string@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/strip-bom-string/-/strip-bom-string-1.0.0.tgz#e5211e9224369fbb81d633a2f00044dc8cedad92" @@ -5888,15 +5775,6 @@ word-wrap@^1.2.5: resolved "https://registry.yarnpkg.com/word-wrap/-/word-wrap-1.2.5.tgz#d2c45c6dd4fbce621a66f136cbe328afd0410b34" integrity sha512-BN22B5eaMMI9UMtjrGd5g5eCYPpCPDUy0FJXbYsaT5zYxjFOckS53SQDE3pWkVoWpHXVb3BrYcEN4Twa55B5cA== -"wrap-ansi-cjs@npm:wrap-ansi@^7.0.0": - version "7.0.0" - resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43" - integrity sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q== - dependencies: - ansi-styles "^4.0.0" - string-width "^4.1.0" - strip-ansi "^6.0.0" - wrap-ansi@^6.2.0: version "6.2.0" resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-6.2.0.tgz#e9393ba07102e6c91a3b221478f0257cd2856e53" @@ -5915,15 +5793,6 @@ wrap-ansi@^7.0.0: string-width "^4.1.0" strip-ansi "^6.0.0" -wrap-ansi@^8.1.0: - version "8.1.0" - resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-8.1.0.tgz#56dc22368ee570face1b49819975d9b9a5ead214" - integrity sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ== - dependencies: - ansi-styles "^6.1.0" - string-width "^5.0.1" - strip-ansi "^7.0.1" - wrappy@1: version "1.0.2" resolved "https://registry.yarnpkg.com/wrappy/-/wrappy-1.0.2.tgz#b5243d8f3ec1aa35f1364605bc0d1036e30ab69f" From 0a0bebc42c580571fcaa4bc31afdfdaa9131ce74 Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Fri, 13 Mar 2026 08:47:38 -0500 Subject: [PATCH 16/27] Fix PR preview and Copilot visual review skipping docs home page when layouts/index.html changes (#6922) * Initial plan * fix: include docs home page in PR preview and Copilot visual review when layouts/index.html changes Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> * fix: improve detect-preview-pages to avoid false needs-author-input when home page auto-detected Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> Co-authored-by: Jason Stirnaman --- .github/scripts/detect-preview-pages.js | 59 ++++++++++++++++-------- .github/scripts/parse-pr-urls.js | 9 +++- .github/scripts/resolve-review-urls.js | 25 +++++++++- .github/scripts/test-parse-pr-urls.js | 61 ++++++++++++++++++++++--- 4 files changed, 126 insertions(+), 28 deletions(-) diff --git a/.github/scripts/detect-preview-pages.js b/.github/scripts/detect-preview-pages.js index 12e255ac4..76ab1eac9 100644 --- a/.github/scripts/detect-preview-pages.js +++ b/.github/scripts/detect-preview-pages.js @@ -35,10 +35,10 @@ if (!/^origin\/[a-zA-Z0-9._\/-]+$/.test(BASE_REF)) { */ function getAllChangedFiles() { try { - const output = execSync( - `git diff --name-only ${BASE_REF}...HEAD`, - { encoding: 'utf-8', stdio: ['pipe', 'pipe', 'pipe'] } - ); + const output = execSync(`git diff --name-only ${BASE_REF}...HEAD`, { + encoding: 'utf-8', + stdio: ['pipe', 'pipe', 'pipe'], + }); return output.trim().split('\n').filter(Boolean); } catch (err) { console.error(`Error detecting changes: ${err.message}`); @@ -53,11 +53,13 @@ function getAllChangedFiles() { */ function categorizeChanges(files) { return { - content: files.filter(f => f.startsWith('content/') && f.endsWith('.md')), - layouts: files.filter(f => f.startsWith('layouts/')), - assets: files.filter(f => f.startsWith('assets/')), - data: files.filter(f => f.startsWith('data/')), - apiDocs: files.filter(f => f.startsWith('api-docs/') || f.startsWith('openapi/')), + content: files.filter((f) => f.startsWith('content/') && f.endsWith('.md')), + layouts: files.filter((f) => f.startsWith('layouts/')), + assets: files.filter((f) => f.startsWith('assets/')), + data: files.filter((f) => f.startsWith('data/')), + apiDocs: files.filter( + (f) => f.startsWith('api-docs/') || f.startsWith('openapi/') + ), }; } @@ -127,7 +129,7 @@ function main() { const htmlPaths = mapContentToPublic(expandedContent, 'public'); // Convert HTML paths to URL paths - pagesToDeploy = Array.from(htmlPaths).map(htmlPath => { + pagesToDeploy = Array.from(htmlPaths).map((htmlPath) => { return '/' + htmlPath.replace('public/', '').replace('/index.html', '/'); }); console.log(` Found ${pagesToDeploy.length} affected pages\n`); @@ -135,34 +137,53 @@ function main() { // Strategy 2: Layout/asset changes - parse URLs from PR body if (hasLayoutChanges) { - console.log('🎨 Layout/asset changes detected, checking PR description for URLs...'); + console.log( + '🎨 Layout/asset changes detected, checking PR description for URLs...' + ); + + // Auto-detect home page when the root template changes + if (changes.layouts.includes('layouts/index.html')) { + pagesToDeploy = [...new Set([...pagesToDeploy, '/'])]; + console.log( + ' 🏠 Home page template (layouts/index.html) changed - auto-adding / to preview pages' + ); + } + const prUrls = extractDocsUrls(PR_BODY); if (prUrls.length > 0) { console.log(` Found ${prUrls.length} URLs in PR description`); // Merge with content pages (deduplicate) pagesToDeploy = [...new Set([...pagesToDeploy, ...prUrls])]; - } else if (changes.content.length === 0) { - // No content changes AND no URLs specified - need author input - console.log(' ⚠️ No URLs found in PR description - author input needed'); + } else if (pagesToDeploy.length === 0) { + // No content changes, no auto-detected pages, and no URLs specified - need author input + console.log( + ' ⚠️ No URLs found in PR description - author input needed' + ); setOutput('pages-to-deploy', '[]'); setOutput('has-layout-changes', 'true'); setOutput('needs-author-input', 'true'); - setOutput('change-summary', 'Layout/asset changes detected - please specify pages to preview'); + setOutput( + 'change-summary', + 'Layout/asset changes detected - please specify pages to preview' + ); return; } } // Apply page limit if (pagesToDeploy.length > MAX_PAGES) { - console.log(`⚠️ Limiting preview to ${MAX_PAGES} pages (found ${pagesToDeploy.length})`); + console.log( + `⚠️ Limiting preview to ${MAX_PAGES} pages (found ${pagesToDeploy.length})` + ); pagesToDeploy = pagesToDeploy.slice(0, MAX_PAGES); } // Generate summary - const summary = pagesToDeploy.length > 0 - ? `${pagesToDeploy.length} page(s) will be previewed` - : 'No pages to preview'; + const summary = + pagesToDeploy.length > 0 + ? `${pagesToDeploy.length} page(s) will be previewed` + : 'No pages to preview'; console.log(`\n✅ ${summary}`); diff --git a/.github/scripts/parse-pr-urls.js b/.github/scripts/parse-pr-urls.js index 7e844fe14..58205b3b1 100644 --- a/.github/scripts/parse-pr-urls.js +++ b/.github/scripts/parse-pr-urls.js @@ -63,6 +63,9 @@ function isValidUrlPath(path) { // Must start with / if (!path.startsWith('/')) return false; + // Allow root path (docs home page at /) + if (path === '/') return true; + // Must start with known product prefix (loaded from products.yml) const validPrefixes = PRODUCT_NAMESPACES.map((ns) => `/${ns}/`); @@ -101,7 +104,8 @@ export function extractDocsUrls(text) { // Pattern 1: Full production URLs // https://docs.influxdata.com/influxdb3/core/get-started/ - const prodUrlPattern = /https?:\/\/docs\.influxdata\.com(\/[^\s)\]>"']+)/g; + // https://docs.influxdata.com/ (home page) + const prodUrlPattern = /https?:\/\/docs\.influxdata\.com(\/[^\s)\]>"']*)/g; let match; while ((match = prodUrlPattern.exec(text)) !== null) { const path = normalizeUrlPath(match[1]); @@ -112,7 +116,8 @@ export function extractDocsUrls(text) { // Pattern 2: Localhost dev URLs // http://localhost:1313/influxdb3/core/ - const localUrlPattern = /https?:\/\/localhost:\d+(\/[^\s)\]>"']+)/g; + // http://localhost:1313/ (home page) + const localUrlPattern = /https?:\/\/localhost:\d+(\/[^\s)\]>"']*)/g; while ((match = localUrlPattern.exec(text)) !== null) { const path = normalizeUrlPath(match[1]); if (isValidUrlPath(path)) { diff --git a/.github/scripts/resolve-review-urls.js b/.github/scripts/resolve-review-urls.js index 8869555d7..886679d35 100644 --- a/.github/scripts/resolve-review-urls.js +++ b/.github/scripts/resolve-review-urls.js @@ -10,6 +10,7 @@ */ import { appendFileSync } from 'fs'; +import { execSync } from 'child_process'; import { getChangedContentFiles, mapContentToPublic, @@ -27,11 +28,33 @@ if (!/^origin\/[a-zA-Z0-9._/-]+$/.test(BASE_REF)) { const changed = getChangedContentFiles(BASE_REF); const htmlPaths = mapContentToPublic(changed, 'public'); -const urls = Array.from(htmlPaths) +const contentUrls = Array.from(htmlPaths) .sort() .map((p) => '/' + p.replace(/^public\//, '').replace(/\/index\.html$/, '/')) .slice(0, MAX_PAGES); +// Check if the home page template changed (layouts/index.html → /) +let homePageUrls = []; +try { + const homePageChanged = execSync( + `git diff --name-only ${BASE_REF}...HEAD -- layouts/index.html`, + { encoding: 'utf-8', stdio: ['pipe', 'pipe', 'pipe'] } + ).trim(); + if (homePageChanged) { + homePageUrls = ['/']; + console.log( + 'Home page template (layouts/index.html) changed - adding / to review URLs' + ); + } +} catch { + // Ignore errors - fall back to content-only URLs +} + +const urls = [...new Set([...homePageUrls, ...contentUrls])].slice( + 0, + MAX_PAGES +); + appendFileSync(GITHUB_OUTPUT, `urls=${JSON.stringify(urls)}\n`); appendFileSync(GITHUB_OUTPUT, `url-count=${urls.length}\n`); diff --git a/.github/scripts/test-parse-pr-urls.js b/.github/scripts/test-parse-pr-urls.js index 6470122ec..36fd98d7c 100644 --- a/.github/scripts/test-parse-pr-urls.js +++ b/.github/scripts/test-parse-pr-urls.js @@ -145,7 +145,11 @@ test('Special characters: backticks are delimiters', () => { // This prevents command substitution injection const text = '/influxdb3/`whoami`/'; const result = extractDocsUrls(text); - assertEquals(result, ['/influxdb3/'], 'Should truncate at backtick delimiter'); + assertEquals( + result, + ['/influxdb3/'], + 'Should truncate at backtick delimiter' + ); }); test('Special characters: single quotes truncate at extraction', () => { @@ -257,31 +261,51 @@ test('Normalization: removes query string', () => { test('Normalization: strips wildcard from path', () => { const text = '/influxdb3/enterprise/*'; const result = extractDocsUrls(text); - assertEquals(result, ['/influxdb3/enterprise/'], 'Should strip wildcard character'); + assertEquals( + result, + ['/influxdb3/enterprise/'], + 'Should strip wildcard character' + ); }); test('Normalization: strips wildcard in middle of path', () => { const text = '/influxdb3/*/admin/'; const result = extractDocsUrls(text); - assertEquals(result, ['/influxdb3/admin/'], 'Should strip wildcard from middle of path'); + assertEquals( + result, + ['/influxdb3/admin/'], + 'Should strip wildcard from middle of path' + ); }); test('Normalization: strips multiple wildcards', () => { const text = '/influxdb3/*/admin/*'; const result = extractDocsUrls(text); - assertEquals(result, ['/influxdb3/admin/'], 'Should strip all wildcard characters'); + assertEquals( + result, + ['/influxdb3/admin/'], + 'Should strip all wildcard characters' + ); }); test('Wildcard in markdown-style notation', () => { const text = '**InfluxDB 3 Enterprise pages** (`/influxdb3/enterprise/*`)'; const result = extractDocsUrls(text); - assertEquals(result, ['/influxdb3/enterprise/'], 'Should extract and normalize path with wildcard in backticks'); + assertEquals( + result, + ['/influxdb3/enterprise/'], + 'Should extract and normalize path with wildcard in backticks' + ); }); test('Wildcard in parentheses', () => { const text = 'Affects pages under (/influxdb3/enterprise/*)'; const result = extractDocsUrls(text); - assertEquals(result, ['/influxdb3/enterprise/'], 'Should extract and normalize path with wildcard in parentheses'); + assertEquals( + result, + ['/influxdb3/enterprise/'], + 'Should extract and normalize path with wildcard in parentheses' + ); }); // Test deduplication @@ -360,6 +384,31 @@ test('BASE_REF: rejects without origin/ prefix', () => { assertEquals(isValid, false, 'Should require origin/ prefix'); }); +// Home page URL support +test('Home page: production URL https://docs.influxdata.com/', () => { + const text = 'Preview: https://docs.influxdata.com/'; + const result = extractDocsUrls(text); + assertEquals(result, ['/'], 'Should extract root path for docs home page'); +}); + +test('Home page: localhost URL http://localhost:1313/', () => { + const text = 'Testing at http://localhost:1313/'; + const result = extractDocsUrls(text); + assertEquals(result, ['/'], 'Should extract root path from localhost URL'); +}); + +test('Home page: relative root path / in text', () => { + // Relative '/' alone is not extractable by the relative pattern (requires product prefix), + // but full URLs with / path are supported + const text = 'https://docs.influxdata.com/ and /influxdb3/core/'; + const result = extractDocsUrls(text); + assertEquals( + result.sort(), + ['/', '/influxdb3/core/'].sort(), + 'Should extract both root path and product path' + ); +}); + // Print summary console.log('\n=== Test Summary ==='); console.log(`Total: ${totalTests}`); From 14e021aa2655bfb39fc939dd56f401b19bf1c8b6 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Fri, 13 Mar 2026 15:37:54 -0500 Subject: [PATCH 17/27] InfluxDB 1.12.3 release (#6872) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * feat: [meta] https-insecure-certificate configuration (#6850) Add documentation for meta node's `[meta] https-insecure-certificate` configuration. This configuration is available in >= 1.12.3. * feat: https-insecure-certificate configuration (#6847) Add documentation for `https-insecure-certificate` configuration in `[cluster]` and `[http]` sections. * feat: [tls] advanced-expiration configuration (#6849) Add `[tls] advanced-expiration` setting for data nodes. * feat: add compression options to influxd-ctl backup (#6717) * feat: add compression options to influxd-ctl backup Added new flags for backup compression and performance tuning. * feat: Update backup.md Co-authored-by: Jason Stirnaman * Update content/enterprise_influxdb/v1/tools/influxd-ctl/backup.md Co-authored-by: Scott Anderson * Apply suggestions from code review Co-authored-by: Scott Anderson --------- Co-authored-by: Jason Stirnaman Co-authored-by: Scott Anderson * fix(enterprise): correct typos and inconsistencies in v1.12.3 release docs Fix grammar, formatting, and accuracy issues across the new v1.12.3 configuration and backup compression documentation. * fix(influxdb-v1): correct FUTURE LIMIT and PAST LIMIT clause order and add to ALTER RETENTION POLICY (#6591) * fix(influxdb-v1): correct FUTURE LIMIT and PAST LIMIT clause order and add to ALTER RETENTION POLICY - Fix clause order: FUTURE LIMIT must appear before PAST LIMIT (parser requirement) - Add FUTURE LIMIT and PAST LIMIT clauses to ALTER RETENTION POLICY syntax - Add grammar definitions for retention_future_limit and retention_past_limit - Add explicit note clarifying the required clause order - Fix "There are" style issue in spec.md closes #6590 * style(influxdb-v1): clean up InfluxQL spec formatting influxdb/v1: - Simplify introduction and use relative anchor links - Convert notes to GitHub-style callout syntax - Fix heading hierarchy (Letters/digits, Identifiers, Keywords, Literals as h3) - Standardize Duration units table heading - Fix "keywords" typo - Reword "See FAQ" to "For more information, see" - Simplify KILL QUERY section - Fix SHOW MEASUREMENT CARDINALITY heading level - Replace "There are" with active voice enterprise_influxdb/v1: - Add related links to frontmatter - Simplify introduction and use relative anchor links - Convert notes to GitHub-style callout syntax - Add Characters and Letters/digits to TOC - Standardize Duration units table heading - Fix "keywords" typo - Reword "See FAQ" to "For more information, see" - Simplify KILL QUERY section for Enterprise clusters - Update SHOW TAG KEYS grammar to include with_key_clause - Remove backticks from SHOW STATS headings * fix(influxdb-v1): address review issues in InfluxQL spec pages (#6931) * fix(influxdb-v1): address review issues in InfluxQL spec pages - Fix Enterprise KILL QUERY: restore proper EBNF grammar with optional ON clause and include both local and cluster examples - Fix duplicate "Durations" heading in both spec files - Fix list item spacing in Enterprise spec - Revert OSS heading level changes to maintain consistency with Enterprise - Restore Comments section to original location under Other in OSS spec * fix(influxdb-v1): move Comments section outside Other in OSS spec Match Enterprise spec structure: Comments is a top-level section before Other, not nested inside it. * fix(influxdb-v1): restore Comments link in OSS spec TOC * fix(influxdb-v1): rewrite KILL QUERY with clear Syntax and Examples sections Use text-typed code block for syntax notation and Syntax heading. Keep both local and cluster examples in sql-typed block. * feat(enterprise,v1): add v1.12.3 release notes and missing OSS config options Add release notes for InfluxDB v1.12.3 (OSS and Enterprise) with links to documented features. Add missing https-insecure-certificate and advanced-expiration config options to OSS docs. Fix backup example gzipBlockSize typo (10048576 → 10485760) and document the default. * fix(enterprise,v1): fix broken links in release notes and spec pages Fix 30+ broken links across v1 release notes and InfluxQL spec pages: - Correct config paths (configuration/ → configure/) - Fix fragment anchors (remove default values from anchors) - Update relocated pages (cluster-commands → tools/influxd-ctl) - Fix cross-product links (Enterprise → OSS for shared content) - Remove dead links (flux/v0.36, whats_new) * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * fix(enterprise,v1): move FUTURE/PAST LIMIT fix from Features to Bug fixes The clause order correction is a bug fix, not a new feature. * fix(v1): correct spec typos and KILL QUERY placeholder in v1.12.3 docs (#6932) * Initial plan * fix(v1): correct typos, grammar references, and example inconsistencies in spec and backup docs Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> * revert(enterprise/v1): restore gzipBlockSize and gzipBlockCount in backup example Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> * revert(v1): restore with_key_clause in spec grammar for show_tag_keys, show_tag_values_cardinality, and exact_cardinality statements Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> * fix(influxdb-v1): fix broken cross-references in meta-nodes config and OSS config - Fix meta-internal-shared-secret links in config-meta-nodes.md to point to config-data-nodes where the heading exists - Update MDN security headers URL to current location * chore(influxdb-v1): bump OSS and Enterprise latest patch to 1.12.3 * docs: tag v1.12.3-only config and backup updates (#6936) * Initial plan * docs(metadata): mark v1.12.3 additions Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> --------- Co-authored-by: Geoffrey Wossum Co-authored-by: WeblWabl Co-authored-by: Scott Anderson Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> --- .../v1/about-the-project/release-notes.md | 101 +++++++-- .../configure/config-data-nodes.md | 24 +++ .../configure/config-meta-nodes.md | 14 +- .../v1/query_language/manage-database.md | 47 ++-- .../v1/query_language/spec.md | 176 ++++++++------- .../v1/tools/influxd-ctl/backup.md | 58 ++++- .../v1/about_the_project/release-notes.md | 48 ++++- content/influxdb/v1/administration/config.md | 20 +- .../v1/query_language/manage-database.md | 45 ++-- content/influxdb/v1/query_language/spec.md | 200 ++++++++++-------- data/products.yml | 4 +- 11 files changed, 469 insertions(+), 268 deletions(-) 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 d7c5a22cc..b0c00e523 100644 --- a/content/enterprise_influxdb/v1/about-the-project/release-notes.md +++ b/content/enterprise_influxdb/v1/about-the-project/release-notes.md @@ -13,6 +13,63 @@ alt_links: +## v1.12.3 {date="2026-01-12"} + +> [!Important] +> #### Upgrade meta nodes first +> +> When upgrading to InfluxDB Enterprise 1.12.1+, upgrade meta nodes before +> upgrading data nodes. + +### Features + +- Add [`https-insecure-certificate` configuration option](/enterprise_influxdb/v1/administration/configure/config-meta-nodes/#https-insecure-certificate) + to meta nodes to skip file permission checking for TLS certificate and private key files. + Also available for data node + [`[cluster]`](/enterprise_influxdb/v1/administration/configure/config-data-nodes/#https-insecure-certificate) + and [`[http]`](/enterprise_influxdb/v1/administration/configure/config-data-nodes/#https-insecure-certificate-1) + sections. +- Add [`advanced-expiration` TLS configuration option](/enterprise_influxdb/v1/administration/configure/config-data-nodes/#advanced-expiration) + to configure how far in advance to log warnings about TLS certificate expiration. +- Add [backup compression options](/enterprise_influxdb/v1/tools/influxd-ctl/backup/#backup-compression) + (`-gzipCompressionLevel`, `-gzipBlockCount`, `-gzipBlockSize`) to + [`influxd-ctl backup`](/enterprise_influxdb/v1/tools/influxd-ctl/backup/). +- Add TLS certificate reloading on `SIGHUP`. +- Add `config` and `cq` (continuous query) diagnostics to the `/debug/vars` endpoint. +- Improve dropped point logging. +- Show user when displaying or logging queries. +- Add `time_format` parameter for the HTTP API. +- Use dynamic logging levels (`zap.AtomicLevel`). +- Report user query bytes. + +### Bug fixes + +- Fix `FUTURE LIMIT` and `PAST LIMIT` + [clause order](/enterprise_influxdb/v1/query_language/manage-database/#future-limit) + in retention policy statements. +- Add locking in `ClearBadShardList`. +- Stop noisy logging about phantom shards that do not belong to a node. +- Resolve `RLock()` leakage in `Store.DeleteSeries()`. +- Fix condition check for optimization of array cursor (tsm1). +- Run `init.sh` `buildtsi` as `influxdb` user. +- Reduce unnecessary purger operations and logging. +- Sort files for adjacency testing. +- Fix operator in host detection (systemd). +- Use correct path in open WAL error message. +- Handle nested low-level files in compaction. +- Correct error logic for writing empty index files. +- Reduce lock contention and races in purger. +- Fix bug with authorizer leakage in `SHOW QUERIES`. +- Rename compact throughput logging keys. +- Fix `https-insecure-certificate` not handled properly in httpd. +- Prevent level regression when compacting mixed-level TSM files. + +### Other + +- Update Go to 1.24.13. + +--- + ## v1.12.2 {date="2025-09-15"} > [!Important] @@ -43,8 +100,8 @@ alt_links: - 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) + - [`[meta].raft-portal-auth-required`](/enterprise_influxdb/v1/administration/configure/config-meta-nodes/#raft-portal-auth-required) + - [`[meta].raft-dialer-auth-required`](/enterprise_influxdb/v1/administration/configure/config-meta-nodes/#raft-dialer-auth-required) - Improve error handling. - InfluxQL updates: - Delete series by retention policy. @@ -407,7 +464,7 @@ alt_links: - Add [/api/v2/delete](/enterprise_influxdb/v1/tools/api/#apiv2delete-http-endpoint) support. - Add wildcard support for retention policies in `SHOW MEASUREMENTS`. - Log slow queries even when query logging is not enabled. -- Add `--start` and `--end` [backup options](/enterprise_influxdb/v1/administration/backup-and-restore/#backup-options) to specify the time to include in backup. +- Add `--start` and `--end` [backup flags](/enterprise_influxdb/v1/administration/backup-and-restore/#backup-flags) to specify the time to include in backup. - Add Raft Status output to `inflxud-ctl show`. #### Flux updates @@ -531,7 +588,7 @@ An edge case regression was introduced into this version that may cause a consta - **Log active queries when a process is terminated**: Add the [`termination-query-log`](/enterprise_influxdb/v1/administration/configure/config-data-nodes/#termination-query-log--false) configuration option. When set to `true` all running queries are printed to the log when a data node process receives a `SIGTERM` (for example, a Kubernetes process exceeds the container memory limit or the process is terminated). -- **Log details of HTTP calls to meta nodes**. When [`cluster-tracing`](/enterprise_influxdb/v1/administration/configure/config-meta-nodes/#cluster-tracing--false) is enabled, all API calls to meta nodes are now logged with details providing an audit trail including IP address of caller, specific API being invoked, action being invoked, and more. +- **Log details of HTTP calls to meta nodes**. When [`cluster-tracing`](/enterprise_influxdb/v1/administration/configure/config-meta-nodes/#cluster-tracing) is enabled, all API calls to meta nodes are now logged with details providing an audit trail including IP address of caller, specific API being invoked, action being invoked, and more. ### Maintenance updates @@ -797,14 +854,14 @@ For details on changes incorporated from the InfluxDB OSS release, see #### Hinted handoff improvements -- Allow out-of-order writes. This change adds a configuration option `allow-out-of-order-writes` to the `[cluster]` section of the data node configuration file. This setting defaults to `false` to match the existing behavior. There are some important operational considerations to review before turning this on. But, the result is enabling this option reduces the time required to drain the hinted handoff queue and increase throughput during recovery. See [`allow-out-of-order-writes`](/enterprise_influxdb/v1/administration/config-data-nodes#allow-out-of-order-writes--false) for more detail. -- Make the number of pending writes configurable. This change adds a configuration option in the `[hinted-handoff]` section called `max-pending-writes`, which defaults to `1024`. See [max-pending-writes](/enterprise_influxdb/v1/administration/config-data-nodes#max-pending-writes-1024) for more detail. +- Allow out-of-order writes. This change adds a configuration option `allow-out-of-order-writes` to the `[cluster]` section of the data node configuration file. This setting defaults to `false` to match the existing behavior. There are some important operational considerations to review before turning this on. But, the result is enabling this option reduces the time required to drain the hinted handoff queue and increase throughput during recovery. See [`allow-out-of-order-writes`](/enterprise_influxdb/v1/administration/configure/config-data-nodes/#allow-out-of-order-writes) for more detail. +- Make the number of pending writes configurable. This change adds a configuration option in the `[hinted-handoff]` section called `max-pending-writes`, which defaults to `1024`. See [`max-writes-pending`](/enterprise_influxdb/v1/administration/configure/config-data-nodes/#max-writes-pending) for more detail. - Update the hinted handoff queue to ensure various entries to segment files occur atomically. Prior to this change, entries were written to disk in three separate writes (len, data, offset). If the process stopped in the middle of any of those writes, the hinted handoff segment file was left in an invalid state. - In certain scenarios, the hinted-handoff queue would fail to drain. Upon node startup, the queue segment files are now verified and truncated if any are corrupted. Some additional logging has been added when a node starts writing to the hinted handoff queue as well. #### `influxd-ctl` CLI improvements -- Add a verbose flag to [`influxd-ctl show-shards`](/enterprise_influxdb/v1/administration/cluster-commands/#show-shards). This option provides more information about each shard owner, including the state (hot/cold), last modified date and time, and size on disk. +- Add a verbose flag to [`influxd-ctl show-shards`](/enterprise_influxdb/v1/tools/influxd-ctl/show-shards/). This option provides more information about each shard owner, including the state (hot/cold), last modified date and time, and size on disk. ### Bug fixes @@ -832,7 +889,7 @@ For details on changes incorporated from the InfluxDB OSS release, see > 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). +For more information, see [Perform a metadata only backup](/enterprise_influxdb/v1/administration/backup-and-restore/#perform-a-metadata-only-backup). #### **Incremental and full backups** @@ -900,7 +957,7 @@ For details on changes incorporated from the InfluxDB OSS release, see [InfluxDB - Added logging when data nodes connect to meta service. ### Features -- The Flux Technical Preview has advanced to version [0.36.2](/flux/v0.36/). +- The Flux Technical Preview has advanced to version 0.36.2. --- @@ -1159,7 +1216,7 @@ Please see the [InfluxDB OSS release notes](/influxdb/v1/about_the_project/relea > 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/). +For highlights of the InfluxDB 1.5 release, see [InfluxDB 1.5 release notes](/influxdb/v1/about_the_project/release-notes/). ### Breaking changes @@ -1397,7 +1454,7 @@ The following configuration changes may need to changed before [upgrading](/ente We've removed the data node's `shard-writer-timeout` configuration option from the `[cluster]` section. As of version 1.2.2, the system sets `shard-writer-timeout` internally. -The configuration option can be removed from the [data node configuration file](/enterprise_influxdb/v1/administration/configuration/#data-node-configuration). +The configuration option can be removed from the [data node configuration file](/enterprise_influxdb/v1/administration/configure/config-data-nodes/). #### retention-autocreate @@ -1415,8 +1472,8 @@ This change only affects users who have disabled the `retention-autocreate` opti ##### Backup and Restore
-- Prevent the `shard not found` error by making [backups](/enterprise_influxdb/v1/administration/backup-and-restore/#backup) skip empty shards -- Prevent the `shard not found` error by making [restore](/enterprise_influxdb/v1/administration/backup-and-restore/#restore) handle empty shards +- Prevent the `shard not found` error by making [backups](/enterprise_influxdb/v1/tools/influxd-ctl/backup/) skip empty shards +- Prevent the `shard not found` error by making [restore](/enterprise_influxdb/v1/tools/influxd-ctl/restore/) handle empty shards - Ensure that restores from an incremental backup correctly handle file paths - Allow incremental backups with restrictions (for example, they use the `-db` or `rp` flags) to be stores in the same directory - Support restores on meta nodes that are not the raft leader @@ -1436,8 +1493,8 @@ This change only affects users who have disabled the `retention-autocreate` opti - Serialize access to the meta client and meta store to prevent raft log buildup - Remove sysvinit package dependency for RPM packages - Make the default retention policy creation an atomic process instead of a two-step process -- Prevent `influxd-ctl`'s [`join` argument](/enterprise_influxdb/v1/features/cluster-commands/#join) from completing a join when the command also specifies the help flag (`-h`) -- Fix the `influxd-ctl`'s [force removal](/enterprise_influxdb/v1/features/cluster-commands/#remove-meta) of meta nodes +- Prevent `influxd-ctl`'s [`join` argument](/enterprise_influxdb/v1/tools/influxd-ctl/join/) from completing a join when the command also specifies the help flag (`-h`) +- Fix the `influxd-ctl`'s [force removal](/enterprise_influxdb/v1/tools/influxd-ctl/remove-meta/) of meta nodes - Update the meta node and data node sample configuration files --- @@ -1459,7 +1516,7 @@ Please see the OSS [release notes](https://github.com/influxdata/influxdb/blob/1 ### Upgrading -* The `retention-autocreate` configuration option has moved from the meta node configuration file to the [data node configuration file](/enterprise_influxdb/v1/administration/configuration/#retention-autocreate-true). +* The `retention-autocreate` configuration option has moved from the meta node configuration file to the [data node configuration file](/enterprise_influxdb/v1/administration/configure/config-data-nodes/#retention-autocreate). To disable the auto-creation of retention policies, set `retention-autocreate` to `false` in your data node configuration files. * The previously deprecated `influxd-ctl force-leave` command has been removed. The replacement command to remove a meta node which is never coming back online is [`influxd-ctl remove-meta -force`](/enterprise_influxdb/v1/features/cluster-commands/). @@ -1468,7 +1525,7 @@ To disable the auto-creation of retention policies, set `retention-autocreate` t - Improve the meta store: any meta store changes are done via a compare and swap - Add support for [incremental backups](/enterprise_influxdb/v1/administration/backup-and-restore/) - Automatically remove any deleted shard groups from the data store -- Uncomment the section headers in the default [configuration file](/enterprise_influxdb/v1/administration/configuration/) +- Uncomment the section headers in the default [configuration file](/enterprise_influxdb/v1/administration/configure/) - Add InfluxQL support for [subqueries](/influxdb/v1/query_language/data_exploration/#subqueries) #### Cluster-specific Bugfixes @@ -1476,13 +1533,13 @@ To disable the auto-creation of retention policies, set `retention-autocreate` t - Update dependencies with Godeps - Fix a data race in meta client - Ensure that the system removes the relevant [user permissions and roles](/enterprise_influxdb/v1/features/users/) when a database is dropped -- Fix a couple typos in demo [configuration file](/enterprise_influxdb/v1/administration/configuration/) +- Fix a couple typos in demo [configuration file](/enterprise_influxdb/v1/administration/configure/) - Make optional the version protobuf field for the meta store - Remove the override of GOMAXPROCS - Remove an unused configuration option (`dir`) from the backend - Fix a panic around processing remote writes - Return an error if a remote write has a field conflict -- Drop points in the hinted handoff that (1) have field conflict errors (2) have [`max-values-per-tag`](/influxdb/v1/administration/config/#max-values-per-tag-100000) errors +- Drop points in the hinted handoff that (1) have field conflict errors (2) have [`max-values-per-tag`](/influxdb/v1/administration/config/#max-values-per-tag) errors - Remove the deprecated `influxd-ctl force-leave` command - Fix issue where CQs would stop running if the first meta node in the cluster stops - Fix logging in the meta httpd handler service @@ -1572,8 +1629,8 @@ Switches to journald logging for on systemd systems. Logs are no longer sent to - Return an error if getting latest snapshot takes longer than 30 seconds - Remove any expired shards from the `/show-shards` output -- Respect the [`pprof-enabled` configuration setting](/enterprise_influxdb/v1/administration/configuration/#pprof-enabled-true) and enable it by default on meta nodes -- Respect the [`pprof-enabled` configuration setting](/enterprise_influxdb/v1/administration/configuration/#pprof-enabled-true-1) on data nodes +- Respect the [`pprof-enabled` configuration setting](/enterprise_influxdb/v1/administration/configure/config-meta-nodes/#pprof-enabled) and enable it by default on meta nodes +- Respect the [`pprof-enabled` configuration setting](/enterprise_influxdb/v1/administration/configure/config-data-nodes/#pprof-enabled) on data nodes - Use the data reference instead of `Clone()` during read-only operations for performance purposes - Prevent the system from double-collecting cluster statistics - Ensure that the Meta API redirects to the cluster leader when it gets the `ErrNotLeader` error @@ -1589,7 +1646,7 @@ Switches to journald logging for on systemd systems. Logs are no longer sent to #### Cluster-specific bug fixes -- Respect the [Hinted Handoff settings](/enterprise_influxdb/v1/administration/configuration/#hinted-handoff) in the configuration file +- Respect the [Hinted Handoff settings](/enterprise_influxdb/v1/administration/configure/config-data-nodes/#hinted-handoff) in the configuration file - Fix expanding regular expressions when all shards do not exist on node that's handling the request --- 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 4a6e54d9a..d8fbdaca5 100644 --- a/content/enterprise_influxdb/v1/administration/configure/config-data-nodes.md +++ b/content/enterprise_influxdb/v1/administration/configure/config-data-nodes.md @@ -624,6 +624,14 @@ Use a separate private key location. Environment variable: `INFLUXDB_CLUSTER_HTTPS_PRIVATE_KEY` +#### https-insecure-certificate {metadata="v1.12.3+"} + +Default is `false`. + +Skips file permission checking for `https-certificate` and `https-private-key` when `true`. + +Environment variable: `INFLUXDB_CLUSTER_HTTPS_INSECURE_CERTIFICATE` + #### https-insecure-tls Default is `false`. @@ -1171,6 +1179,14 @@ The location of the separate private key. Environment variable: `INFLUXDB_HTTP_HTTPS_PRIVATE_KEY` +#### https-insecure-certificate {metadata="v1.12.3+"} + +Default is `false`. + +Skips file permission checking for `https-certificate` and `https-private-key` when `true`. + +Environment variable: `INFLUXDB_HTTP_HTTPS_INSECURE_CERTIFICATE` + #### shared-secret Default is `""`. @@ -1692,6 +1708,14 @@ In the preceding example, `max-version = "tls1.3"` specifies the maximum version Environment variable: `INFLUXDB_TLS_MAX_VERSION` +#### advanced-expiration {metadata="v1.12.3+"} + +Default is `5d`. + +Sets how far in advance to log warnings about TLS certificate expiration. + +Environment variable: `INFLUXDB_TLS_ADVANCED_EXPIRATION` + ## Flux query management settings ### [flux-controller] diff --git a/content/enterprise_influxdb/v1/administration/configure/config-meta-nodes.md b/content/enterprise_influxdb/v1/administration/configure/config-meta-nodes.md index 68a1cb908..e1a105e43 100644 --- a/content/enterprise_influxdb/v1/administration/configure/config-meta-nodes.md +++ b/content/enterprise_influxdb/v1/administration/configure/config-meta-nodes.md @@ -170,6 +170,14 @@ Use either: Environment variable: `INFLUXDB_META_HTTPS_PRIVATE_KEY` +#### https-insecure-certificate + +Default is `false`. + +Skips file permission checking for `https-certificate` and `https-private-key` when `true`. + +Environment variable: `INFLUXDB_META_HTTPS_INSECURE_CERTIFICATE` + #### https-insecure-tls Default is `false`. @@ -341,7 +349,7 @@ The shared secret used by the internal API for JWT authentication for inter-node communication within the cluster. Set this to a long pass phrase. This value must be the same value as the -[`[meta] meta-internal-shared-secret`](/enterprise_influxdb/v1/administration/config-data-nodes#meta-internal-shared-secret) in the data node configuration file. +[`[meta] meta-internal-shared-secret`](/enterprise_influxdb/v1/administration/configure/config-data-nodes/#meta-internal-shared-secret) in the data node configuration file. To use this option, set [`auth-enabled`](#auth-enabled) to `true`. Environment variable: `INFLUXDB_META_INTERNAL_SHARED_SECRET` @@ -452,7 +460,7 @@ Environment variable: `INFLUXDB_META_ENSURE_FIPS` Default is `false`. Require Raft clients to authenticate with server using the -[`meta-internal-shared-secret`](#meta-internal-shared-secret). +[`meta-internal-shared-secret`](/enterprise_influxdb/v1/administration/configure/config-data-nodes/#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`. @@ -465,7 +473,7 @@ Environment variable: `INFLUXDB_META_RAFT_PORTAL_AUTH_REQUIRED` Default is `false`. Require Raft servers to authenticate Raft clients using the -[`meta-internal-shared-secret`](#meta-internal-shared-secret). +[`meta-internal-shared-secret`](/enterprise_influxdb/v1/administration/configure/config-data-nodes/#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`. For existing clusters, it is recommended to enable `raft-portal-auth-required` and restart diff --git a/content/enterprise_influxdb/v1/query_language/manage-database.md b/content/enterprise_influxdb/v1/query_language/manage-database.md index d57aa6efd..d740f413f 100644 --- a/content/enterprise_influxdb/v1/query_language/manage-database.md +++ b/content/enterprise_influxdb/v1/query_language/manage-database.md @@ -62,15 +62,15 @@ 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 ] [FUTURE LIMIT ] [PAST LIMIT ] [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 +The `WITH`, `DURATION`, `REPLICATION`, `SHARD DURATION`, `FUTURE LIMIT`, +`PAST 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 @@ -102,7 +102,7 @@ The query creates a database called `NOAA_water_database`. ``` The query creates a database called `NOAA_water_database`. -It also creates a default retention policy for `NOAA_water_database` with a `DURATION` of three days, a [replication factor](/enterprise_influxdb/v1/concepts/glossary/#replication-factor) of one, a [shard group](/enterprise_influxdb/v1/concepts/glossary/#shard-group) duration of one hour, and with the name `liquid`. +It also creates a default retention policy for `NOAA_water_database` with a `DURATION` of three days, a [replication factor](/enterprise_influxdb/v1/concepts/glossary/#replication-factor-rf) of one, a [shard group](/enterprise_influxdb/v1/concepts/glossary/#shard-group) duration of one hour, and with the name `liquid`. ### Delete a database with DROP DATABASE @@ -258,7 +258,7 @@ You may disable its auto-creation in the [configuration file](/enterprise_influx #### Syntax ```sql -CREATE RETENTION POLICY ON DURATION REPLICATION [SHARD DURATION ] [PAST LIMIT ] [FUTURE LIMIT ] [DEFAULT] +CREATE RETENTION POLICY ON DURATION REPLICATION [SHARD DURATION ] [FUTURE LIMIT ] [PAST LIMIT ] [DEFAULT] ``` #### Description of syntax @@ -306,6 +306,17 @@ See [Shard group duration management](/enterprise_influxdb/v1/concepts/schema_and_data_layout/#shard-group-duration-management) for recommended configurations. +##### `FUTURE LIMIT` {metadata="v1.12.0+"} + +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. + ##### `PAST LIMIT` {metadata="v1.12.0+"} The `PAST LIMIT` clause defines a time boundary before and relative to _now_ @@ -317,25 +328,6 @@ 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. -> [!Important] -> `PAST LIMIT` cannot be changed after it is set. -> This will be fixed in a future release. - -##### `FUTURE LIMIT` {metadata="v1.12.0+"} - -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. - -> [!Important] -> `FUTURE LIMIT` cannot be changed after it is set. -> This will be fixed in a future release. - ##### `DEFAULT` Sets the new retention policy as the default retention policy for the database. @@ -371,14 +363,17 @@ See [Create a database with CREATE DATABASE](/enterprise_influxdb/v1/query_langu ### Modify retention policies with ALTER RETENTION POLICY -The `ALTER RETENTION POLICY` query takes the following form, where you must declare at least one of the retention policy attributes `DURATION`, `REPLICATION`, `SHARD DURATION`, or `DEFAULT`: +The `ALTER RETENTION POLICY` query takes the following form, where you must declare at least one of the retention policy attributes `DURATION`, `REPLICATION`, `SHARD DURATION`, `FUTURE LIMIT`, `PAST LIMIT`, or `DEFAULT`: ```sql -ALTER RETENTION POLICY ON [DURATION ] [REPLICATION ] [SHARD DURATION ] [DEFAULT] +ALTER RETENTION POLICY ON [DURATION ] [REPLICATION ] [SHARD DURATION ] [FUTURE LIMIT ] [PAST LIMIT ] [DEFAULT] ``` {{% warn %}} Replication factors do not serve a purpose with single node instances. {{% /warn %}} +For information about the `FUTURE LIMIT` and `PAST LIMIT` clauses, see +[CREATE RETENTION POLICY](#create-retention-policies-with-create-retention-policy). + First, create the retention policy `what_is_time` with a `DURATION` of two days: ```sql > CREATE RETENTION POLICY "what_is_time" ON "NOAA_water_database" DURATION 2d REPLICATION 1 diff --git a/content/enterprise_influxdb/v1/query_language/spec.md b/content/enterprise_influxdb/v1/query_language/spec.md index 2da1caa11..c3a94748e 100644 --- a/content/enterprise_influxdb/v1/query_language/spec.md +++ b/content/enterprise_influxdb/v1/query_language/spec.md @@ -1,49 +1,39 @@ --- title: Influx Query Language (InfluxQL) reference -description: Reference for Influx Query Language (InfluxQL). +description: InfluxQL is a SQL-like query language for interacting with InfluxDB and providing features specific to storing and analyzing time series data. menu: enterprise_influxdb_v1: name: InfluxQL reference weight: 90 parent: InfluxQL -aliases: - - /influxdb/v2/query_language/spec/ +related: + - /enterprise_influxdb/v1/query_language/internals/ + - /enterprise_influxdb/v1/query_language/explore-data/ + - /enterprise_influxdb/v1/query_language/explore-schema/ + - /enterprise_influxdb/v1/query_language/manage-database/ --- -## Introduction - InfluxQL is a SQL-like query language for interacting with InfluxDB and providing features specific to storing and analyzing time series data. -Find Influx Query Language (InfluxQL) definitions and details, including: - -* [Notation](/enterprise_influxdb/v1/query_language/spec/#notation) -* [Query representation](/enterprise_influxdb/v1/query_language/spec/#query-representation) - * [Characters](/enterprise_influxdb/v1/query_language/spec/#characters) - * [Letters and digits](/enterprise_influxdb/v1/query_language/spec/#letters-and-digits) - * [Identifiers](/enterprise_influxdb/v1/query_language/spec/#identifiers) - * [Keywords](/enterprise_influxdb/v1/query_language/spec/#keywords) - * [Literals](/enterprise_influxdb/v1/query_language/spec/#literals) -* [Queries](/enterprise_influxdb/v1/query_language/spec/#queries) -* [Statements](/enterprise_influxdb/v1/query_language/spec/#statements) -* [Clauses](/enterprise_influxdb/v1/query_language/spec/#clauses) -* [Expressions](/enterprise_influxdb/v1/query_language/spec/#expressions) -* [Comments](/enterprise_influxdb/v1/query_language/spec/#comments) -* [Other](/enterprise_influxdb/v1/query_language/spec/#other) - -To learn more about InfluxQL, browse the following topics: - -* [Explore your data with InfluxQL](/enterprise_influxdb/v1/query_language/explore-data/) -* [Explore your schema with InfluxQL](/enterprise_influxdb/v1/query_language/explore-schema/) -* [Database management](/enterprise_influxdb/v1/query_language/manage-database/) -* [Authentication and authorization](/enterprise_influxdb/v1/administration/authentication_and_authorization/). -* [Query engine internals](/enterprise_influxdb/v1/query_language/spec/#query-engine-internals) +- [Notation](#notation) +- [Query representation](#query-representation) + - [Characters](#characters) + - [Letters and digits](#letters-and-digits) + - [Identifiers](#identifiers) + - [Keywords](#keywords) + - [Literals](#literals) +- [Queries](#queries) +- [Statements](#statements) +- [Clauses](#clauses) +- [Expressions](#expressions) +- [Comments](#comments) +- [Other](#other) ## Notation The syntax is specified using Extended Backus-Naur Form ("EBNF"). -EBNF is the same notation used in the [Go](http://golang.org) programming language specification, -which can be found [here](https://golang.org/ref/spec). +EBNF is the same notation used in the [Go programming language specification](https://golang.org/ref/spec). ``` Production = production_name "=" [ Expression ] "." . @@ -95,7 +85,7 @@ The rules: - double quoted identifiers can contain any unicode character other than a new line - double quoted identifiers can contain escaped `"` characters (i.e., `\"`) -- double quoted identifiers can contain InfluxQL [keywords](/enterprise_influxdb/v1/query_language/spec/#keywords) +- double quoted identifiers can contain InfluxQL [keywords](#keywords) - unquoted identifiers must start with an upper or lowercase ASCII character or "_" - unquoted identifiers may contain only ASCII letters, decimal digits, and "_" @@ -133,7 +123,7 @@ SUBSCRIPTIONS TAG TO USER USERS VALUES WHERE WITH WRITE ``` -If you use an InfluxQL keywords as an +If you use an InfluxQL keyword as an [identifier](/enterprise_influxdb/v1/concepts/glossary/#identifier) you will need to double quote that identifier in every query. @@ -149,7 +139,7 @@ In those cases, `time` does not require double quotes in queries. `time` cannot be a [field key](/enterprise_influxdb/v1/concepts/glossary/#field-key) or [tag key](/enterprise_influxdb/v1/concepts/glossary/#tag-key); InfluxDB rejects writes with `time` as a field key or tag key and returns an error. -See [Frequently Asked Questions](/enterprise_influxdb/v1/troubleshooting/frequently-asked-questions/#time) for more information. +For more information, see [Frequently Asked Questions](/enterprise_influxdb/v1/troubleshooting/frequently-asked-questions/#time). ### Literals @@ -199,6 +189,7 @@ Durations can be specified with mixed units. | d | day | | w | week | + ``` duration_lit = int_lit duration_unit . duration_unit = "ns" | "u" | "µ" | "ms" | "s" | "m" | "h" | "d" | "w" . @@ -232,18 +223,22 @@ regex_lit = "/" { unicode_char } "/" . `=~` matches against `!~` doesn't match against -> **Note:** InfluxQL supports using regular expressions when specifying: + +InfluxQL supports using regular expressions when specifying: + +- [field keys](/enterprise_influxdb/v1/concepts/glossary/#field-key) and [tag keys](/enterprise_influxdb/v1/concepts/glossary/#tag-key) in the [`SELECT` clause](/enterprise_influxdb/v1/query_language/explore-data/#the-basic-select-statement) +- [measurements](/enterprise_influxdb/v1/concepts/glossary/#measurement) in the [`FROM` clause](/enterprise_influxdb/v1/query_language/explore-data/#the-basic-select-statement) +- [tag values](/enterprise_influxdb/v1/concepts/glossary/#tag-value) and string [field values](/enterprise_influxdb/v1/concepts/glossary/#field-value) in the [`WHERE` clause](/enterprise_influxdb/v1/query_language/explore-data/#the-where-clause). +- [tag keys](/enterprise_influxdb/v1/concepts/glossary/#tag-key) in the [`GROUP BY` clause](/enterprise_influxdb/v1/query_language/explore-data/#group-by-tags) + +> [!Note] +> #### Regular expressions and non-string field values > -* [field keys](/enterprise_influxdb/v1/concepts/glossary/#field-key) and [tag keys](/enterprise_influxdb/v1/concepts/glossary/#tag-key) in the [`SELECT` clause](/enterprise_influxdb/v1/query_language/explore-data/#the-basic-select-statement) -* [measurements](/enterprise_influxdb/v1/concepts/glossary/#measurement) in the [`FROM` clause](/enterprise_influxdb/v1/query_language/explore-data/#the-basic-select-statement) -* [tag values](/enterprise_influxdb/v1/concepts/glossary/#tag-value) and string [field values](/enterprise_influxdb/v1/concepts/glossary/#field-value) in the [`WHERE` clause](/enterprise_influxdb/v1/query_language/explore-data/#the-where-clause). -* [tag keys](/enterprise_influxdb/v1/concepts/glossary/#tag-key) in the [`GROUP BY` clause](/enterprise_influxdb/v1/query_language/explore-data/#group-by-tags) -> ->Currently, InfluxQL does not support using regular expressions to match ->non-string field values in the ->`WHERE` clause, ->[databases](/enterprise_influxdb/v1/concepts/glossary/#database), and ->[retention polices](/enterprise_influxdb/v1/concepts/glossary/#retention-policy-rp). +> Currently, InfluxQL does not support using regular expressions to match +> non-string field values in the +> `WHERE` clause, +> [databases](/enterprise_influxdb/v1/concepts/glossary/#database), and +> [retention policies](/enterprise_influxdb/v1/concepts/glossary/#retention-policy-rp). ## Queries @@ -308,6 +303,8 @@ alter_retention_policy_stmt = "ALTER RETENTION POLICY" policy_name on_clause retention_policy_option [ retention_policy_option ] [ retention_policy_option ] + [ retention_policy_option ] + [ retention_policy_option ] [ retention_policy_option ] . ``` @@ -320,6 +317,9 @@ ALTER RETENTION POLICY "1h.cpu" ON "mydb" DEFAULT -- Change duration and replication factor. -- REPLICATION (replication factor) not valid for OSS instances. ALTER RETENTION POLICY "policy1" ON "somedb" DURATION 1h REPLICATION 4 + +-- Change future and past limits. +ALTER RETENTION POLICY "policy1" ON "somedb" FUTURE LIMIT 6h PAST LIMIT 6h ``` ### CREATE CONTINUOUS QUERY @@ -379,13 +379,16 @@ create_database_stmt = "CREATE DATABASE" db_name [ WITH [ retention_policy_duration ] [ retention_policy_replication ] - [ retention_past_limit ] - [ retention_future_limit ] [ retention_policy_shard_group_duration ] + [ retention_future_limit ] + [ retention_past_limit ] [ retention_policy_name ] ] . ``` +> [!Note] +> When using both `FUTURE LIMIT` and `PAST LIMIT` clauses, `FUTURE LIMIT` must appear before `PAST LIMIT`. + > [!Warning] > Replication factors do not serve a purpose with single node instances. @@ -404,8 +407,8 @@ CREATE DATABASE "bar" WITH DURATION 1d REPLICATION 1 SHARD DURATION 30m NAME "my 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" +-- specify the duration, future and past limits, and name of that retention policy +CREATE DATABASE "bar" WITH DURATION 1d FUTURE LIMIT 6h PAST LIMIT 6h NAME "myrp" ``` ### CREATE RETENTION POLICY @@ -415,11 +418,14 @@ 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 ] + [ retention_past_limit ] [ "DEFAULT" ] . ``` +> [!Note] +> When using both `FUTURE LIMIT` and `PAST LIMIT` clauses, `FUTURE LIMIT` must appear before `PAST LIMIT`. + > [!Warning] > Replication factors do not serve a purpose with single node instances. @@ -435,8 +441,8 @@ 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 a retention policy and specify future and past limits. +CREATE RETENTION POLICY "10m.events" ON "somedb" DURATION 12h FUTURE LIMIT 6h PAST LIMIT 6h ``` ### CREATE SUBSCRIPTION @@ -631,7 +637,7 @@ SIZE OF BLOCKS: 931 ### EXPLAIN ANALYZE -Executes the specified SELECT statement and returns data on the query performance and storage during runtime, visualized as a tree. Use this statement to analyze query performance and storage, including [execution time](#execution-time) and [planning time](#planning-time), and the [iterator type](#iterator-type) and [cursor type](#cursor-type). +Executes the specified SELECT statement and returns data on the query performance and storage during runtime, visualized as a tree. Use this statement to analyze query performance and storage, including [execution time](#execution_time) and [planning time](#planning_time), and the [iterator type](#iterator-type) and [cursor type](#cursor-type). For example, executing the following statement: @@ -677,11 +683,11 @@ EXPLAIN ANALYZE > Note: EXPLAIN ANALYZE ignores query output, so the cost of serialization to JSON or CSV is not accounted for. -##### execution_time +#### execution_time Shows the amount of time the query took to execute, including reading the time series data, performing operations as data flows through iterators, and draining processed data from iterators. Execution time doesn't include the time taken to serialize the output into JSON or other formats. -##### planning_time +#### planning_time Shows the amount of time the query took to plan. Planning a query in InfluxDB requires a number of steps. Depending on the complexity of the query, planning can require more work and consume more CPU and memory resources than the executing the query. For example, the number of series keys required to execute a query affects how quickly the query is planned and the required memory. @@ -694,16 +700,16 @@ Next, for each shard and each measurement, InfluxDB performs the following steps 3. Enumerate each tag set and create a cursor and iterator for each series key. 4. Merge iterators and return the merged result to the query executor. -##### iterator type +#### iterator type EXPLAIN ANALYZE supports the following iterator types: - `create_iterator` node represents work done by the local influxd instance──a complex composition of nested iterators combined and merged to produce the final query output. - (InfluxDB Enterprise only) `remote_iterator` node represents work done on remote machines. -For more information about iterators, see [Understanding iterators](#understanding-iterators). +For more information about iterators, see [Understanding iterators](/influxdb/v1/query_language/spec/#understanding-iterators). -##### cursor type +#### cursor type EXPLAIN ANALYZE distinguishes 3 cursor types. While the cursor types have the same data structures and equal CPU and I/O costs, each cursor type is constructed for a different reason and separated in the final output. Consider the following cursor types when tuning a statement: @@ -711,9 +717,9 @@ EXPLAIN ANALYZE distinguishes 3 cursor types. While the cursor types have the sa - cursor_aux: Auxiliary cursor created for simple expression projections (not selectors or an aggregation). For example, `SELECT foo FROM m` or `SELECT foo+bar FROM m`, where `foo` and `bar` are fields. - cursor_cond: Condition cursor created for fields referenced in a WHERE clause. -For more information about cursors, see [Understanding cursors](#understanding-cursors). +For more information about cursors, see [Understanding cursors](/influxdb/v1/query_language/spec/#understanding-cursors). -##### block types +#### block types EXPLAIN ANALYZE separates storage block types, and reports the total number of blocks decoded and their size (in bytes) on disk. The following block types are supported: @@ -727,7 +733,8 @@ For more information about storage blocks, see [TSM files](/enterprise_influxdb/ ### GRANT -> **NOTE:** Users can be granted privileges on databases that do not yet exist. +> [!Note] +> Users can be granted privileges on databases that do not yet exist. ``` grant_stmt = "GRANT" privilege [ on_clause ] to_clause . @@ -745,29 +752,27 @@ GRANT READ ON "mydb" TO "jdoe" ### KILL QUERY -Stop currently-running query. +Stop a currently-running query. -``` -kill_query_statement = "KILL QUERY" query_id . +#### Syntax + +```text +KILL QUERY [ON ""] ``` -Where `query_id` is the query ID, displayed in the [`SHOW QUERIES`](/enterprise_influxdb/v1/troubleshooting/query_management/#list-currently-running-queries-with-show-queries) output as `qid`. +Replace the following: -> ***InfluxDB Enterprise clusters:*** To kill queries on a cluster, you need to specify the query ID (qid) and the TCP host (for example, `myhost:8088`), -> available in the `SHOW QUERIES` output. -> -> ```sql -KILL QUERY ON "" -``` +- `query_id`: your query ID (`qid`) from [`SHOW QUERIES`](/influxdb/v1/troubleshooting/query_management/#list-currently-running-queries-with-show-queries) +- `host`: your TCP host (for example, `myhost:8088`) from [`SHOW QUERIES`](/influxdb/v1/troubleshooting/query_management/#list-currently-running-queries-with-show-queries) + +To kill queries on a cluster, specify both the query ID and the TCP host. #### Examples ```sql -- kill query with qid of 36 on the local host KILL QUERY 36 -``` -```sql -- kill query on InfluxDB Enterprise cluster KILL QUERY 53 ON "myhost:8088" ``` @@ -1004,7 +1009,8 @@ Estimates or counts exactly the cardinality of the series for the current databa - [When do I need more RAM?](/enterprise_influxdb/v1/guides/hardware_sizing/#when-do-i-need-more-ram) in [Hardware Sizing Guidelines](/enterprise_influxdb/v1/guides/hardware_sizing/) - [Don't have too many series](/enterprise_influxdb/v1/concepts/schema_and_data_layout/#avoid-too-many-series) -> **Note:** `ON `, `FROM `, `WITH KEY = `, `WHERE `, `GROUP BY `, and `LIMIT/OFFSET` clauses are optional. +> [!Note] +> `ON `, `FROM `, `WITH KEY = `, `WHERE `, `GROUP BY `, and `LIMIT/OFFSET` clauses are optional. > When using these query clauses, the query falls back to an exact count. > Filtering by `time` is not supported in the `WHERE` clause. @@ -1066,7 +1072,7 @@ id database retention_policy shard_group start_time end_time - `id` column: Shard IDs that belong to the specified `database` and `retention policy`. - `shard_group` column: Group number that a shard belongs to. Shards in the same shard group have the same `start_time` and `end_time`. This interval indicates how long the shard is active, and the `expiry_time` columns shows when the shard group expires. No timestamps will show under `expiry_time` if the retention policy duration is set to infinite. - `owners` column: Shows the data nodes that own a shard. The number of nodes that own a shard is equal to the replication factor. In this example, the replication factor is 3, so 3 nodes own each shard. - + ### SHOW STATS Returns detailed statistics on available components of an InfluxDB node and available (enabled) components. @@ -1099,18 +1105,17 @@ batches_tx bytes_rx connections_active connections_handled 159 3999750 0 1 158110 158110 ``` -### `SHOW STATS FOR ` +### SHOW STATS FOR For the specified component (\), the command returns available statistics. For the `runtime` component, the command returns an overview of memory usage by the InfluxDB system, using the [Go runtime](https://golang.org/pkg/runtime/) package. -### `SHOW STATS FOR 'indexes'` +### SHOW STATS FOR 'indexes' Returns an estimate of memory use of all indexes. Index memory use is not reported with `SHOW STATS` because it is a potentially expensive operation. - ### SHOW SUBSCRIPTIONS ``` @@ -1127,7 +1132,8 @@ SHOW SUBSCRIPTIONS Estimates or counts exactly the cardinality of tag key set on the current database unless a database is specified using the `ON ` option. -> **Note:** `ON `, `FROM `, `WITH KEY = `, `WHERE `, `GROUP BY `, and `LIMIT/OFFSET` clauses are optional. +> [!Note] +> `ON `, `FROM `, `WITH KEY = `, `WHERE `, `GROUP BY `, and `LIMIT/OFFSET` clauses are optional. > When using these query clauses, the query falls back to an exact count. > Filtering by `time` is only supported when TSI (Time Series Index) is enabled and `time` is not supported in the `WHERE` clause. @@ -1149,7 +1155,7 @@ SHOW TAG KEY EXACT CARDINALITY ### SHOW TAG KEYS ``` -show_tag_keys_stmt = "SHOW TAG KEYS" [on_clause] [ from_clause ] [ where_clause ] +show_tag_keys_stmt = "SHOW TAG KEYS" [on_clause] [with_key_clause] [ from_clause ] [ where_clause ] [ limit_clause ] [ offset_clause ] . ``` @@ -1167,6 +1173,9 @@ SHOW TAG KEYS FROM "cpu" WHERE "region" = 'uswest' -- show all tag keys where the host key = 'serverA' SHOW TAG KEYS WHERE "host" = 'serverA' + +-- show specific tag keys +SHOW TAG KEYS WITH KEY IN ("region", "host") ``` ### SHOW TAG VALUES @@ -1196,7 +1205,8 @@ SHOW TAG VALUES FROM "cpu" WITH KEY IN ("region", "host") WHERE "service" = 'red Estimates or counts exactly the cardinality of tag key values for the specified tag key on the current database unless a database is specified using the `ON ` option. -> **Note:** `ON `, `FROM `, `WITH KEY = `, `WHERE `, `GROUP BY `, and `LIMIT/OFFSET` clauses are optional. +> [!Note] +> `ON `, `FROM `, `WITH KEY = `, `WHERE `, `GROUP BY `, and `LIMIT/OFFSET` clauses are optional. > When using these query clauses, the query falls back to an exact count. > Filtering by `time` is only supported when TSI (Time Series Index) is enabled. @@ -1332,6 +1342,8 @@ retention_policy = identifier . retention_policy_option = retention_policy_duration | retention_policy_replication | retention_policy_shard_group_duration | + retention_future_limit | + retention_past_limit | "DEFAULT" . retention_policy_duration = "DURATION" duration_lit . @@ -1340,6 +1352,10 @@ retention_policy_replication = "REPLICATION" int_lit . retention_policy_shard_group_duration = "SHARD DURATION" duration_lit . +retention_future_limit = "FUTURE LIMIT" duration_lit . + +retention_past_limit = "PAST LIMIT" duration_lit . + retention_policy_name = "NAME" identifier . series_id = int_lit . diff --git a/content/enterprise_influxdb/v1/tools/influxd-ctl/backup.md b/content/enterprise_influxdb/v1/tools/influxd-ctl/backup.md index 0c3e06469..bab03a74e 100644 --- a/content/enterprise_influxdb/v1/tools/influxd-ctl/backup.md +++ b/content/enterprise_influxdb/v1/tools/influxd-ctl/backup.md @@ -48,22 +48,49 @@ influxd-ctl backup [flags] ## Flags -| Flag | Description | -| :---------- | :------------------------------------------------------------------ | -| `-db` | Database to backup | -| `-end` | End date for backup _(RFC3339 timestamp)_ | -| `-estimate` | Estimate the size of the requested backup | -| `-from` | Data node TCP address to prefer when backing up | -| `-full` | Perform an full backup _(deprecated in favour of `-strategy full`)_ | -| `-rp` | Retention policy to backup | -| `-shard` | Shard ID to backup | -| `-start` | Start date for backup _(RFC3339 timestamp)_ | -| `-strategy` | Backup strategy to use (`only-meta`, `full`, or `incremental`) | +| Flag | Description | +| :---------------------- | :------------------------------------------------------------------ | +| `-db` | Database to backup | +| `-end` | End date for backup _(RFC3339 timestamp)_ | +| `-estimate` | Estimate the size of the requested backup | +| `-from` | Data node TCP address to prefer when backing up | +| `-full` | Perform a full backup _(deprecated in favor of `-strategy full`)_ | +| `-rp` | Retention policy to backup | +| `-shard` | Shard ID to backup | +| `-start` | Start date for backup _(RFC3339 timestamp)_ | +| `-strategy` | Backup strategy to use (`only-meta`, `full`, or `incremental`) | +| `-gzipCompressionLevel` | Level of compression to use (`default`, `full`, `speedy`, `none`) | +| `-cpuprofile` | Write backup execution to a cpu profile (`true` or `false`) | +| `-gzipBlockCount` | Change the blocks processed concurrently during backup compression | +| `-gzipBlockSize` | Change the size of compressed blocks during backup compression | {{% caption %}} _Also see [`influxd-ctl` global flags](/enterprise_influxdb/v1/tools/influxd-ctl/#influxd-ctl-global-flags)._ {{% /caption %}} +## Backup compression {metadata="v1.12.3+"} + +You can adjust `-gzipCompressionLevel` to allow for faster backups with the tradeoff that data is less compressed. + +| Value | Description | Use Case | +| :------ | :--------------------------------- | :------------------------------------------ | +| default | Standard gzip compression | General purpose, balanced | +| full | Best compression ratio | Minimize storage when time isn't critical | +| speedy | Prioritizes speed over compression | Faster backups with moderate space increase | +| none | No compression | Maximum speed when storage isn't a concern | + +Running backups with different compression settings on ~5.3 GB of data: + +| Compression Level | Backup Time | Size on Disk | Notes | +| :---------------- | :---------: | :----------: | :---------------------------- | +| default | 51s | ~3.0 GB | ~50% compression ratio | +| full | 95s | ~2.7 GB | ~2x slower, ~10% less space | +| speedy | 23s | ~3.3 GB | ~2.2x faster, ~10% more space | +| none | 10s | ~5.3 GB | ~5x faster, ~77% more space | + +We do not recommend changing the values for `-gzipBlockCount` and `-gzipBlockSize`. +These are set to sensible defaults (block size is `1048576` bytes (`1024*1024`)) per the [pgzip library](https://github.com/klauspost/pgzip). + ## Examples - [Perform an incremental backup](#perform-an-incremental-backup) @@ -71,6 +98,7 @@ _Also see [`influxd-ctl` global flags](/enterprise_influxdb/v1/tools/influxd-ctl - [Estimate the size of a backup](#estimate-the-size-of-a-backup) - [Backup data from a specific time range](#backup-data-from-a-specific-time-range) - [Backup a specific shard](#backup-a-specific-shard) +- [Backup data with configured compression](#backup-data-with-configured-compression) ### Perform an incremental backup @@ -104,3 +132,11 @@ influxd-ctl backup \ ```sh influxd-ctl backup -shard 00 /path/to/backup-dir ``` + +### Backup data with configured compression + +The following example uses the fastest possible compression speeds for backup: + +```sh +influxd-ctl backup -strategy full -gzipBlockSize 10485760 -gzipBlockCount 28 -gzipCompressionLevel none . +``` diff --git a/content/influxdb/v1/about_the_project/release-notes.md b/content/influxdb/v1/about_the_project/release-notes.md index 986ccfa81..b60c0aaac 100644 --- a/content/influxdb/v1/about_the_project/release-notes.md +++ b/content/influxdb/v1/about_the_project/release-notes.md @@ -14,6 +14,50 @@ alt_links: --- +## v1.12.3 {date="2026-01-12"} + +### Features + +- Add [`https-insecure-certificate` configuration option](/influxdb/v1/administration/config/#https-insecure-certificate) + to skip file permission checking for TLS certificate and private key files. +- Add [`advanced-expiration` TLS configuration option](/influxdb/v1/administration/config/#advanced-expiration) + to configure how far in advance to log warnings about TLS certificate expiration. +- Add TLS certificate reloading on `SIGHUP`. +- Add `config` and `cq` (continuous query) diagnostics to the `/debug/vars` endpoint. +- Improve dropped point logging. +- Show user when displaying or logging queries. +- Add `time_format` parameter for the HTTP API. +- Use dynamic logging levels (`zap.AtomicLevel`). +- Report user query bytes. + +### Bug fixes + +- Fix `FUTURE LIMIT` and `PAST LIMIT` + [clause order](/influxdb/v1/query_language/manage-database/#future-limit) + in retention policy statements. +- Add locking in `ClearBadShardList`. +- Stop noisy logging about phantom shards that do not belong to a node. +- Resolve `RLock()` leakage in `Store.DeleteSeries()`. +- Fix condition check for optimization of array cursor (tsm1). +- Run `init.sh` `buildtsi` as `influxdb` user. +- Reduce unnecessary purger operations and logging. +- Sort files for adjacency testing. +- Fix operator in host detection (systemd). +- Use correct path in open WAL error message. +- Handle nested low-level files in compaction. +- Correct error logic for writing empty index files. +- Reduce lock contention and races in purger. +- Fix bug with authorizer leakage in `SHOW QUERIES`. +- Rename compact throughput logging keys. +- Fix `https-insecure-certificate` not handled properly in httpd. +- Prevent level regression when compacting mixed-level TSM files. + +### Other + +- Update Go to 1.24.13. + +--- + ## v1.12.2 {date="2025-09-15"} ### Features @@ -340,7 +384,7 @@ reporting an earlier error. - Use latest version of InfluxQL package. - Add `-lponly` flag to [`influx export`](/influxdb/v2/reference/cli/influx/export/) sub-command. -- Add the ability to [track number of values](/platform/monitoring/influxdata-platform/tools/measurements-internal/#valueswrittenok) written via the [/debug/vars HTTP endpoint](/influxdb/v1/tools/api/#debug-vars-http-endpoint). +- Add the ability to [track number of values](/platform/monitoring/influxdata-platform/tools/measurements-internal/#valueswrittenok) written via the [`/debug/vars` HTTP endpoint](/influxdb/v1/tools/api/#debugvars-http-endpoint). - Update UUID library from [github.com/satori/go.uuid](https://github.com/satori/go.uuid) to [github.com/gofrs/uuid](https://github.com/gofrs/uuid). ### Bug fixes @@ -637,7 +681,7 @@ Support for the Flux language and queries has been added in this release. To beg - Enable Flux using the new configuration setting [`[http] flux-enabled = true`](/influxdb/v1/administration/config/#flux-enabled). -- Use the new [`influx -type=flux`](/influxdb/v1/tools/shell/#type) option to enable the Flux REPL shell for creating Flux queries. +- Use the new [`influx -type=flux`](/influxdb/v1/tools/influx-cli/) 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. #### Time Series Index (TSI) query performance and throughputs improvements diff --git a/content/influxdb/v1/administration/config.md b/content/influxdb/v1/administration/config.md index 3930a5395..196d0cd3a 100644 --- a/content/influxdb/v1/administration/config.md +++ b/content/influxdb/v1/administration/config.md @@ -933,7 +933,7 @@ effect if [`auth-enabled`](#auth-enabled) is set to `false`. 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) +[security headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers#security) such as `X-Frame-Options` or `Content Security Policy` where needed. Example: @@ -964,9 +964,16 @@ 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**: `""` +**Default**: `""` **Environment variable**: `INFLUXDB_HTTP_HTTPS_PRIVATE_KEY` +#### https-insecure-certificate {metadata="v1.12.3+"} + +Skips file permission checking for `https-certificate` and `https-private-key` when `true`. + +**Default**: `false` +**Environment variable**: `INFLUXDB_HTTP_HTTPS_INSECURE_CERTIFICATE` + #### shared-secret The shared secret used to validate public API requests using JWT tokens. @@ -1638,5 +1645,12 @@ include: `tls1.0`, `tls1.1`, `tls1.2`, and `tls1.3`. If not specified, 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` +**Default**: `tls1.3` **Environment variable**: `INFLUXDB_TLS_MAX_VERSION` + +#### advanced-expiration {metadata="v1.12.3+"} + +Sets how far in advance to log warnings about TLS certificate expiration. + +**Default**: `5d` +**Environment variable**: `INFLUXDB_TLS_ADVANCED_EXPIRATION` diff --git a/content/influxdb/v1/query_language/manage-database.md b/content/influxdb/v1/query_language/manage-database.md index 4db5d236c..62e5e4285 100644 --- a/content/influxdb/v1/query_language/manage-database.md +++ b/content/influxdb/v1/query_language/manage-database.md @@ -62,15 +62,15 @@ 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 ] [FUTURE LIMIT ] [PAST LIMIT ] [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 +The `WITH`, `DURATION`, `REPLICATION`, `SHARD DURATION`, `FUTURE LIMIT`, +`PAST 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 @@ -259,7 +259,7 @@ You may disable its auto-creation in the [configuration file](/influxdb/v1/admin #### Syntax ```sql -CREATE RETENTION POLICY ON DURATION REPLICATION [SHARD DURATION ] [PAST LIMIT ] [FUTURE LIMIT ] [DEFAULT] +CREATE RETENTION POLICY ON DURATION REPLICATION [SHARD DURATION ] [FUTURE LIMIT ] [PAST LIMIT ] [DEFAULT] ``` #### Description of syntax @@ -307,6 +307,17 @@ See [Shard group duration management](/influxdb/v1/concepts/schema_and_data_layout/#shard-group-duration-management) for recommended configurations. +##### `FUTURE LIMIT` {metadata="v1.12.0+"} + +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. + ##### `PAST LIMIT` {metadata="v1.12.0+"} The `PAST LIMIT` clause defines a time boundary before and relative to _now_ @@ -318,25 +329,6 @@ 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. -> [!Important] -> `PAST LIMIT` cannot be changed after it is set. -> This will be fixed in a future release. - -##### `FUTURE LIMIT` {metadata="v1.12.0+"} - -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. - -> [!Important] -> `FUTURE LIMIT` cannot be changed after it is set. -> This will be fixed in a future release. - ##### `DEFAULT` Sets the new retention policy as the default retention policy for the database. @@ -372,14 +364,17 @@ See [Create a database with CREATE DATABASE](/influxdb/v1/query_language/manage- ### Modify retention policies with ALTER RETENTION POLICY -The `ALTER RETENTION POLICY` query takes the following form, where you must declare at least one of the retention policy attributes `DURATION`, `REPLICATION`, `SHARD DURATION`, or `DEFAULT`: +The `ALTER RETENTION POLICY` query takes the following form, where you must declare at least one of the retention policy attributes `DURATION`, `REPLICATION`, `SHARD DURATION`, `FUTURE LIMIT`, `PAST LIMIT`, or `DEFAULT`: ```sql -ALTER RETENTION POLICY ON [DURATION ] [REPLICATION ] [SHARD DURATION ] [DEFAULT] +ALTER RETENTION POLICY ON [DURATION ] [REPLICATION ] [SHARD DURATION ] [FUTURE LIMIT ] [PAST LIMIT ] [DEFAULT] ``` {{% warn %}} Replication factors do not serve a purpose with single node instances. {{% /warn %}} +For information about the `FUTURE LIMIT` and `PAST LIMIT` clauses, see +[CREATE RETENTION POLICY](#create-retention-policies-with-create-retention-policy). + First, create the retention policy `what_is_time` with a `DURATION` of two days: ```sql > CREATE RETENTION POLICY "what_is_time" ON "NOAA_water_database" DURATION 2d REPLICATION 1 diff --git a/content/influxdb/v1/query_language/spec.md b/content/influxdb/v1/query_language/spec.md index 3805d558f..b7526ee07 100644 --- a/content/influxdb/v1/query_language/spec.md +++ b/content/influxdb/v1/query_language/spec.md @@ -1,6 +1,6 @@ --- title: Influx Query Language (InfluxQL) reference -description: List of resources for Influx Query Language (InfluxQL). +description: InfluxQL is a SQL-like query language for interacting with InfluxDB and providing features specific to storing and analyzing time series data. menu: influxdb_v1: name: InfluxQL reference @@ -8,38 +8,32 @@ menu: parent: InfluxQL aliases: - /influxdb/v2/query_language/spec/ +related: + - /influxdb/v1/query_language/explore-data/ + - /influxdb/v1/query_language/explore-schema/ + - /influxdb/v1/query_language/manage-database/ --- -## Introduction +InfluxQL is a SQL-like query language for interacting with InfluxDB +and providing features specific to storing and analyzing time series data. -Find Influx Query Language (InfluxQL) definitions and details, including: - -- [Notation](/influxdb/v1/query_language/spec/#notation) -- [Query representation](/influxdb/v1/query_language/spec/#query-representation) -- [Identifiers](/influxdb/v1/query_language/spec/#identifiers) -- [Keywords](/influxdb/v1/query_language/spec/#keywords) -- [Literals](/influxdb/v1/query_language/spec/#literals) -- [Queries](/influxdb/v1/query_language/spec/#queries) -- [Statements](/influxdb/v1/query_language/spec/#statements) -- [Clauses](/influxdb/v1/query_language/spec/#clauses) -- [Expressions](/influxdb/v1/query_language/spec/#expressions) -- [Other](/influxdb/v1/query_language/spec/#other) -- [Query engine internals](/influxdb/v1/query_language/spec/#query-engine-internals) - -To learn more about InfluxQL, browse the following topics: - -- [Explore your data with InfluxQL](/influxdb/v1/query_language/explore-data/) -- [Explore your schema with InfluxQL](/influxdb/v1/query_language/explore-schema/) -- [Database management](/influxdb/v1/query_language/manage-database/) -- [Authentication and authorization](/influxdb/v1/administration/authentication_and_authorization/). - -InfluxQL is a SQL-like query language for interacting with InfluxDB and providing features specific to storing and analyzing time series data. +- [Notation](#notation) +- [Query representation](#query-representation) +- [Identifiers](#identifiers) +- [Keywords](#keywords) +- [Literals](#literals) +- [Queries](#queries) +- [Statements](#statements) +- [Clauses](#clauses) +- [Expressions](#expressions) +- [Comments](#comments) +- [Other](#other) +- [Query engine internals](#query-engine-internals) ## Notation The syntax is specified using Extended Backus-Naur Form ("EBNF"). -EBNF is the same notation used in the [Go](http://golang.org) programming language specification, which can be found [here](https://golang.org/ref/spec). -Not so coincidentally, InfluxDB is written in Go. +EBNF is the same notation used in the [Go programming language specification](https://golang.org/ref/spec). ``` Production = production_name "=" [ Expression ] "." . @@ -91,7 +85,7 @@ The rules: - double quoted identifiers can contain any unicode character other than a new line - double quoted identifiers can contain escaped `"` characters (i.e., `\"`) -- double quoted identifiers can contain InfluxQL [keywords](/influxdb/v1/query_language/spec/#keywords) +- double quoted identifiers can contain InfluxQL [keywords](#keywords) - unquoted identifiers must start with an upper or lowercase ASCII character or "_" - unquoted identifiers may contain only ASCII letters, decimal digits, and "_" @@ -129,7 +123,7 @@ SUBSCRIPTIONS TAG TO USER USERS VALUES WHERE WITH WRITE ``` -If you use an InfluxQL keywords as an +If you use an InfluxQL keyword as an [identifier](/influxdb/v1/concepts/glossary/#identifier) you will need to double quote that identifier in every query. @@ -145,7 +139,7 @@ In those cases, `time` does not require double quotes in queries. `time` cannot be a [field key](/influxdb/v1/concepts/glossary/#field-key) or [tag key](/influxdb/v1/concepts/glossary/#tag-key); InfluxDB rejects writes with `time` as a field key or tag key and returns an error. -See [Frequently Asked Questions](/influxdb/v1/troubleshooting/frequently-asked-questions/#time) for more information. +For more information, see [Frequently Asked Questions](/influxdb/v1/troubleshooting/frequently-asked-questions/#time). ## Literals @@ -229,19 +223,22 @@ regex_lit = "/" { unicode_char } "/" . `=~` matches against `!~` doesn't match against + +InfluxQL supports using regular expressions when specifying: + +- [field keys](/influxdb/v1/concepts/glossary/#field-key) and [tag keys](/influxdb/v1/concepts/glossary/#tag-key) in the [`SELECT` clause](/influxdb/v1/query_language/explore-data/#the-basic-select-statement) +- [measurements](/influxdb/v1/concepts/glossary/#measurement) in the [`FROM` clause](/influxdb/v1/query_language/explore-data/#the-basic-select-statement) +- [tag values](/influxdb/v1/concepts/glossary/#tag-value) and string [field values](/influxdb/v1/concepts/glossary/#field-value) in the [`WHERE` clause](/influxdb/v1/query_language/explore-data/#the-where-clause). +- [tag keys](/influxdb/v1/concepts/glossary/#tag-key) in the [`GROUP BY` clause](/influxdb/v1/query_language/explore-data/#group-by-tags) + > [!Note] -> InfluxQL supports using regular expressions when specifying: +> #### Regular expressions and non-string field values > -> * [field keys](/influxdb/v1/concepts/glossary/#field-key) and [tag keys](/influxdb/v1/concepts/glossary/#tag-key) in the [`SELECT` clause](/influxdb/v1/query_language/explore-data/#the-basic-select-statement) -> * [measurements](/influxdb/v1/concepts/glossary/#measurement) in the [`FROM` clause](/influxdb/v1/query_language/explore-data/#the-basic-select-statement) -> * [tag values](/influxdb/v1/concepts/glossary/#tag-value) and string [field values](/influxdb/v1/concepts/glossary/#field-value) in the [`WHERE` clause](/influxdb/v1/query_language/explore-data/#the-where-clause). -> * [tag keys](/influxdb/v1/concepts/glossary/#tag-key) in the [`GROUP BY` clause](/influxdb/v1/query_language/explore-data/#group-by-tags) -> ->Currently, InfluxQL does not support using regular expressions to match ->non-string field values in the ->`WHERE` clause, ->[databases](/influxdb/v1/concepts/glossary/#database), and ->[retention polices](/influxdb/v1/concepts/glossary/#retention-policy-rp). +> Currently, InfluxQL does not support using regular expressions to match +> non-string field values in the +> `WHERE` clause, +> [databases](/influxdb/v1/concepts/glossary/#database), and +> [retention policies](/influxdb/v1/concepts/glossary/#retention-policy-rp). ## Queries @@ -306,6 +303,8 @@ alter_retention_policy_stmt = "ALTER RETENTION POLICY" policy_name on_clause retention_policy_option [ retention_policy_option ] [ retention_policy_option ] + [ retention_policy_option ] + [ retention_policy_option ] [ retention_policy_option ] . ``` @@ -318,6 +317,9 @@ ALTER RETENTION POLICY "1h.cpu" ON "mydb" DEFAULT -- Change duration and replication factor. -- REPLICATION (replication factor) not valid for OSS instances. ALTER RETENTION POLICY "policy1" ON "somedb" DURATION 1h REPLICATION 4 + +-- Change future and past limits. +ALTER RETENTION POLICY "policy1" ON "somedb" FUTURE LIMIT 6h PAST LIMIT 6h ``` ### CREATE CONTINUOUS QUERY @@ -378,12 +380,15 @@ 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_past_limit ] [ retention_policy_name ] ] . ``` +> [!Note] +> When using both `FUTURE LIMIT` and `PAST LIMIT` clauses, `FUTURE LIMIT` must appear before `PAST LIMIT`. + > [!Warning] > Replication factors do not serve a purpose with single node instances. @@ -402,8 +407,8 @@ CREATE DATABASE "bar" WITH DURATION 1d REPLICATION 1 SHARD DURATION 30m NAME "my 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" +-- specify the duration, future and past limits, and name of that retention policy +CREATE DATABASE "bar" WITH DURATION 1d FUTURE LIMIT 6h PAST LIMIT 6h NAME "myrp" ``` ### CREATE RETENTION POLICY @@ -413,11 +418,14 @@ 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 ] + [ retention_past_limit ] [ "DEFAULT" ] . ``` +> [!Note] +> When using both `FUTURE LIMIT` and `PAST LIMIT` clauses, `FUTURE LIMIT` must appear before `PAST LIMIT`. + > [!Warning] > Replication factors do not serve a purpose with single node instances. @@ -433,8 +441,8 @@ 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 a retention policy and specify future and past limits. +CREATE RETENTION POLICY "10m.events" ON "somedb" DURATION 12h FUTURE LIMIT 6h PAST LIMIT 6h ``` ### CREATE SUBSCRIPTION @@ -629,7 +637,7 @@ SIZE OF BLOCKS: 931 ### EXPLAIN ANALYZE -Executes the specified SELECT statement and returns data on the query performance and storage during runtime, visualized as a tree. Use this statement to analyze query performance and storage, including [execution time](#execution-time) and [planning time](#planning-time), and the [iterator type](#iterator-type) and [cursor type](#cursor-type). +Executes the specified SELECT statement and returns data on the query performance and storage during runtime, visualized as a tree. Use this statement to analyze query performance and storage, including [execution time](#execution_time) and [planning time](#planning_time), and the [iterator type](#iterator-type) and [cursor type](#cursor-type). For example, executing the following statement: @@ -725,7 +733,8 @@ For more information about storage blocks, see [TSM files](/influxdb/v1/concepts ### GRANT -> **NOTE:** Users can be granted privileges on databases that do not yet exist. +> [!Note] +> Users can be granted privileges on databases that do not yet exist. ``` grant_stmt = "GRANT" privilege [ on_clause ] to_clause . @@ -743,20 +752,17 @@ GRANT READ ON "mydb" TO "jdoe" ### KILL QUERY -Stop currently-running query. +Stop a currently-running query. + +```sql +KILL QUERY +``` ``` kill_query_statement = "KILL QUERY" query_id . ``` -Where `query_id` is the query ID, displayed in the [`SHOW QUERIES`](/influxdb/v1/troubleshooting/query_management/#list-currently-running-queries-with-show-queries) output as `qid`. - -> ***InfluxDB Enterprise clusters:*** To kill queries on a cluster, you need to specify the query ID (qid) and the TCP host (for example, `myhost:8088`), -> available in the `SHOW QUERIES` output. -> -> ```sql -KILL QUERY ON "" -``` +Replace `query_id` with your query ID from [`SHOW QUERIES`](/influxdb/v1/troubleshooting/query_management/#list-currently-running-queries-with-show-queries), output as `qid`. #### Examples @@ -765,11 +771,6 @@ KILL QUERY ON "" KILL QUERY 36 ``` -```sql --- kill query on InfluxDB Enterprise cluster -KILL QUERY 53 ON "myhost:8088" -``` - ### REVOKE ```sql @@ -912,7 +913,7 @@ show_grants_stmt = "SHOW GRANTS FOR" user_name . SHOW GRANTS FOR "jdoe" ``` -#### SHOW MEASUREMENT CARDINALITY +### SHOW MEASUREMENT CARDINALITY Estimates or counts exactly the cardinality of the measurement set for the current database unless a database is specified using the `ON ` option. @@ -999,10 +1000,11 @@ Estimates or counts exactly the cardinality of the series for the current databa [Series cardinality](/influxdb/v1/concepts/glossary/#series-cardinality) is the major factor that affects RAM requirements. For more information, see: -- [When do I need more RAM?](/influxdb/v1/guides/hardware_sizing/#when-do-i-need-more-ram) in [Hardware Sizing Guidelines](/influxdb/v1/guides/hardware_sizing/) +- [Hardware Sizing Guidelines](/influxdb/v1/guides/hardware_sizing/) - [Don't have too many series](/influxdb/v1/concepts/schema_and_data_layout/#avoid-too-many-series) -> **Note:** `ON `, `FROM `, `WITH KEY = `, `WHERE `, `GROUP BY `, and `LIMIT/OFFSET` clauses are optional. +> [!Note] +> `ON `, `FROM `, `WITH KEY = `, `WHERE `, `GROUP BY `, and `LIMIT/OFFSET` clauses are optional. > When using these query clauses, the query falls back to an exact count. > Filtering by `time` is not supported in the `WHERE` clause. @@ -1069,26 +1071,18 @@ id database retention_policy shard_group start_time end_time Returns detailed statistics on available components of an InfluxDB node and available (enabled) components. +Statistics returned by `SHOW STATS` are stored in memory and reset to zero when the node is restarted, +but `SHOW STATS` is triggered every 10 seconds to populate the `_internal` database. + +The `SHOW STATS` command does not list index memory usage -- +use the [`SHOW STATS FOR 'indexes'`](#show-stats-for-indexes) command. + For more information on using the `SHOW STATS` command, see [Using the SHOW STATS command to monitor InfluxDB](/platform/monitoring/tools/show-stats/). ``` show_stats_stmt = "SHOW STATS [ FOR '' | 'indexes' ]" ``` -#### `SHOW STATS` - -- The `SHOW STATS` command does not list index memory usage -- use the [`SHOW STATS FOR 'indexes'`](#show-stats-for-indexes) command. -- Statistics returned by `SHOW STATS` are stored in memory and reset to zero when the node is restarted, but `SHOW STATS` is triggered every 10 seconds to populate the `_internal` database. - -#### `SHOW STATS FOR ` - -- For the specified component (\), the command returns available statistics. -- For the `runtime` component, the command returns an overview of memory usage by the InfluxDB system, using the [Go runtime](https://golang.org/pkg/runtime/) package. - -#### `SHOW STATS FOR 'indexes'` - -- Returns an estimate of memory use of all indexes. Index memory use is not reported with `SHOW STATS` because it is a potentially expensive operation. - #### Example ```sql @@ -1098,7 +1092,6 @@ name: runtime Alloc Frees HeapAlloc HeapIdle HeapInUse HeapObjects HeapReleased HeapSys Lookups Mallocs NumGC NumGoroutine PauseTotalNs Sys TotalAlloc 4136056 6684537 4136056 34586624 5816320 49412 0 40402944 110 6733949 83 44 36083006 46692600 439945704 - name: graphite tags: proto=tcp batches_tx bytes_rx connections_active connections_handled points_rx points_tx @@ -1106,6 +1099,17 @@ batches_tx bytes_rx connections_active connections_handled 159 3999750 0 1 158110 158110 ``` +### SHOW STATS FOR + +For the specified component (\), the command returns available statistics. +For the `runtime` component, the command returns an overview of memory usage by the InfluxDB system, +using the [Go runtime](https://golang.org/pkg/runtime/) package. + +### SHOW STATS FOR 'indexes' + +Returns an estimate of memory use of all indexes. +Index memory use is not reported with `SHOW STATS` because it is a potentially expensive operation. + ### SHOW SUBSCRIPTIONS ``` @@ -1118,11 +1122,12 @@ show_subscriptions_stmt = "SHOW SUBSCRIPTIONS" . SHOW SUBSCRIPTIONS ``` -#### SHOW TAG KEY CARDINALITY +### SHOW TAG KEY CARDINALITY Estimates or counts exactly the cardinality of tag key set on the current database unless a database is specified using the `ON ` option. -> **Note:** `ON `, `FROM `, `WITH KEY = `, `WHERE `, `GROUP BY `, and `LIMIT/OFFSET` clauses are optional. +> [!Note] +> `ON `, `FROM `, `WITH KEY = `, `WHERE `, `GROUP BY `, and `LIMIT/OFFSET` clauses are optional. > When using these query clauses, the query falls back to an exact count. > Filtering by `time` is only supported when TSI (Time Series Index) is enabled and `time` is not supported in the `WHERE` clause. @@ -1190,11 +1195,12 @@ SHOW TAG VALUES WITH KEY !~ /.*c.*/ SHOW TAG VALUES FROM "cpu" WITH KEY IN ("region", "host") WHERE "service" = 'redis' ``` -#### SHOW TAG VALUES CARDINALITY +### SHOW TAG VALUES CARDINALITY Estimates or counts exactly the cardinality of tag key values for the specified tag key on the current database unless a database is specified using the `ON ` option. -> **Note:** `ON `, `FROM `, `WITH KEY = `, `WHERE `, `GROUP BY `, and `LIMIT/OFFSET` clauses are optional. +> [!Note] +> `ON `, `FROM `, `WITH KEY = `, `WHERE `, `GROUP BY `, and `LIMIT/OFFSET` clauses are optional. > When using these query clauses, the query falls back to an exact count. > Filtering by `time` is only supported when TSI (Time Series Index) is enabled. @@ -1274,6 +1280,15 @@ unary_expr = "(" expr ")" | var_ref | time_lit | string_lit | int_lit | float_lit | bool_lit | duration_lit | regex_lit . ``` +## Comments + +Use comments with InfluxQL statements to describe your queries. + +- A single line comment begins with two hyphens (`--`) and ends where InfluxDB detects a line break. + This comment type cannot span several lines. +- A multi-line comment begins with `/*` and ends with `*/`. This comment type can span several lines. + Multi-line comments do not support nested multi-line comments. + ## Other ``` @@ -1321,6 +1336,8 @@ retention_policy = identifier . retention_policy_option = retention_policy_duration | retention_policy_replication | retention_policy_shard_group_duration | + retention_future_limit | + retention_past_limit | "DEFAULT" . retention_policy_duration = "DURATION" duration_lit . @@ -1329,6 +1346,10 @@ retention_policy_replication = "REPLICATION" int_lit . retention_policy_shard_group_duration = "SHARD DURATION" duration_lit . +retention_future_limit = "FUTURE LIMIT" duration_lit . + +retention_past_limit = "PAST LIMIT" duration_lit . + retention_policy_name = "NAME" identifier . series_id = int_lit . @@ -1350,15 +1371,6 @@ user_name = identifier . var_ref = measurement . ``` -### Comments - -Use comments with InfluxQL statements to describe your queries. - -- A single line comment begins with two hyphens (`--`) and ends where InfluxDB detects a line break. - This comment type cannot span several lines. -- A multi-line comment begins with `/*` and ends with `*/`. This comment type can span several lines. - Multi-line comments do not support nested multi-line comments. - ## Query Engine Internals Once you understand the language itself, it's important to know how these @@ -1458,7 +1470,7 @@ iterator. ### Built-in iterators -There are many helper iterators that let us build queries: +{{% product-name %}} provides many helper iterators for building queries: - Merge Iterator - This iterator combines one or more iterators into a single new iterator of the same type. This iterator guarantees that all points diff --git a/data/products.yml b/data/products.yml index 9693cb96d..c4694165e 100644 --- a/data/products.yml +++ b/data/products.yml @@ -216,7 +216,7 @@ influxdb: latest: v2.8 latest_patches: v2: 2.8.0 - v1: 1.12.2 + v1: 1.12.3 latest_cli: v2: 2.7.5 detector_config: @@ -349,7 +349,7 @@ enterprise_influxdb: versions: [v1] latest: v1.12 latest_patches: - v1: 1.12.2 + v1: 1.12.3 detector_config: query_languages: InfluxQL: From 09eabb25498f7046342ffe693b59bfefeb408ef0 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Fri, 13 Mar 2026 17:27:05 -0500 Subject: [PATCH 18/27] fix: warn instead of block on yarn audit failures for non-default branches (#6943) The packages-audit pre-push hook now detects the current branch and only blocks pushes on the default branch. On feature branches, vulnerabilities are reported as warnings with a link to create a GitHub issue. --- lefthook.yml | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/lefthook.yml b/lefthook.yml index 1595531e0..7f88047e9 100644 --- a/lefthook.yml +++ b/lefthook.yml @@ -148,7 +148,16 @@ pre-push: commands: packages-audit: tags: frontend security - run: yarn audit + run: | + default_branch=$(git symbolic-ref refs/remotes/origin/HEAD 2>/dev/null | sed 's@^refs/remotes/origin/@@') || default_branch="master" + current_branch=$(git branch --show-current) + yarn audit; status=$? + if [ $status -ne 0 ] && [ "$current_branch" != "$default_branch" ]; then + echo "⚠️ yarn audit found vulnerabilities (warning only — non-default branch '$current_branch')" + echo " Create an issue: https://github.com/influxdata/docs-v2/issues/new?title=yarn+audit+vulnerabilities&labels=security" + exit 0 + fi + exit $status e2e-shortcode-examples: tags: [frontend, test] From a3dbf2e8836cc8c74f0f0a4f179b531d9a12c978 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Sat, 14 Mar 2026 15:12:40 -0500 Subject: [PATCH 19/27] fix(v1): publish OSS v1.12.3, defer Enterprise v1.12.3 pending GA (#6945) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Revert "InfluxDB 1.12.3 release (#6872)" This reverts commit 14e021aa2655bfb39fc939dd56f401b19bf1c8b6. * fix(v1): split v1.12.3 release — publish OSS, defer Enterprise pending GA Revert the combined InfluxDB 1.12.3 release commit and re-add only OSS v1.12.3 documentation. Enterprise v1.12.3 docs will be published in a separate PR once the release artifact is GA in the portal. Also adds FUTURE/PAST LIMIT ordering caution for users on versions prior to v1.12.3 (from copilot/restore-ordering-warning-influxql). * chore: document separate OSS/Enterprise PR workflow for v1 releases Update the influxdb1-tech-writer agent, v1 release PR template, and prepare-release-notes command to enforce the practice of always creating separate PRs for OSS v1 and Enterprise v1 releases. Enterprise must wait for GA in the portal before merging. * fix(enterprise): restore FUTURE/PAST LIMIT grammar productions in InfluxQL spec The revert of the combined v1.12.3 commit removed grammar production definitions (retention_future_limit, retention_past_limit) that document existing InfluxQL syntax, not v1.12.3-specific features. Restore them so the grammar is complete. * Revert "fix(enterprise): restore FUTURE/PAST LIMIT grammar productions in InfluxQL spec" This reverts commit c497f136a1df0f07114a6ccc86b52d69e4c345f1. * fix(v1): remove incorrect FUTURE/PAST LIMIT ordering caution from OSS spec The caution stated that prior to v1.12.3, PAST LIMIT must appear before FUTURE LIMIT. This is incorrect — the correct syntax has always been FUTURE LIMIT before PAST LIMIT. The v1.12.3 fix addresses Enterprise meta-node recording of limits, not parser syntax order. --- .claude/agents/influxdb1-tech-writer.md | 9 + .claude/commands/prepare-release-notes.md | 23 +++ .../influxdb_v1_release.md | 38 ++-- .../v1/about-the-project/release-notes.md | 101 +++------- .../configure/config-data-nodes.md | 24 --- .../configure/config-meta-nodes.md | 14 +- .../v1/query_language/manage-database.md | 47 ++--- .../v1/query_language/spec.md | 176 ++++++++---------- .../v1/tools/influxd-ctl/backup.md | 58 ++---- data/products.yml | 2 +- 10 files changed, 198 insertions(+), 294 deletions(-) diff --git a/.claude/agents/influxdb1-tech-writer.md b/.claude/agents/influxdb1-tech-writer.md index 2ec900b83..a65681fed 100644 --- a/.claude/agents/influxdb1-tech-writer.md +++ b/.claude/agents/influxdb1-tech-writer.md @@ -61,6 +61,15 @@ You are an expert InfluxDB v1 technical writer with deep knowledge of InfluxData 5. **Apply Standards:** Ensure compliance with style guidelines and documentation conventions 6. **Cross-Reference:** Verify consistency with related documentation and product variants +## Release Documentation Workflow + +**Always create separate PRs for OSS v1 and Enterprise v1 releases.** + +- **OSS v1:** Publish immediately when the release tag is available on GitHub (`https://github.com/influxdata/influxdb/releases/tag/v1.x.x`). +- **Enterprise v1:** Publish only after the release artifact is generally available (GA) in the InfluxData portal. Create the PR as a **draft** until the v1 codeowner signals readiness (e.g., applies a release label). +- **`data/products.yml`:** Split version bumps per product. The OSS PR bumps `influxdb.latest_patches.v1`; the Enterprise PR bumps `enterprise_influxdb.latest_patches.v1`. +- **PR template:** Use `.github/pull_request_template/influxdb_v1_release.md` and select the appropriate release type (OSS or Enterprise). + ## Quality Assurance - All code examples must be testable and include proper pytest-codeblocks annotations diff --git a/.claude/commands/prepare-release-notes.md b/.claude/commands/prepare-release-notes.md index e3e241fd2..c51350493 100644 --- a/.claude/commands/prepare-release-notes.md +++ b/.claude/commands/prepare-release-notes.md @@ -222,6 +222,29 @@ influxdb3_core, influxdb3_enterprise, telegraf /influxdb3/core, /influxdb3/enterprise, /telegraf ``` +## v1 Release Workflow + +**InfluxDB v1 releases require separate PRs for OSS and Enterprise.** + +1. **OSS PR** — publish immediately when the GitHub release tag is available. +2. **Enterprise PR** — create as a draft; merge only after the v1 codeowner signals readiness (e.g., applies a release label) and the release artifact is GA in the InfluxData portal. + +Each PR should bump only its own product version in `data/products.yml`: +- OSS: `influxdb > latest_patches > v1` +- Enterprise: `enterprise_influxdb > latest_patches > v1` + +Use the PR template `.github/pull_request_template/influxdb_v1_release.md` and select the appropriate release type. + +### Examples for v1 + +```bash +# Generate OSS v1 release notes +docs release-notes v1.12.2 v1.12.3 --repos ~/github/influxdata/influxdb + +# Generate Enterprise v1 release notes (separate PR) +# Use the Enterprise changelog at https://dl.influxdata.com/enterprise/nightlies/master/CHANGELOG.md +``` + ## Related - **docs-cli-workflow** skill - When to use CLI tools diff --git a/.github/pull_request_template/influxdb_v1_release.md b/.github/pull_request_template/influxdb_v1_release.md index cc341db77..cbfe0e6c4 100644 --- a/.github/pull_request_template/influxdb_v1_release.md +++ b/.github/pull_request_template/influxdb_v1_release.md @@ -1,27 +1,37 @@ ## InfluxDB v1 Release Documentation -**Release Version:** v1.x.x -**Release Type:** [ ] OSS [ ] Enterprise [ ] Both +**Release Version:** v1.x.x +**Release Type:** [ ] OSS [ ] Enterprise + +> [!Important] +> **Always create separate PRs for OSS and Enterprise releases.** +> OSS can publish immediately when the GitHub release tag is available. +> Enterprise must wait until the release artifact is GA in the InfluxData portal. +> Never combine both products in a single release PR. ### Description Brief description of the release and documentation changes. +### Pre-merge Gate (Enterprise only) +- [ ] **Confirm release artifact is GA in the InfluxData portal** +- [ ] **v1 codeowner has signaled readiness** (e.g., applied a release label) + ### Release Documentation Checklist #### Release Notes - [ ] Generate release notes from changelog - - [ ] OSS: Use commit messages from GitHub release tag `https://github.com/influxdata/influxdb/releases/tag/v1.x.x` - - [ ] Enterprise: Use `https://dl.influxdata.com/enterprise/nightlies/master/CHANGELOG.md` - - [ ] **Note**: For Enterprise releases, include important updates, features, and fixes from the corresponding OSS tag + - OSS: Use commit messages from GitHub release tag `https://github.com/influxdata/influxdb/releases/tag/v1.x.x` + - Enterprise: Use `https://dl.influxdata.com/enterprise/nightlies/master/CHANGELOG.md` + - **Note**: For Enterprise releases, include important updates, features, and fixes from the corresponding OSS tag - [ ] Update release notes in appropriate location - - [ ] OSS: `/content/influxdb/v1/about_the_project/releasenotes-changelog.md` - - [ ] Enterprise: `/content/enterprise_influxdb/v1/about-the-project/release-notes.md` + - OSS: `content/influxdb/v1/about_the_project/release-notes.md` + - Enterprise: `content/enterprise_influxdb/v1/about-the-project/release-notes.md` - [ ] Ensure release notes follow documentation formatting standards #### Version Updates -- [ ] Update patch version in `/data/products.yml` - - [ ] OSS: `influxdb > v1 > latest` - - [ ] Enterprise: `enterprise_influxdb > v1 > latest` +- [ ] Update patch version in `data/products.yml` (**only for this product**) + - OSS: `influxdb > latest_patches > v1` + - Enterprise: `enterprise_influxdb > latest_patches > v1` - [ ] Update version references in documentation - [ ] Installation guides - [ ] Docker documentation @@ -37,8 +47,9 @@ Brief description of the release and documentation changes. #### Testing - [ ] Build documentation locally and verify changes render correctly - [ ] Test all updated links -- [ ] Run link validation: `yarn test:links content/influxdb/v1/**/*.md` -- [ ] Run link validation: `yarn test:links content/enterprise_influxdb/v1/**/*.md` +- [ ] Run link validation for the product being released: + - OSS: `yarn test:links content/influxdb/v1/**/*.md` + - Enterprise: `yarn test:links content/enterprise_influxdb/v1/**/*.md` ### Related Resources - DAR Issue: # @@ -50,6 +61,3 @@ Brief description of the release and documentation changes. - [ ] Verify documentation is deployed to production - [ ] Announce in #docs channel - [ ] Close related DAR issue(s) - ---- -**Note:** For Enterprise releases, ensure you have access to the Enterprise changelog and coordinate with the release team for timing. \ No newline at end of file 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 b0c00e523..d7c5a22cc 100644 --- a/content/enterprise_influxdb/v1/about-the-project/release-notes.md +++ b/content/enterprise_influxdb/v1/about-the-project/release-notes.md @@ -13,63 +13,6 @@ alt_links: -## v1.12.3 {date="2026-01-12"} - -> [!Important] -> #### Upgrade meta nodes first -> -> When upgrading to InfluxDB Enterprise 1.12.1+, upgrade meta nodes before -> upgrading data nodes. - -### Features - -- Add [`https-insecure-certificate` configuration option](/enterprise_influxdb/v1/administration/configure/config-meta-nodes/#https-insecure-certificate) - to meta nodes to skip file permission checking for TLS certificate and private key files. - Also available for data node - [`[cluster]`](/enterprise_influxdb/v1/administration/configure/config-data-nodes/#https-insecure-certificate) - and [`[http]`](/enterprise_influxdb/v1/administration/configure/config-data-nodes/#https-insecure-certificate-1) - sections. -- Add [`advanced-expiration` TLS configuration option](/enterprise_influxdb/v1/administration/configure/config-data-nodes/#advanced-expiration) - to configure how far in advance to log warnings about TLS certificate expiration. -- Add [backup compression options](/enterprise_influxdb/v1/tools/influxd-ctl/backup/#backup-compression) - (`-gzipCompressionLevel`, `-gzipBlockCount`, `-gzipBlockSize`) to - [`influxd-ctl backup`](/enterprise_influxdb/v1/tools/influxd-ctl/backup/). -- Add TLS certificate reloading on `SIGHUP`. -- Add `config` and `cq` (continuous query) diagnostics to the `/debug/vars` endpoint. -- Improve dropped point logging. -- Show user when displaying or logging queries. -- Add `time_format` parameter for the HTTP API. -- Use dynamic logging levels (`zap.AtomicLevel`). -- Report user query bytes. - -### Bug fixes - -- Fix `FUTURE LIMIT` and `PAST LIMIT` - [clause order](/enterprise_influxdb/v1/query_language/manage-database/#future-limit) - in retention policy statements. -- Add locking in `ClearBadShardList`. -- Stop noisy logging about phantom shards that do not belong to a node. -- Resolve `RLock()` leakage in `Store.DeleteSeries()`. -- Fix condition check for optimization of array cursor (tsm1). -- Run `init.sh` `buildtsi` as `influxdb` user. -- Reduce unnecessary purger operations and logging. -- Sort files for adjacency testing. -- Fix operator in host detection (systemd). -- Use correct path in open WAL error message. -- Handle nested low-level files in compaction. -- Correct error logic for writing empty index files. -- Reduce lock contention and races in purger. -- Fix bug with authorizer leakage in `SHOW QUERIES`. -- Rename compact throughput logging keys. -- Fix `https-insecure-certificate` not handled properly in httpd. -- Prevent level regression when compacting mixed-level TSM files. - -### Other - -- Update Go to 1.24.13. - ---- - ## v1.12.2 {date="2025-09-15"} > [!Important] @@ -100,8 +43,8 @@ alt_links: - 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-meta-nodes/#raft-portal-auth-required) - - [`[meta].raft-dialer-auth-required`](/enterprise_influxdb/v1/administration/configure/config-meta-nodes/#raft-dialer-auth-required) + - [`[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. @@ -464,7 +407,7 @@ alt_links: - Add [/api/v2/delete](/enterprise_influxdb/v1/tools/api/#apiv2delete-http-endpoint) support. - Add wildcard support for retention policies in `SHOW MEASUREMENTS`. - Log slow queries even when query logging is not enabled. -- Add `--start` and `--end` [backup flags](/enterprise_influxdb/v1/administration/backup-and-restore/#backup-flags) to specify the time to include in backup. +- Add `--start` and `--end` [backup options](/enterprise_influxdb/v1/administration/backup-and-restore/#backup-options) to specify the time to include in backup. - Add Raft Status output to `inflxud-ctl show`. #### Flux updates @@ -588,7 +531,7 @@ An edge case regression was introduced into this version that may cause a consta - **Log active queries when a process is terminated**: Add the [`termination-query-log`](/enterprise_influxdb/v1/administration/configure/config-data-nodes/#termination-query-log--false) configuration option. When set to `true` all running queries are printed to the log when a data node process receives a `SIGTERM` (for example, a Kubernetes process exceeds the container memory limit or the process is terminated). -- **Log details of HTTP calls to meta nodes**. When [`cluster-tracing`](/enterprise_influxdb/v1/administration/configure/config-meta-nodes/#cluster-tracing) is enabled, all API calls to meta nodes are now logged with details providing an audit trail including IP address of caller, specific API being invoked, action being invoked, and more. +- **Log details of HTTP calls to meta nodes**. When [`cluster-tracing`](/enterprise_influxdb/v1/administration/configure/config-meta-nodes/#cluster-tracing--false) is enabled, all API calls to meta nodes are now logged with details providing an audit trail including IP address of caller, specific API being invoked, action being invoked, and more. ### Maintenance updates @@ -854,14 +797,14 @@ For details on changes incorporated from the InfluxDB OSS release, see #### Hinted handoff improvements -- Allow out-of-order writes. This change adds a configuration option `allow-out-of-order-writes` to the `[cluster]` section of the data node configuration file. This setting defaults to `false` to match the existing behavior. There are some important operational considerations to review before turning this on. But, the result is enabling this option reduces the time required to drain the hinted handoff queue and increase throughput during recovery. See [`allow-out-of-order-writes`](/enterprise_influxdb/v1/administration/configure/config-data-nodes/#allow-out-of-order-writes) for more detail. -- Make the number of pending writes configurable. This change adds a configuration option in the `[hinted-handoff]` section called `max-pending-writes`, which defaults to `1024`. See [`max-writes-pending`](/enterprise_influxdb/v1/administration/configure/config-data-nodes/#max-writes-pending) for more detail. +- Allow out-of-order writes. This change adds a configuration option `allow-out-of-order-writes` to the `[cluster]` section of the data node configuration file. This setting defaults to `false` to match the existing behavior. There are some important operational considerations to review before turning this on. But, the result is enabling this option reduces the time required to drain the hinted handoff queue and increase throughput during recovery. See [`allow-out-of-order-writes`](/enterprise_influxdb/v1/administration/config-data-nodes#allow-out-of-order-writes--false) for more detail. +- Make the number of pending writes configurable. This change adds a configuration option in the `[hinted-handoff]` section called `max-pending-writes`, which defaults to `1024`. See [max-pending-writes](/enterprise_influxdb/v1/administration/config-data-nodes#max-pending-writes-1024) for more detail. - Update the hinted handoff queue to ensure various entries to segment files occur atomically. Prior to this change, entries were written to disk in three separate writes (len, data, offset). If the process stopped in the middle of any of those writes, the hinted handoff segment file was left in an invalid state. - In certain scenarios, the hinted-handoff queue would fail to drain. Upon node startup, the queue segment files are now verified and truncated if any are corrupted. Some additional logging has been added when a node starts writing to the hinted handoff queue as well. #### `influxd-ctl` CLI improvements -- Add a verbose flag to [`influxd-ctl show-shards`](/enterprise_influxdb/v1/tools/influxd-ctl/show-shards/). This option provides more information about each shard owner, including the state (hot/cold), last modified date and time, and size on disk. +- Add a verbose flag to [`influxd-ctl show-shards`](/enterprise_influxdb/v1/administration/cluster-commands/#show-shards). This option provides more information about each shard owner, including the state (hot/cold), last modified date and time, and size on disk. ### Bug fixes @@ -889,7 +832,7 @@ For details on changes incorporated from the InfluxDB OSS release, see > 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 metadata only backup](/enterprise_influxdb/v1/administration/backup-and-restore/#perform-a-metadata-only-backup). +For more information, see [Perform a metastore only backup](/enterprise_influxdb/v1/administration/backup-and-restore/#perform-a-metastore-only-backup). #### **Incremental and full backups** @@ -957,7 +900,7 @@ For details on changes incorporated from the InfluxDB OSS release, see [InfluxDB - Added logging when data nodes connect to meta service. ### Features -- The Flux Technical Preview has advanced to version 0.36.2. +- The Flux Technical Preview has advanced to version [0.36.2](/flux/v0.36/). --- @@ -1216,7 +1159,7 @@ Please see the [InfluxDB OSS release notes](/influxdb/v1/about_the_project/relea > 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 [InfluxDB 1.5 release notes](/influxdb/v1/about_the_project/release-notes/). +For highlights of the InfluxDB 1.5 release, see [What's new in InfluxDB 1.5](/influxdb/v1/about_the_project/whats_new/). ### Breaking changes @@ -1454,7 +1397,7 @@ The following configuration changes may need to changed before [upgrading](/ente We've removed the data node's `shard-writer-timeout` configuration option from the `[cluster]` section. As of version 1.2.2, the system sets `shard-writer-timeout` internally. -The configuration option can be removed from the [data node configuration file](/enterprise_influxdb/v1/administration/configure/config-data-nodes/). +The configuration option can be removed from the [data node configuration file](/enterprise_influxdb/v1/administration/configuration/#data-node-configuration). #### retention-autocreate @@ -1472,8 +1415,8 @@ This change only affects users who have disabled the `retention-autocreate` opti ##### Backup and Restore
-- Prevent the `shard not found` error by making [backups](/enterprise_influxdb/v1/tools/influxd-ctl/backup/) skip empty shards -- Prevent the `shard not found` error by making [restore](/enterprise_influxdb/v1/tools/influxd-ctl/restore/) handle empty shards +- Prevent the `shard not found` error by making [backups](/enterprise_influxdb/v1/administration/backup-and-restore/#backup) skip empty shards +- Prevent the `shard not found` error by making [restore](/enterprise_influxdb/v1/administration/backup-and-restore/#restore) handle empty shards - Ensure that restores from an incremental backup correctly handle file paths - Allow incremental backups with restrictions (for example, they use the `-db` or `rp` flags) to be stores in the same directory - Support restores on meta nodes that are not the raft leader @@ -1493,8 +1436,8 @@ This change only affects users who have disabled the `retention-autocreate` opti - Serialize access to the meta client and meta store to prevent raft log buildup - Remove sysvinit package dependency for RPM packages - Make the default retention policy creation an atomic process instead of a two-step process -- Prevent `influxd-ctl`'s [`join` argument](/enterprise_influxdb/v1/tools/influxd-ctl/join/) from completing a join when the command also specifies the help flag (`-h`) -- Fix the `influxd-ctl`'s [force removal](/enterprise_influxdb/v1/tools/influxd-ctl/remove-meta/) of meta nodes +- Prevent `influxd-ctl`'s [`join` argument](/enterprise_influxdb/v1/features/cluster-commands/#join) from completing a join when the command also specifies the help flag (`-h`) +- Fix the `influxd-ctl`'s [force removal](/enterprise_influxdb/v1/features/cluster-commands/#remove-meta) of meta nodes - Update the meta node and data node sample configuration files --- @@ -1516,7 +1459,7 @@ Please see the OSS [release notes](https://github.com/influxdata/influxdb/blob/1 ### Upgrading -* The `retention-autocreate` configuration option has moved from the meta node configuration file to the [data node configuration file](/enterprise_influxdb/v1/administration/configure/config-data-nodes/#retention-autocreate). +* The `retention-autocreate` configuration option has moved from the meta node configuration file to the [data node configuration file](/enterprise_influxdb/v1/administration/configuration/#retention-autocreate-true). To disable the auto-creation of retention policies, set `retention-autocreate` to `false` in your data node configuration files. * The previously deprecated `influxd-ctl force-leave` command has been removed. The replacement command to remove a meta node which is never coming back online is [`influxd-ctl remove-meta -force`](/enterprise_influxdb/v1/features/cluster-commands/). @@ -1525,7 +1468,7 @@ To disable the auto-creation of retention policies, set `retention-autocreate` t - Improve the meta store: any meta store changes are done via a compare and swap - Add support for [incremental backups](/enterprise_influxdb/v1/administration/backup-and-restore/) - Automatically remove any deleted shard groups from the data store -- Uncomment the section headers in the default [configuration file](/enterprise_influxdb/v1/administration/configure/) +- Uncomment the section headers in the default [configuration file](/enterprise_influxdb/v1/administration/configuration/) - Add InfluxQL support for [subqueries](/influxdb/v1/query_language/data_exploration/#subqueries) #### Cluster-specific Bugfixes @@ -1533,13 +1476,13 @@ To disable the auto-creation of retention policies, set `retention-autocreate` t - Update dependencies with Godeps - Fix a data race in meta client - Ensure that the system removes the relevant [user permissions and roles](/enterprise_influxdb/v1/features/users/) when a database is dropped -- Fix a couple typos in demo [configuration file](/enterprise_influxdb/v1/administration/configure/) +- Fix a couple typos in demo [configuration file](/enterprise_influxdb/v1/administration/configuration/) - Make optional the version protobuf field for the meta store - Remove the override of GOMAXPROCS - Remove an unused configuration option (`dir`) from the backend - Fix a panic around processing remote writes - Return an error if a remote write has a field conflict -- Drop points in the hinted handoff that (1) have field conflict errors (2) have [`max-values-per-tag`](/influxdb/v1/administration/config/#max-values-per-tag) errors +- Drop points in the hinted handoff that (1) have field conflict errors (2) have [`max-values-per-tag`](/influxdb/v1/administration/config/#max-values-per-tag-100000) errors - Remove the deprecated `influxd-ctl force-leave` command - Fix issue where CQs would stop running if the first meta node in the cluster stops - Fix logging in the meta httpd handler service @@ -1629,8 +1572,8 @@ Switches to journald logging for on systemd systems. Logs are no longer sent to - Return an error if getting latest snapshot takes longer than 30 seconds - Remove any expired shards from the `/show-shards` output -- Respect the [`pprof-enabled` configuration setting](/enterprise_influxdb/v1/administration/configure/config-meta-nodes/#pprof-enabled) and enable it by default on meta nodes -- Respect the [`pprof-enabled` configuration setting](/enterprise_influxdb/v1/administration/configure/config-data-nodes/#pprof-enabled) on data nodes +- Respect the [`pprof-enabled` configuration setting](/enterprise_influxdb/v1/administration/configuration/#pprof-enabled-true) and enable it by default on meta nodes +- Respect the [`pprof-enabled` configuration setting](/enterprise_influxdb/v1/administration/configuration/#pprof-enabled-true-1) on data nodes - Use the data reference instead of `Clone()` during read-only operations for performance purposes - Prevent the system from double-collecting cluster statistics - Ensure that the Meta API redirects to the cluster leader when it gets the `ErrNotLeader` error @@ -1646,7 +1589,7 @@ Switches to journald logging for on systemd systems. Logs are no longer sent to #### Cluster-specific bug fixes -- Respect the [Hinted Handoff settings](/enterprise_influxdb/v1/administration/configure/config-data-nodes/#hinted-handoff) in the configuration file +- Respect the [Hinted Handoff settings](/enterprise_influxdb/v1/administration/configuration/#hinted-handoff) in the configuration file - Fix expanding regular expressions when all shards do not exist on node that's handling the request --- 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 d8fbdaca5..4a6e54d9a 100644 --- a/content/enterprise_influxdb/v1/administration/configure/config-data-nodes.md +++ b/content/enterprise_influxdb/v1/administration/configure/config-data-nodes.md @@ -624,14 +624,6 @@ Use a separate private key location. Environment variable: `INFLUXDB_CLUSTER_HTTPS_PRIVATE_KEY` -#### https-insecure-certificate {metadata="v1.12.3+"} - -Default is `false`. - -Skips file permission checking for `https-certificate` and `https-private-key` when `true`. - -Environment variable: `INFLUXDB_CLUSTER_HTTPS_INSECURE_CERTIFICATE` - #### https-insecure-tls Default is `false`. @@ -1179,14 +1171,6 @@ The location of the separate private key. Environment variable: `INFLUXDB_HTTP_HTTPS_PRIVATE_KEY` -#### https-insecure-certificate {metadata="v1.12.3+"} - -Default is `false`. - -Skips file permission checking for `https-certificate` and `https-private-key` when `true`. - -Environment variable: `INFLUXDB_HTTP_HTTPS_INSECURE_CERTIFICATE` - #### shared-secret Default is `""`. @@ -1708,14 +1692,6 @@ In the preceding example, `max-version = "tls1.3"` specifies the maximum version Environment variable: `INFLUXDB_TLS_MAX_VERSION` -#### advanced-expiration {metadata="v1.12.3+"} - -Default is `5d`. - -Sets how far in advance to log warnings about TLS certificate expiration. - -Environment variable: `INFLUXDB_TLS_ADVANCED_EXPIRATION` - ## Flux query management settings ### [flux-controller] diff --git a/content/enterprise_influxdb/v1/administration/configure/config-meta-nodes.md b/content/enterprise_influxdb/v1/administration/configure/config-meta-nodes.md index e1a105e43..68a1cb908 100644 --- a/content/enterprise_influxdb/v1/administration/configure/config-meta-nodes.md +++ b/content/enterprise_influxdb/v1/administration/configure/config-meta-nodes.md @@ -170,14 +170,6 @@ Use either: Environment variable: `INFLUXDB_META_HTTPS_PRIVATE_KEY` -#### https-insecure-certificate - -Default is `false`. - -Skips file permission checking for `https-certificate` and `https-private-key` when `true`. - -Environment variable: `INFLUXDB_META_HTTPS_INSECURE_CERTIFICATE` - #### https-insecure-tls Default is `false`. @@ -349,7 +341,7 @@ The shared secret used by the internal API for JWT authentication for inter-node communication within the cluster. Set this to a long pass phrase. This value must be the same value as the -[`[meta] meta-internal-shared-secret`](/enterprise_influxdb/v1/administration/configure/config-data-nodes/#meta-internal-shared-secret) in the data node configuration file. +[`[meta] meta-internal-shared-secret`](/enterprise_influxdb/v1/administration/config-data-nodes#meta-internal-shared-secret) in the data node configuration file. To use this option, set [`auth-enabled`](#auth-enabled) to `true`. Environment variable: `INFLUXDB_META_INTERNAL_SHARED_SECRET` @@ -460,7 +452,7 @@ Environment variable: `INFLUXDB_META_ENSURE_FIPS` Default is `false`. Require Raft clients to authenticate with server using the -[`meta-internal-shared-secret`](/enterprise_influxdb/v1/administration/configure/config-data-nodes/#meta-internal-shared-secret). +[`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`. @@ -473,7 +465,7 @@ Environment variable: `INFLUXDB_META_RAFT_PORTAL_AUTH_REQUIRED` Default is `false`. Require Raft servers to authenticate Raft clients using the -[`meta-internal-shared-secret`](/enterprise_influxdb/v1/administration/configure/config-data-nodes/#meta-internal-shared-secret). +[`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`. For existing clusters, it is recommended to enable `raft-portal-auth-required` and restart diff --git a/content/enterprise_influxdb/v1/query_language/manage-database.md b/content/enterprise_influxdb/v1/query_language/manage-database.md index d740f413f..d57aa6efd 100644 --- a/content/enterprise_influxdb/v1/query_language/manage-database.md +++ b/content/enterprise_influxdb/v1/query_language/manage-database.md @@ -62,15 +62,15 @@ Creates a new database. #### Syntax ```sql -CREATE DATABASE [WITH [DURATION ] [REPLICATION ] [SHARD DURATION ] [FUTURE LIMIT ] [PAST LIMIT ] [NAME ]] +CREATE DATABASE [WITH [DURATION ] [REPLICATION ] [SHARD DURATION ] [PAST LIMIT ] [FUTURE LIMIT ] [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`, `FUTURE LIMIT`, -`PAST LIMIT`, and `NAME` clauses are optional and create a single +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 @@ -102,7 +102,7 @@ The query creates a database called `NOAA_water_database`. ``` The query creates a database called `NOAA_water_database`. -It also creates a default retention policy for `NOAA_water_database` with a `DURATION` of three days, a [replication factor](/enterprise_influxdb/v1/concepts/glossary/#replication-factor-rf) of one, a [shard group](/enterprise_influxdb/v1/concepts/glossary/#shard-group) duration of one hour, and with the name `liquid`. +It also creates a default retention policy for `NOAA_water_database` with a `DURATION` of three days, a [replication factor](/enterprise_influxdb/v1/concepts/glossary/#replication-factor) of one, a [shard group](/enterprise_influxdb/v1/concepts/glossary/#shard-group) duration of one hour, and with the name `liquid`. ### Delete a database with DROP DATABASE @@ -258,7 +258,7 @@ You may disable its auto-creation in the [configuration file](/enterprise_influx #### Syntax ```sql -CREATE RETENTION POLICY ON DURATION REPLICATION [SHARD DURATION ] [FUTURE LIMIT ] [PAST LIMIT ] [DEFAULT] +CREATE RETENTION POLICY ON DURATION REPLICATION [SHARD DURATION ] [PAST LIMIT ] [FUTURE LIMIT ] [DEFAULT] ``` #### Description of syntax @@ -306,17 +306,6 @@ See [Shard group duration management](/enterprise_influxdb/v1/concepts/schema_and_data_layout/#shard-group-duration-management) for recommended configurations. -##### `FUTURE LIMIT` {metadata="v1.12.0+"} - -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. - ##### `PAST LIMIT` {metadata="v1.12.0+"} The `PAST LIMIT` clause defines a time boundary before and relative to _now_ @@ -328,6 +317,25 @@ 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. +> [!Important] +> `PAST LIMIT` cannot be changed after it is set. +> This will be fixed in a future release. + +##### `FUTURE LIMIT` {metadata="v1.12.0+"} + +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. + +> [!Important] +> `FUTURE LIMIT` cannot be changed after it is set. +> This will be fixed in a future release. + ##### `DEFAULT` Sets the new retention policy as the default retention policy for the database. @@ -363,17 +371,14 @@ See [Create a database with CREATE DATABASE](/enterprise_influxdb/v1/query_langu ### Modify retention policies with ALTER RETENTION POLICY -The `ALTER RETENTION POLICY` query takes the following form, where you must declare at least one of the retention policy attributes `DURATION`, `REPLICATION`, `SHARD DURATION`, `FUTURE LIMIT`, `PAST LIMIT`, or `DEFAULT`: +The `ALTER RETENTION POLICY` query takes the following form, where you must declare at least one of the retention policy attributes `DURATION`, `REPLICATION`, `SHARD DURATION`, or `DEFAULT`: ```sql -ALTER RETENTION POLICY ON [DURATION ] [REPLICATION ] [SHARD DURATION ] [FUTURE LIMIT ] [PAST LIMIT ] [DEFAULT] +ALTER RETENTION POLICY ON [DURATION ] [REPLICATION ] [SHARD DURATION ] [DEFAULT] ``` {{% warn %}} Replication factors do not serve a purpose with single node instances. {{% /warn %}} -For information about the `FUTURE LIMIT` and `PAST LIMIT` clauses, see -[CREATE RETENTION POLICY](#create-retention-policies-with-create-retention-policy). - First, create the retention policy `what_is_time` with a `DURATION` of two days: ```sql > CREATE RETENTION POLICY "what_is_time" ON "NOAA_water_database" DURATION 2d REPLICATION 1 diff --git a/content/enterprise_influxdb/v1/query_language/spec.md b/content/enterprise_influxdb/v1/query_language/spec.md index c3a94748e..2da1caa11 100644 --- a/content/enterprise_influxdb/v1/query_language/spec.md +++ b/content/enterprise_influxdb/v1/query_language/spec.md @@ -1,39 +1,49 @@ --- title: Influx Query Language (InfluxQL) reference -description: InfluxQL is a SQL-like query language for interacting with InfluxDB and providing features specific to storing and analyzing time series data. +description: Reference for Influx Query Language (InfluxQL). menu: enterprise_influxdb_v1: name: InfluxQL reference weight: 90 parent: InfluxQL -related: - - /enterprise_influxdb/v1/query_language/internals/ - - /enterprise_influxdb/v1/query_language/explore-data/ - - /enterprise_influxdb/v1/query_language/explore-schema/ - - /enterprise_influxdb/v1/query_language/manage-database/ +aliases: + - /influxdb/v2/query_language/spec/ --- +## Introduction + InfluxQL is a SQL-like query language for interacting with InfluxDB and providing features specific to storing and analyzing time series data. -- [Notation](#notation) -- [Query representation](#query-representation) - - [Characters](#characters) - - [Letters and digits](#letters-and-digits) - - [Identifiers](#identifiers) - - [Keywords](#keywords) - - [Literals](#literals) -- [Queries](#queries) -- [Statements](#statements) -- [Clauses](#clauses) -- [Expressions](#expressions) -- [Comments](#comments) -- [Other](#other) +Find Influx Query Language (InfluxQL) definitions and details, including: + +* [Notation](/enterprise_influxdb/v1/query_language/spec/#notation) +* [Query representation](/enterprise_influxdb/v1/query_language/spec/#query-representation) + * [Characters](/enterprise_influxdb/v1/query_language/spec/#characters) + * [Letters and digits](/enterprise_influxdb/v1/query_language/spec/#letters-and-digits) + * [Identifiers](/enterprise_influxdb/v1/query_language/spec/#identifiers) + * [Keywords](/enterprise_influxdb/v1/query_language/spec/#keywords) + * [Literals](/enterprise_influxdb/v1/query_language/spec/#literals) +* [Queries](/enterprise_influxdb/v1/query_language/spec/#queries) +* [Statements](/enterprise_influxdb/v1/query_language/spec/#statements) +* [Clauses](/enterprise_influxdb/v1/query_language/spec/#clauses) +* [Expressions](/enterprise_influxdb/v1/query_language/spec/#expressions) +* [Comments](/enterprise_influxdb/v1/query_language/spec/#comments) +* [Other](/enterprise_influxdb/v1/query_language/spec/#other) + +To learn more about InfluxQL, browse the following topics: + +* [Explore your data with InfluxQL](/enterprise_influxdb/v1/query_language/explore-data/) +* [Explore your schema with InfluxQL](/enterprise_influxdb/v1/query_language/explore-schema/) +* [Database management](/enterprise_influxdb/v1/query_language/manage-database/) +* [Authentication and authorization](/enterprise_influxdb/v1/administration/authentication_and_authorization/). +* [Query engine internals](/enterprise_influxdb/v1/query_language/spec/#query-engine-internals) ## Notation The syntax is specified using Extended Backus-Naur Form ("EBNF"). -EBNF is the same notation used in the [Go programming language specification](https://golang.org/ref/spec). +EBNF is the same notation used in the [Go](http://golang.org) programming language specification, +which can be found [here](https://golang.org/ref/spec). ``` Production = production_name "=" [ Expression ] "." . @@ -85,7 +95,7 @@ The rules: - double quoted identifiers can contain any unicode character other than a new line - double quoted identifiers can contain escaped `"` characters (i.e., `\"`) -- double quoted identifiers can contain InfluxQL [keywords](#keywords) +- double quoted identifiers can contain InfluxQL [keywords](/enterprise_influxdb/v1/query_language/spec/#keywords) - unquoted identifiers must start with an upper or lowercase ASCII character or "_" - unquoted identifiers may contain only ASCII letters, decimal digits, and "_" @@ -123,7 +133,7 @@ SUBSCRIPTIONS TAG TO USER USERS VALUES WHERE WITH WRITE ``` -If you use an InfluxQL keyword as an +If you use an InfluxQL keywords as an [identifier](/enterprise_influxdb/v1/concepts/glossary/#identifier) you will need to double quote that identifier in every query. @@ -139,7 +149,7 @@ In those cases, `time` does not require double quotes in queries. `time` cannot be a [field key](/enterprise_influxdb/v1/concepts/glossary/#field-key) or [tag key](/enterprise_influxdb/v1/concepts/glossary/#tag-key); InfluxDB rejects writes with `time` as a field key or tag key and returns an error. -For more information, see [Frequently Asked Questions](/enterprise_influxdb/v1/troubleshooting/frequently-asked-questions/#time). +See [Frequently Asked Questions](/enterprise_influxdb/v1/troubleshooting/frequently-asked-questions/#time) for more information. ### Literals @@ -189,7 +199,6 @@ Durations can be specified with mixed units. | d | day | | w | week | - ``` duration_lit = int_lit duration_unit . duration_unit = "ns" | "u" | "µ" | "ms" | "s" | "m" | "h" | "d" | "w" . @@ -223,22 +232,18 @@ regex_lit = "/" { unicode_char } "/" . `=~` matches against `!~` doesn't match against - -InfluxQL supports using regular expressions when specifying: - -- [field keys](/enterprise_influxdb/v1/concepts/glossary/#field-key) and [tag keys](/enterprise_influxdb/v1/concepts/glossary/#tag-key) in the [`SELECT` clause](/enterprise_influxdb/v1/query_language/explore-data/#the-basic-select-statement) -- [measurements](/enterprise_influxdb/v1/concepts/glossary/#measurement) in the [`FROM` clause](/enterprise_influxdb/v1/query_language/explore-data/#the-basic-select-statement) -- [tag values](/enterprise_influxdb/v1/concepts/glossary/#tag-value) and string [field values](/enterprise_influxdb/v1/concepts/glossary/#field-value) in the [`WHERE` clause](/enterprise_influxdb/v1/query_language/explore-data/#the-where-clause). -- [tag keys](/enterprise_influxdb/v1/concepts/glossary/#tag-key) in the [`GROUP BY` clause](/enterprise_influxdb/v1/query_language/explore-data/#group-by-tags) - -> [!Note] -> #### Regular expressions and non-string field values +> **Note:** InfluxQL supports using regular expressions when specifying: > -> Currently, InfluxQL does not support using regular expressions to match -> non-string field values in the -> `WHERE` clause, -> [databases](/enterprise_influxdb/v1/concepts/glossary/#database), and -> [retention policies](/enterprise_influxdb/v1/concepts/glossary/#retention-policy-rp). +* [field keys](/enterprise_influxdb/v1/concepts/glossary/#field-key) and [tag keys](/enterprise_influxdb/v1/concepts/glossary/#tag-key) in the [`SELECT` clause](/enterprise_influxdb/v1/query_language/explore-data/#the-basic-select-statement) +* [measurements](/enterprise_influxdb/v1/concepts/glossary/#measurement) in the [`FROM` clause](/enterprise_influxdb/v1/query_language/explore-data/#the-basic-select-statement) +* [tag values](/enterprise_influxdb/v1/concepts/glossary/#tag-value) and string [field values](/enterprise_influxdb/v1/concepts/glossary/#field-value) in the [`WHERE` clause](/enterprise_influxdb/v1/query_language/explore-data/#the-where-clause). +* [tag keys](/enterprise_influxdb/v1/concepts/glossary/#tag-key) in the [`GROUP BY` clause](/enterprise_influxdb/v1/query_language/explore-data/#group-by-tags) +> +>Currently, InfluxQL does not support using regular expressions to match +>non-string field values in the +>`WHERE` clause, +>[databases](/enterprise_influxdb/v1/concepts/glossary/#database), and +>[retention polices](/enterprise_influxdb/v1/concepts/glossary/#retention-policy-rp). ## Queries @@ -303,8 +308,6 @@ alter_retention_policy_stmt = "ALTER RETENTION POLICY" policy_name on_clause retention_policy_option [ retention_policy_option ] [ retention_policy_option ] - [ retention_policy_option ] - [ retention_policy_option ] [ retention_policy_option ] . ``` @@ -317,9 +320,6 @@ ALTER RETENTION POLICY "1h.cpu" ON "mydb" DEFAULT -- Change duration and replication factor. -- REPLICATION (replication factor) not valid for OSS instances. ALTER RETENTION POLICY "policy1" ON "somedb" DURATION 1h REPLICATION 4 - --- Change future and past limits. -ALTER RETENTION POLICY "policy1" ON "somedb" FUTURE LIMIT 6h PAST LIMIT 6h ``` ### CREATE CONTINUOUS QUERY @@ -379,16 +379,13 @@ create_database_stmt = "CREATE DATABASE" db_name [ WITH [ retention_policy_duration ] [ retention_policy_replication ] - [ retention_policy_shard_group_duration ] - [ retention_future_limit ] [ retention_past_limit ] + [ retention_future_limit ] + [ retention_policy_shard_group_duration ] [ retention_policy_name ] ] . ``` -> [!Note] -> When using both `FUTURE LIMIT` and `PAST LIMIT` clauses, `FUTURE LIMIT` must appear before `PAST LIMIT`. - > [!Warning] > Replication factors do not serve a purpose with single node instances. @@ -407,8 +404,8 @@ CREATE DATABASE "bar" WITH DURATION 1d REPLICATION 1 SHARD DURATION 30m NAME "my CREATE DATABASE "mydb" WITH NAME "myrp" -- Create a database called bar with a new retention policy named "myrp", and --- specify the duration, future and past limits, and name of that retention policy -CREATE DATABASE "bar" WITH DURATION 1d FUTURE LIMIT 6h PAST LIMIT 6h NAME "myrp" +-- 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 @@ -418,14 +415,11 @@ create_retention_policy_stmt = "CREATE RETENTION POLICY" policy_name on_clause retention_policy_duration retention_policy_replication [ retention_policy_shard_group_duration ] - [ retention_future_limit ] [ retention_past_limit ] + [ retention_future_limit ] [ "DEFAULT" ] . ``` -> [!Note] -> When using both `FUTURE LIMIT` and `PAST LIMIT` clauses, `FUTURE LIMIT` must appear before `PAST LIMIT`. - > [!Warning] > Replication factors do not serve a purpose with single node instances. @@ -441,8 +435,8 @@ 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 future and past limits. -CREATE RETENTION POLICY "10m.events" ON "somedb" DURATION 12h FUTURE LIMIT 6h PAST LIMIT 6h +-- 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 @@ -637,7 +631,7 @@ SIZE OF BLOCKS: 931 ### EXPLAIN ANALYZE -Executes the specified SELECT statement and returns data on the query performance and storage during runtime, visualized as a tree. Use this statement to analyze query performance and storage, including [execution time](#execution_time) and [planning time](#planning_time), and the [iterator type](#iterator-type) and [cursor type](#cursor-type). +Executes the specified SELECT statement and returns data on the query performance and storage during runtime, visualized as a tree. Use this statement to analyze query performance and storage, including [execution time](#execution-time) and [planning time](#planning-time), and the [iterator type](#iterator-type) and [cursor type](#cursor-type). For example, executing the following statement: @@ -683,11 +677,11 @@ EXPLAIN ANALYZE > Note: EXPLAIN ANALYZE ignores query output, so the cost of serialization to JSON or CSV is not accounted for. -#### execution_time +##### execution_time Shows the amount of time the query took to execute, including reading the time series data, performing operations as data flows through iterators, and draining processed data from iterators. Execution time doesn't include the time taken to serialize the output into JSON or other formats. -#### planning_time +##### planning_time Shows the amount of time the query took to plan. Planning a query in InfluxDB requires a number of steps. Depending on the complexity of the query, planning can require more work and consume more CPU and memory resources than the executing the query. For example, the number of series keys required to execute a query affects how quickly the query is planned and the required memory. @@ -700,16 +694,16 @@ Next, for each shard and each measurement, InfluxDB performs the following steps 3. Enumerate each tag set and create a cursor and iterator for each series key. 4. Merge iterators and return the merged result to the query executor. -#### iterator type +##### iterator type EXPLAIN ANALYZE supports the following iterator types: - `create_iterator` node represents work done by the local influxd instance──a complex composition of nested iterators combined and merged to produce the final query output. - (InfluxDB Enterprise only) `remote_iterator` node represents work done on remote machines. -For more information about iterators, see [Understanding iterators](/influxdb/v1/query_language/spec/#understanding-iterators). +For more information about iterators, see [Understanding iterators](#understanding-iterators). -#### cursor type +##### cursor type EXPLAIN ANALYZE distinguishes 3 cursor types. While the cursor types have the same data structures and equal CPU and I/O costs, each cursor type is constructed for a different reason and separated in the final output. Consider the following cursor types when tuning a statement: @@ -717,9 +711,9 @@ EXPLAIN ANALYZE distinguishes 3 cursor types. While the cursor types have the sa - cursor_aux: Auxiliary cursor created for simple expression projections (not selectors or an aggregation). For example, `SELECT foo FROM m` or `SELECT foo+bar FROM m`, where `foo` and `bar` are fields. - cursor_cond: Condition cursor created for fields referenced in a WHERE clause. -For more information about cursors, see [Understanding cursors](/influxdb/v1/query_language/spec/#understanding-cursors). +For more information about cursors, see [Understanding cursors](#understanding-cursors). -#### block types +##### block types EXPLAIN ANALYZE separates storage block types, and reports the total number of blocks decoded and their size (in bytes) on disk. The following block types are supported: @@ -733,8 +727,7 @@ For more information about storage blocks, see [TSM files](/enterprise_influxdb/ ### GRANT -> [!Note] -> Users can be granted privileges on databases that do not yet exist. +> **NOTE:** Users can be granted privileges on databases that do not yet exist. ``` grant_stmt = "GRANT" privilege [ on_clause ] to_clause . @@ -752,27 +745,29 @@ GRANT READ ON "mydb" TO "jdoe" ### KILL QUERY -Stop a currently-running query. +Stop currently-running query. -#### Syntax - -```text -KILL QUERY [ON ""] +``` +kill_query_statement = "KILL QUERY" query_id . ``` -Replace the following: +Where `query_id` is the query ID, displayed in the [`SHOW QUERIES`](/enterprise_influxdb/v1/troubleshooting/query_management/#list-currently-running-queries-with-show-queries) output as `qid`. -- `query_id`: your query ID (`qid`) from [`SHOW QUERIES`](/influxdb/v1/troubleshooting/query_management/#list-currently-running-queries-with-show-queries) -- `host`: your TCP host (for example, `myhost:8088`) from [`SHOW QUERIES`](/influxdb/v1/troubleshooting/query_management/#list-currently-running-queries-with-show-queries) - -To kill queries on a cluster, specify both the query ID and the TCP host. +> ***InfluxDB Enterprise clusters:*** To kill queries on a cluster, you need to specify the query ID (qid) and the TCP host (for example, `myhost:8088`), +> available in the `SHOW QUERIES` output. +> +> ```sql +KILL QUERY ON "" +``` #### Examples ```sql -- kill query with qid of 36 on the local host KILL QUERY 36 +``` +```sql -- kill query on InfluxDB Enterprise cluster KILL QUERY 53 ON "myhost:8088" ``` @@ -1009,8 +1004,7 @@ Estimates or counts exactly the cardinality of the series for the current databa - [When do I need more RAM?](/enterprise_influxdb/v1/guides/hardware_sizing/#when-do-i-need-more-ram) in [Hardware Sizing Guidelines](/enterprise_influxdb/v1/guides/hardware_sizing/) - [Don't have too many series](/enterprise_influxdb/v1/concepts/schema_and_data_layout/#avoid-too-many-series) -> [!Note] -> `ON `, `FROM `, `WITH KEY = `, `WHERE `, `GROUP BY `, and `LIMIT/OFFSET` clauses are optional. +> **Note:** `ON `, `FROM `, `WITH KEY = `, `WHERE `, `GROUP BY `, and `LIMIT/OFFSET` clauses are optional. > When using these query clauses, the query falls back to an exact count. > Filtering by `time` is not supported in the `WHERE` clause. @@ -1072,7 +1066,7 @@ id database retention_policy shard_group start_time end_time - `id` column: Shard IDs that belong to the specified `database` and `retention policy`. - `shard_group` column: Group number that a shard belongs to. Shards in the same shard group have the same `start_time` and `end_time`. This interval indicates how long the shard is active, and the `expiry_time` columns shows when the shard group expires. No timestamps will show under `expiry_time` if the retention policy duration is set to infinite. - `owners` column: Shows the data nodes that own a shard. The number of nodes that own a shard is equal to the replication factor. In this example, the replication factor is 3, so 3 nodes own each shard. - + ### SHOW STATS Returns detailed statistics on available components of an InfluxDB node and available (enabled) components. @@ -1105,17 +1099,18 @@ batches_tx bytes_rx connections_active connections_handled 159 3999750 0 1 158110 158110 ``` -### SHOW STATS FOR +### `SHOW STATS FOR ` For the specified component (\), the command returns available statistics. For the `runtime` component, the command returns an overview of memory usage by the InfluxDB system, using the [Go runtime](https://golang.org/pkg/runtime/) package. -### SHOW STATS FOR 'indexes' +### `SHOW STATS FOR 'indexes'` Returns an estimate of memory use of all indexes. Index memory use is not reported with `SHOW STATS` because it is a potentially expensive operation. + ### SHOW SUBSCRIPTIONS ``` @@ -1132,8 +1127,7 @@ SHOW SUBSCRIPTIONS Estimates or counts exactly the cardinality of tag key set on the current database unless a database is specified using the `ON ` option. -> [!Note] -> `ON `, `FROM `, `WITH KEY = `, `WHERE `, `GROUP BY `, and `LIMIT/OFFSET` clauses are optional. +> **Note:** `ON `, `FROM `, `WITH KEY = `, `WHERE `, `GROUP BY `, and `LIMIT/OFFSET` clauses are optional. > When using these query clauses, the query falls back to an exact count. > Filtering by `time` is only supported when TSI (Time Series Index) is enabled and `time` is not supported in the `WHERE` clause. @@ -1155,7 +1149,7 @@ SHOW TAG KEY EXACT CARDINALITY ### SHOW TAG KEYS ``` -show_tag_keys_stmt = "SHOW TAG KEYS" [on_clause] [with_key_clause] [ from_clause ] [ where_clause ] +show_tag_keys_stmt = "SHOW TAG KEYS" [on_clause] [ from_clause ] [ where_clause ] [ limit_clause ] [ offset_clause ] . ``` @@ -1173,9 +1167,6 @@ SHOW TAG KEYS FROM "cpu" WHERE "region" = 'uswest' -- show all tag keys where the host key = 'serverA' SHOW TAG KEYS WHERE "host" = 'serverA' - --- show specific tag keys -SHOW TAG KEYS WITH KEY IN ("region", "host") ``` ### SHOW TAG VALUES @@ -1205,8 +1196,7 @@ SHOW TAG VALUES FROM "cpu" WITH KEY IN ("region", "host") WHERE "service" = 'red Estimates or counts exactly the cardinality of tag key values for the specified tag key on the current database unless a database is specified using the `ON ` option. -> [!Note] -> `ON `, `FROM `, `WITH KEY = `, `WHERE `, `GROUP BY `, and `LIMIT/OFFSET` clauses are optional. +> **Note:** `ON `, `FROM `, `WITH KEY = `, `WHERE `, `GROUP BY `, and `LIMIT/OFFSET` clauses are optional. > When using these query clauses, the query falls back to an exact count. > Filtering by `time` is only supported when TSI (Time Series Index) is enabled. @@ -1342,8 +1332,6 @@ retention_policy = identifier . retention_policy_option = retention_policy_duration | retention_policy_replication | retention_policy_shard_group_duration | - retention_future_limit | - retention_past_limit | "DEFAULT" . retention_policy_duration = "DURATION" duration_lit . @@ -1352,10 +1340,6 @@ retention_policy_replication = "REPLICATION" int_lit . retention_policy_shard_group_duration = "SHARD DURATION" duration_lit . -retention_future_limit = "FUTURE LIMIT" duration_lit . - -retention_past_limit = "PAST LIMIT" duration_lit . - retention_policy_name = "NAME" identifier . series_id = int_lit . diff --git a/content/enterprise_influxdb/v1/tools/influxd-ctl/backup.md b/content/enterprise_influxdb/v1/tools/influxd-ctl/backup.md index bab03a74e..0c3e06469 100644 --- a/content/enterprise_influxdb/v1/tools/influxd-ctl/backup.md +++ b/content/enterprise_influxdb/v1/tools/influxd-ctl/backup.md @@ -48,49 +48,22 @@ influxd-ctl backup [flags] ## Flags -| Flag | Description | -| :---------------------- | :------------------------------------------------------------------ | -| `-db` | Database to backup | -| `-end` | End date for backup _(RFC3339 timestamp)_ | -| `-estimate` | Estimate the size of the requested backup | -| `-from` | Data node TCP address to prefer when backing up | -| `-full` | Perform a full backup _(deprecated in favor of `-strategy full`)_ | -| `-rp` | Retention policy to backup | -| `-shard` | Shard ID to backup | -| `-start` | Start date for backup _(RFC3339 timestamp)_ | -| `-strategy` | Backup strategy to use (`only-meta`, `full`, or `incremental`) | -| `-gzipCompressionLevel` | Level of compression to use (`default`, `full`, `speedy`, `none`) | -| `-cpuprofile` | Write backup execution to a cpu profile (`true` or `false`) | -| `-gzipBlockCount` | Change the blocks processed concurrently during backup compression | -| `-gzipBlockSize` | Change the size of compressed blocks during backup compression | +| Flag | Description | +| :---------- | :------------------------------------------------------------------ | +| `-db` | Database to backup | +| `-end` | End date for backup _(RFC3339 timestamp)_ | +| `-estimate` | Estimate the size of the requested backup | +| `-from` | Data node TCP address to prefer when backing up | +| `-full` | Perform an full backup _(deprecated in favour of `-strategy full`)_ | +| `-rp` | Retention policy to backup | +| `-shard` | Shard ID to backup | +| `-start` | Start date for backup _(RFC3339 timestamp)_ | +| `-strategy` | Backup strategy to use (`only-meta`, `full`, or `incremental`) | {{% caption %}} _Also see [`influxd-ctl` global flags](/enterprise_influxdb/v1/tools/influxd-ctl/#influxd-ctl-global-flags)._ {{% /caption %}} -## Backup compression {metadata="v1.12.3+"} - -You can adjust `-gzipCompressionLevel` to allow for faster backups with the tradeoff that data is less compressed. - -| Value | Description | Use Case | -| :------ | :--------------------------------- | :------------------------------------------ | -| default | Standard gzip compression | General purpose, balanced | -| full | Best compression ratio | Minimize storage when time isn't critical | -| speedy | Prioritizes speed over compression | Faster backups with moderate space increase | -| none | No compression | Maximum speed when storage isn't a concern | - -Running backups with different compression settings on ~5.3 GB of data: - -| Compression Level | Backup Time | Size on Disk | Notes | -| :---------------- | :---------: | :----------: | :---------------------------- | -| default | 51s | ~3.0 GB | ~50% compression ratio | -| full | 95s | ~2.7 GB | ~2x slower, ~10% less space | -| speedy | 23s | ~3.3 GB | ~2.2x faster, ~10% more space | -| none | 10s | ~5.3 GB | ~5x faster, ~77% more space | - -We do not recommend changing the values for `-gzipBlockCount` and `-gzipBlockSize`. -These are set to sensible defaults (block size is `1048576` bytes (`1024*1024`)) per the [pgzip library](https://github.com/klauspost/pgzip). - ## Examples - [Perform an incremental backup](#perform-an-incremental-backup) @@ -98,7 +71,6 @@ These are set to sensible defaults (block size is `1048576` bytes (`1024*1024`)) - [Estimate the size of a backup](#estimate-the-size-of-a-backup) - [Backup data from a specific time range](#backup-data-from-a-specific-time-range) - [Backup a specific shard](#backup-a-specific-shard) -- [Backup data with configured compression](#backup-data-with-configured-compression) ### Perform an incremental backup @@ -132,11 +104,3 @@ influxd-ctl backup \ ```sh influxd-ctl backup -shard 00 /path/to/backup-dir ``` - -### Backup data with configured compression - -The following example uses the fastest possible compression speeds for backup: - -```sh -influxd-ctl backup -strategy full -gzipBlockSize 10485760 -gzipBlockCount 28 -gzipCompressionLevel none . -``` diff --git a/data/products.yml b/data/products.yml index c4694165e..ec212bc84 100644 --- a/data/products.yml +++ b/data/products.yml @@ -349,7 +349,7 @@ enterprise_influxdb: versions: [v1] latest: v1.12 latest_patches: - v1: 1.12.3 + v1: 1.12.2 detector_config: query_languages: InfluxQL: From a445b7b70988f42ccc652508344dd9ca51e70b16 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 16 Mar 2026 09:50:09 -0500 Subject: [PATCH 20/27] chore(deps): update Vale to v3.14.0 (#6951) Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> --- .ci/vale/vale.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.ci/vale/vale.sh b/.ci/vale/vale.sh index e0f385f58..1ea3b422b 100755 --- a/.ci/vale/vale.sh +++ b/.ci/vale/vale.sh @@ -13,7 +13,7 @@ set -euo pipefail # --minAlertLevel=suggestion \ # --config=content/influxdb/cloud-dedicated/.vale.ini -VALE_VERSION="3.13.1" +VALE_VERSION="3.14.0" VALE_MAJOR_MIN=3 if command -v vale &>/dev/null; then From 8df6acda2ac1fb14a53e9abc428657771921aad1 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Mon, 16 Mar 2026 11:33:47 -0500 Subject: [PATCH 21/27] fix: update MCP server auth docs to include GitHub as sign-in option (#6952) The InfluxDB documentation MCP server (hosted by Kapa) now supports authentication via both Google and GitHub accounts. Update all references to reflect both providers and document GitHub's scope behavior (no scopes requested, public profile only). https://claude.ai/code/session_01X29cSTjYM6CQrxRJT62tG6 Co-authored-by: Claude --- .claude/skills/content-editing/SKILL.md | 4 ++-- .mcp.json | 2 +- .../influxdb3-admin/mcp-server-docs-only.md | 23 +++++++++++-------- content/shared/influxdb3-admin/mcp-server.md | 23 +++++++++++-------- 4 files changed, 29 insertions(+), 23 deletions(-) diff --git a/.claude/skills/content-editing/SKILL.md b/.claude/skills/content-editing/SKILL.md index 863b5c101..d34b1bd6b 100644 --- a/.claude/skills/content-editing/SKILL.md +++ b/.claude/skills/content-editing/SKILL.md @@ -364,7 +364,7 @@ The documentation MCP server is hosted at `https://influxdb-docs.mcp.kapa.ai`— Already configured in [`.mcp.json`](/.mcp.json). Two server entries are available: - **`influxdb-docs`** (API key) — Set `INFLUXDATA_DOCS_KAPA_API_KEY` env var. 60 req/min. -- **`influxdb-docs-oauth`** (OAuth) — No setup. Authenticates via Google on first use. 40 req/hr, 200 req/day. +- **`influxdb-docs-oauth`** (OAuth) — No setup. Authenticates via Google or GitHub on first use. 40 req/hr, 200 req/day. ### Available Tool @@ -534,7 +534,7 @@ touch content/influxdb3/enterprise/path/to/file.md **Troubleshooting steps:** - **API key auth** (`influxdb-docs`): Verify `INFLUXDATA_DOCS_KAPA_API_KEY` is set. Rate limit: 60 req/min. -- **OAuth auth** (`influxdb-docs-oauth`): Sign in with Google on first use. Rate limits: 40 req/hr, 200 req/day. +- **OAuth auth** (`influxdb-docs-oauth`): Sign in with Google or GitHub on first use. Rate limits: 40 req/hr, 200 req/day. - Verify your network allows connections to `*.kapa.ai` - Check if you've exceeded rate limits (wait and retry) diff --git a/.mcp.json b/.mcp.json index f53854090..f18a0f326 100644 --- a/.mcp.json +++ b/.mcp.json @@ -11,7 +11,7 @@ } }, "influxdb-docs-oauth": { - "comment": "Hosted InfluxDB documentation search (OAuth). No API key needed--authenticates via Google OAuth on first use. Rate limits: 40 req/hr, 200 req/day.", + "comment": "Hosted InfluxDB documentation search (OAuth). No API key needed--authenticates via Google or GitHub OAuth on first use. Rate limits: 40 req/hr, 200 req/day.", "type": "sse", "url": "https://influxdb-docs.mcp.kapa.ai" }, diff --git a/content/shared/influxdb3-admin/mcp-server-docs-only.md b/content/shared/influxdb3-admin/mcp-server-docs-only.md index f92a780f7..60ffaf7f1 100644 --- a/content/shared/influxdb3-admin/mcp-server-docs-only.md +++ b/content/shared/influxdb3-admin/mcp-server-docs-only.md @@ -22,7 +22,7 @@ The documentation MCP server is a hosted service—you don't need to install or Add the server URL to your AI assistant's MCP configuration. > [!Note] -> On first use, you'll be prompted to sign in with Google. +> On first use, you'll be prompted to sign in with a Google or GitHub account. > This authentication is used only for rate limiting—no personal data is collected. **MCP server URL:** @@ -168,23 +168,26 @@ The InfluxDB documentation search tools will be available in your OpenCode sessi ## Authentication and rate limits -When you connect to the documentation MCP server for the first time, a Google sign-in -window opens to complete an OAuth/OpenID Connect login. +When you connect to the documentation MCP server for the first time, a sign-in +window opens where you can choose to authenticate with a **Google** or **GitHub** account. -The hosted MCP server: +The hosted MCP server uses your account only to generate a stable, opaque user ID +for rate limiting—no personal data is collected: -- Requests only the `openid` scope from Google -- Receives an ID token (JWT) containing a stable, opaque user ID -- Does not request `email` or `profile` scopes—your name, email address, and other - personal data are not collected +- **Google**: Requests only the `openid` scope. Does not request `email` or `profile` + scopes—your name, email address, and other personal data are not collected. +- **GitHub**: Requests no OAuth scopes. With no scopes requested, GitHub grants + read-only access to public profile information only. The server does not access + repositories, organizations, email addresses, or other GitHub data. -The anonymous Google ID enforces per-user rate limits to prevent abuse: +The anonymous user ID enforces per-user rate limits to prevent abuse: - **40 requests** per user per hour - **200 requests** per user per day > [!Tip] -> On Google's consent screen, this appears as "Associate you with your personal info on Google." +> If you sign in with Google, the consent screen may display +> "Associate you with your personal info on Google." > This is Google's generic wording for the `openid` scope—it means the app can recognize > that the same Google account is signing in again. > It does not grant access to your email, name, contacts, or other data. diff --git a/content/shared/influxdb3-admin/mcp-server.md b/content/shared/influxdb3-admin/mcp-server.md index 87b3f86ea..98ede7cc0 100644 --- a/content/shared/influxdb3-admin/mcp-server.md +++ b/content/shared/influxdb3-admin/mcp-server.md @@ -382,7 +382,7 @@ The documentation MCP server is a hosted service—you don't need to install or Add the server URL to your AI assistant's MCP configuration. > [!Note] -> On first use, you'll be prompted to sign in with Google. +> On first use, you'll be prompted to sign in with a Google or GitHub account. > This authentication is used only for rate limiting—no personal data is collected. **MCP server URL:** @@ -528,23 +528,26 @@ The InfluxDB documentation search tools will be available in your OpenCode sessi ### Authentication and rate limits -When you connect to the documentation MCP server for the first time, a Google sign-in -window opens to complete an OAuth/OpenID Connect login. +When you connect to the documentation MCP server for the first time, a sign-in +window opens where you can choose to authenticate with a **Google** or **GitHub** account. -The hosted MCP server: +The hosted MCP server uses your account only to generate a stable, opaque user ID +for rate limiting—no personal data is collected: -- Requests only the `openid` scope from Google -- Receives an ID token (JWT) containing a stable, opaque user ID -- Does not request `email` or `profile` scopes—your name, email address, and other - personal data are not collected +- **Google**: Requests only the `openid` scope. Does not request `email` or `profile` + scopes—your name, email address, and other personal data are not collected. +- **GitHub**: Requests no OAuth scopes. With no scopes requested, GitHub grants + read-only access to public profile information only. The server does not access + repositories, organizations, email addresses, or other GitHub data. -The anonymous Google ID enforces per-user rate limits to prevent abuse: +The anonymous user ID enforces per-user rate limits to prevent abuse: - **40 requests** per user per hour - **200 requests** per user per day > [!Tip] -> On Google's consent screen, this appears as "Associate you with your personal info on Google." +> If you sign in with Google, the consent screen may display +> "Associate you with your personal info on Google." > This is Google's generic wording for the `openid` scope—it means the app can recognize > that the same Google account is signing in again. > It does not grant access to your email, name, contacts, or other data. From c83161c6c2fa463fc0eaefe72a7669d8981bd707 Mon Sep 17 00:00:00 2001 From: Sven Rebhan <36194019+srebhan@users.noreply.github.com> Date: Tue, 17 Mar 2026 02:57:49 +0100 Subject: [PATCH 22/27] Telegraf v1.38.1 (#6954) * Updating changelog * Updating product version * Updating plugins --- .../aggregator-plugins/basicstats/_index.md | 2 +- .../aggregator-plugins/derivative/_index.md | 2 +- .../v1/aggregator-plugins/final/_index.md | 2 +- .../v1/aggregator-plugins/histogram/_index.md | 2 +- .../v1/aggregator-plugins/merge/_index.md | 2 +- .../v1/aggregator-plugins/minmax/_index.md | 2 +- .../v1/aggregator-plugins/quantile/_index.md | 2 +- .../v1/aggregator-plugins/starlark/_index.md | 2 +- .../aggregator-plugins/valuecounter/_index.md | 2 +- .../v1/input-plugins/activemq/_index.md | 2 +- .../v1/input-plugins/aerospike/_index.md | 2 +- .../v1/input-plugins/aliyuncms/_index.md | 2 +- .../v1/input-plugins/amd_rocm_smi/_index.md | 2 +- .../v1/input-plugins/amqp_consumer/_index.md | 2 +- .../v1/input-plugins/apache/_index.md | 2 +- .../v1/input-plugins/apcupsd/_index.md | 2 +- .../v1/input-plugins/aurora/_index.md | 2 +- .../v1/input-plugins/azure_monitor/_index.md | 2 +- .../azure_storage_queue/_index.md | 2 +- .../v1/input-plugins/bcache/_index.md | 2 +- .../v1/input-plugins/beanstalkd/_index.md | 2 +- .../telegraf/v1/input-plugins/beat/_index.md | 2 +- .../telegraf/v1/input-plugins/bind/_index.md | 2 +- .../telegraf/v1/input-plugins/bond/_index.md | 2 +- .../v1/input-plugins/burrow/_index.md | 2 +- .../telegraf/v1/input-plugins/ceph/_index.md | 2 +- .../v1/input-plugins/cgroup/_index.md | 2 +- .../v1/input-plugins/chrony/_index.md | 2 +- .../cisco_telemetry_mdt/_index.md | 2 +- .../v1/input-plugins/clickhouse/_index.md | 2 +- .../v1/input-plugins/cloud_pubsub/_index.md | 2 +- .../input-plugins/cloud_pubsub_push/_index.md | 2 +- .../v1/input-plugins/cloudwatch/_index.md | 2 +- .../cloudwatch_metric_streams/_index.md | 2 +- .../v1/input-plugins/conntrack/_index.md | 2 +- .../v1/input-plugins/consul/_index.md | 2 +- .../v1/input-plugins/consul_agent/_index.md | 2 +- .../v1/input-plugins/couchbase/_index.md | 2 +- .../v1/input-plugins/couchdb/_index.md | 2 +- .../telegraf/v1/input-plugins/cpu/_index.md | 2 +- .../telegraf/v1/input-plugins/csgo/_index.md | 2 +- .../input-plugins/ctrlx_datalayer/_index.md | 2 +- .../telegraf/v1/input-plugins/dcos/_index.md | 2 +- .../input-plugins/directory_monitor/_index.md | 2 +- .../telegraf/v1/input-plugins/disk/_index.md | 2 +- .../v1/input-plugins/diskio/_index.md | 2 +- .../v1/input-plugins/disque/_index.md | 2 +- .../v1/input-plugins/dmcache/_index.md | 2 +- .../v1/input-plugins/dns_query/_index.md | 2 +- .../v1/input-plugins/docker/_index.md | 2 +- .../v1/input-plugins/docker_log/_index.md | 2 +- .../v1/input-plugins/dovecot/_index.md | 2 +- .../telegraf/v1/input-plugins/dpdk/_index.md | 2 +- .../telegraf/v1/input-plugins/ecs/_index.md | 2 +- .../v1/input-plugins/elasticsearch/_index.md | 2 +- .../elasticsearch_query/_index.md | 2 +- .../v1/input-plugins/ethtool/_index.md | 2 +- .../input-plugins/eventhub_consumer/_index.md | 2 +- .../telegraf/v1/input-plugins/exec/_index.md | 17 +++++++++-- .../telegraf/v1/input-plugins/execd/_index.md | 2 +- .../v1/input-plugins/fail2ban/_index.md | 2 +- .../v1/input-plugins/fibaro/_index.md | 2 +- .../telegraf/v1/input-plugins/file/_index.md | 2 +- .../v1/input-plugins/filecount/_index.md | 2 +- .../v1/input-plugins/filestat/_index.md | 2 +- .../v1/input-plugins/fireboard/_index.md | 2 +- .../v1/input-plugins/firehose/_index.md | 2 +- .../v1/input-plugins/fluentd/_index.md | 2 +- .../v1/input-plugins/fritzbox/_index.md | 2 +- .../v1/input-plugins/github/_index.md | 2 +- .../telegraf/v1/input-plugins/gnmi/_index.md | 2 +- .../google_cloud_storage/_index.md | 2 +- .../v1/input-plugins/graylog/_index.md | 2 +- .../v1/input-plugins/haproxy/_index.md | 2 +- .../v1/input-plugins/hddtemp/_index.md | 2 +- .../telegraf/v1/input-plugins/http/_index.md | 2 +- .../input-plugins/http_listener_v2/_index.md | 2 +- .../v1/input-plugins/http_response/_index.md | 2 +- .../v1/input-plugins/huebridge/_index.md | 2 +- .../v1/input-plugins/hugepages/_index.md | 2 +- .../v1/input-plugins/icinga2/_index.md | 2 +- .../v1/input-plugins/infiniband/_index.md | 2 +- .../v1/input-plugins/influxdb/_index.md | 2 +- .../input-plugins/influxdb_listener/_index.md | 2 +- .../influxdb_v2_listener/_index.md | 2 +- .../v1/input-plugins/intel_baseband/_index.md | 2 +- .../v1/input-plugins/intel_dlb/_index.md | 2 +- .../v1/input-plugins/intel_pmt/_index.md | 2 +- .../v1/input-plugins/intel_pmu/_index.md | 2 +- .../input-plugins/intel_powerstat/_index.md | 2 +- .../v1/input-plugins/intel_rdt/_index.md | 2 +- .../v1/input-plugins/internal/_index.md | 2 +- .../v1/input-plugins/internet_speed/_index.md | 2 +- .../v1/input-plugins/interrupts/_index.md | 2 +- .../v1/input-plugins/ipmi_sensor/_index.md | 2 +- .../telegraf/v1/input-plugins/ipset/_index.md | 2 +- .../v1/input-plugins/iptables/_index.md | 2 +- .../telegraf/v1/input-plugins/ipvs/_index.md | 2 +- .../v1/input-plugins/jenkins/_index.md | 2 +- .../v1/input-plugins/jolokia2_agent/_index.md | 2 +- .../v1/input-plugins/jolokia2_proxy/_index.md | 2 +- .../jti_openconfig_telemetry/_index.md | 2 +- .../v1/input-plugins/kafka_consumer/_index.md | 2 +- .../v1/input-plugins/kapacitor/_index.md | 2 +- .../v1/input-plugins/kernel/_index.md | 2 +- .../v1/input-plugins/kernel_vmstat/_index.md | 2 +- .../v1/input-plugins/kibana/_index.md | 2 +- .../input-plugins/kinesis_consumer/_index.md | 2 +- .../v1/input-plugins/knx_listener/_index.md | 2 +- .../v1/input-plugins/kube_inventory/_index.md | 2 +- .../v1/input-plugins/kubernetes/_index.md | 2 +- .../telegraf/v1/input-plugins/lanz/_index.md | 2 +- .../telegraf/v1/input-plugins/ldap/_index.md | 2 +- .../telegraf/v1/input-plugins/leofs/_index.md | 2 +- .../v1/input-plugins/libvirt/_index.md | 2 +- .../v1/input-plugins/linux_cpu/_index.md | 2 +- .../input-plugins/linux_sysctl_fs/_index.md | 2 +- .../telegraf/v1/input-plugins/logql/_index.md | 2 +- .../v1/input-plugins/logstash/_index.md | 2 +- .../v1/input-plugins/lustre2/_index.md | 2 +- .../telegraf/v1/input-plugins/lvm/_index.md | 2 +- .../v1/input-plugins/mailchimp/_index.md | 2 +- .../v1/input-plugins/marklogic/_index.md | 2 +- .../v1/input-plugins/mavlink/_index.md | 2 +- .../v1/input-plugins/mcrouter/_index.md | 2 +- .../v1/input-plugins/mdstat/_index.md | 2 +- .../telegraf/v1/input-plugins/mem/_index.md | 2 +- .../v1/input-plugins/memcached/_index.md | 2 +- .../telegraf/v1/input-plugins/mesos/_index.md | 2 +- .../v1/input-plugins/minecraft/_index.md | 2 +- .../telegraf/v1/input-plugins/mock/_index.md | 2 +- .../v1/input-plugins/modbus/_index.md | 2 +- .../v1/input-plugins/mongodb/_index.md | 2 +- .../telegraf/v1/input-plugins/monit/_index.md | 2 +- .../v1/input-plugins/mqtt_consumer/_index.md | 2 +- .../v1/input-plugins/multifile/_index.md | 2 +- .../telegraf/v1/input-plugins/mysql/_index.md | 2 +- .../telegraf/v1/input-plugins/nats/_index.md | 2 +- .../v1/input-plugins/nats_consumer/_index.md | 2 +- .../v1/input-plugins/neoom_beaam/_index.md | 2 +- .../v1/input-plugins/neptune_apex/_index.md | 2 +- .../telegraf/v1/input-plugins/net/_index.md | 2 +- .../v1/input-plugins/net_response/_index.md | 2 +- .../v1/input-plugins/netflow/_index.md | 2 +- .../v1/input-plugins/netstat/_index.md | 2 +- .../v1/input-plugins/nfsclient/_index.md | 2 +- .../v1/input-plugins/nftables/_index.md | 2 +- .../telegraf/v1/input-plugins/nginx/_index.md | 2 +- .../v1/input-plugins/nginx_plus/_index.md | 2 +- .../v1/input-plugins/nginx_plus_api/_index.md | 2 +- .../v1/input-plugins/nginx_sts/_index.md | 2 +- .../nginx_upstream_check/_index.md | 2 +- .../v1/input-plugins/nginx_vts/_index.md | 2 +- .../telegraf/v1/input-plugins/nomad/_index.md | 2 +- .../telegraf/v1/input-plugins/nsd/_index.md | 2 +- .../telegraf/v1/input-plugins/nsdp/_index.md | 2 +- .../telegraf/v1/input-plugins/nsq/_index.md | 2 +- .../v1/input-plugins/nsq_consumer/_index.md | 2 +- .../telegraf/v1/input-plugins/nstat/_index.md | 2 +- .../telegraf/v1/input-plugins/ntpq/_index.md | 2 +- .../v1/input-plugins/nvidia_smi/_index.md | 2 +- .../telegraf/v1/input-plugins/opcua/_index.md | 2 +- .../v1/input-plugins/opcua_listener/_index.md | 2 +- .../v1/input-plugins/openldap/_index.md | 2 +- .../v1/input-plugins/openntpd/_index.md | 2 +- .../input-plugins/opensearch_query/_index.md | 2 +- .../v1/input-plugins/opensmtpd/_index.md | 2 +- .../v1/input-plugins/openstack/_index.md | 2 +- .../v1/input-plugins/opentelemetry/_index.md | 2 +- .../v1/input-plugins/openweathermap/_index.md | 2 +- .../v1/input-plugins/p4runtime/_index.md | 2 +- .../v1/input-plugins/passenger/_index.md | 2 +- .../telegraf/v1/input-plugins/pf/_index.md | 2 +- .../v1/input-plugins/pgbouncer/_index.md | 2 +- .../v1/input-plugins/phpfpm/_index.md | 2 +- .../telegraf/v1/input-plugins/ping/_index.md | 12 +++++--- .../v1/input-plugins/postfix/_index.md | 2 +- .../v1/input-plugins/postgresql/_index.md | 2 +- .../postgresql_extensible/_index.md | 2 +- .../v1/input-plugins/powerdns/_index.md | 2 +- .../input-plugins/powerdns_recursor/_index.md | 2 +- .../v1/input-plugins/processes/_index.md | 2 +- .../v1/input-plugins/procstat/_index.md | 2 +- .../v1/input-plugins/prometheus/_index.md | 2 +- .../v1/input-plugins/promql/_index.md | 2 +- .../v1/input-plugins/proxmox/_index.md | 2 +- .../v1/input-plugins/puppetagent/_index.md | 2 +- .../v1/input-plugins/rabbitmq/_index.md | 2 +- .../v1/input-plugins/radius/_index.md | 2 +- .../v1/input-plugins/raindrops/_index.md | 2 +- .../telegraf/v1/input-plugins/ras/_index.md | 2 +- .../v1/input-plugins/ravendb/_index.md | 2 +- .../v1/input-plugins/redfish/_index.md | 2 +- .../telegraf/v1/input-plugins/redis/_index.md | 2 +- .../v1/input-plugins/redis_sentinel/_index.md | 2 +- .../v1/input-plugins/rethinkdb/_index.md | 2 +- .../telegraf/v1/input-plugins/riak/_index.md | 2 +- .../input-plugins/riemann_listener/_index.md | 2 +- .../v1/input-plugins/s7comm/_index.md | 2 +- .../v1/input-plugins/salesforce/_index.md | 2 +- .../v1/input-plugins/sensors/_index.md | 2 +- .../telegraf/v1/input-plugins/sflow/_index.md | 2 +- .../telegraf/v1/input-plugins/sip/_index.md | 2 +- .../telegraf/v1/input-plugins/slab/_index.md | 2 +- .../telegraf/v1/input-plugins/slurm/_index.md | 2 +- .../telegraf/v1/input-plugins/smart/_index.md | 2 +- .../v1/input-plugins/smartctl/_index.md | 2 +- .../telegraf/v1/input-plugins/snmp/_index.md | 2 +- .../v1/input-plugins/snmp_trap/_index.md | 2 +- .../input-plugins/socket_listener/_index.md | 2 +- .../v1/input-plugins/socketstat/_index.md | 2 +- .../telegraf/v1/input-plugins/solr/_index.md | 2 +- .../telegraf/v1/input-plugins/sql/_index.md | 2 +- .../v1/input-plugins/sqlserver/_index.md | 2 +- .../v1/input-plugins/stackdriver/_index.md | 2 +- .../v1/input-plugins/statsd/_index.md | 2 +- .../v1/input-plugins/supervisor/_index.md | 2 +- .../v1/input-plugins/suricata/_index.md | 2 +- .../telegraf/v1/input-plugins/swap/_index.md | 2 +- .../v1/input-plugins/synproxy/_index.md | 2 +- .../v1/input-plugins/syslog/_index.md | 2 +- .../v1/input-plugins/sysstat/_index.md | 2 +- .../v1/input-plugins/system/_index.md | 2 +- .../v1/input-plugins/systemd_units/_index.md | 2 +- .../v1/input-plugins/tacacs/_index.md | 2 +- .../telegraf/v1/input-plugins/tail/_index.md | 2 +- .../v1/input-plugins/teamspeak/_index.md | 2 +- .../telegraf/v1/input-plugins/temp/_index.md | 2 +- .../v1/input-plugins/tengine/_index.md | 2 +- .../telegraf/v1/input-plugins/timex/_index.md | 2 +- .../v1/input-plugins/tomcat/_index.md | 2 +- .../telegraf/v1/input-plugins/trig/_index.md | 2 +- .../v1/input-plugins/turbostat/_index.md | 2 +- .../v1/input-plugins/twemproxy/_index.md | 2 +- .../v1/input-plugins/unbound/_index.md | 2 +- .../telegraf/v1/input-plugins/upsd/_index.md | 2 +- .../telegraf/v1/input-plugins/uwsgi/_index.md | 2 +- .../v1/input-plugins/varnish/_index.md | 2 +- .../telegraf/v1/input-plugins/vault/_index.md | 2 +- .../v1/input-plugins/vsphere/_index.md | 2 +- .../v1/input-plugins/webhooks/_index.md | 2 +- .../telegraf/v1/input-plugins/whois/_index.md | 2 +- .../v1/input-plugins/win_eventlog/_index.md | 2 +- .../input-plugins/win_perf_counters/_index.md | 2 +- .../v1/input-plugins/win_services/_index.md | 2 +- .../v1/input-plugins/win_wmi/_index.md | 2 +- .../v1/input-plugins/wireguard/_index.md | 2 +- .../v1/input-plugins/wireless/_index.md | 2 +- .../v1/input-plugins/x509_cert/_index.md | 2 +- .../v1/input-plugins/xtremio/_index.md | 2 +- .../telegraf/v1/input-plugins/zfs/_index.md | 2 +- .../v1/input-plugins/zipkin/_index.md | 2 +- .../v1/input-plugins/zookeeper/_index.md | 2 +- .../telegraf/v1/output-plugins/amon/_index.md | 2 +- .../telegraf/v1/output-plugins/amqp/_index.md | 2 +- .../application_insights/_index.md | 2 +- .../telegraf/v1/output-plugins/arc/_index.md | 2 +- .../azure_data_explorer/_index.md | 2 +- .../v1/output-plugins/azure_monitor/_index.md | 2 +- .../v1/output-plugins/bigquery/_index.md | 2 +- .../v1/output-plugins/clarify/_index.md | 2 +- .../v1/output-plugins/cloud_pubsub/_index.md | 2 +- .../v1/output-plugins/cloudwatch/_index.md | 2 +- .../output-plugins/cloudwatch_logs/_index.md | 2 +- .../v1/output-plugins/cratedb/_index.md | 2 +- .../v1/output-plugins/datadog/_index.md | 2 +- .../v1/output-plugins/discard/_index.md | 2 +- .../v1/output-plugins/dynatrace/_index.md | 2 +- .../v1/output-plugins/elasticsearch/_index.md | 2 +- .../v1/output-plugins/event_hubs/_index.md | 2 +- .../telegraf/v1/output-plugins/exec/_index.md | 2 +- .../v1/output-plugins/execd/_index.md | 2 +- .../telegraf/v1/output-plugins/file/_index.md | 2 +- .../v1/output-plugins/graphite/_index.md | 2 +- .../v1/output-plugins/graylog/_index.md | 2 +- .../v1/output-plugins/groundwork/_index.md | 2 +- .../v1/output-plugins/health/_index.md | 2 +- .../v1/output-plugins/heartbeat/_index.md | 2 +- .../telegraf/v1/output-plugins/http/_index.md | 2 +- .../v1/output-plugins/influxdb/_index.md | 2 +- .../v1/output-plugins/influxdb_v2/_index.md | 2 +- .../v1/output-plugins/influxdb_v3/_index.md | 2 +- .../v1/output-plugins/inlong/_index.md | 2 +- .../v1/output-plugins/instrumental/_index.md | 2 +- .../v1/output-plugins/iotdb/_index.md | 2 +- .../v1/output-plugins/kafka/_index.md | 2 +- .../v1/output-plugins/kinesis/_index.md | 2 +- .../v1/output-plugins/librato/_index.md | 2 +- .../v1/output-plugins/logzio/_index.md | 2 +- .../telegraf/v1/output-plugins/loki/_index.md | 2 +- .../output-plugins/microsoft_fabric/_index.md | 2 +- .../v1/output-plugins/mongodb/_index.md | 2 +- .../telegraf/v1/output-plugins/mqtt/_index.md | 2 +- .../telegraf/v1/output-plugins/nats/_index.md | 2 +- .../nebius_cloud_monitoring/_index.md | 2 +- .../v1/output-plugins/newrelic/_index.md | 2 +- .../telegraf/v1/output-plugins/nsq/_index.md | 2 +- .../v1/output-plugins/opensearch/_index.md | 2 +- .../v1/output-plugins/opentelemetry/_index.md | 2 +- .../v1/output-plugins/opentsdb/_index.md | 2 +- .../v1/output-plugins/parquet/_index.md | 2 +- .../v1/output-plugins/postgresql/_index.md | 2 +- .../prometheus_client/_index.md | 2 +- .../telegraf/v1/output-plugins/quix/_index.md | 2 +- .../output-plugins/redistimeseries/_index.md | 2 +- .../v1/output-plugins/remotefile/_index.md | 2 +- .../v1/output-plugins/riemann/_index.md | 2 +- .../v1/output-plugins/sensu/_index.md | 2 +- .../v1/output-plugins/signalfx/_index.md | 2 +- .../v1/output-plugins/socket_writer/_index.md | 2 +- .../telegraf/v1/output-plugins/sql/_index.md | 2 +- .../v1/output-plugins/stackdriver/_index.md | 2 +- .../v1/output-plugins/stomp/_index.md | 2 +- .../v1/output-plugins/sumologic/_index.md | 2 +- .../v1/output-plugins/syslog/_index.md | 2 +- .../v1/output-plugins/timestream/_index.md | 2 +- .../v1/output-plugins/warp10/_index.md | 2 +- .../v1/output-plugins/wavefront/_index.md | 2 +- .../v1/output-plugins/websocket/_index.md | 2 +- .../yandex_cloud_monitoring/_index.md | 2 +- .../v1/output-plugins/zabbix/_index.md | 2 +- .../v1/processor-plugins/aws_ec2/_index.md | 2 +- .../v1/processor-plugins/batch/_index.md | 2 +- .../v1/processor-plugins/clone/_index.md | 2 +- .../v1/processor-plugins/converter/_index.md | 2 +- .../cumulative_sum/_index.md | 2 +- .../v1/processor-plugins/date/_index.md | 2 +- .../v1/processor-plugins/dedup/_index.md | 2 +- .../v1/processor-plugins/defaults/_index.md | 2 +- .../v1/processor-plugins/enum/_index.md | 2 +- .../v1/processor-plugins/execd/_index.md | 2 +- .../v1/processor-plugins/filepath/_index.md | 2 +- .../v1/processor-plugins/filter/_index.md | 2 +- .../v1/processor-plugins/ifname/_index.md | 2 +- .../v1/processor-plugins/lookup/_index.md | 2 +- .../v1/processor-plugins/noise/_index.md | 2 +- .../v1/processor-plugins/override/_index.md | 2 +- .../v1/processor-plugins/parser/_index.md | 2 +- .../v1/processor-plugins/pivot/_index.md | 2 +- .../v1/processor-plugins/port_name/_index.md | 2 +- .../v1/processor-plugins/printer/_index.md | 2 +- .../v1/processor-plugins/regex/_index.md | 2 +- .../v1/processor-plugins/rename/_index.md | 2 +- .../processor-plugins/reverse_dns/_index.md | 2 +- .../v1/processor-plugins/round/_index.md | 2 +- .../v1/processor-plugins/s2geo/_index.md | 2 +- .../v1/processor-plugins/scale/_index.md | 2 +- .../processor-plugins/snmp_lookup/_index.md | 2 +- .../v1/processor-plugins/split/_index.md | 2 +- .../v1/processor-plugins/starlark/_index.md | 2 +- .../v1/processor-plugins/strings/_index.md | 2 +- .../v1/processor-plugins/tag_limit/_index.md | 2 +- .../v1/processor-plugins/template/_index.md | 2 +- .../v1/processor-plugins/timestamp/_index.md | 2 +- .../v1/processor-plugins/topk/_index.md | 2 +- .../v1/processor-plugins/unpivot/_index.md | 2 +- content/telegraf/v1/release-notes.md | 30 +++++++++++++++++++ data/products.yml | 2 +- 358 files changed, 407 insertions(+), 362 deletions(-) diff --git a/content/telegraf/v1/aggregator-plugins/basicstats/_index.md b/content/telegraf/v1/aggregator-plugins/basicstats/_index.md index 761316c00..9934f2147 100644 --- a/content/telegraf/v1/aggregator-plugins/basicstats/_index.md +++ b/content/telegraf/v1/aggregator-plugins/basicstats/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/aggregators/basicstats/README.md, Basic Statistics Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/aggregators/basicstats/README.md, Basic Statistics Plugin Source --- # Basic Statistics Aggregator Plugin diff --git a/content/telegraf/v1/aggregator-plugins/derivative/_index.md b/content/telegraf/v1/aggregator-plugins/derivative/_index.md index ac8c7622c..342e166e6 100644 --- a/content/telegraf/v1/aggregator-plugins/derivative/_index.md +++ b/content/telegraf/v1/aggregator-plugins/derivative/_index.md @@ -10,7 +10,7 @@ introduced: "v1.18.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/aggregators/derivative/README.md, Derivative Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/aggregators/derivative/README.md, Derivative Plugin Source --- # Derivative Aggregator Plugin diff --git a/content/telegraf/v1/aggregator-plugins/final/_index.md b/content/telegraf/v1/aggregator-plugins/final/_index.md index 50c244777..9b54fb53c 100644 --- a/content/telegraf/v1/aggregator-plugins/final/_index.md +++ b/content/telegraf/v1/aggregator-plugins/final/_index.md @@ -10,7 +10,7 @@ introduced: "v1.11.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/aggregators/final/README.md, Final Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/aggregators/final/README.md, Final Plugin Source --- # Final Aggregator Plugin diff --git a/content/telegraf/v1/aggregator-plugins/histogram/_index.md b/content/telegraf/v1/aggregator-plugins/histogram/_index.md index 9e679991c..ee9dce32f 100644 --- a/content/telegraf/v1/aggregator-plugins/histogram/_index.md +++ b/content/telegraf/v1/aggregator-plugins/histogram/_index.md @@ -10,7 +10,7 @@ introduced: "v1.4.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/aggregators/histogram/README.md, Histogram Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/aggregators/histogram/README.md, Histogram Plugin Source --- # Histogram Aggregator Plugin diff --git a/content/telegraf/v1/aggregator-plugins/merge/_index.md b/content/telegraf/v1/aggregator-plugins/merge/_index.md index 46d645c45..31e83af02 100644 --- a/content/telegraf/v1/aggregator-plugins/merge/_index.md +++ b/content/telegraf/v1/aggregator-plugins/merge/_index.md @@ -10,7 +10,7 @@ introduced: "v1.13.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/aggregators/merge/README.md, Merge Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/aggregators/merge/README.md, Merge Plugin Source --- # Merge Aggregator Plugin diff --git a/content/telegraf/v1/aggregator-plugins/minmax/_index.md b/content/telegraf/v1/aggregator-plugins/minmax/_index.md index 70c4bfd1b..9ab75d087 100644 --- a/content/telegraf/v1/aggregator-plugins/minmax/_index.md +++ b/content/telegraf/v1/aggregator-plugins/minmax/_index.md @@ -10,7 +10,7 @@ introduced: "v1.1.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/aggregators/minmax/README.md, Minimum-Maximum Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/aggregators/minmax/README.md, Minimum-Maximum Plugin Source --- # Minimum-Maximum Aggregator Plugin diff --git a/content/telegraf/v1/aggregator-plugins/quantile/_index.md b/content/telegraf/v1/aggregator-plugins/quantile/_index.md index b46d45cbb..48d03f126 100644 --- a/content/telegraf/v1/aggregator-plugins/quantile/_index.md +++ b/content/telegraf/v1/aggregator-plugins/quantile/_index.md @@ -10,7 +10,7 @@ introduced: "v1.18.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/aggregators/quantile/README.md, Quantile Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/aggregators/quantile/README.md, Quantile Plugin Source --- # Quantile Aggregator Plugin diff --git a/content/telegraf/v1/aggregator-plugins/starlark/_index.md b/content/telegraf/v1/aggregator-plugins/starlark/_index.md index 98a47d683..b4571a150 100644 --- a/content/telegraf/v1/aggregator-plugins/starlark/_index.md +++ b/content/telegraf/v1/aggregator-plugins/starlark/_index.md @@ -10,7 +10,7 @@ introduced: "v1.21.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/aggregators/starlark/README.md, Starlark Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/aggregators/starlark/README.md, Starlark Plugin Source --- # Starlark Aggregator Plugin diff --git a/content/telegraf/v1/aggregator-plugins/valuecounter/_index.md b/content/telegraf/v1/aggregator-plugins/valuecounter/_index.md index 9877f44bb..7ca97e020 100644 --- a/content/telegraf/v1/aggregator-plugins/valuecounter/_index.md +++ b/content/telegraf/v1/aggregator-plugins/valuecounter/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/aggregators/valuecounter/README.md, Value Counter Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/aggregators/valuecounter/README.md, Value Counter Plugin Source --- # Value Counter Aggregator Plugin diff --git a/content/telegraf/v1/input-plugins/activemq/_index.md b/content/telegraf/v1/input-plugins/activemq/_index.md index eb3db060e..7a794f1e6 100644 --- a/content/telegraf/v1/input-plugins/activemq/_index.md +++ b/content/telegraf/v1/input-plugins/activemq/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/activemq/README.md, ActiveMQ Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/activemq/README.md, ActiveMQ Plugin Source --- # ActiveMQ Input Plugin diff --git a/content/telegraf/v1/input-plugins/aerospike/_index.md b/content/telegraf/v1/input-plugins/aerospike/_index.md index 377fdcacb..efc731210 100644 --- a/content/telegraf/v1/input-plugins/aerospike/_index.md +++ b/content/telegraf/v1/input-plugins/aerospike/_index.md @@ -12,7 +12,7 @@ removal: v1.40.0 os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/aerospike/README.md, Aerospike Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/aerospike/README.md, Aerospike Plugin Source --- # Aerospike Input Plugin diff --git a/content/telegraf/v1/input-plugins/aliyuncms/_index.md b/content/telegraf/v1/input-plugins/aliyuncms/_index.md index 7d1430371..ad92d7c49 100644 --- a/content/telegraf/v1/input-plugins/aliyuncms/_index.md +++ b/content/telegraf/v1/input-plugins/aliyuncms/_index.md @@ -10,7 +10,7 @@ introduced: "v1.19.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/aliyuncms/README.md, Alibaba Cloud Monitor Service (Aliyun) Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/aliyuncms/README.md, Alibaba Cloud Monitor Service (Aliyun) Plugin Source --- # Alibaba Cloud Monitor Service (Aliyun) Input Plugin diff --git a/content/telegraf/v1/input-plugins/amd_rocm_smi/_index.md b/content/telegraf/v1/input-plugins/amd_rocm_smi/_index.md index fa47fb0ff..62619a52b 100644 --- a/content/telegraf/v1/input-plugins/amd_rocm_smi/_index.md +++ b/content/telegraf/v1/input-plugins/amd_rocm_smi/_index.md @@ -10,7 +10,7 @@ introduced: "v1.20.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/amd_rocm_smi/README.md, AMD ROCm System Management Interface (SMI) Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/amd_rocm_smi/README.md, AMD ROCm System Management Interface (SMI) Plugin Source --- # AMD ROCm System Management Interface (SMI) Input Plugin diff --git a/content/telegraf/v1/input-plugins/amqp_consumer/_index.md b/content/telegraf/v1/input-plugins/amqp_consumer/_index.md index cf55e8315..761ef2d3f 100644 --- a/content/telegraf/v1/input-plugins/amqp_consumer/_index.md +++ b/content/telegraf/v1/input-plugins/amqp_consumer/_index.md @@ -10,7 +10,7 @@ introduced: "v1.3.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/amqp_consumer/README.md, AMQP Consumer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/amqp_consumer/README.md, AMQP Consumer Plugin Source --- # AMQP Consumer Input Plugin diff --git a/content/telegraf/v1/input-plugins/apache/_index.md b/content/telegraf/v1/input-plugins/apache/_index.md index 5352b30b8..ae7f979a9 100644 --- a/content/telegraf/v1/input-plugins/apache/_index.md +++ b/content/telegraf/v1/input-plugins/apache/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/apache/README.md, Apache Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/apache/README.md, Apache Plugin Source --- # Apache Input Plugin diff --git a/content/telegraf/v1/input-plugins/apcupsd/_index.md b/content/telegraf/v1/input-plugins/apcupsd/_index.md index 1f081d193..b80eee70f 100644 --- a/content/telegraf/v1/input-plugins/apcupsd/_index.md +++ b/content/telegraf/v1/input-plugins/apcupsd/_index.md @@ -10,7 +10,7 @@ introduced: "v1.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/apcupsd/README.md, APC UPSD Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/apcupsd/README.md, APC UPSD Plugin Source --- # APC UPSD Input Plugin diff --git a/content/telegraf/v1/input-plugins/aurora/_index.md b/content/telegraf/v1/input-plugins/aurora/_index.md index d56c935f8..f2cda189b 100644 --- a/content/telegraf/v1/input-plugins/aurora/_index.md +++ b/content/telegraf/v1/input-plugins/aurora/_index.md @@ -10,7 +10,7 @@ introduced: "v1.7.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/aurora/README.md, Apache Aurora Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/aurora/README.md, Apache Aurora Plugin Source --- # Apache Aurora Input Plugin diff --git a/content/telegraf/v1/input-plugins/azure_monitor/_index.md b/content/telegraf/v1/input-plugins/azure_monitor/_index.md index 47a1bbbfe..59f59f1c7 100644 --- a/content/telegraf/v1/input-plugins/azure_monitor/_index.md +++ b/content/telegraf/v1/input-plugins/azure_monitor/_index.md @@ -10,7 +10,7 @@ introduced: "v1.25.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/azure_monitor/README.md, Azure Monitor Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/azure_monitor/README.md, Azure Monitor Plugin Source --- # Azure Monitor Input Plugin diff --git a/content/telegraf/v1/input-plugins/azure_storage_queue/_index.md b/content/telegraf/v1/input-plugins/azure_storage_queue/_index.md index 0fdf846ca..f525d2c32 100644 --- a/content/telegraf/v1/input-plugins/azure_storage_queue/_index.md +++ b/content/telegraf/v1/input-plugins/azure_storage_queue/_index.md @@ -10,7 +10,7 @@ introduced: "v1.13.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/azure_storage_queue/README.md, Azure Queue Storage Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/azure_storage_queue/README.md, Azure Queue Storage Plugin Source --- # Azure Queue Storage Input Plugin diff --git a/content/telegraf/v1/input-plugins/bcache/_index.md b/content/telegraf/v1/input-plugins/bcache/_index.md index 04d998e4e..873fdd5f0 100644 --- a/content/telegraf/v1/input-plugins/bcache/_index.md +++ b/content/telegraf/v1/input-plugins/bcache/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/bcache/README.md, Bcache Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/bcache/README.md, Bcache Plugin Source --- # Bcache Input Plugin diff --git a/content/telegraf/v1/input-plugins/beanstalkd/_index.md b/content/telegraf/v1/input-plugins/beanstalkd/_index.md index 66aa0f22a..c76e6e79c 100644 --- a/content/telegraf/v1/input-plugins/beanstalkd/_index.md +++ b/content/telegraf/v1/input-plugins/beanstalkd/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/beanstalkd/README.md, Beanstalkd Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/beanstalkd/README.md, Beanstalkd Plugin Source --- # Beanstalkd Input Plugin diff --git a/content/telegraf/v1/input-plugins/beat/_index.md b/content/telegraf/v1/input-plugins/beat/_index.md index 98d42d9ca..e344a50ea 100644 --- a/content/telegraf/v1/input-plugins/beat/_index.md +++ b/content/telegraf/v1/input-plugins/beat/_index.md @@ -10,7 +10,7 @@ introduced: "v1.18.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/beat/README.md, Beat Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/beat/README.md, Beat Plugin Source --- # Beat Input Plugin diff --git a/content/telegraf/v1/input-plugins/bind/_index.md b/content/telegraf/v1/input-plugins/bind/_index.md index 8bb23bbd6..519259732 100644 --- a/content/telegraf/v1/input-plugins/bind/_index.md +++ b/content/telegraf/v1/input-plugins/bind/_index.md @@ -10,7 +10,7 @@ introduced: "v1.11.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/bind/README.md, BIND 9 Nameserver Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/bind/README.md, BIND 9 Nameserver Plugin Source --- # BIND 9 Nameserver Input Plugin diff --git a/content/telegraf/v1/input-plugins/bond/_index.md b/content/telegraf/v1/input-plugins/bond/_index.md index f4af68588..7edbcdcc5 100644 --- a/content/telegraf/v1/input-plugins/bond/_index.md +++ b/content/telegraf/v1/input-plugins/bond/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/bond/README.md, Bond Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/bond/README.md, Bond Plugin Source --- # Bond Input Plugin diff --git a/content/telegraf/v1/input-plugins/burrow/_index.md b/content/telegraf/v1/input-plugins/burrow/_index.md index 8cdf5715a..a401d2699 100644 --- a/content/telegraf/v1/input-plugins/burrow/_index.md +++ b/content/telegraf/v1/input-plugins/burrow/_index.md @@ -10,7 +10,7 @@ introduced: "v1.7.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/burrow/README.md, Burrow Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/burrow/README.md, Burrow Plugin Source --- # Burrow Input Plugin diff --git a/content/telegraf/v1/input-plugins/ceph/_index.md b/content/telegraf/v1/input-plugins/ceph/_index.md index 4e2457853..3589e43c1 100644 --- a/content/telegraf/v1/input-plugins/ceph/_index.md +++ b/content/telegraf/v1/input-plugins/ceph/_index.md @@ -10,7 +10,7 @@ introduced: "v0.13.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/ceph/README.md, Ceph Storage Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/ceph/README.md, Ceph Storage Plugin Source --- # Ceph Storage Input Plugin diff --git a/content/telegraf/v1/input-plugins/cgroup/_index.md b/content/telegraf/v1/input-plugins/cgroup/_index.md index e18fb7861..614778cb6 100644 --- a/content/telegraf/v1/input-plugins/cgroup/_index.md +++ b/content/telegraf/v1/input-plugins/cgroup/_index.md @@ -10,7 +10,7 @@ introduced: "v1.0.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/cgroup/README.md, Control Group Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/cgroup/README.md, Control Group Plugin Source --- # Control Group Input Plugin diff --git a/content/telegraf/v1/input-plugins/chrony/_index.md b/content/telegraf/v1/input-plugins/chrony/_index.md index dde05fefe..3d94d05e5 100644 --- a/content/telegraf/v1/input-plugins/chrony/_index.md +++ b/content/telegraf/v1/input-plugins/chrony/_index.md @@ -10,7 +10,7 @@ introduced: "v0.13.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/chrony/README.md, chrony Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/chrony/README.md, chrony Plugin Source --- # chrony Input Plugin diff --git a/content/telegraf/v1/input-plugins/cisco_telemetry_mdt/_index.md b/content/telegraf/v1/input-plugins/cisco_telemetry_mdt/_index.md index dfde41571..442c09970 100644 --- a/content/telegraf/v1/input-plugins/cisco_telemetry_mdt/_index.md +++ b/content/telegraf/v1/input-plugins/cisco_telemetry_mdt/_index.md @@ -10,7 +10,7 @@ introduced: "v1.11.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/cisco_telemetry_mdt/README.md, Cisco Model-Driven Telemetry (MDT) Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/cisco_telemetry_mdt/README.md, Cisco Model-Driven Telemetry (MDT) Plugin Source --- # Cisco Model-Driven Telemetry (MDT) Input Plugin diff --git a/content/telegraf/v1/input-plugins/clickhouse/_index.md b/content/telegraf/v1/input-plugins/clickhouse/_index.md index 720a87aec..632f3671f 100644 --- a/content/telegraf/v1/input-plugins/clickhouse/_index.md +++ b/content/telegraf/v1/input-plugins/clickhouse/_index.md @@ -10,7 +10,7 @@ introduced: "v1.14.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/clickhouse/README.md, ClickHouse Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/clickhouse/README.md, ClickHouse Plugin Source --- # ClickHouse Input Plugin diff --git a/content/telegraf/v1/input-plugins/cloud_pubsub/_index.md b/content/telegraf/v1/input-plugins/cloud_pubsub/_index.md index 85b9f8d22..c4fcb249a 100644 --- a/content/telegraf/v1/input-plugins/cloud_pubsub/_index.md +++ b/content/telegraf/v1/input-plugins/cloud_pubsub/_index.md @@ -10,7 +10,7 @@ introduced: "v1.10.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/cloud_pubsub/README.md, Google Cloud PubSub Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/cloud_pubsub/README.md, Google Cloud PubSub Plugin Source --- # Google Cloud PubSub Input Plugin diff --git a/content/telegraf/v1/input-plugins/cloud_pubsub_push/_index.md b/content/telegraf/v1/input-plugins/cloud_pubsub_push/_index.md index cb8c8fdbe..de90c22b2 100644 --- a/content/telegraf/v1/input-plugins/cloud_pubsub_push/_index.md +++ b/content/telegraf/v1/input-plugins/cloud_pubsub_push/_index.md @@ -10,7 +10,7 @@ introduced: "v1.10.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/cloud_pubsub_push/README.md, Google Cloud PubSub Push Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/cloud_pubsub_push/README.md, Google Cloud PubSub Push Plugin Source --- # Google Cloud PubSub Push Input Plugin diff --git a/content/telegraf/v1/input-plugins/cloudwatch/_index.md b/content/telegraf/v1/input-plugins/cloudwatch/_index.md index dbb171736..4659d57ad 100644 --- a/content/telegraf/v1/input-plugins/cloudwatch/_index.md +++ b/content/telegraf/v1/input-plugins/cloudwatch/_index.md @@ -10,7 +10,7 @@ introduced: "v0.12.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/cloudwatch/README.md, Amazon CloudWatch Statistics Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/cloudwatch/README.md, Amazon CloudWatch Statistics Plugin Source --- # Amazon CloudWatch Statistics Input Plugin diff --git a/content/telegraf/v1/input-plugins/cloudwatch_metric_streams/_index.md b/content/telegraf/v1/input-plugins/cloudwatch_metric_streams/_index.md index 3bea44860..17645608a 100644 --- a/content/telegraf/v1/input-plugins/cloudwatch_metric_streams/_index.md +++ b/content/telegraf/v1/input-plugins/cloudwatch_metric_streams/_index.md @@ -10,7 +10,7 @@ introduced: "v1.24.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/cloudwatch_metric_streams/README.md, Amazon CloudWatch Metric Streams Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/cloudwatch_metric_streams/README.md, Amazon CloudWatch Metric Streams Plugin Source --- # Amazon CloudWatch Metric Streams Input Plugin diff --git a/content/telegraf/v1/input-plugins/conntrack/_index.md b/content/telegraf/v1/input-plugins/conntrack/_index.md index b2c919063..c0bf6117d 100644 --- a/content/telegraf/v1/input-plugins/conntrack/_index.md +++ b/content/telegraf/v1/input-plugins/conntrack/_index.md @@ -10,7 +10,7 @@ introduced: "v1.0.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/conntrack/README.md, Netfilter Conntrack Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/conntrack/README.md, Netfilter Conntrack Plugin Source --- # Netfilter Conntrack Input Plugin diff --git a/content/telegraf/v1/input-plugins/consul/_index.md b/content/telegraf/v1/input-plugins/consul/_index.md index c96d4a6a3..ea1e4885b 100644 --- a/content/telegraf/v1/input-plugins/consul/_index.md +++ b/content/telegraf/v1/input-plugins/consul/_index.md @@ -10,7 +10,7 @@ introduced: "v1.0.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/consul/README.md, Hashicorp Consul Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/consul/README.md, Hashicorp Consul Plugin Source --- # Hashicorp Consul Input Plugin diff --git a/content/telegraf/v1/input-plugins/consul_agent/_index.md b/content/telegraf/v1/input-plugins/consul_agent/_index.md index 916e39818..bdec51b9f 100644 --- a/content/telegraf/v1/input-plugins/consul_agent/_index.md +++ b/content/telegraf/v1/input-plugins/consul_agent/_index.md @@ -10,7 +10,7 @@ introduced: "v1.22.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/consul_agent/README.md, Hashicorp Consul Agent Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/consul_agent/README.md, Hashicorp Consul Agent Plugin Source --- # Hashicorp Consul Agent Input Plugin diff --git a/content/telegraf/v1/input-plugins/couchbase/_index.md b/content/telegraf/v1/input-plugins/couchbase/_index.md index b6cccd27e..883be54ad 100644 --- a/content/telegraf/v1/input-plugins/couchbase/_index.md +++ b/content/telegraf/v1/input-plugins/couchbase/_index.md @@ -10,7 +10,7 @@ introduced: "v0.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/couchbase/README.md, Couchbase Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/couchbase/README.md, Couchbase Plugin Source --- # Couchbase Input Plugin diff --git a/content/telegraf/v1/input-plugins/couchdb/_index.md b/content/telegraf/v1/input-plugins/couchdb/_index.md index d5fe0e4b1..448cc5437 100644 --- a/content/telegraf/v1/input-plugins/couchdb/_index.md +++ b/content/telegraf/v1/input-plugins/couchdb/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.3" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/couchdb/README.md, Apache CouchDB Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/couchdb/README.md, Apache CouchDB Plugin Source --- # Apache CouchDB Input Plugin diff --git a/content/telegraf/v1/input-plugins/cpu/_index.md b/content/telegraf/v1/input-plugins/cpu/_index.md index 9cfd0a595..959568eaf 100644 --- a/content/telegraf/v1/input-plugins/cpu/_index.md +++ b/content/telegraf/v1/input-plugins/cpu/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.5" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/cpu/README.md, CPU Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/cpu/README.md, CPU Plugin Source --- # CPU Input Plugin diff --git a/content/telegraf/v1/input-plugins/csgo/_index.md b/content/telegraf/v1/input-plugins/csgo/_index.md index 4adffe244..a48c862fa 100644 --- a/content/telegraf/v1/input-plugins/csgo/_index.md +++ b/content/telegraf/v1/input-plugins/csgo/_index.md @@ -10,7 +10,7 @@ introduced: "v1.18.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/csgo/README.md, Counter-Strike Global Offensive (CSGO) Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/csgo/README.md, Counter-Strike Global Offensive (CSGO) Plugin Source --- # Counter-Strike: Global Offensive (CSGO) Input Plugin diff --git a/content/telegraf/v1/input-plugins/ctrlx_datalayer/_index.md b/content/telegraf/v1/input-plugins/ctrlx_datalayer/_index.md index 8cf6feff3..ff66ca3df 100644 --- a/content/telegraf/v1/input-plugins/ctrlx_datalayer/_index.md +++ b/content/telegraf/v1/input-plugins/ctrlx_datalayer/_index.md @@ -10,7 +10,7 @@ introduced: "v1.27.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/ctrlx_datalayer/README.md, Bosch Rexroth ctrlX Data Layer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/ctrlx_datalayer/README.md, Bosch Rexroth ctrlX Data Layer Plugin Source --- # Bosch Rexroth ctrlX Data Layer Input Plugin diff --git a/content/telegraf/v1/input-plugins/dcos/_index.md b/content/telegraf/v1/input-plugins/dcos/_index.md index 6340b5d0d..c3599c7bc 100644 --- a/content/telegraf/v1/input-plugins/dcos/_index.md +++ b/content/telegraf/v1/input-plugins/dcos/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/dcos/README.md, Mesosphere Distributed Cloud OS Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/dcos/README.md, Mesosphere Distributed Cloud OS Plugin Source --- # Mesosphere Distributed Cloud OS Input Plugin diff --git a/content/telegraf/v1/input-plugins/directory_monitor/_index.md b/content/telegraf/v1/input-plugins/directory_monitor/_index.md index 4a131d4a3..acb205d84 100644 --- a/content/telegraf/v1/input-plugins/directory_monitor/_index.md +++ b/content/telegraf/v1/input-plugins/directory_monitor/_index.md @@ -10,7 +10,7 @@ introduced: "v1.18.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/directory_monitor/README.md, Directory Monitor Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/directory_monitor/README.md, Directory Monitor Plugin Source --- # Directory Monitor Input Plugin diff --git a/content/telegraf/v1/input-plugins/disk/_index.md b/content/telegraf/v1/input-plugins/disk/_index.md index 2f61daf2f..a9cac3b6d 100644 --- a/content/telegraf/v1/input-plugins/disk/_index.md +++ b/content/telegraf/v1/input-plugins/disk/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/disk/README.md, Disk Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/disk/README.md, Disk Plugin Source --- # Disk Input Plugin diff --git a/content/telegraf/v1/input-plugins/diskio/_index.md b/content/telegraf/v1/input-plugins/diskio/_index.md index 7a3ba1888..1cedfb441 100644 --- a/content/telegraf/v1/input-plugins/diskio/_index.md +++ b/content/telegraf/v1/input-plugins/diskio/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/diskio/README.md, DiskIO Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/diskio/README.md, DiskIO Plugin Source --- # DiskIO Input Plugin diff --git a/content/telegraf/v1/input-plugins/disque/_index.md b/content/telegraf/v1/input-plugins/disque/_index.md index f42f62937..be1c6532e 100644 --- a/content/telegraf/v1/input-plugins/disque/_index.md +++ b/content/telegraf/v1/input-plugins/disque/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/disque/README.md, Disque Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/disque/README.md, Disque Plugin Source --- # Disque Input Plugin diff --git a/content/telegraf/v1/input-plugins/dmcache/_index.md b/content/telegraf/v1/input-plugins/dmcache/_index.md index 3768a54cf..6a8a5b859 100644 --- a/content/telegraf/v1/input-plugins/dmcache/_index.md +++ b/content/telegraf/v1/input-plugins/dmcache/_index.md @@ -10,7 +10,7 @@ introduced: "v1.3.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/dmcache/README.md, Device Mapper Cache Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/dmcache/README.md, Device Mapper Cache Plugin Source --- # Device Mapper Cache Input Plugin diff --git a/content/telegraf/v1/input-plugins/dns_query/_index.md b/content/telegraf/v1/input-plugins/dns_query/_index.md index dba08d1a2..0b31da541 100644 --- a/content/telegraf/v1/input-plugins/dns_query/_index.md +++ b/content/telegraf/v1/input-plugins/dns_query/_index.md @@ -10,7 +10,7 @@ introduced: "v1.4.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/dns_query/README.md, DNS Query Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/dns_query/README.md, DNS Query Plugin Source --- # DNS Query Input Plugin diff --git a/content/telegraf/v1/input-plugins/docker/_index.md b/content/telegraf/v1/input-plugins/docker/_index.md index 9493c7e13..9e56c368e 100644 --- a/content/telegraf/v1/input-plugins/docker/_index.md +++ b/content/telegraf/v1/input-plugins/docker/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.9" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/docker/README.md, Docker Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/docker/README.md, Docker Plugin Source --- # Docker Input Plugin diff --git a/content/telegraf/v1/input-plugins/docker_log/_index.md b/content/telegraf/v1/input-plugins/docker_log/_index.md index 155cddee7..e16d68964 100644 --- a/content/telegraf/v1/input-plugins/docker_log/_index.md +++ b/content/telegraf/v1/input-plugins/docker_log/_index.md @@ -10,7 +10,7 @@ introduced: "v1.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/docker_log/README.md, Docker Log Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/docker_log/README.md, Docker Log Plugin Source --- # Docker Log Input Plugin diff --git a/content/telegraf/v1/input-plugins/dovecot/_index.md b/content/telegraf/v1/input-plugins/dovecot/_index.md index 595f35fb3..383b8ebce 100644 --- a/content/telegraf/v1/input-plugins/dovecot/_index.md +++ b/content/telegraf/v1/input-plugins/dovecot/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.3" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/dovecot/README.md, Dovecot Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/dovecot/README.md, Dovecot Plugin Source --- # Dovecot Input Plugin diff --git a/content/telegraf/v1/input-plugins/dpdk/_index.md b/content/telegraf/v1/input-plugins/dpdk/_index.md index f23988ea4..fe9778476 100644 --- a/content/telegraf/v1/input-plugins/dpdk/_index.md +++ b/content/telegraf/v1/input-plugins/dpdk/_index.md @@ -10,7 +10,7 @@ introduced: "v1.19.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/dpdk/README.md, Data Plane Development Kit (DPDK) Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/dpdk/README.md, Data Plane Development Kit (DPDK) Plugin Source --- # Data Plane Development Kit (DPDK) Input Plugin diff --git a/content/telegraf/v1/input-plugins/ecs/_index.md b/content/telegraf/v1/input-plugins/ecs/_index.md index b209580f7..ea03862bb 100644 --- a/content/telegraf/v1/input-plugins/ecs/_index.md +++ b/content/telegraf/v1/input-plugins/ecs/_index.md @@ -10,7 +10,7 @@ introduced: "v1.11.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/ecs/README.md, Amazon Elastic Container Service Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/ecs/README.md, Amazon Elastic Container Service Plugin Source --- # Amazon Elastic Container Service Input Plugin diff --git a/content/telegraf/v1/input-plugins/elasticsearch/_index.md b/content/telegraf/v1/input-plugins/elasticsearch/_index.md index 9720200e4..0fac01d58 100644 --- a/content/telegraf/v1/input-plugins/elasticsearch/_index.md +++ b/content/telegraf/v1/input-plugins/elasticsearch/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.5" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/elasticsearch/README.md, Elasticsearch Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/elasticsearch/README.md, Elasticsearch Plugin Source --- # Elasticsearch Input Plugin diff --git a/content/telegraf/v1/input-plugins/elasticsearch_query/_index.md b/content/telegraf/v1/input-plugins/elasticsearch_query/_index.md index 5a2958dbf..c9c6f3188 100644 --- a/content/telegraf/v1/input-plugins/elasticsearch_query/_index.md +++ b/content/telegraf/v1/input-plugins/elasticsearch_query/_index.md @@ -10,7 +10,7 @@ introduced: "v1.20.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/elasticsearch_query/README.md, Elasticsearch Query Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/elasticsearch_query/README.md, Elasticsearch Query Plugin Source --- # Elasticsearch Query Input Plugin diff --git a/content/telegraf/v1/input-plugins/ethtool/_index.md b/content/telegraf/v1/input-plugins/ethtool/_index.md index 876c5b753..50c2f4350 100644 --- a/content/telegraf/v1/input-plugins/ethtool/_index.md +++ b/content/telegraf/v1/input-plugins/ethtool/_index.md @@ -10,7 +10,7 @@ introduced: "v1.13.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/ethtool/README.md, Ethtool Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/ethtool/README.md, Ethtool Plugin Source --- # Ethtool Input Plugin diff --git a/content/telegraf/v1/input-plugins/eventhub_consumer/_index.md b/content/telegraf/v1/input-plugins/eventhub_consumer/_index.md index 95e073e6f..e7681aae8 100644 --- a/content/telegraf/v1/input-plugins/eventhub_consumer/_index.md +++ b/content/telegraf/v1/input-plugins/eventhub_consumer/_index.md @@ -10,7 +10,7 @@ introduced: "v1.14.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/eventhub_consumer/README.md, Azure Event Hub Consumer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/eventhub_consumer/README.md, Azure Event Hub Consumer Plugin Source --- # Azure Event Hub Consumer Input Plugin diff --git a/content/telegraf/v1/input-plugins/exec/_index.md b/content/telegraf/v1/input-plugins/exec/_index.md index c542d6d0b..315839475 100644 --- a/content/telegraf/v1/input-plugins/exec/_index.md +++ b/content/telegraf/v1/input-plugins/exec/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.5" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/exec/README.md, Exec Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/exec/README.md, Exec Plugin Source --- # Exec Input Plugin @@ -59,6 +59,9 @@ plugin ordering. See [CONFIGURATION.md](/telegraf/v1/configuration/#plugins) for ## plugin will continue to parse the output. # ignore_error = false + ## Log all messages sent to stderr + # log_stderr = false + ## Data format ## By default, exec expects JSON. This was done for historical reasons and is ## different than other inputs that use the influx line protocol. Each data @@ -71,7 +74,15 @@ plugin ordering. See [CONFIGURATION.md](/telegraf/v1/configuration/#plugins) for Glob patterns in the `command` option are matched on every run, so adding new scripts that match the pattern will cause them to be picked up immediately. -## Example +### Logging + +When setting `log_stderr` to `true`, the called command may write log messages +to `stderr`, which Telegraf will log line-wise using the configured logging +facility. By default, the _error_ level will be used. Use the known prefixes +`E!`, `W!`, `I!`, `D!` or `T!` to log with the _error_, _warning_, _info_, +_debug_ or _trace_ log-level, respectively. + +### Example This script produces static values, since no timestamp is specified the values are at the current time. Ensure that int values are followed with `i` for proper @@ -92,7 +103,7 @@ It can be paired with the following configuration and will be run at the data_format = "influx" ``` -## Common Issues +## Troubleshooting ### My script works when I run it by hand, but not when Telegraf is running as a service diff --git a/content/telegraf/v1/input-plugins/execd/_index.md b/content/telegraf/v1/input-plugins/execd/_index.md index 3202d578c..45d4e1c8b 100644 --- a/content/telegraf/v1/input-plugins/execd/_index.md +++ b/content/telegraf/v1/input-plugins/execd/_index.md @@ -10,7 +10,7 @@ introduced: "v1.14.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/execd/README.md, Execd Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/execd/README.md, Execd Plugin Source --- # Execd Input Plugin diff --git a/content/telegraf/v1/input-plugins/fail2ban/_index.md b/content/telegraf/v1/input-plugins/fail2ban/_index.md index 7d355b038..ff70c0764 100644 --- a/content/telegraf/v1/input-plugins/fail2ban/_index.md +++ b/content/telegraf/v1/input-plugins/fail2ban/_index.md @@ -10,7 +10,7 @@ introduced: "v1.4.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/fail2ban/README.md, Fail2ban Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/fail2ban/README.md, Fail2ban Plugin Source --- # Fail2ban Input Plugin diff --git a/content/telegraf/v1/input-plugins/fibaro/_index.md b/content/telegraf/v1/input-plugins/fibaro/_index.md index 7e48c3801..fe2fc359b 100644 --- a/content/telegraf/v1/input-plugins/fibaro/_index.md +++ b/content/telegraf/v1/input-plugins/fibaro/_index.md @@ -10,7 +10,7 @@ introduced: "v1.7.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/fibaro/README.md, Fibaro Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/fibaro/README.md, Fibaro Plugin Source --- # Fibaro Input Plugin diff --git a/content/telegraf/v1/input-plugins/file/_index.md b/content/telegraf/v1/input-plugins/file/_index.md index 570bf0c16..5d4b6af3b 100644 --- a/content/telegraf/v1/input-plugins/file/_index.md +++ b/content/telegraf/v1/input-plugins/file/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/file/README.md, File Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/file/README.md, File Plugin Source --- # File Input Plugin diff --git a/content/telegraf/v1/input-plugins/filecount/_index.md b/content/telegraf/v1/input-plugins/filecount/_index.md index e3ab21c98..5efb14755 100644 --- a/content/telegraf/v1/input-plugins/filecount/_index.md +++ b/content/telegraf/v1/input-plugins/filecount/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/filecount/README.md, Filecount Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/filecount/README.md, Filecount Plugin Source --- # Filecount Input Plugin diff --git a/content/telegraf/v1/input-plugins/filestat/_index.md b/content/telegraf/v1/input-plugins/filestat/_index.md index 445959fd4..dadc391b5 100644 --- a/content/telegraf/v1/input-plugins/filestat/_index.md +++ b/content/telegraf/v1/input-plugins/filestat/_index.md @@ -10,7 +10,7 @@ introduced: "v0.13.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/filestat/README.md, File statistics Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/filestat/README.md, File statistics Plugin Source --- # File statistics Input Plugin diff --git a/content/telegraf/v1/input-plugins/fireboard/_index.md b/content/telegraf/v1/input-plugins/fireboard/_index.md index 324508952..bb6bc8adc 100644 --- a/content/telegraf/v1/input-plugins/fireboard/_index.md +++ b/content/telegraf/v1/input-plugins/fireboard/_index.md @@ -10,7 +10,7 @@ introduced: "v1.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/fireboard/README.md, Fireboard Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/fireboard/README.md, Fireboard Plugin Source --- # Fireboard Input Plugin diff --git a/content/telegraf/v1/input-plugins/firehose/_index.md b/content/telegraf/v1/input-plugins/firehose/_index.md index b7c7a20c4..6d7ac09d0 100644 --- a/content/telegraf/v1/input-plugins/firehose/_index.md +++ b/content/telegraf/v1/input-plugins/firehose/_index.md @@ -10,7 +10,7 @@ introduced: "v1.34.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/firehose/README.md, AWS Data Firehose Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/firehose/README.md, AWS Data Firehose Plugin Source --- # AWS Data Firehose Input Plugin diff --git a/content/telegraf/v1/input-plugins/fluentd/_index.md b/content/telegraf/v1/input-plugins/fluentd/_index.md index 4d8b89e73..50ec7902b 100644 --- a/content/telegraf/v1/input-plugins/fluentd/_index.md +++ b/content/telegraf/v1/input-plugins/fluentd/_index.md @@ -10,7 +10,7 @@ introduced: "v1.4.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/fluentd/README.md, Fluentd Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/fluentd/README.md, Fluentd Plugin Source --- # Fluentd Input Plugin diff --git a/content/telegraf/v1/input-plugins/fritzbox/_index.md b/content/telegraf/v1/input-plugins/fritzbox/_index.md index 0c55e106d..7746d3395 100644 --- a/content/telegraf/v1/input-plugins/fritzbox/_index.md +++ b/content/telegraf/v1/input-plugins/fritzbox/_index.md @@ -10,7 +10,7 @@ introduced: "v1.35.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/fritzbox/README.md, Fritzbox Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/fritzbox/README.md, Fritzbox Plugin Source --- # Fritzbox Input Plugin diff --git a/content/telegraf/v1/input-plugins/github/_index.md b/content/telegraf/v1/input-plugins/github/_index.md index 6f2e64af1..cf895bee7 100644 --- a/content/telegraf/v1/input-plugins/github/_index.md +++ b/content/telegraf/v1/input-plugins/github/_index.md @@ -10,7 +10,7 @@ introduced: "v1.11.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/github/README.md, GitHub Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/github/README.md, GitHub Plugin Source --- # GitHub Input Plugin diff --git a/content/telegraf/v1/input-plugins/gnmi/_index.md b/content/telegraf/v1/input-plugins/gnmi/_index.md index ff455b9d8..6dc411586 100644 --- a/content/telegraf/v1/input-plugins/gnmi/_index.md +++ b/content/telegraf/v1/input-plugins/gnmi/_index.md @@ -10,7 +10,7 @@ introduced: "v1.15.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/gnmi/README.md, gNMI (gRPC Network Management Interface) Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/gnmi/README.md, gNMI (gRPC Network Management Interface) Plugin Source --- # gNMI (gRPC Network Management Interface) Input Plugin diff --git a/content/telegraf/v1/input-plugins/google_cloud_storage/_index.md b/content/telegraf/v1/input-plugins/google_cloud_storage/_index.md index 83c26d2fb..61f74514e 100644 --- a/content/telegraf/v1/input-plugins/google_cloud_storage/_index.md +++ b/content/telegraf/v1/input-plugins/google_cloud_storage/_index.md @@ -10,7 +10,7 @@ introduced: "v1.25.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/google_cloud_storage/README.md, Google Cloud Storage Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/google_cloud_storage/README.md, Google Cloud Storage Plugin Source --- # Google Cloud Storage Input Plugin diff --git a/content/telegraf/v1/input-plugins/graylog/_index.md b/content/telegraf/v1/input-plugins/graylog/_index.md index 2ce54eb3f..89c67c013 100644 --- a/content/telegraf/v1/input-plugins/graylog/_index.md +++ b/content/telegraf/v1/input-plugins/graylog/_index.md @@ -10,7 +10,7 @@ introduced: "v1.0.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/graylog/README.md, GrayLog Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/graylog/README.md, GrayLog Plugin Source --- # GrayLog Input Plugin diff --git a/content/telegraf/v1/input-plugins/haproxy/_index.md b/content/telegraf/v1/input-plugins/haproxy/_index.md index 6a033ac83..84c85b7b6 100644 --- a/content/telegraf/v1/input-plugins/haproxy/_index.md +++ b/content/telegraf/v1/input-plugins/haproxy/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.5" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/haproxy/README.md, HAProxy Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/haproxy/README.md, HAProxy Plugin Source --- # HAProxy Input Plugin diff --git a/content/telegraf/v1/input-plugins/hddtemp/_index.md b/content/telegraf/v1/input-plugins/hddtemp/_index.md index a81942c1b..ef684e8fd 100644 --- a/content/telegraf/v1/input-plugins/hddtemp/_index.md +++ b/content/telegraf/v1/input-plugins/hddtemp/_index.md @@ -10,7 +10,7 @@ introduced: "v1.0.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/hddtemp/README.md, HDDtemp Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/hddtemp/README.md, HDDtemp Plugin Source --- # HDDtemp Input Plugin diff --git a/content/telegraf/v1/input-plugins/http/_index.md b/content/telegraf/v1/input-plugins/http/_index.md index f83815209..2a70fbeca 100644 --- a/content/telegraf/v1/input-plugins/http/_index.md +++ b/content/telegraf/v1/input-plugins/http/_index.md @@ -10,7 +10,7 @@ introduced: "v1.6.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/http/README.md, HTTP Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/http/README.md, HTTP Plugin Source --- # HTTP Input Plugin diff --git a/content/telegraf/v1/input-plugins/http_listener_v2/_index.md b/content/telegraf/v1/input-plugins/http_listener_v2/_index.md index dac3a1ff7..c7f653d1d 100644 --- a/content/telegraf/v1/input-plugins/http_listener_v2/_index.md +++ b/content/telegraf/v1/input-plugins/http_listener_v2/_index.md @@ -10,7 +10,7 @@ introduced: "v1.9.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/http_listener_v2/README.md, HTTP Listener v2 Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/http_listener_v2/README.md, HTTP Listener v2 Plugin Source --- # HTTP Listener v2 Input Plugin diff --git a/content/telegraf/v1/input-plugins/http_response/_index.md b/content/telegraf/v1/input-plugins/http_response/_index.md index d1b1c14db..bc6d36e88 100644 --- a/content/telegraf/v1/input-plugins/http_response/_index.md +++ b/content/telegraf/v1/input-plugins/http_response/_index.md @@ -10,7 +10,7 @@ introduced: "v0.12.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/http_response/README.md, HTTP Response Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/http_response/README.md, HTTP Response Plugin Source --- # HTTP Response Input Plugin diff --git a/content/telegraf/v1/input-plugins/huebridge/_index.md b/content/telegraf/v1/input-plugins/huebridge/_index.md index a161383e2..476d32457 100644 --- a/content/telegraf/v1/input-plugins/huebridge/_index.md +++ b/content/telegraf/v1/input-plugins/huebridge/_index.md @@ -10,7 +10,7 @@ introduced: "v1.34.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/huebridge/README.md, HueBridge Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/huebridge/README.md, HueBridge Plugin Source --- # HueBridge Input Plugin diff --git a/content/telegraf/v1/input-plugins/hugepages/_index.md b/content/telegraf/v1/input-plugins/hugepages/_index.md index 9c5d18482..96dae0e7e 100644 --- a/content/telegraf/v1/input-plugins/hugepages/_index.md +++ b/content/telegraf/v1/input-plugins/hugepages/_index.md @@ -10,7 +10,7 @@ introduced: "v1.22.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/hugepages/README.md, Hugepages Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/hugepages/README.md, Hugepages Plugin Source --- # Hugepages Input Plugin diff --git a/content/telegraf/v1/input-plugins/icinga2/_index.md b/content/telegraf/v1/input-plugins/icinga2/_index.md index 5731b4edb..78d004bd6 100644 --- a/content/telegraf/v1/input-plugins/icinga2/_index.md +++ b/content/telegraf/v1/input-plugins/icinga2/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/icinga2/README.md, Icinga2 Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/icinga2/README.md, Icinga2 Plugin Source --- # Icinga2 Input Plugin diff --git a/content/telegraf/v1/input-plugins/infiniband/_index.md b/content/telegraf/v1/input-plugins/infiniband/_index.md index e49548c6b..825b6c5fa 100644 --- a/content/telegraf/v1/input-plugins/infiniband/_index.md +++ b/content/telegraf/v1/input-plugins/infiniband/_index.md @@ -10,7 +10,7 @@ introduced: "v1.14.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/infiniband/README.md, InfiniBand Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/infiniband/README.md, InfiniBand Plugin Source --- # InfiniBand Input Plugin diff --git a/content/telegraf/v1/input-plugins/influxdb/_index.md b/content/telegraf/v1/input-plugins/influxdb/_index.md index 7f4aea245..c026f6a59 100644 --- a/content/telegraf/v1/input-plugins/influxdb/_index.md +++ b/content/telegraf/v1/input-plugins/influxdb/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.5" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/influxdb/README.md, InfluxDB Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/influxdb/README.md, InfluxDB Plugin Source --- # InfluxDB Input Plugin diff --git a/content/telegraf/v1/input-plugins/influxdb_listener/_index.md b/content/telegraf/v1/input-plugins/influxdb_listener/_index.md index 7ee64afc3..ddc66fed7 100644 --- a/content/telegraf/v1/input-plugins/influxdb_listener/_index.md +++ b/content/telegraf/v1/input-plugins/influxdb_listener/_index.md @@ -10,7 +10,7 @@ introduced: "v1.9.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/influxdb_listener/README.md, InfluxDB Listener Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/influxdb_listener/README.md, InfluxDB Listener Plugin Source --- # InfluxDB Listener Input Plugin diff --git a/content/telegraf/v1/input-plugins/influxdb_v2_listener/_index.md b/content/telegraf/v1/input-plugins/influxdb_v2_listener/_index.md index acf23499f..12aca4273 100644 --- a/content/telegraf/v1/input-plugins/influxdb_v2_listener/_index.md +++ b/content/telegraf/v1/input-plugins/influxdb_v2_listener/_index.md @@ -10,7 +10,7 @@ introduced: "v1.16.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/influxdb_v2_listener/README.md, InfluxDB V2 Listener Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/influxdb_v2_listener/README.md, InfluxDB V2 Listener Plugin Source --- # InfluxDB V2 Listener Input Plugin diff --git a/content/telegraf/v1/input-plugins/intel_baseband/_index.md b/content/telegraf/v1/input-plugins/intel_baseband/_index.md index bec0e9128..960a9c2f5 100644 --- a/content/telegraf/v1/input-plugins/intel_baseband/_index.md +++ b/content/telegraf/v1/input-plugins/intel_baseband/_index.md @@ -10,7 +10,7 @@ introduced: "v1.27.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/intel_baseband/README.md, Intel Baseband Accelerator Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/intel_baseband/README.md, Intel Baseband Accelerator Plugin Source --- # Intel Baseband Accelerator Input Plugin diff --git a/content/telegraf/v1/input-plugins/intel_dlb/_index.md b/content/telegraf/v1/input-plugins/intel_dlb/_index.md index b8413787e..d36b4b38f 100644 --- a/content/telegraf/v1/input-plugins/intel_dlb/_index.md +++ b/content/telegraf/v1/input-plugins/intel_dlb/_index.md @@ -10,7 +10,7 @@ introduced: "v1.25.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/intel_dlb/README.md, Intel® Dynamic Load Balancer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/intel_dlb/README.md, Intel® Dynamic Load Balancer Plugin Source --- # Intel® Dynamic Load Balancer Input Plugin diff --git a/content/telegraf/v1/input-plugins/intel_pmt/_index.md b/content/telegraf/v1/input-plugins/intel_pmt/_index.md index 5ee77cf4f..12674cf11 100644 --- a/content/telegraf/v1/input-plugins/intel_pmt/_index.md +++ b/content/telegraf/v1/input-plugins/intel_pmt/_index.md @@ -10,7 +10,7 @@ introduced: "v1.28.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/intel_pmt/README.md, Intel® Platform Monitoring Technology Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/intel_pmt/README.md, Intel® Platform Monitoring Technology Plugin Source --- # Intel® Platform Monitoring Technology Input Plugin diff --git a/content/telegraf/v1/input-plugins/intel_pmu/_index.md b/content/telegraf/v1/input-plugins/intel_pmu/_index.md index c52e3aace..d6a93b744 100644 --- a/content/telegraf/v1/input-plugins/intel_pmu/_index.md +++ b/content/telegraf/v1/input-plugins/intel_pmu/_index.md @@ -10,7 +10,7 @@ introduced: "v1.21.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/intel_pmu/README.md, Intel Performance Monitoring Unit Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/intel_pmu/README.md, Intel Performance Monitoring Unit Plugin Source --- # Intel Performance Monitoring Unit Plugin diff --git a/content/telegraf/v1/input-plugins/intel_powerstat/_index.md b/content/telegraf/v1/input-plugins/intel_powerstat/_index.md index f1c45121b..a41ee796f 100644 --- a/content/telegraf/v1/input-plugins/intel_powerstat/_index.md +++ b/content/telegraf/v1/input-plugins/intel_powerstat/_index.md @@ -10,7 +10,7 @@ introduced: "v1.17.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/intel_powerstat/README.md, Intel PowerStat Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/intel_powerstat/README.md, Intel PowerStat Plugin Source --- # Intel PowerStat Input Plugin diff --git a/content/telegraf/v1/input-plugins/intel_rdt/_index.md b/content/telegraf/v1/input-plugins/intel_rdt/_index.md index c39039552..b09b457a9 100644 --- a/content/telegraf/v1/input-plugins/intel_rdt/_index.md +++ b/content/telegraf/v1/input-plugins/intel_rdt/_index.md @@ -10,7 +10,7 @@ introduced: "v1.16.0" os_support: "freebsd, linux, macos" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/intel_rdt/README.md, Intel RDT Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/intel_rdt/README.md, Intel RDT Plugin Source --- # Intel RDT Input Plugin diff --git a/content/telegraf/v1/input-plugins/internal/_index.md b/content/telegraf/v1/input-plugins/internal/_index.md index b60595fc2..927c21fd1 100644 --- a/content/telegraf/v1/input-plugins/internal/_index.md +++ b/content/telegraf/v1/input-plugins/internal/_index.md @@ -10,7 +10,7 @@ introduced: "v1.2.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/internal/README.md, Telegraf Internal Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/internal/README.md, Telegraf Internal Plugin Source --- # Telegraf Internal Input Plugin diff --git a/content/telegraf/v1/input-plugins/internet_speed/_index.md b/content/telegraf/v1/input-plugins/internet_speed/_index.md index a22e8f7d8..fa26baf84 100644 --- a/content/telegraf/v1/input-plugins/internet_speed/_index.md +++ b/content/telegraf/v1/input-plugins/internet_speed/_index.md @@ -10,7 +10,7 @@ introduced: "v1.20.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/internet_speed/README.md, Internet Speed Monitor Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/internet_speed/README.md, Internet Speed Monitor Plugin Source --- # Internet Speed Monitor Input Plugin diff --git a/content/telegraf/v1/input-plugins/interrupts/_index.md b/content/telegraf/v1/input-plugins/interrupts/_index.md index 3b20515cb..aed518f9a 100644 --- a/content/telegraf/v1/input-plugins/interrupts/_index.md +++ b/content/telegraf/v1/input-plugins/interrupts/_index.md @@ -10,7 +10,7 @@ introduced: "v1.3.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/interrupts/README.md, Interrupts Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/interrupts/README.md, Interrupts Plugin Source --- # Interrupts Input Plugin diff --git a/content/telegraf/v1/input-plugins/ipmi_sensor/_index.md b/content/telegraf/v1/input-plugins/ipmi_sensor/_index.md index efba924e5..201331f7f 100644 --- a/content/telegraf/v1/input-plugins/ipmi_sensor/_index.md +++ b/content/telegraf/v1/input-plugins/ipmi_sensor/_index.md @@ -10,7 +10,7 @@ introduced: "v0.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/ipmi_sensor/README.md, IPMI Sensor Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/ipmi_sensor/README.md, IPMI Sensor Plugin Source --- # IPMI Sensor Input Plugin diff --git a/content/telegraf/v1/input-plugins/ipset/_index.md b/content/telegraf/v1/input-plugins/ipset/_index.md index dc649f4df..da330220a 100644 --- a/content/telegraf/v1/input-plugins/ipset/_index.md +++ b/content/telegraf/v1/input-plugins/ipset/_index.md @@ -10,7 +10,7 @@ introduced: "v1.6.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/ipset/README.md, Ipset Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/ipset/README.md, Ipset Plugin Source --- # Ipset Input Plugin diff --git a/content/telegraf/v1/input-plugins/iptables/_index.md b/content/telegraf/v1/input-plugins/iptables/_index.md index ebad367e7..3e25d246c 100644 --- a/content/telegraf/v1/input-plugins/iptables/_index.md +++ b/content/telegraf/v1/input-plugins/iptables/_index.md @@ -10,7 +10,7 @@ introduced: "v1.1.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/iptables/README.md, Iptables Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/iptables/README.md, Iptables Plugin Source --- # Iptables Input Plugin diff --git a/content/telegraf/v1/input-plugins/ipvs/_index.md b/content/telegraf/v1/input-plugins/ipvs/_index.md index af3bcb998..3d172029b 100644 --- a/content/telegraf/v1/input-plugins/ipvs/_index.md +++ b/content/telegraf/v1/input-plugins/ipvs/_index.md @@ -10,7 +10,7 @@ introduced: "v1.9.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/ipvs/README.md, IPVS Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/ipvs/README.md, IPVS Plugin Source --- # IPVS Input Plugin diff --git a/content/telegraf/v1/input-plugins/jenkins/_index.md b/content/telegraf/v1/input-plugins/jenkins/_index.md index 18a8b1814..6933b3738 100644 --- a/content/telegraf/v1/input-plugins/jenkins/_index.md +++ b/content/telegraf/v1/input-plugins/jenkins/_index.md @@ -10,7 +10,7 @@ introduced: "v1.9.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/jenkins/README.md, Jenkins Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/jenkins/README.md, Jenkins Plugin Source --- # Jenkins Input Plugin diff --git a/content/telegraf/v1/input-plugins/jolokia2_agent/_index.md b/content/telegraf/v1/input-plugins/jolokia2_agent/_index.md index d9abc046d..e4cf96656 100644 --- a/content/telegraf/v1/input-plugins/jolokia2_agent/_index.md +++ b/content/telegraf/v1/input-plugins/jolokia2_agent/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/jolokia2_agent/README.md, Jolokia2 Agent Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/jolokia2_agent/README.md, Jolokia2 Agent Plugin Source --- # Jolokia2 Agent Input Plugin diff --git a/content/telegraf/v1/input-plugins/jolokia2_proxy/_index.md b/content/telegraf/v1/input-plugins/jolokia2_proxy/_index.md index f0b842deb..a45116045 100644 --- a/content/telegraf/v1/input-plugins/jolokia2_proxy/_index.md +++ b/content/telegraf/v1/input-plugins/jolokia2_proxy/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/jolokia2_proxy/README.md, Jolokia2 Proxy Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/jolokia2_proxy/README.md, Jolokia2 Proxy Plugin Source --- # Jolokia2 Proxy Input Plugin diff --git a/content/telegraf/v1/input-plugins/jti_openconfig_telemetry/_index.md b/content/telegraf/v1/input-plugins/jti_openconfig_telemetry/_index.md index 1a42ea301..895678262 100644 --- a/content/telegraf/v1/input-plugins/jti_openconfig_telemetry/_index.md +++ b/content/telegraf/v1/input-plugins/jti_openconfig_telemetry/_index.md @@ -10,7 +10,7 @@ introduced: "v1.7.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/jti_openconfig_telemetry/README.md, Juniper Telemetry Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/jti_openconfig_telemetry/README.md, Juniper Telemetry Plugin Source --- # Juniper Telemetry Input Plugin diff --git a/content/telegraf/v1/input-plugins/kafka_consumer/_index.md b/content/telegraf/v1/input-plugins/kafka_consumer/_index.md index 0ce0ddef7..6bba2f4a6 100644 --- a/content/telegraf/v1/input-plugins/kafka_consumer/_index.md +++ b/content/telegraf/v1/input-plugins/kafka_consumer/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.3" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/kafka_consumer/README.md, Apache Kafka Consumer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/kafka_consumer/README.md, Apache Kafka Consumer Plugin Source --- # Apache Kafka Consumer Input Plugin diff --git a/content/telegraf/v1/input-plugins/kapacitor/_index.md b/content/telegraf/v1/input-plugins/kapacitor/_index.md index 96ec47145..0a1d2d414 100644 --- a/content/telegraf/v1/input-plugins/kapacitor/_index.md +++ b/content/telegraf/v1/input-plugins/kapacitor/_index.md @@ -10,7 +10,7 @@ introduced: "v1.3.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/kapacitor/README.md, Kapacitor Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/kapacitor/README.md, Kapacitor Plugin Source --- # Kapacitor Input Plugin diff --git a/content/telegraf/v1/input-plugins/kernel/_index.md b/content/telegraf/v1/input-plugins/kernel/_index.md index 99ae68478..f4bf915b1 100644 --- a/content/telegraf/v1/input-plugins/kernel/_index.md +++ b/content/telegraf/v1/input-plugins/kernel/_index.md @@ -10,7 +10,7 @@ introduced: "v0.11.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/kernel/README.md, Kernel Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/kernel/README.md, Kernel Plugin Source --- # Kernel Input Plugin diff --git a/content/telegraf/v1/input-plugins/kernel_vmstat/_index.md b/content/telegraf/v1/input-plugins/kernel_vmstat/_index.md index 91c30e94b..5d719b499 100644 --- a/content/telegraf/v1/input-plugins/kernel_vmstat/_index.md +++ b/content/telegraf/v1/input-plugins/kernel_vmstat/_index.md @@ -10,7 +10,7 @@ introduced: "v1.0.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/kernel_vmstat/README.md, Kernel VM Statistics Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/kernel_vmstat/README.md, Kernel VM Statistics Plugin Source --- # Kernel VM Statistics Input Plugin diff --git a/content/telegraf/v1/input-plugins/kibana/_index.md b/content/telegraf/v1/input-plugins/kibana/_index.md index 81aba85e6..cffd7d91c 100644 --- a/content/telegraf/v1/input-plugins/kibana/_index.md +++ b/content/telegraf/v1/input-plugins/kibana/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/kibana/README.md, Kibana Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/kibana/README.md, Kibana Plugin Source --- # Kibana Input Plugin diff --git a/content/telegraf/v1/input-plugins/kinesis_consumer/_index.md b/content/telegraf/v1/input-plugins/kinesis_consumer/_index.md index fd5ae57af..6f1e017a2 100644 --- a/content/telegraf/v1/input-plugins/kinesis_consumer/_index.md +++ b/content/telegraf/v1/input-plugins/kinesis_consumer/_index.md @@ -10,7 +10,7 @@ introduced: "v1.10.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/kinesis_consumer/README.md, Kinesis Consumer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/kinesis_consumer/README.md, Kinesis Consumer Plugin Source --- # Kinesis Consumer Input Plugin diff --git a/content/telegraf/v1/input-plugins/knx_listener/_index.md b/content/telegraf/v1/input-plugins/knx_listener/_index.md index f8e3b64c1..849f42bda 100644 --- a/content/telegraf/v1/input-plugins/knx_listener/_index.md +++ b/content/telegraf/v1/input-plugins/knx_listener/_index.md @@ -10,7 +10,7 @@ introduced: "v1.19.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/knx_listener/README.md, KNX Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/knx_listener/README.md, KNX Plugin Source --- # KNX Input Plugin diff --git a/content/telegraf/v1/input-plugins/kube_inventory/_index.md b/content/telegraf/v1/input-plugins/kube_inventory/_index.md index 109a1f4a9..89caf69fd 100644 --- a/content/telegraf/v1/input-plugins/kube_inventory/_index.md +++ b/content/telegraf/v1/input-plugins/kube_inventory/_index.md @@ -10,7 +10,7 @@ introduced: "v1.10.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/kube_inventory/README.md, Kubernetes Inventory Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/kube_inventory/README.md, Kubernetes Inventory Plugin Source --- # Kubernetes Inventory Input Plugin diff --git a/content/telegraf/v1/input-plugins/kubernetes/_index.md b/content/telegraf/v1/input-plugins/kubernetes/_index.md index ca819f3cd..7c84a8345 100644 --- a/content/telegraf/v1/input-plugins/kubernetes/_index.md +++ b/content/telegraf/v1/input-plugins/kubernetes/_index.md @@ -10,7 +10,7 @@ introduced: "v1.1.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/kubernetes/README.md, Kubernetes Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/kubernetes/README.md, Kubernetes Plugin Source --- # Kubernetes Input Plugin diff --git a/content/telegraf/v1/input-plugins/lanz/_index.md b/content/telegraf/v1/input-plugins/lanz/_index.md index 142a6d4ac..beab20e82 100644 --- a/content/telegraf/v1/input-plugins/lanz/_index.md +++ b/content/telegraf/v1/input-plugins/lanz/_index.md @@ -10,7 +10,7 @@ introduced: "v1.14.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/lanz/README.md, Arista LANZ Consumer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/lanz/README.md, Arista LANZ Consumer Plugin Source --- # Arista LANZ Consumer Input Plugin diff --git a/content/telegraf/v1/input-plugins/ldap/_index.md b/content/telegraf/v1/input-plugins/ldap/_index.md index e21452871..4febbd5d9 100644 --- a/content/telegraf/v1/input-plugins/ldap/_index.md +++ b/content/telegraf/v1/input-plugins/ldap/_index.md @@ -10,7 +10,7 @@ introduced: "v1.29.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/ldap/README.md, LDAP Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/ldap/README.md, LDAP Plugin Source --- # LDAP Input Plugin diff --git a/content/telegraf/v1/input-plugins/leofs/_index.md b/content/telegraf/v1/input-plugins/leofs/_index.md index 79aa4366f..901e531ad 100644 --- a/content/telegraf/v1/input-plugins/leofs/_index.md +++ b/content/telegraf/v1/input-plugins/leofs/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.5" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/leofs/README.md, LeoFS Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/leofs/README.md, LeoFS Plugin Source --- # LeoFS Input Plugin diff --git a/content/telegraf/v1/input-plugins/libvirt/_index.md b/content/telegraf/v1/input-plugins/libvirt/_index.md index e751aced3..25f3fbf58 100644 --- a/content/telegraf/v1/input-plugins/libvirt/_index.md +++ b/content/telegraf/v1/input-plugins/libvirt/_index.md @@ -10,7 +10,7 @@ introduced: "v1.25.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/libvirt/README.md, Libvirt Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/libvirt/README.md, Libvirt Plugin Source --- # Libvirt Input Plugin diff --git a/content/telegraf/v1/input-plugins/linux_cpu/_index.md b/content/telegraf/v1/input-plugins/linux_cpu/_index.md index 74a2d13f5..de8d56b2a 100644 --- a/content/telegraf/v1/input-plugins/linux_cpu/_index.md +++ b/content/telegraf/v1/input-plugins/linux_cpu/_index.md @@ -10,7 +10,7 @@ introduced: "v1.24.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/linux_cpu/README.md, Linux CPU Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/linux_cpu/README.md, Linux CPU Plugin Source --- # Linux CPU Input Plugin diff --git a/content/telegraf/v1/input-plugins/linux_sysctl_fs/_index.md b/content/telegraf/v1/input-plugins/linux_sysctl_fs/_index.md index 01c498cce..72c8d5cdc 100644 --- a/content/telegraf/v1/input-plugins/linux_sysctl_fs/_index.md +++ b/content/telegraf/v1/input-plugins/linux_sysctl_fs/_index.md @@ -10,7 +10,7 @@ introduced: "v1.24.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/linux_sysctl_fs/README.md, Linux Sysctl Filesystem Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/linux_sysctl_fs/README.md, Linux Sysctl Filesystem Plugin Source --- # Linux Sysctl Filesystem Input Plugin diff --git a/content/telegraf/v1/input-plugins/logql/_index.md b/content/telegraf/v1/input-plugins/logql/_index.md index d612a27a9..eca93a069 100644 --- a/content/telegraf/v1/input-plugins/logql/_index.md +++ b/content/telegraf/v1/input-plugins/logql/_index.md @@ -10,7 +10,7 @@ introduced: "v1.37.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/logql/README.md, LogQL Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/logql/README.md, LogQL Plugin Source --- # LogQL Input Plugin diff --git a/content/telegraf/v1/input-plugins/logstash/_index.md b/content/telegraf/v1/input-plugins/logstash/_index.md index c9340e768..8f317e4df 100644 --- a/content/telegraf/v1/input-plugins/logstash/_index.md +++ b/content/telegraf/v1/input-plugins/logstash/_index.md @@ -10,7 +10,7 @@ introduced: "v1.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/logstash/README.md, Logstash Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/logstash/README.md, Logstash Plugin Source --- # Logstash Input Plugin diff --git a/content/telegraf/v1/input-plugins/lustre2/_index.md b/content/telegraf/v1/input-plugins/lustre2/_index.md index 718ffa91d..573e6f1dc 100644 --- a/content/telegraf/v1/input-plugins/lustre2/_index.md +++ b/content/telegraf/v1/input-plugins/lustre2/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.5" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/lustre2/README.md, Lustre Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/lustre2/README.md, Lustre Plugin Source --- # Lustre Input Plugin diff --git a/content/telegraf/v1/input-plugins/lvm/_index.md b/content/telegraf/v1/input-plugins/lvm/_index.md index 8cab33dd5..0ff6d90ce 100644 --- a/content/telegraf/v1/input-plugins/lvm/_index.md +++ b/content/telegraf/v1/input-plugins/lvm/_index.md @@ -10,7 +10,7 @@ introduced: "v1.21.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/lvm/README.md, Logical Volume Manager Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/lvm/README.md, Logical Volume Manager Plugin Source --- # Logical Volume Manager Input Plugin diff --git a/content/telegraf/v1/input-plugins/mailchimp/_index.md b/content/telegraf/v1/input-plugins/mailchimp/_index.md index 6fcee3432..cdc9b8a81 100644 --- a/content/telegraf/v1/input-plugins/mailchimp/_index.md +++ b/content/telegraf/v1/input-plugins/mailchimp/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.4" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/mailchimp/README.md, Mailchimp Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/mailchimp/README.md, Mailchimp Plugin Source --- # Mailchimp Input Plugin diff --git a/content/telegraf/v1/input-plugins/marklogic/_index.md b/content/telegraf/v1/input-plugins/marklogic/_index.md index 96cf441bc..5ac53dcd5 100644 --- a/content/telegraf/v1/input-plugins/marklogic/_index.md +++ b/content/telegraf/v1/input-plugins/marklogic/_index.md @@ -10,7 +10,7 @@ introduced: "v1.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/marklogic/README.md, MarkLogic Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/marklogic/README.md, MarkLogic Plugin Source --- # MarkLogic Input Plugin diff --git a/content/telegraf/v1/input-plugins/mavlink/_index.md b/content/telegraf/v1/input-plugins/mavlink/_index.md index 19a4f24b8..fcf1bd735 100644 --- a/content/telegraf/v1/input-plugins/mavlink/_index.md +++ b/content/telegraf/v1/input-plugins/mavlink/_index.md @@ -10,7 +10,7 @@ introduced: "v1.35.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/mavlink/README.md, MavLink Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/mavlink/README.md, MavLink Plugin Source --- # MavLink Input Plugin diff --git a/content/telegraf/v1/input-plugins/mcrouter/_index.md b/content/telegraf/v1/input-plugins/mcrouter/_index.md index 6f6832498..387bc508f 100644 --- a/content/telegraf/v1/input-plugins/mcrouter/_index.md +++ b/content/telegraf/v1/input-plugins/mcrouter/_index.md @@ -10,7 +10,7 @@ introduced: "v1.7.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/mcrouter/README.md, Mcrouter Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/mcrouter/README.md, Mcrouter Plugin Source --- # Mcrouter Input Plugin diff --git a/content/telegraf/v1/input-plugins/mdstat/_index.md b/content/telegraf/v1/input-plugins/mdstat/_index.md index 6317b5d78..89dc40937 100644 --- a/content/telegraf/v1/input-plugins/mdstat/_index.md +++ b/content/telegraf/v1/input-plugins/mdstat/_index.md @@ -10,7 +10,7 @@ introduced: "v1.20.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/mdstat/README.md, MD RAID Statistics Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/mdstat/README.md, MD RAID Statistics Plugin Source --- # MD RAID Statistics Input Plugin diff --git a/content/telegraf/v1/input-plugins/mem/_index.md b/content/telegraf/v1/input-plugins/mem/_index.md index d8cc65783..a554738d1 100644 --- a/content/telegraf/v1/input-plugins/mem/_index.md +++ b/content/telegraf/v1/input-plugins/mem/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.5" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/mem/README.md, Memory Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/mem/README.md, Memory Plugin Source --- # Memory Input Plugin diff --git a/content/telegraf/v1/input-plugins/memcached/_index.md b/content/telegraf/v1/input-plugins/memcached/_index.md index 1653714fb..24f1fa7de 100644 --- a/content/telegraf/v1/input-plugins/memcached/_index.md +++ b/content/telegraf/v1/input-plugins/memcached/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.2" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/memcached/README.md, Memcached Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/memcached/README.md, Memcached Plugin Source --- # Memcached Input Plugin diff --git a/content/telegraf/v1/input-plugins/mesos/_index.md b/content/telegraf/v1/input-plugins/mesos/_index.md index f1b2c504d..150bdd270 100644 --- a/content/telegraf/v1/input-plugins/mesos/_index.md +++ b/content/telegraf/v1/input-plugins/mesos/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.3" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/mesos/README.md, Apache Mesos Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/mesos/README.md, Apache Mesos Plugin Source --- # Apache Mesos Input Plugin diff --git a/content/telegraf/v1/input-plugins/minecraft/_index.md b/content/telegraf/v1/input-plugins/minecraft/_index.md index 3909fa361..1e4f4ffc3 100644 --- a/content/telegraf/v1/input-plugins/minecraft/_index.md +++ b/content/telegraf/v1/input-plugins/minecraft/_index.md @@ -10,7 +10,7 @@ introduced: "v1.4.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/minecraft/README.md, Minecraft Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/minecraft/README.md, Minecraft Plugin Source --- # Minecraft Input Plugin diff --git a/content/telegraf/v1/input-plugins/mock/_index.md b/content/telegraf/v1/input-plugins/mock/_index.md index 97d7c726a..8147ca945 100644 --- a/content/telegraf/v1/input-plugins/mock/_index.md +++ b/content/telegraf/v1/input-plugins/mock/_index.md @@ -10,7 +10,7 @@ introduced: "v1.22.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/mock/README.md, Mock Data Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/mock/README.md, Mock Data Plugin Source --- # Mock Data Input Plugin diff --git a/content/telegraf/v1/input-plugins/modbus/_index.md b/content/telegraf/v1/input-plugins/modbus/_index.md index 02291a350..04cbeada1 100644 --- a/content/telegraf/v1/input-plugins/modbus/_index.md +++ b/content/telegraf/v1/input-plugins/modbus/_index.md @@ -10,7 +10,7 @@ introduced: "v1.14.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/modbus/README.md, Modbus Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/modbus/README.md, Modbus Plugin Source --- diff --git a/content/telegraf/v1/input-plugins/mongodb/_index.md b/content/telegraf/v1/input-plugins/mongodb/_index.md index 6083e33c5..a6424688a 100644 --- a/content/telegraf/v1/input-plugins/mongodb/_index.md +++ b/content/telegraf/v1/input-plugins/mongodb/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.5" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/mongodb/README.md, MongoDB Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/mongodb/README.md, MongoDB Plugin Source --- # MongoDB Input Plugin diff --git a/content/telegraf/v1/input-plugins/monit/_index.md b/content/telegraf/v1/input-plugins/monit/_index.md index 7b24ecc47..ee28763de 100644 --- a/content/telegraf/v1/input-plugins/monit/_index.md +++ b/content/telegraf/v1/input-plugins/monit/_index.md @@ -10,7 +10,7 @@ introduced: "v1.14.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/monit/README.md, Monit Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/monit/README.md, Monit Plugin Source --- # Monit Input Plugin diff --git a/content/telegraf/v1/input-plugins/mqtt_consumer/_index.md b/content/telegraf/v1/input-plugins/mqtt_consumer/_index.md index 310bde179..50c6c6ccc 100644 --- a/content/telegraf/v1/input-plugins/mqtt_consumer/_index.md +++ b/content/telegraf/v1/input-plugins/mqtt_consumer/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.3" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/mqtt_consumer/README.md, MQTT Consumer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/mqtt_consumer/README.md, MQTT Consumer Plugin Source --- # MQTT Consumer Input Plugin diff --git a/content/telegraf/v1/input-plugins/multifile/_index.md b/content/telegraf/v1/input-plugins/multifile/_index.md index fd3581f29..332c0a27a 100644 --- a/content/telegraf/v1/input-plugins/multifile/_index.md +++ b/content/telegraf/v1/input-plugins/multifile/_index.md @@ -10,7 +10,7 @@ introduced: "v1.10.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/multifile/README.md, Multifile Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/multifile/README.md, Multifile Plugin Source --- # Multifile Input Plugin diff --git a/content/telegraf/v1/input-plugins/mysql/_index.md b/content/telegraf/v1/input-plugins/mysql/_index.md index 3b35d5f10..18d5ec447 100644 --- a/content/telegraf/v1/input-plugins/mysql/_index.md +++ b/content/telegraf/v1/input-plugins/mysql/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/mysql/README.md, MySQL Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/mysql/README.md, MySQL Plugin Source --- # MySQL Input Plugin diff --git a/content/telegraf/v1/input-plugins/nats/_index.md b/content/telegraf/v1/input-plugins/nats/_index.md index 5bb210653..f6c2af180 100644 --- a/content/telegraf/v1/input-plugins/nats/_index.md +++ b/content/telegraf/v1/input-plugins/nats/_index.md @@ -10,7 +10,7 @@ introduced: "v1.6.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nats/README.md, NATS Server Monitoring Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/nats/README.md, NATS Server Monitoring Plugin Source --- # NATS Server Monitoring Input Plugin diff --git a/content/telegraf/v1/input-plugins/nats_consumer/_index.md b/content/telegraf/v1/input-plugins/nats_consumer/_index.md index f3fc6c680..2184afb62 100644 --- a/content/telegraf/v1/input-plugins/nats_consumer/_index.md +++ b/content/telegraf/v1/input-plugins/nats_consumer/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.3" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nats_consumer/README.md, NATS Consumer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/nats_consumer/README.md, NATS Consumer Plugin Source --- # NATS Consumer Input Plugin diff --git a/content/telegraf/v1/input-plugins/neoom_beaam/_index.md b/content/telegraf/v1/input-plugins/neoom_beaam/_index.md index 601fe0054..f39e62a83 100644 --- a/content/telegraf/v1/input-plugins/neoom_beaam/_index.md +++ b/content/telegraf/v1/input-plugins/neoom_beaam/_index.md @@ -10,7 +10,7 @@ introduced: "v1.33.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/neoom_beaam/README.md, Neoom Beaam Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/neoom_beaam/README.md, Neoom Beaam Plugin Source --- # Neoom Beaam Input Plugin diff --git a/content/telegraf/v1/input-plugins/neptune_apex/_index.md b/content/telegraf/v1/input-plugins/neptune_apex/_index.md index 9362837fc..70ab01ebb 100644 --- a/content/telegraf/v1/input-plugins/neptune_apex/_index.md +++ b/content/telegraf/v1/input-plugins/neptune_apex/_index.md @@ -10,7 +10,7 @@ introduced: "v1.10.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/neptune_apex/README.md, Neptune Apex Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/neptune_apex/README.md, Neptune Apex Plugin Source --- # Neptune Apex Input Plugin diff --git a/content/telegraf/v1/input-plugins/net/_index.md b/content/telegraf/v1/input-plugins/net/_index.md index 22490b185..031506c34 100644 --- a/content/telegraf/v1/input-plugins/net/_index.md +++ b/content/telegraf/v1/input-plugins/net/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/net/README.md, Network Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/net/README.md, Network Plugin Source --- # Network Input Plugin diff --git a/content/telegraf/v1/input-plugins/net_response/_index.md b/content/telegraf/v1/input-plugins/net_response/_index.md index 29bdaf294..77b90823b 100644 --- a/content/telegraf/v1/input-plugins/net_response/_index.md +++ b/content/telegraf/v1/input-plugins/net_response/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.3" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/net_response/README.md, Network Response Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/net_response/README.md, Network Response Plugin Source --- # Network Response Input Plugin diff --git a/content/telegraf/v1/input-plugins/netflow/_index.md b/content/telegraf/v1/input-plugins/netflow/_index.md index 95ff91fd4..503769121 100644 --- a/content/telegraf/v1/input-plugins/netflow/_index.md +++ b/content/telegraf/v1/input-plugins/netflow/_index.md @@ -10,7 +10,7 @@ introduced: "v1.25.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/netflow/README.md, Netflow Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/netflow/README.md, Netflow Plugin Source --- # Netflow Input Plugin diff --git a/content/telegraf/v1/input-plugins/netstat/_index.md b/content/telegraf/v1/input-plugins/netstat/_index.md index 6a338a4cd..77c2e7ce2 100644 --- a/content/telegraf/v1/input-plugins/netstat/_index.md +++ b/content/telegraf/v1/input-plugins/netstat/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/netstat/README.md, Network Connection Statistics Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/netstat/README.md, Network Connection Statistics Plugin Source --- # Network Connection Statistics Input Plugin diff --git a/content/telegraf/v1/input-plugins/nfsclient/_index.md b/content/telegraf/v1/input-plugins/nfsclient/_index.md index c2881bfa3..c4c7fe785 100644 --- a/content/telegraf/v1/input-plugins/nfsclient/_index.md +++ b/content/telegraf/v1/input-plugins/nfsclient/_index.md @@ -10,7 +10,7 @@ introduced: "v1.18.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nfsclient/README.md, Network Filesystem Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/nfsclient/README.md, Network Filesystem Plugin Source --- # Network Filesystem Input Plugin diff --git a/content/telegraf/v1/input-plugins/nftables/_index.md b/content/telegraf/v1/input-plugins/nftables/_index.md index aa8cb9a4e..c11fdb289 100644 --- a/content/telegraf/v1/input-plugins/nftables/_index.md +++ b/content/telegraf/v1/input-plugins/nftables/_index.md @@ -10,7 +10,7 @@ introduced: "v1.37.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nftables/README.md, Nftables Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/nftables/README.md, Nftables Plugin Source --- # Nftables Plugin diff --git a/content/telegraf/v1/input-plugins/nginx/_index.md b/content/telegraf/v1/input-plugins/nginx/_index.md index a856f1f41..f8e005e31 100644 --- a/content/telegraf/v1/input-plugins/nginx/_index.md +++ b/content/telegraf/v1/input-plugins/nginx/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.5" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nginx/README.md, Nginx Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/nginx/README.md, Nginx Plugin Source --- # Nginx Input Plugin diff --git a/content/telegraf/v1/input-plugins/nginx_plus/_index.md b/content/telegraf/v1/input-plugins/nginx_plus/_index.md index 19039c2ad..4b1f4b89a 100644 --- a/content/telegraf/v1/input-plugins/nginx_plus/_index.md +++ b/content/telegraf/v1/input-plugins/nginx_plus/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nginx_plus/README.md, Nginx Plus Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/nginx_plus/README.md, Nginx Plus Plugin Source --- # Nginx Plus Input Plugin diff --git a/content/telegraf/v1/input-plugins/nginx_plus_api/_index.md b/content/telegraf/v1/input-plugins/nginx_plus_api/_index.md index 219e7dad2..fdf04eceb 100644 --- a/content/telegraf/v1/input-plugins/nginx_plus_api/_index.md +++ b/content/telegraf/v1/input-plugins/nginx_plus_api/_index.md @@ -10,7 +10,7 @@ introduced: "v1.9.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nginx_plus_api/README.md, Nginx Plus API Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/nginx_plus_api/README.md, Nginx Plus API Plugin Source --- # Nginx Plus API Input Plugin diff --git a/content/telegraf/v1/input-plugins/nginx_sts/_index.md b/content/telegraf/v1/input-plugins/nginx_sts/_index.md index 8cedbcc79..afb76a4c4 100644 --- a/content/telegraf/v1/input-plugins/nginx_sts/_index.md +++ b/content/telegraf/v1/input-plugins/nginx_sts/_index.md @@ -10,7 +10,7 @@ introduced: "v1.15.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nginx_sts/README.md, Nginx Stream Server Traffic Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/nginx_sts/README.md, Nginx Stream Server Traffic Plugin Source --- # Nginx Stream Server Traffic Input Plugin diff --git a/content/telegraf/v1/input-plugins/nginx_upstream_check/_index.md b/content/telegraf/v1/input-plugins/nginx_upstream_check/_index.md index a03f93b09..2313516d4 100644 --- a/content/telegraf/v1/input-plugins/nginx_upstream_check/_index.md +++ b/content/telegraf/v1/input-plugins/nginx_upstream_check/_index.md @@ -10,7 +10,7 @@ introduced: "v1.10.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nginx_upstream_check/README.md, Nginx Upstream Check Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/nginx_upstream_check/README.md, Nginx Upstream Check Plugin Source --- # Nginx Upstream Check Input Plugin diff --git a/content/telegraf/v1/input-plugins/nginx_vts/_index.md b/content/telegraf/v1/input-plugins/nginx_vts/_index.md index 4542d2f7e..e79e08826 100644 --- a/content/telegraf/v1/input-plugins/nginx_vts/_index.md +++ b/content/telegraf/v1/input-plugins/nginx_vts/_index.md @@ -10,7 +10,7 @@ introduced: "v1.9.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nginx_vts/README.md, Nginx Virtual Host Traffic Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/nginx_vts/README.md, Nginx Virtual Host Traffic Plugin Source --- # Nginx Virtual Host Traffic Input Plugin diff --git a/content/telegraf/v1/input-plugins/nomad/_index.md b/content/telegraf/v1/input-plugins/nomad/_index.md index c657b90a7..e30dc578b 100644 --- a/content/telegraf/v1/input-plugins/nomad/_index.md +++ b/content/telegraf/v1/input-plugins/nomad/_index.md @@ -10,7 +10,7 @@ introduced: "v1.22.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nomad/README.md, Hashicorp Nomad Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/nomad/README.md, Hashicorp Nomad Plugin Source --- # Hashicorp Nomad Input Plugin diff --git a/content/telegraf/v1/input-plugins/nsd/_index.md b/content/telegraf/v1/input-plugins/nsd/_index.md index fb0917056..bdbe372d8 100644 --- a/content/telegraf/v1/input-plugins/nsd/_index.md +++ b/content/telegraf/v1/input-plugins/nsd/_index.md @@ -10,7 +10,7 @@ introduced: "v1.0.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nsd/README.md, NLnet Labs Name Server Daemon Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/nsd/README.md, NLnet Labs Name Server Daemon Plugin Source --- # NLnet Labs Name Server Daemon Input Plugin diff --git a/content/telegraf/v1/input-plugins/nsdp/_index.md b/content/telegraf/v1/input-plugins/nsdp/_index.md index c2de1c995..fff2dbd14 100644 --- a/content/telegraf/v1/input-plugins/nsdp/_index.md +++ b/content/telegraf/v1/input-plugins/nsdp/_index.md @@ -10,7 +10,7 @@ introduced: "v1.34.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nsdp/README.md, Netgear Switch Discovery Protocol Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/nsdp/README.md, Netgear Switch Discovery Protocol Plugin Source --- # Netgear Switch Discovery Protocol Input Plugin diff --git a/content/telegraf/v1/input-plugins/nsq/_index.md b/content/telegraf/v1/input-plugins/nsq/_index.md index 549983ba0..a80e4d8ea 100644 --- a/content/telegraf/v1/input-plugins/nsq/_index.md +++ b/content/telegraf/v1/input-plugins/nsq/_index.md @@ -10,7 +10,7 @@ introduced: "v1.16.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nsq/README.md, NSQ Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/nsq/README.md, NSQ Plugin Source --- # NSQ Input Plugin diff --git a/content/telegraf/v1/input-plugins/nsq_consumer/_index.md b/content/telegraf/v1/input-plugins/nsq_consumer/_index.md index a87436ea2..f94985560 100644 --- a/content/telegraf/v1/input-plugins/nsq_consumer/_index.md +++ b/content/telegraf/v1/input-plugins/nsq_consumer/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nsq_consumer/README.md, NSQ Consumer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/nsq_consumer/README.md, NSQ Consumer Plugin Source --- # NSQ Consumer Input Plugin diff --git a/content/telegraf/v1/input-plugins/nstat/_index.md b/content/telegraf/v1/input-plugins/nstat/_index.md index 3e74a8a81..d3f70b14d 100644 --- a/content/telegraf/v1/input-plugins/nstat/_index.md +++ b/content/telegraf/v1/input-plugins/nstat/_index.md @@ -10,7 +10,7 @@ introduced: "v0.13.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nstat/README.md, Kernel Network Statistics Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/nstat/README.md, Kernel Network Statistics Plugin Source --- # Kernel Network Statistics Input Plugin diff --git a/content/telegraf/v1/input-plugins/ntpq/_index.md b/content/telegraf/v1/input-plugins/ntpq/_index.md index ac1115ce8..d3ca0a637 100644 --- a/content/telegraf/v1/input-plugins/ntpq/_index.md +++ b/content/telegraf/v1/input-plugins/ntpq/_index.md @@ -10,7 +10,7 @@ introduced: "v0.11.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/ntpq/README.md, Network Time Protocol Query Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/ntpq/README.md, Network Time Protocol Query Plugin Source --- # Network Time Protocol Query Input Plugin diff --git a/content/telegraf/v1/input-plugins/nvidia_smi/_index.md b/content/telegraf/v1/input-plugins/nvidia_smi/_index.md index d35bdbbfe..317ba1518 100644 --- a/content/telegraf/v1/input-plugins/nvidia_smi/_index.md +++ b/content/telegraf/v1/input-plugins/nvidia_smi/_index.md @@ -10,7 +10,7 @@ introduced: "v1.7.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/nvidia_smi/README.md, Nvidia System Management Interface (SMI) Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/nvidia_smi/README.md, Nvidia System Management Interface (SMI) Plugin Source --- # Nvidia System Management Interface (SMI) Input Plugin diff --git a/content/telegraf/v1/input-plugins/opcua/_index.md b/content/telegraf/v1/input-plugins/opcua/_index.md index 6100b0eaf..88fdfc671 100644 --- a/content/telegraf/v1/input-plugins/opcua/_index.md +++ b/content/telegraf/v1/input-plugins/opcua/_index.md @@ -10,7 +10,7 @@ introduced: "v1.16.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/opcua/README.md, OPC UA Client Reader Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/opcua/README.md, OPC UA Client Reader Plugin Source --- # OPC UA Client Reader Input Plugin diff --git a/content/telegraf/v1/input-plugins/opcua_listener/_index.md b/content/telegraf/v1/input-plugins/opcua_listener/_index.md index 043f03a55..d3fad94dd 100644 --- a/content/telegraf/v1/input-plugins/opcua_listener/_index.md +++ b/content/telegraf/v1/input-plugins/opcua_listener/_index.md @@ -10,7 +10,7 @@ introduced: "v1.25.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/opcua_listener/README.md, OPC UA Client Listener Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/opcua_listener/README.md, OPC UA Client Listener Plugin Source --- # OPC UA Client Listener Input Plugin diff --git a/content/telegraf/v1/input-plugins/openldap/_index.md b/content/telegraf/v1/input-plugins/openldap/_index.md index 1dc9a64b4..85d896f9d 100644 --- a/content/telegraf/v1/input-plugins/openldap/_index.md +++ b/content/telegraf/v1/input-plugins/openldap/_index.md @@ -10,7 +10,7 @@ introduced: "v1.4.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/openldap/README.md, OpenLDAP Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/openldap/README.md, OpenLDAP Plugin Source --- # OpenLDAP Input Plugin diff --git a/content/telegraf/v1/input-plugins/openntpd/_index.md b/content/telegraf/v1/input-plugins/openntpd/_index.md index 180ca5a46..bd9fcba82 100644 --- a/content/telegraf/v1/input-plugins/openntpd/_index.md +++ b/content/telegraf/v1/input-plugins/openntpd/_index.md @@ -10,7 +10,7 @@ introduced: "v1.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/openntpd/README.md, OpenNTPD Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/openntpd/README.md, OpenNTPD Plugin Source --- # OpenNTPD Input Plugin diff --git a/content/telegraf/v1/input-plugins/opensearch_query/_index.md b/content/telegraf/v1/input-plugins/opensearch_query/_index.md index 19c6d994c..6c92db673 100644 --- a/content/telegraf/v1/input-plugins/opensearch_query/_index.md +++ b/content/telegraf/v1/input-plugins/opensearch_query/_index.md @@ -10,7 +10,7 @@ introduced: "v1.26.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/opensearch_query/README.md, OpenSearch Query Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/opensearch_query/README.md, OpenSearch Query Plugin Source --- # OpenSearch Query Input Plugin diff --git a/content/telegraf/v1/input-plugins/opensmtpd/_index.md b/content/telegraf/v1/input-plugins/opensmtpd/_index.md index 954840396..58c326185 100644 --- a/content/telegraf/v1/input-plugins/opensmtpd/_index.md +++ b/content/telegraf/v1/input-plugins/opensmtpd/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/opensmtpd/README.md, OpenSMTPD Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/opensmtpd/README.md, OpenSMTPD Plugin Source --- # OpenSMTPD Input Plugin diff --git a/content/telegraf/v1/input-plugins/openstack/_index.md b/content/telegraf/v1/input-plugins/openstack/_index.md index b98b8f152..492663404 100644 --- a/content/telegraf/v1/input-plugins/openstack/_index.md +++ b/content/telegraf/v1/input-plugins/openstack/_index.md @@ -10,7 +10,7 @@ introduced: "v1.21.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/openstack/README.md, OpenStack Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/openstack/README.md, OpenStack Plugin Source --- # OpenStack Input Plugin diff --git a/content/telegraf/v1/input-plugins/opentelemetry/_index.md b/content/telegraf/v1/input-plugins/opentelemetry/_index.md index 4b2cafc7f..e64dd1374 100644 --- a/content/telegraf/v1/input-plugins/opentelemetry/_index.md +++ b/content/telegraf/v1/input-plugins/opentelemetry/_index.md @@ -10,7 +10,7 @@ introduced: "v1.19.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/opentelemetry/README.md, OpenTelemetry Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/opentelemetry/README.md, OpenTelemetry Plugin Source --- # OpenTelemetry Input Plugin diff --git a/content/telegraf/v1/input-plugins/openweathermap/_index.md b/content/telegraf/v1/input-plugins/openweathermap/_index.md index 88e7eaf72..d0a9a12a5 100644 --- a/content/telegraf/v1/input-plugins/openweathermap/_index.md +++ b/content/telegraf/v1/input-plugins/openweathermap/_index.md @@ -10,7 +10,7 @@ introduced: "v1.11.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/openweathermap/README.md, OpenWeatherMap Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/openweathermap/README.md, OpenWeatherMap Plugin Source --- # OpenWeatherMap Input Plugin diff --git a/content/telegraf/v1/input-plugins/p4runtime/_index.md b/content/telegraf/v1/input-plugins/p4runtime/_index.md index f0b79c03f..0b9346789 100644 --- a/content/telegraf/v1/input-plugins/p4runtime/_index.md +++ b/content/telegraf/v1/input-plugins/p4runtime/_index.md @@ -10,7 +10,7 @@ introduced: "v1.26.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/p4runtime/README.md, P4 Runtime Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/p4runtime/README.md, P4 Runtime Plugin Source --- # P4 Runtime Input Plugin diff --git a/content/telegraf/v1/input-plugins/passenger/_index.md b/content/telegraf/v1/input-plugins/passenger/_index.md index eec567344..559aefe43 100644 --- a/content/telegraf/v1/input-plugins/passenger/_index.md +++ b/content/telegraf/v1/input-plugins/passenger/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/passenger/README.md, Passenger Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/passenger/README.md, Passenger Plugin Source --- # Passenger Input Plugin diff --git a/content/telegraf/v1/input-plugins/pf/_index.md b/content/telegraf/v1/input-plugins/pf/_index.md index 1c4918994..43cba0fdb 100644 --- a/content/telegraf/v1/input-plugins/pf/_index.md +++ b/content/telegraf/v1/input-plugins/pf/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/pf/README.md, PF Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/pf/README.md, PF Plugin Source --- # PF Input Plugin diff --git a/content/telegraf/v1/input-plugins/pgbouncer/_index.md b/content/telegraf/v1/input-plugins/pgbouncer/_index.md index 802117955..715a5dcf3 100644 --- a/content/telegraf/v1/input-plugins/pgbouncer/_index.md +++ b/content/telegraf/v1/input-plugins/pgbouncer/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/pgbouncer/README.md, PgBouncer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/pgbouncer/README.md, PgBouncer Plugin Source --- # PgBouncer Input Plugin diff --git a/content/telegraf/v1/input-plugins/phpfpm/_index.md b/content/telegraf/v1/input-plugins/phpfpm/_index.md index 20673fe7c..dd9376a4d 100644 --- a/content/telegraf/v1/input-plugins/phpfpm/_index.md +++ b/content/telegraf/v1/input-plugins/phpfpm/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.10" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/phpfpm/README.md, PHP-FPM Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/phpfpm/README.md, PHP-FPM Plugin Source --- # PHP-FPM Input Plugin diff --git a/content/telegraf/v1/input-plugins/ping/_index.md b/content/telegraf/v1/input-plugins/ping/_index.md index 040760f29..9797bc63a 100644 --- a/content/telegraf/v1/input-plugins/ping/_index.md +++ b/content/telegraf/v1/input-plugins/ping/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.8" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/ping/README.md, Ping Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/ping/README.md, Ping Plugin Source --- # Ping Input Plugin @@ -60,11 +60,12 @@ plugin ordering. See [CONFIGURATION.md](/telegraf/v1/configuration/#plugins) for # ping_interval = 1.0 ## If set, the time to wait for a ping response in seconds. Operates like - ## the "-W" option of the ping command. + ## the "-W" option of the ping command (for "exec" method only) # timeout = 1.0 - ## If set, the total ping deadline, in seconds. Operates like the -w option - ## of the ping command. + ## If set, the total ping deadline, in seconds. Operates like the "-w" + ## option of the ping command. Use this option to control timeout behavior + ## when using the "native" method. # deadline = 10 ## Interface or source address to send ping from. Operates like the -I or -S @@ -115,6 +116,9 @@ reported in native Go by the Telegraf process, eliminating the need to execute the system `ping` command. Therefore, this method doesn't have external dependencies. +With `method = "native"`, the `timeout` option is ignored. Use `deadline` to +control the total runtime instead. + ### File Limit Since this plugin runs the ping command, it may need to open multiple files per diff --git a/content/telegraf/v1/input-plugins/postfix/_index.md b/content/telegraf/v1/input-plugins/postfix/_index.md index 9b62f7702..092b17af4 100644 --- a/content/telegraf/v1/input-plugins/postfix/_index.md +++ b/content/telegraf/v1/input-plugins/postfix/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd, linux, macos, solaris" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/postfix/README.md, Postfix Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/postfix/README.md, Postfix Plugin Source --- # Postfix Input Plugin diff --git a/content/telegraf/v1/input-plugins/postgresql/_index.md b/content/telegraf/v1/input-plugins/postgresql/_index.md index 13647079a..81a589fc3 100644 --- a/content/telegraf/v1/input-plugins/postgresql/_index.md +++ b/content/telegraf/v1/input-plugins/postgresql/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.3" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/postgresql/README.md, PostgreSQL Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/postgresql/README.md, PostgreSQL Plugin Source --- # PostgreSQL Input Plugin diff --git a/content/telegraf/v1/input-plugins/postgresql_extensible/_index.md b/content/telegraf/v1/input-plugins/postgresql_extensible/_index.md index 8d0975b8a..32682a15a 100644 --- a/content/telegraf/v1/input-plugins/postgresql_extensible/_index.md +++ b/content/telegraf/v1/input-plugins/postgresql_extensible/_index.md @@ -10,7 +10,7 @@ introduced: "v0.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/postgresql_extensible/README.md, PostgreSQL Extensible Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/postgresql_extensible/README.md, PostgreSQL Extensible Plugin Source --- # PostgreSQL Extensible Input Plugin diff --git a/content/telegraf/v1/input-plugins/powerdns/_index.md b/content/telegraf/v1/input-plugins/powerdns/_index.md index 2f6e7357a..414c7730d 100644 --- a/content/telegraf/v1/input-plugins/powerdns/_index.md +++ b/content/telegraf/v1/input-plugins/powerdns/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.2" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/powerdns/README.md, PowerDNS Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/powerdns/README.md, PowerDNS Plugin Source --- # PowerDNS Input Plugin diff --git a/content/telegraf/v1/input-plugins/powerdns_recursor/_index.md b/content/telegraf/v1/input-plugins/powerdns_recursor/_index.md index 1f40df3aa..395a6941b 100644 --- a/content/telegraf/v1/input-plugins/powerdns_recursor/_index.md +++ b/content/telegraf/v1/input-plugins/powerdns_recursor/_index.md @@ -10,7 +10,7 @@ introduced: "v1.11.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/powerdns_recursor/README.md, PowerDNS Recursor Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/powerdns_recursor/README.md, PowerDNS Recursor Plugin Source --- # PowerDNS Recursor Input Plugin diff --git a/content/telegraf/v1/input-plugins/processes/_index.md b/content/telegraf/v1/input-plugins/processes/_index.md index 4cfd56d60..33a0907f2 100644 --- a/content/telegraf/v1/input-plugins/processes/_index.md +++ b/content/telegraf/v1/input-plugins/processes/_index.md @@ -10,7 +10,7 @@ introduced: "v0.11.0" os_support: "freebsd, linux, macos" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/processes/README.md, Processes Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/processes/README.md, Processes Plugin Source --- # Processes Input Plugin diff --git a/content/telegraf/v1/input-plugins/procstat/_index.md b/content/telegraf/v1/input-plugins/procstat/_index.md index 6c053924a..38b0db03b 100644 --- a/content/telegraf/v1/input-plugins/procstat/_index.md +++ b/content/telegraf/v1/input-plugins/procstat/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/procstat/README.md, Procstat Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/procstat/README.md, Procstat Plugin Source --- # Procstat Input Plugin diff --git a/content/telegraf/v1/input-plugins/prometheus/_index.md b/content/telegraf/v1/input-plugins/prometheus/_index.md index b50c5041e..3487fb5d9 100644 --- a/content/telegraf/v1/input-plugins/prometheus/_index.md +++ b/content/telegraf/v1/input-plugins/prometheus/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.5" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/prometheus/README.md, Prometheus Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/prometheus/README.md, Prometheus Plugin Source --- # Prometheus Input Plugin diff --git a/content/telegraf/v1/input-plugins/promql/_index.md b/content/telegraf/v1/input-plugins/promql/_index.md index b1170b421..95aef2b75 100644 --- a/content/telegraf/v1/input-plugins/promql/_index.md +++ b/content/telegraf/v1/input-plugins/promql/_index.md @@ -10,7 +10,7 @@ introduced: "v1.37.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/promql/README.md, PromQL Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/promql/README.md, PromQL Plugin Source --- # PromQL Input Plugin diff --git a/content/telegraf/v1/input-plugins/proxmox/_index.md b/content/telegraf/v1/input-plugins/proxmox/_index.md index c8c0e2276..abf7270f6 100644 --- a/content/telegraf/v1/input-plugins/proxmox/_index.md +++ b/content/telegraf/v1/input-plugins/proxmox/_index.md @@ -10,7 +10,7 @@ introduced: "v1.16.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/proxmox/README.md, Proxmox Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/proxmox/README.md, Proxmox Plugin Source --- # Proxmox Input Plugin diff --git a/content/telegraf/v1/input-plugins/puppetagent/_index.md b/content/telegraf/v1/input-plugins/puppetagent/_index.md index 89f732da6..233f683af 100644 --- a/content/telegraf/v1/input-plugins/puppetagent/_index.md +++ b/content/telegraf/v1/input-plugins/puppetagent/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/puppetagent/README.md, Puppet Agent Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/puppetagent/README.md, Puppet Agent Plugin Source --- # Puppet Agent Input Plugin diff --git a/content/telegraf/v1/input-plugins/rabbitmq/_index.md b/content/telegraf/v1/input-plugins/rabbitmq/_index.md index f6ed7c171..77ca8d9b7 100644 --- a/content/telegraf/v1/input-plugins/rabbitmq/_index.md +++ b/content/telegraf/v1/input-plugins/rabbitmq/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.5" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/rabbitmq/README.md, RabbitMQ Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/rabbitmq/README.md, RabbitMQ Plugin Source --- # RabbitMQ Input Plugin diff --git a/content/telegraf/v1/input-plugins/radius/_index.md b/content/telegraf/v1/input-plugins/radius/_index.md index 1850d08ae..e09070a68 100644 --- a/content/telegraf/v1/input-plugins/radius/_index.md +++ b/content/telegraf/v1/input-plugins/radius/_index.md @@ -10,7 +10,7 @@ introduced: "v1.26.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/radius/README.md, Radius Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/radius/README.md, Radius Plugin Source --- # Radius Input Plugin diff --git a/content/telegraf/v1/input-plugins/raindrops/_index.md b/content/telegraf/v1/input-plugins/raindrops/_index.md index a31e3bf26..e0910c202 100644 --- a/content/telegraf/v1/input-plugins/raindrops/_index.md +++ b/content/telegraf/v1/input-plugins/raindrops/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.3" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/raindrops/README.md, Raindrops Middleware Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/raindrops/README.md, Raindrops Middleware Plugin Source --- # Raindrops Middleware Input Plugin diff --git a/content/telegraf/v1/input-plugins/ras/_index.md b/content/telegraf/v1/input-plugins/ras/_index.md index a13cdfaf5..c5504fa8b 100644 --- a/content/telegraf/v1/input-plugins/ras/_index.md +++ b/content/telegraf/v1/input-plugins/ras/_index.md @@ -10,7 +10,7 @@ introduced: "v1.16.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/ras/README.md, RAS Daemon Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/ras/README.md, RAS Daemon Plugin Source --- # RAS Daemon Input Plugin diff --git a/content/telegraf/v1/input-plugins/ravendb/_index.md b/content/telegraf/v1/input-plugins/ravendb/_index.md index a2ec18ced..73d4eade3 100644 --- a/content/telegraf/v1/input-plugins/ravendb/_index.md +++ b/content/telegraf/v1/input-plugins/ravendb/_index.md @@ -10,7 +10,7 @@ introduced: "v1.18.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/ravendb/README.md, RavenDB Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/ravendb/README.md, RavenDB Plugin Source --- # RavenDB Input Plugin diff --git a/content/telegraf/v1/input-plugins/redfish/_index.md b/content/telegraf/v1/input-plugins/redfish/_index.md index 069fbacd8..f7e47f13f 100644 --- a/content/telegraf/v1/input-plugins/redfish/_index.md +++ b/content/telegraf/v1/input-plugins/redfish/_index.md @@ -10,7 +10,7 @@ introduced: "v1.15.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/redfish/README.md, Redfish Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/redfish/README.md, Redfish Plugin Source --- # Redfish Input Plugin diff --git a/content/telegraf/v1/input-plugins/redis/_index.md b/content/telegraf/v1/input-plugins/redis/_index.md index 9472c4ae3..62bb5295c 100644 --- a/content/telegraf/v1/input-plugins/redis/_index.md +++ b/content/telegraf/v1/input-plugins/redis/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/redis/README.md, Redis Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/redis/README.md, Redis Plugin Source --- # Redis Input Plugin diff --git a/content/telegraf/v1/input-plugins/redis_sentinel/_index.md b/content/telegraf/v1/input-plugins/redis_sentinel/_index.md index ef77c13a0..7118694f2 100644 --- a/content/telegraf/v1/input-plugins/redis_sentinel/_index.md +++ b/content/telegraf/v1/input-plugins/redis_sentinel/_index.md @@ -10,7 +10,7 @@ introduced: "v1.22.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/redis_sentinel/README.md, Redis Sentinel Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/redis_sentinel/README.md, Redis Sentinel Plugin Source --- # Redis Sentinel Input Plugin diff --git a/content/telegraf/v1/input-plugins/rethinkdb/_index.md b/content/telegraf/v1/input-plugins/rethinkdb/_index.md index 3d9881c4d..89d878941 100644 --- a/content/telegraf/v1/input-plugins/rethinkdb/_index.md +++ b/content/telegraf/v1/input-plugins/rethinkdb/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.3" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/rethinkdb/README.md, RethinkDB Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/rethinkdb/README.md, RethinkDB Plugin Source --- # RethinkDB Input Plugin diff --git a/content/telegraf/v1/input-plugins/riak/_index.md b/content/telegraf/v1/input-plugins/riak/_index.md index 0531a8c98..8e0d7bc64 100644 --- a/content/telegraf/v1/input-plugins/riak/_index.md +++ b/content/telegraf/v1/input-plugins/riak/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.4" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/riak/README.md, Riak Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/riak/README.md, Riak Plugin Source --- # Riak Input Plugin diff --git a/content/telegraf/v1/input-plugins/riemann_listener/_index.md b/content/telegraf/v1/input-plugins/riemann_listener/_index.md index 62929360e..fb43a4480 100644 --- a/content/telegraf/v1/input-plugins/riemann_listener/_index.md +++ b/content/telegraf/v1/input-plugins/riemann_listener/_index.md @@ -10,7 +10,7 @@ introduced: "v1.17.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/riemann_listener/README.md, Riemann Listener Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/riemann_listener/README.md, Riemann Listener Plugin Source --- # Riemann Listener Input Plugin diff --git a/content/telegraf/v1/input-plugins/s7comm/_index.md b/content/telegraf/v1/input-plugins/s7comm/_index.md index 11776766a..3101f250a 100644 --- a/content/telegraf/v1/input-plugins/s7comm/_index.md +++ b/content/telegraf/v1/input-plugins/s7comm/_index.md @@ -10,7 +10,7 @@ introduced: "v1.28.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/s7comm/README.md, Siemens S7 Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/s7comm/README.md, Siemens S7 Plugin Source --- # Siemens S7 Input Plugin diff --git a/content/telegraf/v1/input-plugins/salesforce/_index.md b/content/telegraf/v1/input-plugins/salesforce/_index.md index 990a58193..063d8028c 100644 --- a/content/telegraf/v1/input-plugins/salesforce/_index.md +++ b/content/telegraf/v1/input-plugins/salesforce/_index.md @@ -10,7 +10,7 @@ introduced: "v1.4.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/salesforce/README.md, Salesforce Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/salesforce/README.md, Salesforce Plugin Source --- # Salesforce Input Plugin diff --git a/content/telegraf/v1/input-plugins/sensors/_index.md b/content/telegraf/v1/input-plugins/sensors/_index.md index f2da8bc24..70c5b053e 100644 --- a/content/telegraf/v1/input-plugins/sensors/_index.md +++ b/content/telegraf/v1/input-plugins/sensors/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.1" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/sensors/README.md, LM Sensors Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/sensors/README.md, LM Sensors Plugin Source --- # LM Sensors Input Plugin diff --git a/content/telegraf/v1/input-plugins/sflow/_index.md b/content/telegraf/v1/input-plugins/sflow/_index.md index 36de6d5de..0a654c55e 100644 --- a/content/telegraf/v1/input-plugins/sflow/_index.md +++ b/content/telegraf/v1/input-plugins/sflow/_index.md @@ -10,7 +10,7 @@ introduced: "v1.14.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/sflow/README.md, SFlow Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/sflow/README.md, SFlow Plugin Source --- # SFlow Input Plugin diff --git a/content/telegraf/v1/input-plugins/sip/_index.md b/content/telegraf/v1/input-plugins/sip/_index.md index 9cabab6c7..1c9e40d5d 100644 --- a/content/telegraf/v1/input-plugins/sip/_index.md +++ b/content/telegraf/v1/input-plugins/sip/_index.md @@ -10,7 +10,7 @@ introduced: "v1.38.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/sip/README.md, SIP Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/sip/README.md, SIP Plugin Source --- # SIP Input Plugin diff --git a/content/telegraf/v1/input-plugins/slab/_index.md b/content/telegraf/v1/input-plugins/slab/_index.md index 8e699cb75..ec054573c 100644 --- a/content/telegraf/v1/input-plugins/slab/_index.md +++ b/content/telegraf/v1/input-plugins/slab/_index.md @@ -10,7 +10,7 @@ introduced: "v1.23.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/slab/README.md, Slab Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/slab/README.md, Slab Plugin Source --- # Slab Input Plugin diff --git a/content/telegraf/v1/input-plugins/slurm/_index.md b/content/telegraf/v1/input-plugins/slurm/_index.md index 7b3d6a352..d602f23bc 100644 --- a/content/telegraf/v1/input-plugins/slurm/_index.md +++ b/content/telegraf/v1/input-plugins/slurm/_index.md @@ -10,7 +10,7 @@ introduced: "v1.32.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/slurm/README.md, SLURM Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/slurm/README.md, SLURM Plugin Source --- # SLURM Input Plugin diff --git a/content/telegraf/v1/input-plugins/smart/_index.md b/content/telegraf/v1/input-plugins/smart/_index.md index 2eff62373..4dffb14d2 100644 --- a/content/telegraf/v1/input-plugins/smart/_index.md +++ b/content/telegraf/v1/input-plugins/smart/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/smart/README.md, S.M.A.R.T. Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/smart/README.md, S.M.A.R.T. Plugin Source --- # S.M.A.R.T. Input Plugin diff --git a/content/telegraf/v1/input-plugins/smartctl/_index.md b/content/telegraf/v1/input-plugins/smartctl/_index.md index 36c1a65b5..de929a475 100644 --- a/content/telegraf/v1/input-plugins/smartctl/_index.md +++ b/content/telegraf/v1/input-plugins/smartctl/_index.md @@ -10,7 +10,7 @@ introduced: "v1.31.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/smartctl/README.md, smartctl JSON Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/smartctl/README.md, smartctl JSON Plugin Source --- # smartctl JSON Input Plugin diff --git a/content/telegraf/v1/input-plugins/snmp/_index.md b/content/telegraf/v1/input-plugins/snmp/_index.md index 5e7f7433a..01f7b0b4c 100644 --- a/content/telegraf/v1/input-plugins/snmp/_index.md +++ b/content/telegraf/v1/input-plugins/snmp/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/snmp/README.md, SNMP Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/snmp/README.md, SNMP Plugin Source --- # SNMP Input Plugin diff --git a/content/telegraf/v1/input-plugins/snmp_trap/_index.md b/content/telegraf/v1/input-plugins/snmp_trap/_index.md index 0c785bae6..32ff7c170 100644 --- a/content/telegraf/v1/input-plugins/snmp_trap/_index.md +++ b/content/telegraf/v1/input-plugins/snmp_trap/_index.md @@ -10,7 +10,7 @@ introduced: "v1.13.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/snmp_trap/README.md, SNMP Trap Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/snmp_trap/README.md, SNMP Trap Plugin Source --- # SNMP Trap Input Plugin diff --git a/content/telegraf/v1/input-plugins/socket_listener/_index.md b/content/telegraf/v1/input-plugins/socket_listener/_index.md index 18c9a3bcc..d97d001a3 100644 --- a/content/telegraf/v1/input-plugins/socket_listener/_index.md +++ b/content/telegraf/v1/input-plugins/socket_listener/_index.md @@ -10,7 +10,7 @@ introduced: "v1.3.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/socket_listener/README.md, Socket Listener Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/socket_listener/README.md, Socket Listener Plugin Source --- # Socket Listener Input Plugin diff --git a/content/telegraf/v1/input-plugins/socketstat/_index.md b/content/telegraf/v1/input-plugins/socketstat/_index.md index eb978f037..a25a94df0 100644 --- a/content/telegraf/v1/input-plugins/socketstat/_index.md +++ b/content/telegraf/v1/input-plugins/socketstat/_index.md @@ -10,7 +10,7 @@ introduced: "v1.22.0" os_support: "freebsd, linux, macos" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/socketstat/README.md, Socket Statistics Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/socketstat/README.md, Socket Statistics Plugin Source --- # Socket Statistics Input Plugin diff --git a/content/telegraf/v1/input-plugins/solr/_index.md b/content/telegraf/v1/input-plugins/solr/_index.md index 7bba310ee..0fb08aa20 100644 --- a/content/telegraf/v1/input-plugins/solr/_index.md +++ b/content/telegraf/v1/input-plugins/solr/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/solr/README.md, Apache Solr Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/solr/README.md, Apache Solr Plugin Source --- # Apache Solr Input Plugin diff --git a/content/telegraf/v1/input-plugins/sql/_index.md b/content/telegraf/v1/input-plugins/sql/_index.md index 0d4919ebd..a405060c1 100644 --- a/content/telegraf/v1/input-plugins/sql/_index.md +++ b/content/telegraf/v1/input-plugins/sql/_index.md @@ -10,7 +10,7 @@ introduced: "v1.19.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/sql/README.md, SQL Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/sql/README.md, SQL Plugin Source --- # SQL Input Plugin diff --git a/content/telegraf/v1/input-plugins/sqlserver/_index.md b/content/telegraf/v1/input-plugins/sqlserver/_index.md index 848d689e0..21f141ed7 100644 --- a/content/telegraf/v1/input-plugins/sqlserver/_index.md +++ b/content/telegraf/v1/input-plugins/sqlserver/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/sqlserver/README.md, Microsoft SQL Server Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/sqlserver/README.md, Microsoft SQL Server Plugin Source --- # Microsoft SQL Server Input Plugin diff --git a/content/telegraf/v1/input-plugins/stackdriver/_index.md b/content/telegraf/v1/input-plugins/stackdriver/_index.md index e4dd9dfa1..823b11c6a 100644 --- a/content/telegraf/v1/input-plugins/stackdriver/_index.md +++ b/content/telegraf/v1/input-plugins/stackdriver/_index.md @@ -10,7 +10,7 @@ introduced: "v1.10.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/stackdriver/README.md, Stackdriver Google Cloud Monitoring Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/stackdriver/README.md, Stackdriver Google Cloud Monitoring Plugin Source --- # Stackdriver Google Cloud Monitoring Input Plugin diff --git a/content/telegraf/v1/input-plugins/statsd/_index.md b/content/telegraf/v1/input-plugins/statsd/_index.md index 7bb86749a..cc42065f3 100644 --- a/content/telegraf/v1/input-plugins/statsd/_index.md +++ b/content/telegraf/v1/input-plugins/statsd/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/statsd/README.md, StatsD Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/statsd/README.md, StatsD Plugin Source --- # StatsD Input Plugin diff --git a/content/telegraf/v1/input-plugins/supervisor/_index.md b/content/telegraf/v1/input-plugins/supervisor/_index.md index 0308383d9..eface786b 100644 --- a/content/telegraf/v1/input-plugins/supervisor/_index.md +++ b/content/telegraf/v1/input-plugins/supervisor/_index.md @@ -10,7 +10,7 @@ introduced: "v1.24.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/supervisor/README.md, Supervisor Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/supervisor/README.md, Supervisor Plugin Source --- # Supervisor Input Plugin diff --git a/content/telegraf/v1/input-plugins/suricata/_index.md b/content/telegraf/v1/input-plugins/suricata/_index.md index 00db0d451..fd1eaabf3 100644 --- a/content/telegraf/v1/input-plugins/suricata/_index.md +++ b/content/telegraf/v1/input-plugins/suricata/_index.md @@ -10,7 +10,7 @@ introduced: "v1.13.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/suricata/README.md, Suricata Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/suricata/README.md, Suricata Plugin Source --- # Suricata Input Plugin diff --git a/content/telegraf/v1/input-plugins/swap/_index.md b/content/telegraf/v1/input-plugins/swap/_index.md index 6316dac31..0cf7576b7 100644 --- a/content/telegraf/v1/input-plugins/swap/_index.md +++ b/content/telegraf/v1/input-plugins/swap/_index.md @@ -10,7 +10,7 @@ introduced: "v1.7.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/swap/README.md, Swap Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/swap/README.md, Swap Plugin Source --- # Swap Input Plugin diff --git a/content/telegraf/v1/input-plugins/synproxy/_index.md b/content/telegraf/v1/input-plugins/synproxy/_index.md index b958653fa..9b5aeddf9 100644 --- a/content/telegraf/v1/input-plugins/synproxy/_index.md +++ b/content/telegraf/v1/input-plugins/synproxy/_index.md @@ -10,7 +10,7 @@ introduced: "v1.13.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/synproxy/README.md, Synproxy Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/synproxy/README.md, Synproxy Plugin Source --- # Synproxy Input Plugin diff --git a/content/telegraf/v1/input-plugins/syslog/_index.md b/content/telegraf/v1/input-plugins/syslog/_index.md index fa16c2085..b80f3217c 100644 --- a/content/telegraf/v1/input-plugins/syslog/_index.md +++ b/content/telegraf/v1/input-plugins/syslog/_index.md @@ -10,7 +10,7 @@ introduced: "v1.7.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/syslog/README.md, Syslog Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/syslog/README.md, Syslog Plugin Source --- # Syslog Input Plugin diff --git a/content/telegraf/v1/input-plugins/sysstat/_index.md b/content/telegraf/v1/input-plugins/sysstat/_index.md index 5dc88528f..64e3fcc40 100644 --- a/content/telegraf/v1/input-plugins/sysstat/_index.md +++ b/content/telegraf/v1/input-plugins/sysstat/_index.md @@ -10,7 +10,7 @@ introduced: "v0.12.1" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/sysstat/README.md, System Performance Statistics Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/sysstat/README.md, System Performance Statistics Plugin Source --- # System Performance Statistics Input Plugin diff --git a/content/telegraf/v1/input-plugins/system/_index.md b/content/telegraf/v1/input-plugins/system/_index.md index e8f6ddac2..00d1f5479 100644 --- a/content/telegraf/v1/input-plugins/system/_index.md +++ b/content/telegraf/v1/input-plugins/system/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.6" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/system/README.md, System Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/system/README.md, System Plugin Source --- # System Input Plugin diff --git a/content/telegraf/v1/input-plugins/systemd_units/_index.md b/content/telegraf/v1/input-plugins/systemd_units/_index.md index d68b0d64c..2c85a049a 100644 --- a/content/telegraf/v1/input-plugins/systemd_units/_index.md +++ b/content/telegraf/v1/input-plugins/systemd_units/_index.md @@ -10,7 +10,7 @@ introduced: "v1.13.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/systemd_units/README.md, Systemd-Units Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/systemd_units/README.md, Systemd-Units Plugin Source --- # Systemd-Units Input Plugin diff --git a/content/telegraf/v1/input-plugins/tacacs/_index.md b/content/telegraf/v1/input-plugins/tacacs/_index.md index 085b3de27..acda19227 100644 --- a/content/telegraf/v1/input-plugins/tacacs/_index.md +++ b/content/telegraf/v1/input-plugins/tacacs/_index.md @@ -10,7 +10,7 @@ introduced: "v1.28.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/tacacs/README.md, Tacacs Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/tacacs/README.md, Tacacs Plugin Source --- # Tacacs Input Plugin diff --git a/content/telegraf/v1/input-plugins/tail/_index.md b/content/telegraf/v1/input-plugins/tail/_index.md index 1c358c692..1c60bba22 100644 --- a/content/telegraf/v1/input-plugins/tail/_index.md +++ b/content/telegraf/v1/input-plugins/tail/_index.md @@ -10,7 +10,7 @@ introduced: "v1.1.2" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/tail/README.md, Tail Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/tail/README.md, Tail Plugin Source --- # Tail Input Plugin diff --git a/content/telegraf/v1/input-plugins/teamspeak/_index.md b/content/telegraf/v1/input-plugins/teamspeak/_index.md index 3834d03e1..6085cc667 100644 --- a/content/telegraf/v1/input-plugins/teamspeak/_index.md +++ b/content/telegraf/v1/input-plugins/teamspeak/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/teamspeak/README.md, Teamspeak Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/teamspeak/README.md, Teamspeak Plugin Source --- # Teamspeak Input Plugin diff --git a/content/telegraf/v1/input-plugins/temp/_index.md b/content/telegraf/v1/input-plugins/temp/_index.md index e0708cdff..c27800fbe 100644 --- a/content/telegraf/v1/input-plugins/temp/_index.md +++ b/content/telegraf/v1/input-plugins/temp/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "linux, macos, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/temp/README.md, Temperature Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/temp/README.md, Temperature Plugin Source --- # Temperature Input Plugin diff --git a/content/telegraf/v1/input-plugins/tengine/_index.md b/content/telegraf/v1/input-plugins/tengine/_index.md index 773aa9b61..ae51e53dd 100644 --- a/content/telegraf/v1/input-plugins/tengine/_index.md +++ b/content/telegraf/v1/input-plugins/tengine/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/tengine/README.md, Tengine Web Server Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/tengine/README.md, Tengine Web Server Plugin Source --- # Tengine Web Server Input Plugin diff --git a/content/telegraf/v1/input-plugins/timex/_index.md b/content/telegraf/v1/input-plugins/timex/_index.md index 2e8c68d74..ec0dbb1a3 100644 --- a/content/telegraf/v1/input-plugins/timex/_index.md +++ b/content/telegraf/v1/input-plugins/timex/_index.md @@ -10,7 +10,7 @@ introduced: "v1.37.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/timex/README.md, Timex Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/timex/README.md, Timex Plugin Source --- # Timex Input Plugin diff --git a/content/telegraf/v1/input-plugins/tomcat/_index.md b/content/telegraf/v1/input-plugins/tomcat/_index.md index fd55d5ca4..909f9582f 100644 --- a/content/telegraf/v1/input-plugins/tomcat/_index.md +++ b/content/telegraf/v1/input-plugins/tomcat/_index.md @@ -10,7 +10,7 @@ introduced: "v1.4.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/tomcat/README.md, Apache Tomcat Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/tomcat/README.md, Apache Tomcat Plugin Source --- # Apache Tomcat Input Plugin diff --git a/content/telegraf/v1/input-plugins/trig/_index.md b/content/telegraf/v1/input-plugins/trig/_index.md index aaadc3279..7d41a6037 100644 --- a/content/telegraf/v1/input-plugins/trig/_index.md +++ b/content/telegraf/v1/input-plugins/trig/_index.md @@ -10,7 +10,7 @@ introduced: "v0.3.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/trig/README.md, Trig Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/trig/README.md, Trig Plugin Source --- # Trig Input Plugin diff --git a/content/telegraf/v1/input-plugins/turbostat/_index.md b/content/telegraf/v1/input-plugins/turbostat/_index.md index b3d9a9e50..05f3cb55d 100644 --- a/content/telegraf/v1/input-plugins/turbostat/_index.md +++ b/content/telegraf/v1/input-plugins/turbostat/_index.md @@ -10,7 +10,7 @@ introduced: "v1.36.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/turbostat/README.md, Turbostat Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/turbostat/README.md, Turbostat Plugin Source --- # Turbostat Input Plugin diff --git a/content/telegraf/v1/input-plugins/twemproxy/_index.md b/content/telegraf/v1/input-plugins/twemproxy/_index.md index d1d1d4710..35a358ebd 100644 --- a/content/telegraf/v1/input-plugins/twemproxy/_index.md +++ b/content/telegraf/v1/input-plugins/twemproxy/_index.md @@ -10,7 +10,7 @@ introduced: "v0.3.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/twemproxy/README.md, Twemproxy Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/twemproxy/README.md, Twemproxy Plugin Source --- # Twemproxy Input Plugin diff --git a/content/telegraf/v1/input-plugins/unbound/_index.md b/content/telegraf/v1/input-plugins/unbound/_index.md index cbcc346bd..b0fd7077a 100644 --- a/content/telegraf/v1/input-plugins/unbound/_index.md +++ b/content/telegraf/v1/input-plugins/unbound/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/unbound/README.md, Unbound Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/unbound/README.md, Unbound Plugin Source --- # Unbound Input Plugin diff --git a/content/telegraf/v1/input-plugins/upsd/_index.md b/content/telegraf/v1/input-plugins/upsd/_index.md index 0de57dba9..1bbafc808 100644 --- a/content/telegraf/v1/input-plugins/upsd/_index.md +++ b/content/telegraf/v1/input-plugins/upsd/_index.md @@ -10,7 +10,7 @@ introduced: "v1.24.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/upsd/README.md, UPSD Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/upsd/README.md, UPSD Plugin Source --- # UPSD Input Plugin diff --git a/content/telegraf/v1/input-plugins/uwsgi/_index.md b/content/telegraf/v1/input-plugins/uwsgi/_index.md index 0aac387b4..493169762 100644 --- a/content/telegraf/v1/input-plugins/uwsgi/_index.md +++ b/content/telegraf/v1/input-plugins/uwsgi/_index.md @@ -10,7 +10,7 @@ introduced: "v1.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/uwsgi/README.md, uWSGI Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/uwsgi/README.md, uWSGI Plugin Source --- # uWSGI Input Plugin diff --git a/content/telegraf/v1/input-plugins/varnish/_index.md b/content/telegraf/v1/input-plugins/varnish/_index.md index 0eeeed248..514a526a2 100644 --- a/content/telegraf/v1/input-plugins/varnish/_index.md +++ b/content/telegraf/v1/input-plugins/varnish/_index.md @@ -10,7 +10,7 @@ introduced: "v0.13.1" os_support: "freebsd, linux, macos" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/varnish/README.md, Varnish Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/varnish/README.md, Varnish Plugin Source --- # Varnish Input Plugin diff --git a/content/telegraf/v1/input-plugins/vault/_index.md b/content/telegraf/v1/input-plugins/vault/_index.md index 7ba6462ec..a3fd25fa7 100644 --- a/content/telegraf/v1/input-plugins/vault/_index.md +++ b/content/telegraf/v1/input-plugins/vault/_index.md @@ -10,7 +10,7 @@ introduced: "v1.22.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/vault/README.md, Hashicorp Vault Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/vault/README.md, Hashicorp Vault Plugin Source --- # Hashicorp Vault Input Plugin diff --git a/content/telegraf/v1/input-plugins/vsphere/_index.md b/content/telegraf/v1/input-plugins/vsphere/_index.md index 9913b6f84..0760e69ae 100644 --- a/content/telegraf/v1/input-plugins/vsphere/_index.md +++ b/content/telegraf/v1/input-plugins/vsphere/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/vsphere/README.md, VMware vSphere Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/vsphere/README.md, VMware vSphere Plugin Source --- # VMware vSphere Input Plugin diff --git a/content/telegraf/v1/input-plugins/webhooks/_index.md b/content/telegraf/v1/input-plugins/webhooks/_index.md index e653be2f0..76e2f2e1b 100644 --- a/content/telegraf/v1/input-plugins/webhooks/_index.md +++ b/content/telegraf/v1/input-plugins/webhooks/_index.md @@ -10,7 +10,7 @@ introduced: "v1.0.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/webhooks/README.md, Webhooks Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/webhooks/README.md, Webhooks Plugin Source --- # Webhooks Input Plugin diff --git a/content/telegraf/v1/input-plugins/whois/_index.md b/content/telegraf/v1/input-plugins/whois/_index.md index cdaea29eb..d4f6d72f3 100644 --- a/content/telegraf/v1/input-plugins/whois/_index.md +++ b/content/telegraf/v1/input-plugins/whois/_index.md @@ -10,7 +10,7 @@ introduced: "v1.35.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/whois/README.md, WHOIS Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/whois/README.md, WHOIS Plugin Source --- # WHOIS Input Plugin diff --git a/content/telegraf/v1/input-plugins/win_eventlog/_index.md b/content/telegraf/v1/input-plugins/win_eventlog/_index.md index 7c7cfb820..903597fe6 100644 --- a/content/telegraf/v1/input-plugins/win_eventlog/_index.md +++ b/content/telegraf/v1/input-plugins/win_eventlog/_index.md @@ -10,7 +10,7 @@ introduced: "v1.16.0" os_support: "windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/win_eventlog/README.md, Windows Eventlog Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/win_eventlog/README.md, Windows Eventlog Plugin Source --- # Windows Eventlog Input Plugin diff --git a/content/telegraf/v1/input-plugins/win_perf_counters/_index.md b/content/telegraf/v1/input-plugins/win_perf_counters/_index.md index 425519318..8397124cb 100644 --- a/content/telegraf/v1/input-plugins/win_perf_counters/_index.md +++ b/content/telegraf/v1/input-plugins/win_perf_counters/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.2" os_support: "windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/win_perf_counters/README.md, Windows Performance Counters Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/win_perf_counters/README.md, Windows Performance Counters Plugin Source --- # Windows Performance Counters Input Plugin diff --git a/content/telegraf/v1/input-plugins/win_services/_index.md b/content/telegraf/v1/input-plugins/win_services/_index.md index 1360ba626..492eb3d3a 100644 --- a/content/telegraf/v1/input-plugins/win_services/_index.md +++ b/content/telegraf/v1/input-plugins/win_services/_index.md @@ -10,7 +10,7 @@ introduced: "v1.4.0" os_support: "windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/win_services/README.md, Windows Services Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/win_services/README.md, Windows Services Plugin Source --- # Windows Services Input Plugin diff --git a/content/telegraf/v1/input-plugins/win_wmi/_index.md b/content/telegraf/v1/input-plugins/win_wmi/_index.md index 509fcdb91..e62a3e5b3 100644 --- a/content/telegraf/v1/input-plugins/win_wmi/_index.md +++ b/content/telegraf/v1/input-plugins/win_wmi/_index.md @@ -10,7 +10,7 @@ introduced: "v1.26.0" os_support: "windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/win_wmi/README.md, Windows Management Instrumentation Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/win_wmi/README.md, Windows Management Instrumentation Plugin Source --- # Windows Management Instrumentation Input Plugin diff --git a/content/telegraf/v1/input-plugins/wireguard/_index.md b/content/telegraf/v1/input-plugins/wireguard/_index.md index 2b4cf5b31..5c9832bea 100644 --- a/content/telegraf/v1/input-plugins/wireguard/_index.md +++ b/content/telegraf/v1/input-plugins/wireguard/_index.md @@ -10,7 +10,7 @@ introduced: "v1.14.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/wireguard/README.md, Wireguard Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/wireguard/README.md, Wireguard Plugin Source --- # Wireguard Input Plugin diff --git a/content/telegraf/v1/input-plugins/wireless/_index.md b/content/telegraf/v1/input-plugins/wireless/_index.md index 5d4035ea8..3e4fb0b88 100644 --- a/content/telegraf/v1/input-plugins/wireless/_index.md +++ b/content/telegraf/v1/input-plugins/wireless/_index.md @@ -10,7 +10,7 @@ introduced: "v1.9.0" os_support: "linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/wireless/README.md, Wireless Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/wireless/README.md, Wireless Plugin Source --- # Wireless Input Plugin diff --git a/content/telegraf/v1/input-plugins/x509_cert/_index.md b/content/telegraf/v1/input-plugins/x509_cert/_index.md index 71476f6c9..de9f953c1 100644 --- a/content/telegraf/v1/input-plugins/x509_cert/_index.md +++ b/content/telegraf/v1/input-plugins/x509_cert/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/x509_cert/README.md, x509 Certificate Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/x509_cert/README.md, x509 Certificate Plugin Source --- # x509 Certificate Input Plugin diff --git a/content/telegraf/v1/input-plugins/xtremio/_index.md b/content/telegraf/v1/input-plugins/xtremio/_index.md index 9a7ce75f9..cdd334dbb 100644 --- a/content/telegraf/v1/input-plugins/xtremio/_index.md +++ b/content/telegraf/v1/input-plugins/xtremio/_index.md @@ -10,7 +10,7 @@ introduced: "v1.22.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/xtremio/README.md, Dell EMC XtremIO Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/xtremio/README.md, Dell EMC XtremIO Plugin Source --- # Dell EMC XtremIO Input Plugin diff --git a/content/telegraf/v1/input-plugins/zfs/_index.md b/content/telegraf/v1/input-plugins/zfs/_index.md index d054658c8..bec55fc60 100644 --- a/content/telegraf/v1/input-plugins/zfs/_index.md +++ b/content/telegraf/v1/input-plugins/zfs/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.1" os_support: "freebsd, linux" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/zfs/README.md, ZFS Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/zfs/README.md, ZFS Plugin Source --- # ZFS Input Plugin diff --git a/content/telegraf/v1/input-plugins/zipkin/_index.md b/content/telegraf/v1/input-plugins/zipkin/_index.md index 43c8473f9..3289d0f19 100644 --- a/content/telegraf/v1/input-plugins/zipkin/_index.md +++ b/content/telegraf/v1/input-plugins/zipkin/_index.md @@ -10,7 +10,7 @@ introduced: "v1.4.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/zipkin/README.md, Zipkin Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/zipkin/README.md, Zipkin Plugin Source --- # Zipkin Input Plugin diff --git a/content/telegraf/v1/input-plugins/zookeeper/_index.md b/content/telegraf/v1/input-plugins/zookeeper/_index.md index 847a88b3e..26d5bcd5b 100644 --- a/content/telegraf/v1/input-plugins/zookeeper/_index.md +++ b/content/telegraf/v1/input-plugins/zookeeper/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/inputs/zookeeper/README.md, Apache Zookeeper Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/inputs/zookeeper/README.md, Apache Zookeeper Plugin Source --- # Apache Zookeeper Input Plugin diff --git a/content/telegraf/v1/output-plugins/amon/_index.md b/content/telegraf/v1/output-plugins/amon/_index.md index 30fb0b5e4..9b7742c22 100644 --- a/content/telegraf/v1/output-plugins/amon/_index.md +++ b/content/telegraf/v1/output-plugins/amon/_index.md @@ -12,7 +12,7 @@ removal: v1.40.0 os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/amon/README.md, Amon Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/amon/README.md, Amon Plugin Source --- # Amon Output Plugin diff --git a/content/telegraf/v1/output-plugins/amqp/_index.md b/content/telegraf/v1/output-plugins/amqp/_index.md index 007cff3f8..9b89233f1 100644 --- a/content/telegraf/v1/output-plugins/amqp/_index.md +++ b/content/telegraf/v1/output-plugins/amqp/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.9" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/amqp/README.md, AMQP Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/amqp/README.md, AMQP Plugin Source --- # AMQP Output Plugin diff --git a/content/telegraf/v1/output-plugins/application_insights/_index.md b/content/telegraf/v1/output-plugins/application_insights/_index.md index b00a7af99..d00ab68e1 100644 --- a/content/telegraf/v1/output-plugins/application_insights/_index.md +++ b/content/telegraf/v1/output-plugins/application_insights/_index.md @@ -10,7 +10,7 @@ introduced: "v1.7.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/application_insights/README.md, Azure Application Insights Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/application_insights/README.md, Azure Application Insights Plugin Source --- # Azure Application Insights Output Plugin diff --git a/content/telegraf/v1/output-plugins/arc/_index.md b/content/telegraf/v1/output-plugins/arc/_index.md index 0d3ef9d2b..1dab35186 100644 --- a/content/telegraf/v1/output-plugins/arc/_index.md +++ b/content/telegraf/v1/output-plugins/arc/_index.md @@ -10,7 +10,7 @@ introduced: "v1.37.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/arc/README.md, Arc Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/arc/README.md, Arc Plugin Source --- # Arc Output Plugin diff --git a/content/telegraf/v1/output-plugins/azure_data_explorer/_index.md b/content/telegraf/v1/output-plugins/azure_data_explorer/_index.md index 04647c41e..cc34762fd 100644 --- a/content/telegraf/v1/output-plugins/azure_data_explorer/_index.md +++ b/content/telegraf/v1/output-plugins/azure_data_explorer/_index.md @@ -10,7 +10,7 @@ introduced: "v1.20.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/azure_data_explorer/README.md, Azure Data Explorer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/azure_data_explorer/README.md, Azure Data Explorer Plugin Source --- # Azure Data Explorer Output Plugin diff --git a/content/telegraf/v1/output-plugins/azure_monitor/_index.md b/content/telegraf/v1/output-plugins/azure_monitor/_index.md index 6c2c587bf..754a98dfc 100644 --- a/content/telegraf/v1/output-plugins/azure_monitor/_index.md +++ b/content/telegraf/v1/output-plugins/azure_monitor/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/azure_monitor/README.md, Azure Monitor Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/azure_monitor/README.md, Azure Monitor Plugin Source --- # Azure Monitor Output Plugin diff --git a/content/telegraf/v1/output-plugins/bigquery/_index.md b/content/telegraf/v1/output-plugins/bigquery/_index.md index 81e032ce8..543c168a1 100644 --- a/content/telegraf/v1/output-plugins/bigquery/_index.md +++ b/content/telegraf/v1/output-plugins/bigquery/_index.md @@ -10,7 +10,7 @@ introduced: "v1.18.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/bigquery/README.md, Google BigQuery Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/bigquery/README.md, Google BigQuery Plugin Source --- # Google BigQuery Output Plugin diff --git a/content/telegraf/v1/output-plugins/clarify/_index.md b/content/telegraf/v1/output-plugins/clarify/_index.md index 03a277e44..20e369cdc 100644 --- a/content/telegraf/v1/output-plugins/clarify/_index.md +++ b/content/telegraf/v1/output-plugins/clarify/_index.md @@ -10,7 +10,7 @@ introduced: "v1.27.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/clarify/README.md, Clarify Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/clarify/README.md, Clarify Plugin Source --- # Clarify Output Plugin diff --git a/content/telegraf/v1/output-plugins/cloud_pubsub/_index.md b/content/telegraf/v1/output-plugins/cloud_pubsub/_index.md index 1bfe0bccc..aff97ed08 100644 --- a/content/telegraf/v1/output-plugins/cloud_pubsub/_index.md +++ b/content/telegraf/v1/output-plugins/cloud_pubsub/_index.md @@ -10,7 +10,7 @@ introduced: "v1.10.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/cloud_pubsub/README.md, Google Cloud PubSub Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/cloud_pubsub/README.md, Google Cloud PubSub Plugin Source --- # Google Cloud PubSub Output Plugin diff --git a/content/telegraf/v1/output-plugins/cloudwatch/_index.md b/content/telegraf/v1/output-plugins/cloudwatch/_index.md index 0b956edea..1e4b2ae29 100644 --- a/content/telegraf/v1/output-plugins/cloudwatch/_index.md +++ b/content/telegraf/v1/output-plugins/cloudwatch/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/cloudwatch/README.md, Amazon CloudWatch Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/cloudwatch/README.md, Amazon CloudWatch Plugin Source --- # Amazon CloudWatch Output Plugin diff --git a/content/telegraf/v1/output-plugins/cloudwatch_logs/_index.md b/content/telegraf/v1/output-plugins/cloudwatch_logs/_index.md index 007c3cd87..bfebc31d7 100644 --- a/content/telegraf/v1/output-plugins/cloudwatch_logs/_index.md +++ b/content/telegraf/v1/output-plugins/cloudwatch_logs/_index.md @@ -10,7 +10,7 @@ introduced: "v1.19.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/cloudwatch_logs/README.md, Amazon CloudWatch Logs Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/cloudwatch_logs/README.md, Amazon CloudWatch Logs Plugin Source --- # Amazon CloudWatch Logs Output Plugin diff --git a/content/telegraf/v1/output-plugins/cratedb/_index.md b/content/telegraf/v1/output-plugins/cratedb/_index.md index 145464efd..71f76b1ee 100644 --- a/content/telegraf/v1/output-plugins/cratedb/_index.md +++ b/content/telegraf/v1/output-plugins/cratedb/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/cratedb/README.md, CrateDB Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/cratedb/README.md, CrateDB Plugin Source --- # CrateDB Output Plugin diff --git a/content/telegraf/v1/output-plugins/datadog/_index.md b/content/telegraf/v1/output-plugins/datadog/_index.md index 2574e9340..fb9a30a53 100644 --- a/content/telegraf/v1/output-plugins/datadog/_index.md +++ b/content/telegraf/v1/output-plugins/datadog/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.6" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/datadog/README.md, Datadog Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/datadog/README.md, Datadog Plugin Source --- # Datadog Output Plugin diff --git a/content/telegraf/v1/output-plugins/discard/_index.md b/content/telegraf/v1/output-plugins/discard/_index.md index b587e37d9..07ba5fe59 100644 --- a/content/telegraf/v1/output-plugins/discard/_index.md +++ b/content/telegraf/v1/output-plugins/discard/_index.md @@ -10,7 +10,7 @@ introduced: "v1.2.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/discard/README.md, Discard Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/discard/README.md, Discard Plugin Source --- # Discard Output Plugin diff --git a/content/telegraf/v1/output-plugins/dynatrace/_index.md b/content/telegraf/v1/output-plugins/dynatrace/_index.md index 17dd1fa96..f542584c4 100644 --- a/content/telegraf/v1/output-plugins/dynatrace/_index.md +++ b/content/telegraf/v1/output-plugins/dynatrace/_index.md @@ -10,7 +10,7 @@ introduced: "v1.16.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/dynatrace/README.md, Dynatrace Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/dynatrace/README.md, Dynatrace Plugin Source --- # Dynatrace Output Plugin diff --git a/content/telegraf/v1/output-plugins/elasticsearch/_index.md b/content/telegraf/v1/output-plugins/elasticsearch/_index.md index c8f39f92d..8171a63b9 100644 --- a/content/telegraf/v1/output-plugins/elasticsearch/_index.md +++ b/content/telegraf/v1/output-plugins/elasticsearch/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.5" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/elasticsearch/README.md, Elasticsearch Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/elasticsearch/README.md, Elasticsearch Plugin Source --- # Elasticsearch Output Plugin diff --git a/content/telegraf/v1/output-plugins/event_hubs/_index.md b/content/telegraf/v1/output-plugins/event_hubs/_index.md index d8cfa9cb8..b31e939e7 100644 --- a/content/telegraf/v1/output-plugins/event_hubs/_index.md +++ b/content/telegraf/v1/output-plugins/event_hubs/_index.md @@ -10,7 +10,7 @@ introduced: "v1.21.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/event_hubs/README.md, Azure Event Hubs Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/event_hubs/README.md, Azure Event Hubs Plugin Source --- # Azure Event Hubs Output Plugin diff --git a/content/telegraf/v1/output-plugins/exec/_index.md b/content/telegraf/v1/output-plugins/exec/_index.md index 6b9fc2a95..40abd5975 100644 --- a/content/telegraf/v1/output-plugins/exec/_index.md +++ b/content/telegraf/v1/output-plugins/exec/_index.md @@ -10,7 +10,7 @@ introduced: "v1.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/exec/README.md, Executable Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/exec/README.md, Executable Plugin Source --- # Executable Output Plugin diff --git a/content/telegraf/v1/output-plugins/execd/_index.md b/content/telegraf/v1/output-plugins/execd/_index.md index 0958fd4b1..28dbddf97 100644 --- a/content/telegraf/v1/output-plugins/execd/_index.md +++ b/content/telegraf/v1/output-plugins/execd/_index.md @@ -10,7 +10,7 @@ introduced: "v1.15.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/execd/README.md, Executable Daemon Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/execd/README.md, Executable Daemon Plugin Source --- # Executable Daemon Output Plugin diff --git a/content/telegraf/v1/output-plugins/file/_index.md b/content/telegraf/v1/output-plugins/file/_index.md index 38ce613c9..526ff14c1 100644 --- a/content/telegraf/v1/output-plugins/file/_index.md +++ b/content/telegraf/v1/output-plugins/file/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.3" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/file/README.md, File Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/file/README.md, File Plugin Source --- # File Output Plugin diff --git a/content/telegraf/v1/output-plugins/graphite/_index.md b/content/telegraf/v1/output-plugins/graphite/_index.md index ec2cb6558..372a857fa 100644 --- a/content/telegraf/v1/output-plugins/graphite/_index.md +++ b/content/telegraf/v1/output-plugins/graphite/_index.md @@ -10,7 +10,7 @@ introduced: "v0.10.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/graphite/README.md, Graphite Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/graphite/README.md, Graphite Plugin Source --- # Graphite Output Plugin diff --git a/content/telegraf/v1/output-plugins/graylog/_index.md b/content/telegraf/v1/output-plugins/graylog/_index.md index 98e2c1b3f..442cab400 100644 --- a/content/telegraf/v1/output-plugins/graylog/_index.md +++ b/content/telegraf/v1/output-plugins/graylog/_index.md @@ -10,7 +10,7 @@ introduced: "v1.0.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/graylog/README.md, Graylog Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/graylog/README.md, Graylog Plugin Source --- # Graylog Output Plugin diff --git a/content/telegraf/v1/output-plugins/groundwork/_index.md b/content/telegraf/v1/output-plugins/groundwork/_index.md index 1308320bb..82020b7a7 100644 --- a/content/telegraf/v1/output-plugins/groundwork/_index.md +++ b/content/telegraf/v1/output-plugins/groundwork/_index.md @@ -10,7 +10,7 @@ introduced: "v1.21.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/groundwork/README.md, GroundWork Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/groundwork/README.md, GroundWork Plugin Source --- # GroundWork Output Plugin diff --git a/content/telegraf/v1/output-plugins/health/_index.md b/content/telegraf/v1/output-plugins/health/_index.md index 66890f70d..ad35bd26a 100644 --- a/content/telegraf/v1/output-plugins/health/_index.md +++ b/content/telegraf/v1/output-plugins/health/_index.md @@ -10,7 +10,7 @@ introduced: "v1.11.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/health/README.md, Health Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/health/README.md, Health Plugin Source --- # Health Output Plugin diff --git a/content/telegraf/v1/output-plugins/heartbeat/_index.md b/content/telegraf/v1/output-plugins/heartbeat/_index.md index f507c8c17..9c52f9d86 100644 --- a/content/telegraf/v1/output-plugins/heartbeat/_index.md +++ b/content/telegraf/v1/output-plugins/heartbeat/_index.md @@ -10,7 +10,7 @@ introduced: "v1.37.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/heartbeat/README.md, Heartbeat Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/heartbeat/README.md, Heartbeat Plugin Source --- # Heartbeat Output Plugin diff --git a/content/telegraf/v1/output-plugins/http/_index.md b/content/telegraf/v1/output-plugins/http/_index.md index c39dd87b1..217355d4c 100644 --- a/content/telegraf/v1/output-plugins/http/_index.md +++ b/content/telegraf/v1/output-plugins/http/_index.md @@ -10,7 +10,7 @@ introduced: "v1.7.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/http/README.md, HTTP Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/http/README.md, HTTP Plugin Source --- # HTTP Output Plugin diff --git a/content/telegraf/v1/output-plugins/influxdb/_index.md b/content/telegraf/v1/output-plugins/influxdb/_index.md index b574679c6..40f8fdffc 100644 --- a/content/telegraf/v1/output-plugins/influxdb/_index.md +++ b/content/telegraf/v1/output-plugins/influxdb/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/influxdb/README.md, InfluxDB v1.x Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/influxdb/README.md, InfluxDB v1.x Plugin Source --- # InfluxDB v1.x Output Plugin diff --git a/content/telegraf/v1/output-plugins/influxdb_v2/_index.md b/content/telegraf/v1/output-plugins/influxdb_v2/_index.md index dfbec8759..e92c57e78 100644 --- a/content/telegraf/v1/output-plugins/influxdb_v2/_index.md +++ b/content/telegraf/v1/output-plugins/influxdb_v2/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/influxdb_v2/README.md, InfluxDB v2.x Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/influxdb_v2/README.md, InfluxDB v2.x Plugin Source --- # InfluxDB v2.x Output Plugin diff --git a/content/telegraf/v1/output-plugins/influxdb_v3/_index.md b/content/telegraf/v1/output-plugins/influxdb_v3/_index.md index 3ba99085d..dc3f277dd 100644 --- a/content/telegraf/v1/output-plugins/influxdb_v3/_index.md +++ b/content/telegraf/v1/output-plugins/influxdb_v3/_index.md @@ -10,7 +10,7 @@ introduced: "v1.38.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/influxdb_v3/README.md, InfluxDB v3.x Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/influxdb_v3/README.md, InfluxDB v3.x Plugin Source --- # InfluxDB v3.x Output Plugin diff --git a/content/telegraf/v1/output-plugins/inlong/_index.md b/content/telegraf/v1/output-plugins/inlong/_index.md index 1568c504b..e5c45c61e 100644 --- a/content/telegraf/v1/output-plugins/inlong/_index.md +++ b/content/telegraf/v1/output-plugins/inlong/_index.md @@ -10,7 +10,7 @@ introduced: "v1.35.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/inlong/README.md, Inlong Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/inlong/README.md, Inlong Plugin Source --- # Inlong Output Plugin diff --git a/content/telegraf/v1/output-plugins/instrumental/_index.md b/content/telegraf/v1/output-plugins/instrumental/_index.md index ebc6fdb2a..94d19ec2d 100644 --- a/content/telegraf/v1/output-plugins/instrumental/_index.md +++ b/content/telegraf/v1/output-plugins/instrumental/_index.md @@ -10,7 +10,7 @@ introduced: "v0.13.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/instrumental/README.md, Instrumental Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/instrumental/README.md, Instrumental Plugin Source --- # Instrumental Output Plugin diff --git a/content/telegraf/v1/output-plugins/iotdb/_index.md b/content/telegraf/v1/output-plugins/iotdb/_index.md index 45776967e..d315c4c1d 100644 --- a/content/telegraf/v1/output-plugins/iotdb/_index.md +++ b/content/telegraf/v1/output-plugins/iotdb/_index.md @@ -10,7 +10,7 @@ introduced: "v1.24.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/iotdb/README.md, Apache IoTDB Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/iotdb/README.md, Apache IoTDB Plugin Source --- # Apache IoTDB Output Plugin diff --git a/content/telegraf/v1/output-plugins/kafka/_index.md b/content/telegraf/v1/output-plugins/kafka/_index.md index d04a67847..2b25405d9 100644 --- a/content/telegraf/v1/output-plugins/kafka/_index.md +++ b/content/telegraf/v1/output-plugins/kafka/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.7" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/kafka/README.md, Kafka Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/kafka/README.md, Kafka Plugin Source --- # Kafka Output Plugin diff --git a/content/telegraf/v1/output-plugins/kinesis/_index.md b/content/telegraf/v1/output-plugins/kinesis/_index.md index 53526180e..997dcc793 100644 --- a/content/telegraf/v1/output-plugins/kinesis/_index.md +++ b/content/telegraf/v1/output-plugins/kinesis/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.5" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/kinesis/README.md, Amazon Kinesis Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/kinesis/README.md, Amazon Kinesis Plugin Source --- # Amazon Kinesis Output Plugin diff --git a/content/telegraf/v1/output-plugins/librato/_index.md b/content/telegraf/v1/output-plugins/librato/_index.md index a77ad163b..3949798d3 100644 --- a/content/telegraf/v1/output-plugins/librato/_index.md +++ b/content/telegraf/v1/output-plugins/librato/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/librato/README.md, Librato Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/librato/README.md, Librato Plugin Source --- # Librato Output Plugin diff --git a/content/telegraf/v1/output-plugins/logzio/_index.md b/content/telegraf/v1/output-plugins/logzio/_index.md index 9f7e4044c..8a0573a19 100644 --- a/content/telegraf/v1/output-plugins/logzio/_index.md +++ b/content/telegraf/v1/output-plugins/logzio/_index.md @@ -10,7 +10,7 @@ introduced: "v1.17.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/logzio/README.md, Logz.io Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/logzio/README.md, Logz.io Plugin Source --- # Logz.io Output Plugin diff --git a/content/telegraf/v1/output-plugins/loki/_index.md b/content/telegraf/v1/output-plugins/loki/_index.md index 2d1b16ddb..6920b4927 100644 --- a/content/telegraf/v1/output-plugins/loki/_index.md +++ b/content/telegraf/v1/output-plugins/loki/_index.md @@ -10,7 +10,7 @@ introduced: "v1.18.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/loki/README.md, Grafana Loki Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/loki/README.md, Grafana Loki Plugin Source --- # Grafana Loki Output Plugin diff --git a/content/telegraf/v1/output-plugins/microsoft_fabric/_index.md b/content/telegraf/v1/output-plugins/microsoft_fabric/_index.md index 54a32c47c..da2882cfc 100644 --- a/content/telegraf/v1/output-plugins/microsoft_fabric/_index.md +++ b/content/telegraf/v1/output-plugins/microsoft_fabric/_index.md @@ -10,7 +10,7 @@ introduced: "v1.35.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/microsoft_fabric/README.md, Microsoft Fabric Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/microsoft_fabric/README.md, Microsoft Fabric Plugin Source --- # Microsoft Fabric Output Plugin diff --git a/content/telegraf/v1/output-plugins/mongodb/_index.md b/content/telegraf/v1/output-plugins/mongodb/_index.md index 58f485a76..a56d0faae 100644 --- a/content/telegraf/v1/output-plugins/mongodb/_index.md +++ b/content/telegraf/v1/output-plugins/mongodb/_index.md @@ -10,7 +10,7 @@ introduced: "v1.21.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/mongodb/README.md, MongoDB Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/mongodb/README.md, MongoDB Plugin Source --- # MongoDB Output Plugin diff --git a/content/telegraf/v1/output-plugins/mqtt/_index.md b/content/telegraf/v1/output-plugins/mqtt/_index.md index 66ec6f64e..46eab829c 100644 --- a/content/telegraf/v1/output-plugins/mqtt/_index.md +++ b/content/telegraf/v1/output-plugins/mqtt/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/mqtt/README.md, MQTT Producer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/mqtt/README.md, MQTT Producer Plugin Source --- # MQTT Producer Output Plugin diff --git a/content/telegraf/v1/output-plugins/nats/_index.md b/content/telegraf/v1/output-plugins/nats/_index.md index 546b1f3c3..e6949a51d 100644 --- a/content/telegraf/v1/output-plugins/nats/_index.md +++ b/content/telegraf/v1/output-plugins/nats/_index.md @@ -10,7 +10,7 @@ introduced: "v1.1.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/nats/README.md, NATS Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/nats/README.md, NATS Plugin Source --- # NATS Output Plugin diff --git a/content/telegraf/v1/output-plugins/nebius_cloud_monitoring/_index.md b/content/telegraf/v1/output-plugins/nebius_cloud_monitoring/_index.md index 290f93b83..4cfb1e16f 100644 --- a/content/telegraf/v1/output-plugins/nebius_cloud_monitoring/_index.md +++ b/content/telegraf/v1/output-plugins/nebius_cloud_monitoring/_index.md @@ -10,7 +10,7 @@ introduced: "v1.27.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/nebius_cloud_monitoring/README.md, Nebius Cloud Monitoring Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/nebius_cloud_monitoring/README.md, Nebius Cloud Monitoring Plugin Source --- # Nebius Cloud Monitoring Output Plugin diff --git a/content/telegraf/v1/output-plugins/newrelic/_index.md b/content/telegraf/v1/output-plugins/newrelic/_index.md index 9b35ab3be..647c76f3a 100644 --- a/content/telegraf/v1/output-plugins/newrelic/_index.md +++ b/content/telegraf/v1/output-plugins/newrelic/_index.md @@ -10,7 +10,7 @@ introduced: "v1.15.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/newrelic/README.md, New Relic Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/newrelic/README.md, New Relic Plugin Source --- # New Relic Output Plugin diff --git a/content/telegraf/v1/output-plugins/nsq/_index.md b/content/telegraf/v1/output-plugins/nsq/_index.md index 239fd7fa4..7a37dbcc0 100644 --- a/content/telegraf/v1/output-plugins/nsq/_index.md +++ b/content/telegraf/v1/output-plugins/nsq/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/nsq/README.md, NSQ Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/nsq/README.md, NSQ Plugin Source --- # NSQ Output Plugin diff --git a/content/telegraf/v1/output-plugins/opensearch/_index.md b/content/telegraf/v1/output-plugins/opensearch/_index.md index eb4415856..256b1f7f2 100644 --- a/content/telegraf/v1/output-plugins/opensearch/_index.md +++ b/content/telegraf/v1/output-plugins/opensearch/_index.md @@ -10,7 +10,7 @@ introduced: "v1.29.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/opensearch/README.md, OpenSearch Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/opensearch/README.md, OpenSearch Plugin Source --- # OpenSearch Output Plugin diff --git a/content/telegraf/v1/output-plugins/opentelemetry/_index.md b/content/telegraf/v1/output-plugins/opentelemetry/_index.md index 263057124..1b8dce1f7 100644 --- a/content/telegraf/v1/output-plugins/opentelemetry/_index.md +++ b/content/telegraf/v1/output-plugins/opentelemetry/_index.md @@ -10,7 +10,7 @@ introduced: "v1.20.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/opentelemetry/README.md, OpenTelemetry Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/opentelemetry/README.md, OpenTelemetry Plugin Source --- # OpenTelemetry Output Plugin diff --git a/content/telegraf/v1/output-plugins/opentsdb/_index.md b/content/telegraf/v1/output-plugins/opentsdb/_index.md index c4c0803ff..860558d85 100644 --- a/content/telegraf/v1/output-plugins/opentsdb/_index.md +++ b/content/telegraf/v1/output-plugins/opentsdb/_index.md @@ -10,7 +10,7 @@ introduced: "v0.1.9" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/opentsdb/README.md, OpenTSDB Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/opentsdb/README.md, OpenTSDB Plugin Source --- # OpenTSDB Output Plugin diff --git a/content/telegraf/v1/output-plugins/parquet/_index.md b/content/telegraf/v1/output-plugins/parquet/_index.md index 361eb01aa..1fc7596af 100644 --- a/content/telegraf/v1/output-plugins/parquet/_index.md +++ b/content/telegraf/v1/output-plugins/parquet/_index.md @@ -10,7 +10,7 @@ introduced: "v1.32.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/parquet/README.md, Parquet Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/parquet/README.md, Parquet Plugin Source --- # Parquet Output Plugin diff --git a/content/telegraf/v1/output-plugins/postgresql/_index.md b/content/telegraf/v1/output-plugins/postgresql/_index.md index cf227560d..a87adb2a9 100644 --- a/content/telegraf/v1/output-plugins/postgresql/_index.md +++ b/content/telegraf/v1/output-plugins/postgresql/_index.md @@ -10,7 +10,7 @@ introduced: "v1.24.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/postgresql/README.md, PostgreSQL Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/postgresql/README.md, PostgreSQL Plugin Source --- # PostgreSQL Output Plugin diff --git a/content/telegraf/v1/output-plugins/prometheus_client/_index.md b/content/telegraf/v1/output-plugins/prometheus_client/_index.md index f1c6bcdee..180c5d7f2 100644 --- a/content/telegraf/v1/output-plugins/prometheus_client/_index.md +++ b/content/telegraf/v1/output-plugins/prometheus_client/_index.md @@ -10,7 +10,7 @@ introduced: "v0.2.1" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/prometheus_client/README.md, Prometheus Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/prometheus_client/README.md, Prometheus Plugin Source --- # Prometheus Output Plugin diff --git a/content/telegraf/v1/output-plugins/quix/_index.md b/content/telegraf/v1/output-plugins/quix/_index.md index 15bfdde24..ed3c37481 100644 --- a/content/telegraf/v1/output-plugins/quix/_index.md +++ b/content/telegraf/v1/output-plugins/quix/_index.md @@ -10,7 +10,7 @@ introduced: "v1.33.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/quix/README.md, Quix Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/quix/README.md, Quix Plugin Source --- # Quix Output Plugin diff --git a/content/telegraf/v1/output-plugins/redistimeseries/_index.md b/content/telegraf/v1/output-plugins/redistimeseries/_index.md index 66b7b1a30..918020f50 100644 --- a/content/telegraf/v1/output-plugins/redistimeseries/_index.md +++ b/content/telegraf/v1/output-plugins/redistimeseries/_index.md @@ -10,7 +10,7 @@ introduced: "v1.0.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/redistimeseries/README.md, Redis Time Series Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/redistimeseries/README.md, Redis Time Series Plugin Source --- # Redis Time Series Output Plugin diff --git a/content/telegraf/v1/output-plugins/remotefile/_index.md b/content/telegraf/v1/output-plugins/remotefile/_index.md index 00c444a6e..42777efb6 100644 --- a/content/telegraf/v1/output-plugins/remotefile/_index.md +++ b/content/telegraf/v1/output-plugins/remotefile/_index.md @@ -10,7 +10,7 @@ introduced: "v1.32.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/remotefile/README.md, Remote File Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/remotefile/README.md, Remote File Plugin Source --- # Remote File Output Plugin diff --git a/content/telegraf/v1/output-plugins/riemann/_index.md b/content/telegraf/v1/output-plugins/riemann/_index.md index 2a3a3a714..104f363d3 100644 --- a/content/telegraf/v1/output-plugins/riemann/_index.md +++ b/content/telegraf/v1/output-plugins/riemann/_index.md @@ -10,7 +10,7 @@ introduced: "v1.3.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/riemann/README.md, Riemann Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/riemann/README.md, Riemann Plugin Source --- # Riemann Output Plugin diff --git a/content/telegraf/v1/output-plugins/sensu/_index.md b/content/telegraf/v1/output-plugins/sensu/_index.md index 8b8168239..7099371f4 100644 --- a/content/telegraf/v1/output-plugins/sensu/_index.md +++ b/content/telegraf/v1/output-plugins/sensu/_index.md @@ -10,7 +10,7 @@ introduced: "v1.18.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/sensu/README.md, Sensu Go Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/sensu/README.md, Sensu Go Plugin Source --- # Sensu Go Output Plugin diff --git a/content/telegraf/v1/output-plugins/signalfx/_index.md b/content/telegraf/v1/output-plugins/signalfx/_index.md index 4b581611c..e5776f8ba 100644 --- a/content/telegraf/v1/output-plugins/signalfx/_index.md +++ b/content/telegraf/v1/output-plugins/signalfx/_index.md @@ -10,7 +10,7 @@ introduced: "v1.18.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/signalfx/README.md, SignalFx Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/signalfx/README.md, SignalFx Plugin Source --- # SignalFx Output Plugin diff --git a/content/telegraf/v1/output-plugins/socket_writer/_index.md b/content/telegraf/v1/output-plugins/socket_writer/_index.md index ba29532a9..82adb253a 100644 --- a/content/telegraf/v1/output-plugins/socket_writer/_index.md +++ b/content/telegraf/v1/output-plugins/socket_writer/_index.md @@ -10,7 +10,7 @@ introduced: "v1.3.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/socket_writer/README.md, Socket Writer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/socket_writer/README.md, Socket Writer Plugin Source --- # Socket Writer Output Plugin diff --git a/content/telegraf/v1/output-plugins/sql/_index.md b/content/telegraf/v1/output-plugins/sql/_index.md index bd7851586..a002579a1 100644 --- a/content/telegraf/v1/output-plugins/sql/_index.md +++ b/content/telegraf/v1/output-plugins/sql/_index.md @@ -10,7 +10,7 @@ introduced: "v1.19.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/sql/README.md, SQL Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/sql/README.md, SQL Plugin Source --- # SQL Output Plugin diff --git a/content/telegraf/v1/output-plugins/stackdriver/_index.md b/content/telegraf/v1/output-plugins/stackdriver/_index.md index c3e4c7d5d..b41e85969 100644 --- a/content/telegraf/v1/output-plugins/stackdriver/_index.md +++ b/content/telegraf/v1/output-plugins/stackdriver/_index.md @@ -10,7 +10,7 @@ introduced: "v1.9.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/stackdriver/README.md, Google Cloud Monitoring Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/stackdriver/README.md, Google Cloud Monitoring Plugin Source --- # Google Cloud Monitoring Output Plugin diff --git a/content/telegraf/v1/output-plugins/stomp/_index.md b/content/telegraf/v1/output-plugins/stomp/_index.md index 6a7bcdd35..94ccab985 100644 --- a/content/telegraf/v1/output-plugins/stomp/_index.md +++ b/content/telegraf/v1/output-plugins/stomp/_index.md @@ -10,7 +10,7 @@ introduced: "v1.24.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/stomp/README.md, ActiveMQ STOMP Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/stomp/README.md, ActiveMQ STOMP Plugin Source --- # ActiveMQ STOMP Output Plugin diff --git a/content/telegraf/v1/output-plugins/sumologic/_index.md b/content/telegraf/v1/output-plugins/sumologic/_index.md index 83b4434e4..958a848e1 100644 --- a/content/telegraf/v1/output-plugins/sumologic/_index.md +++ b/content/telegraf/v1/output-plugins/sumologic/_index.md @@ -10,7 +10,7 @@ introduced: "v1.16.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/sumologic/README.md, Sumo Logic Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/sumologic/README.md, Sumo Logic Plugin Source --- # Sumo Logic Output Plugin diff --git a/content/telegraf/v1/output-plugins/syslog/_index.md b/content/telegraf/v1/output-plugins/syslog/_index.md index 7d748fcb4..1de635722 100644 --- a/content/telegraf/v1/output-plugins/syslog/_index.md +++ b/content/telegraf/v1/output-plugins/syslog/_index.md @@ -10,7 +10,7 @@ introduced: "v1.11.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/syslog/README.md, Syslog Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/syslog/README.md, Syslog Plugin Source --- # Syslog Output Plugin diff --git a/content/telegraf/v1/output-plugins/timestream/_index.md b/content/telegraf/v1/output-plugins/timestream/_index.md index 845caaa8c..2d27a424e 100644 --- a/content/telegraf/v1/output-plugins/timestream/_index.md +++ b/content/telegraf/v1/output-plugins/timestream/_index.md @@ -10,7 +10,7 @@ introduced: "v1.16.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/timestream/README.md, Amazon Timestream Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/timestream/README.md, Amazon Timestream Plugin Source --- # Amazon Timestream Output Plugin diff --git a/content/telegraf/v1/output-plugins/warp10/_index.md b/content/telegraf/v1/output-plugins/warp10/_index.md index 11eafbe5e..87a49de0a 100644 --- a/content/telegraf/v1/output-plugins/warp10/_index.md +++ b/content/telegraf/v1/output-plugins/warp10/_index.md @@ -10,7 +10,7 @@ introduced: "v1.14.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/warp10/README.md, Warp10 Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/warp10/README.md, Warp10 Plugin Source --- # Warp10 Output Plugin diff --git a/content/telegraf/v1/output-plugins/wavefront/_index.md b/content/telegraf/v1/output-plugins/wavefront/_index.md index bb1632b05..cc358fc1a 100644 --- a/content/telegraf/v1/output-plugins/wavefront/_index.md +++ b/content/telegraf/v1/output-plugins/wavefront/_index.md @@ -10,7 +10,7 @@ introduced: "v1.5.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/wavefront/README.md, Wavefront Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/wavefront/README.md, Wavefront Plugin Source --- # Wavefront Output Plugin diff --git a/content/telegraf/v1/output-plugins/websocket/_index.md b/content/telegraf/v1/output-plugins/websocket/_index.md index f39c5a93a..d7347354d 100644 --- a/content/telegraf/v1/output-plugins/websocket/_index.md +++ b/content/telegraf/v1/output-plugins/websocket/_index.md @@ -10,7 +10,7 @@ introduced: "v1.19.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/websocket/README.md, Websocket Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/websocket/README.md, Websocket Plugin Source --- # Websocket Output Plugin diff --git a/content/telegraf/v1/output-plugins/yandex_cloud_monitoring/_index.md b/content/telegraf/v1/output-plugins/yandex_cloud_monitoring/_index.md index 26bf629ed..b0c8052f5 100644 --- a/content/telegraf/v1/output-plugins/yandex_cloud_monitoring/_index.md +++ b/content/telegraf/v1/output-plugins/yandex_cloud_monitoring/_index.md @@ -10,7 +10,7 @@ introduced: "v1.17.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/yandex_cloud_monitoring/README.md, Yandex Cloud Monitoring Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/yandex_cloud_monitoring/README.md, Yandex Cloud Monitoring Plugin Source --- # Yandex Cloud Monitoring Output Plugin diff --git a/content/telegraf/v1/output-plugins/zabbix/_index.md b/content/telegraf/v1/output-plugins/zabbix/_index.md index 5bc8888fe..97f607a8d 100644 --- a/content/telegraf/v1/output-plugins/zabbix/_index.md +++ b/content/telegraf/v1/output-plugins/zabbix/_index.md @@ -10,7 +10,7 @@ introduced: "v1.30.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/outputs/zabbix/README.md, Zabbix Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/outputs/zabbix/README.md, Zabbix Plugin Source --- # Zabbix Output Plugin diff --git a/content/telegraf/v1/processor-plugins/aws_ec2/_index.md b/content/telegraf/v1/processor-plugins/aws_ec2/_index.md index ca824176e..1c78d795e 100644 --- a/content/telegraf/v1/processor-plugins/aws_ec2/_index.md +++ b/content/telegraf/v1/processor-plugins/aws_ec2/_index.md @@ -10,7 +10,7 @@ introduced: "v1.18.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/aws_ec2/README.md, AWS EC2 Metadata Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/aws_ec2/README.md, AWS EC2 Metadata Plugin Source --- # AWS EC2 Metadata Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/batch/_index.md b/content/telegraf/v1/processor-plugins/batch/_index.md index 3f8d0392f..a79590654 100644 --- a/content/telegraf/v1/processor-plugins/batch/_index.md +++ b/content/telegraf/v1/processor-plugins/batch/_index.md @@ -10,7 +10,7 @@ introduced: "v1.33.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/batch/README.md, Batch Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/batch/README.md, Batch Plugin Source --- # Batch Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/clone/_index.md b/content/telegraf/v1/processor-plugins/clone/_index.md index a3f1bed7b..6538fdb3c 100644 --- a/content/telegraf/v1/processor-plugins/clone/_index.md +++ b/content/telegraf/v1/processor-plugins/clone/_index.md @@ -10,7 +10,7 @@ introduced: "v1.13.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/clone/README.md, Clone Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/clone/README.md, Clone Plugin Source --- # Clone Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/converter/_index.md b/content/telegraf/v1/processor-plugins/converter/_index.md index cd5dc402a..b49f9cb97 100644 --- a/content/telegraf/v1/processor-plugins/converter/_index.md +++ b/content/telegraf/v1/processor-plugins/converter/_index.md @@ -10,7 +10,7 @@ introduced: "v1.7.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/converter/README.md, Converter Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/converter/README.md, Converter Plugin Source --- # Converter Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/cumulative_sum/_index.md b/content/telegraf/v1/processor-plugins/cumulative_sum/_index.md index 09807da97..d63e80831 100644 --- a/content/telegraf/v1/processor-plugins/cumulative_sum/_index.md +++ b/content/telegraf/v1/processor-plugins/cumulative_sum/_index.md @@ -10,7 +10,7 @@ introduced: "v1.35.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/cumulative_sum/README.md, Cumulative Sum Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/cumulative_sum/README.md, Cumulative Sum Plugin Source --- # Cumulative Sum Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/date/_index.md b/content/telegraf/v1/processor-plugins/date/_index.md index 2ce955e9e..3b127c8d6 100644 --- a/content/telegraf/v1/processor-plugins/date/_index.md +++ b/content/telegraf/v1/processor-plugins/date/_index.md @@ -10,7 +10,7 @@ introduced: "v1.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/date/README.md, Date Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/date/README.md, Date Plugin Source --- # Date Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/dedup/_index.md b/content/telegraf/v1/processor-plugins/dedup/_index.md index 9691aba84..ca308af53 100644 --- a/content/telegraf/v1/processor-plugins/dedup/_index.md +++ b/content/telegraf/v1/processor-plugins/dedup/_index.md @@ -10,7 +10,7 @@ introduced: "v1.14.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/dedup/README.md, Dedup Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/dedup/README.md, Dedup Plugin Source --- # Dedup Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/defaults/_index.md b/content/telegraf/v1/processor-plugins/defaults/_index.md index d4ebb1c82..947874e4f 100644 --- a/content/telegraf/v1/processor-plugins/defaults/_index.md +++ b/content/telegraf/v1/processor-plugins/defaults/_index.md @@ -10,7 +10,7 @@ introduced: "v1.15.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/defaults/README.md, Defaults Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/defaults/README.md, Defaults Plugin Source --- # Defaults Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/enum/_index.md b/content/telegraf/v1/processor-plugins/enum/_index.md index d180f7105..a2eddc8d3 100644 --- a/content/telegraf/v1/processor-plugins/enum/_index.md +++ b/content/telegraf/v1/processor-plugins/enum/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/enum/README.md, Enum Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/enum/README.md, Enum Plugin Source --- # Enum Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/execd/_index.md b/content/telegraf/v1/processor-plugins/execd/_index.md index 2270dbb3f..77f057d1b 100644 --- a/content/telegraf/v1/processor-plugins/execd/_index.md +++ b/content/telegraf/v1/processor-plugins/execd/_index.md @@ -10,7 +10,7 @@ introduced: "v1.15.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/execd/README.md, Execd Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/execd/README.md, Execd Plugin Source --- # Execd Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/filepath/_index.md b/content/telegraf/v1/processor-plugins/filepath/_index.md index f31d1ff25..b5454b244 100644 --- a/content/telegraf/v1/processor-plugins/filepath/_index.md +++ b/content/telegraf/v1/processor-plugins/filepath/_index.md @@ -10,7 +10,7 @@ introduced: "v1.15.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/filepath/README.md, Filepath Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/filepath/README.md, Filepath Plugin Source --- # Filepath Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/filter/_index.md b/content/telegraf/v1/processor-plugins/filter/_index.md index fb8dbfdbd..a303b550b 100644 --- a/content/telegraf/v1/processor-plugins/filter/_index.md +++ b/content/telegraf/v1/processor-plugins/filter/_index.md @@ -10,7 +10,7 @@ introduced: "v1.29.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/filter/README.md, Filter Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/filter/README.md, Filter Plugin Source --- # Filter Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/ifname/_index.md b/content/telegraf/v1/processor-plugins/ifname/_index.md index feb994de5..fb1499cbf 100644 --- a/content/telegraf/v1/processor-plugins/ifname/_index.md +++ b/content/telegraf/v1/processor-plugins/ifname/_index.md @@ -10,7 +10,7 @@ introduced: "v1.15.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/ifname/README.md, Network Interface Name Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/ifname/README.md, Network Interface Name Plugin Source --- # Network Interface Name Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/lookup/_index.md b/content/telegraf/v1/processor-plugins/lookup/_index.md index 271ab8484..877a552c3 100644 --- a/content/telegraf/v1/processor-plugins/lookup/_index.md +++ b/content/telegraf/v1/processor-plugins/lookup/_index.md @@ -10,7 +10,7 @@ introduced: "v1.15.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/lookup/README.md, Lookup Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/lookup/README.md, Lookup Plugin Source --- # Lookup Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/noise/_index.md b/content/telegraf/v1/processor-plugins/noise/_index.md index 6a451438f..65b433113 100644 --- a/content/telegraf/v1/processor-plugins/noise/_index.md +++ b/content/telegraf/v1/processor-plugins/noise/_index.md @@ -10,7 +10,7 @@ introduced: "v1.22.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/noise/README.md, Noise Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/noise/README.md, Noise Plugin Source --- # Noise Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/override/_index.md b/content/telegraf/v1/processor-plugins/override/_index.md index 42ee0f52d..803434671 100644 --- a/content/telegraf/v1/processor-plugins/override/_index.md +++ b/content/telegraf/v1/processor-plugins/override/_index.md @@ -10,7 +10,7 @@ introduced: "v1.6.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/override/README.md, Override Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/override/README.md, Override Plugin Source --- # Override Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/parser/_index.md b/content/telegraf/v1/processor-plugins/parser/_index.md index 5dca40d7d..b374b4c30 100644 --- a/content/telegraf/v1/processor-plugins/parser/_index.md +++ b/content/telegraf/v1/processor-plugins/parser/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/parser/README.md, Parser Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/parser/README.md, Parser Plugin Source --- # Parser Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/pivot/_index.md b/content/telegraf/v1/processor-plugins/pivot/_index.md index 6e6e4f65f..dfacca19d 100644 --- a/content/telegraf/v1/processor-plugins/pivot/_index.md +++ b/content/telegraf/v1/processor-plugins/pivot/_index.md @@ -10,7 +10,7 @@ introduced: "v1.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/pivot/README.md, Pivot Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/pivot/README.md, Pivot Plugin Source --- # Pivot Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/port_name/_index.md b/content/telegraf/v1/processor-plugins/port_name/_index.md index 3e6244797..274ec0d4f 100644 --- a/content/telegraf/v1/processor-plugins/port_name/_index.md +++ b/content/telegraf/v1/processor-plugins/port_name/_index.md @@ -10,7 +10,7 @@ introduced: "v1.15.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/port_name/README.md, Port Name Lookup Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/port_name/README.md, Port Name Lookup Plugin Source --- # Port Name Lookup Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/printer/_index.md b/content/telegraf/v1/processor-plugins/printer/_index.md index 5cda8275f..3695818b9 100644 --- a/content/telegraf/v1/processor-plugins/printer/_index.md +++ b/content/telegraf/v1/processor-plugins/printer/_index.md @@ -10,7 +10,7 @@ introduced: "v1.1.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/printer/README.md, Printer Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/printer/README.md, Printer Plugin Source --- # Printer Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/regex/_index.md b/content/telegraf/v1/processor-plugins/regex/_index.md index f2d13c045..2ad3d9a25 100644 --- a/content/telegraf/v1/processor-plugins/regex/_index.md +++ b/content/telegraf/v1/processor-plugins/regex/_index.md @@ -10,7 +10,7 @@ introduced: "v1.7.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/regex/README.md, Regex Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/regex/README.md, Regex Plugin Source --- # Regex Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/rename/_index.md b/content/telegraf/v1/processor-plugins/rename/_index.md index b0becb81b..288e88cc1 100644 --- a/content/telegraf/v1/processor-plugins/rename/_index.md +++ b/content/telegraf/v1/processor-plugins/rename/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/rename/README.md, Rename Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/rename/README.md, Rename Plugin Source --- # Rename Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/reverse_dns/_index.md b/content/telegraf/v1/processor-plugins/reverse_dns/_index.md index 6130a66d2..69579233b 100644 --- a/content/telegraf/v1/processor-plugins/reverse_dns/_index.md +++ b/content/telegraf/v1/processor-plugins/reverse_dns/_index.md @@ -10,7 +10,7 @@ introduced: "v1.15.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/reverse_dns/README.md, Reverse DNS Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/reverse_dns/README.md, Reverse DNS Plugin Source --- # Reverse DNS Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/round/_index.md b/content/telegraf/v1/processor-plugins/round/_index.md index 24a97f4b8..6cabaeb9a 100644 --- a/content/telegraf/v1/processor-plugins/round/_index.md +++ b/content/telegraf/v1/processor-plugins/round/_index.md @@ -10,7 +10,7 @@ introduced: "v1.36.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/round/README.md, Round Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/round/README.md, Round Plugin Source --- # Round Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/s2geo/_index.md b/content/telegraf/v1/processor-plugins/s2geo/_index.md index 7b4d50bd6..ef843ffd5 100644 --- a/content/telegraf/v1/processor-plugins/s2geo/_index.md +++ b/content/telegraf/v1/processor-plugins/s2geo/_index.md @@ -10,7 +10,7 @@ introduced: "v1.14.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/s2geo/README.md, S2 Geo Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/s2geo/README.md, S2 Geo Plugin Source --- # S2 Geo Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/scale/_index.md b/content/telegraf/v1/processor-plugins/scale/_index.md index 8b47950c4..38cfb4379 100644 --- a/content/telegraf/v1/processor-plugins/scale/_index.md +++ b/content/telegraf/v1/processor-plugins/scale/_index.md @@ -10,7 +10,7 @@ introduced: "v1.27.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/scale/README.md, Scale Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/scale/README.md, Scale Plugin Source --- # Scale Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/snmp_lookup/_index.md b/content/telegraf/v1/processor-plugins/snmp_lookup/_index.md index b32a1e3ac..7aee599e1 100644 --- a/content/telegraf/v1/processor-plugins/snmp_lookup/_index.md +++ b/content/telegraf/v1/processor-plugins/snmp_lookup/_index.md @@ -10,7 +10,7 @@ introduced: "v1.30.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/snmp_lookup/README.md, SNMP Lookup Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/snmp_lookup/README.md, SNMP Lookup Plugin Source --- # SNMP Lookup Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/split/_index.md b/content/telegraf/v1/processor-plugins/split/_index.md index 2407f23a9..91bafc2da 100644 --- a/content/telegraf/v1/processor-plugins/split/_index.md +++ b/content/telegraf/v1/processor-plugins/split/_index.md @@ -10,7 +10,7 @@ introduced: "v1.28.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/split/README.md, Split Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/split/README.md, Split Plugin Source --- # Split Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/starlark/_index.md b/content/telegraf/v1/processor-plugins/starlark/_index.md index 3647123ca..1a5459eae 100644 --- a/content/telegraf/v1/processor-plugins/starlark/_index.md +++ b/content/telegraf/v1/processor-plugins/starlark/_index.md @@ -10,7 +10,7 @@ introduced: "v1.15.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/starlark/README.md, Starlark Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/starlark/README.md, Starlark Plugin Source --- # Starlark Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/strings/_index.md b/content/telegraf/v1/processor-plugins/strings/_index.md index b5b59e9c8..41e533ebf 100644 --- a/content/telegraf/v1/processor-plugins/strings/_index.md +++ b/content/telegraf/v1/processor-plugins/strings/_index.md @@ -10,7 +10,7 @@ introduced: "v1.8.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/strings/README.md, Strings Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/strings/README.md, Strings Plugin Source --- # Strings Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/tag_limit/_index.md b/content/telegraf/v1/processor-plugins/tag_limit/_index.md index cb1773c46..6557cc3d0 100644 --- a/content/telegraf/v1/processor-plugins/tag_limit/_index.md +++ b/content/telegraf/v1/processor-plugins/tag_limit/_index.md @@ -10,7 +10,7 @@ introduced: "v1.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/tag_limit/README.md, Tag Limit Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/tag_limit/README.md, Tag Limit Plugin Source --- # Tag Limit Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/template/_index.md b/content/telegraf/v1/processor-plugins/template/_index.md index 2fe864e7c..952042189 100644 --- a/content/telegraf/v1/processor-plugins/template/_index.md +++ b/content/telegraf/v1/processor-plugins/template/_index.md @@ -10,7 +10,7 @@ introduced: "v1.14.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/template/README.md, Template Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/template/README.md, Template Plugin Source --- # Template Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/timestamp/_index.md b/content/telegraf/v1/processor-plugins/timestamp/_index.md index ef3a1b872..a9add1ad8 100644 --- a/content/telegraf/v1/processor-plugins/timestamp/_index.md +++ b/content/telegraf/v1/processor-plugins/timestamp/_index.md @@ -10,7 +10,7 @@ introduced: "v1.31.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/timestamp/README.md, Timestamp Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/timestamp/README.md, Timestamp Plugin Source --- # Timestamp Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/topk/_index.md b/content/telegraf/v1/processor-plugins/topk/_index.md index 14a1d3290..cd657cb01 100644 --- a/content/telegraf/v1/processor-plugins/topk/_index.md +++ b/content/telegraf/v1/processor-plugins/topk/_index.md @@ -10,7 +10,7 @@ introduced: "v1.7.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/topk/README.md, TopK Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/topk/README.md, TopK Plugin Source --- # TopK Processor Plugin diff --git a/content/telegraf/v1/processor-plugins/unpivot/_index.md b/content/telegraf/v1/processor-plugins/unpivot/_index.md index a56eab141..1ee3e9f1a 100644 --- a/content/telegraf/v1/processor-plugins/unpivot/_index.md +++ b/content/telegraf/v1/processor-plugins/unpivot/_index.md @@ -10,7 +10,7 @@ introduced: "v1.12.0" os_support: "freebsd, linux, macos, solaris, windows" related: - /telegraf/v1/configure_plugins/ - - https://github.com/influxdata/telegraf/tree/v1.38.0/plugins/processors/unpivot/README.md, Unpivot Plugin Source + - https://github.com/influxdata/telegraf/tree/v1.38.1/plugins/processors/unpivot/README.md, Unpivot Plugin Source --- # Unpivot Processor Plugin diff --git a/content/telegraf/v1/release-notes.md b/content/telegraf/v1/release-notes.md index f5ae49a89..973f4b651 100644 --- a/content/telegraf/v1/release-notes.md +++ b/content/telegraf/v1/release-notes.md @@ -11,6 +11,36 @@ menu: weight: 60 --- +## v1.38.1 {date="2026-03-16"} + +### Bugfixes + +- [#18491](https://github.com/influxdata/telegraf/pull/18491) `inputs.diskio` Sanitize newline characters in serial tag +- [#18453](https://github.com/influxdata/telegraf/pull/18453) `inputs.docker` Emit status metrics for non-running containers +- [#18513](https://github.com/influxdata/telegraf/pull/18513) `inputs.exec` Log stderr messages +- [#18469](https://github.com/influxdata/telegraf/pull/18469) `inputs.mem` Use vm.Cached as vm.Buffers on OpenBSD +- [#18455](https://github.com/influxdata/telegraf/pull/18455) `inputs.ping` Warn on using timeout parameter for native method +- [#18471](https://github.com/influxdata/telegraf/pull/18471) `internal` Extract go version even more robustly +- [#18509](https://github.com/influxdata/telegraf/pull/18509) `outputs.influxdb_v3` Remove duplicate timeout setting + +### Dependency Updates + +- [#18486](https://github.com/influxdata/telegraf/pull/18486) `deps` Bump github.com/SAP/go-hdb from 1.15.1 to 1.15.2 +- [#18477](https://github.com/influxdata/telegraf/pull/18477) `deps` Bump github.com/alitto/pond/v2 from 2.6.2 to 2.7.0 +- [#18488](https://github.com/influxdata/telegraf/pull/18488) `deps` Bump github.com/apache/arrow-go/v18 from 18.5.1 to 18.5.2 +- [#18487](https://github.com/influxdata/telegraf/pull/18487) `deps` Bump github.com/emiago/sipgo from 1.2.0 to 1.2.1 +- [#18475](https://github.com/influxdata/telegraf/pull/18475) `deps` Bump github.com/gophercloud/gophercloud/v2 from 2.10.0 to 2.11.0 +- [#18481](https://github.com/influxdata/telegraf/pull/18481) `deps` Bump github.com/nats-io/nats-server/v2 from 2.12.4 to 2.12.5 +- [#18075](https://github.com/influxdata/telegraf/pull/18075) `deps` Bump go.opentelemetry.io/collector/pdata from 1.46.0 to 1.53.0 +- [#18483](https://github.com/influxdata/telegraf/pull/18483) `deps` Bump go.opentelemetry.io/proto/otlp from 1.9.0 to 1.10.0 +- [#18485](https://github.com/influxdata/telegraf/pull/18485) `deps` Bump go.opentelemetry.io/proto/otlp/collector/profiles/v1development from 0.2.0 to 0.3.0 +- [#18478](https://github.com/influxdata/telegraf/pull/18478) `deps` Bump golang.org/x/oauth2 from 0.35.0 to 0.36.0 +- [#18484](https://github.com/influxdata/telegraf/pull/18484) `deps` Bump golang.org/x/sync from 0.19.0 to 0.20.0 +- [#18480](https://github.com/influxdata/telegraf/pull/18480) `deps` Bump google.golang.org/api from 0.269.0 to 0.270.0 +- [#18490](https://github.com/influxdata/telegraf/pull/18490) `deps` Bump google.golang.org/grpc from 1.79.1 to 1.79.2 +- [#18474](https://github.com/influxdata/telegraf/pull/18474) `deps` Bump the aws-sdk-go-v2 group with 11 updates +- [#18473](https://github.com/influxdata/telegraf/pull/18473) `deps` Bump tj-actions/changed-files from 47.0.4 to 47.0.5 + ## v1.38.0 {date="2026-03-09"} ### Important Changes diff --git a/data/products.yml b/data/products.yml index ec212bc84..37517d792 100644 --- a/data/products.yml +++ b/data/products.yml @@ -289,7 +289,7 @@ telegraf: versions: [v1] latest: v1.38 latest_patches: - v1: 1.38.0 + v1: 1.38.1 ai_sample_questions: - How do I configure Telegraf for InfluxDB 3? - How do I write a custom Telegraf plugin? From ab8223d11ecd64ef223d891a0662b58e3838fb94 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Mon, 16 Mar 2026 21:05:47 -0500 Subject: [PATCH 23/27] fix(ui): fix Ask AI code control and add e2e tests (#6955) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * feat(ui): add Ask AI to code block controls menu Add an "Ask AI" option to the code controls dropdown menu on all code blocks. Uses data-ask-ai-query attribute if provided by the template, otherwise builds a query from the code content. Delegates to the existing Kapa widget integration via the ask-ai-open click handler. * fix(ui): fix Ask AI code control and add e2e tests ## Summary - Add "Ask AI" option to the code controls dropdown (three-dot menu) on all code blocks - Uses `data-ask-ai-query` attribute from the template if available, otherwise builds a query from the code content - Delegates to the existing Kapa widget via the `ask-ai-open` click handler contract - Reorder menu items: Copy → Ask AI → Fill window ## Bug fix Fix Ask AI button not opening the Kapa widget. jQuery `.trigger('click')` doesn't dispatch native DOM events, so the native `document.addEventListener` in ask-ai-trigger.js never received the click. Switch to native `.click()` and remove `href="#"` to prevent scroll-to-top. ## Tests Add Cypress e2e test suite (`code-controls.cy.js`) with 16 tests covering: - Initialization: code blocks wrapped, controls appended, menu item order - Toggle: open/close on click, close on outside click, independent menus - Copy to clipboard: success lifecycle, revert after timeout - Fullscreen: modal open/close, body scroll lock, placeholder restore - Ask AI: Kapa modal opens, query built with code content (MutationObserver) * fix(ui): apply icon spacing to all code control menu items Move .cf-icon margin-right rule from .copy-code and .fullscreen-toggle to the shared li level so it applies to all menu items including Ask AI. * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * fix(ui): add keyboard accessibility to code controls menu Replace clickable and
  • elements with proper + `; @@ -27,12 +28,17 @@ function initialize() { // Click outside of the code-controls to close them $(document).click(function () { - $('.code-controls').removeClass('open'); + $('.code-controls.open').each(function () { + $(this).removeClass('open'); + $(this).find('.code-controls-toggle').attr('aria-expanded', 'false'); + }); }); // Click the code controls toggle to open code controls $('.code-controls-toggle').click(function () { - $(this).parent('.code-controls').toggleClass('open'); + var $controls = $(this).parent('.code-controls'); + var isOpen = $controls.toggleClass('open').hasClass('open'); + $(this).attr('aria-expanded', String(isOpen)); }); // Stop event propagation for clicks inside of the code-controls div @@ -235,6 +241,34 @@ function initialize() { return info; } + ////////////////////////////////// ASK AI //////////////////////////////////// + + // Build a query from the code block and open Kapa via the ask-ai-open contract + $('.ask-ai-code').click(function () { + var codeElement = $(this) + .closest('.code-controls') + .prevAll('pre:has(code)')[0]; + if (!codeElement) return; + + var code = codeElement.innerText.trim(); + // Use the data-ask-ai-query attribute if the template provided one, + // otherwise build a generic query from the code content + var query = + $(codeElement).attr('data-ask-ai-query') || + 'Explain this code:\n```\n' + code.substring(0, 500) + '\n```'; + + // Delegate to the global ask-ai-open handler by synthesizing a click. + // Use native .click() instead of jQuery .trigger() so the event + // reaches the native document.addEventListener in ask-ai-trigger.js. + // No href — prevents scroll-to-top when the native click fires. + var triggerEl = document.createElement('a'); + triggerEl.className = 'ask-ai-open'; + triggerEl.dataset.query = query; + document.body.appendChild(triggerEl); + triggerEl.click(); + triggerEl.remove(); + }); + /////////////////////////////// FULL WINDOW CODE /////////////////////////////// /* diff --git a/assets/styles/layouts/_code-controls.scss b/assets/styles/layouts/_code-controls.scss index 36272a257..68353bed5 100644 --- a/assets/styles/layouts/_code-controls.scss +++ b/assets/styles/layouts/_code-controls.scss @@ -16,10 +16,12 @@ opacity: .5; transition: opacity .2s; border-radius: $radius; + border: none; + background: none; line-height: 0; - cursor: pointer; + cursor: pointer; - &:hover { + &:hover, &:focus-visible { opacity: 1; background-color: rgba($article-text, .1); backdrop-filter: blur(15px); @@ -35,21 +37,26 @@ backdrop-filter: blur(15px); display: none; - li { + button { + display: block; + width: 100%; + text-align: left; margin: 0; padding: .4rem .5rem .6rem; + border: none; + background: none; border-radius: $radius; color: $article-bold; font-size: .87rem; line-height: 0; - cursor: pointer; + cursor: pointer; - &:hover {background-color: rgba($article-text, .07)} - - &.copy-code, &.fullscreen-toggle { - .cf-icon {margin-right: .35rem;} + &:hover, &:focus-visible { + background-color: rgba($article-text, .07); } + .cf-icon {margin-right: .35rem;} + &.copy-code { .message { text-shadow: 0px 0px 8px rgba($article-text, 0); @@ -69,6 +76,8 @@ } } } + + li {margin: 0;} } &.open { diff --git a/cypress/e2e/content/code-controls.cy.js b/cypress/e2e/content/code-controls.cy.js new file mode 100644 index 000000000..0480e29a5 --- /dev/null +++ b/cypress/e2e/content/code-controls.cy.js @@ -0,0 +1,345 @@ +/// + +/** + * Code Controls E2E Test Suite + * + * Tests for the code block controls menu (code-controls.js): + * - Initialization: wraps code blocks, appends control menus + * - Toggle: opens/closes menu on click, closes on outside click + * - Copy to clipboard: success/failure lifecycle + * - Fullscreen: opens modal with cloned code, closes and restores + * - Ask AI: delegates to global ask-ai-open handler + * + * TEST SCENARIOS CHECKLIST: + * + * Initialization: + * --------------- + * - [x] Code blocks are wrapped in .codeblock divs + * - [x] Each codeblock has a .code-controls container + * - [x] Controls contain toggle, copy, Ask AI, and fullscreen items + * - [x] Menu is hidden by default (toggle visible) + * - [x] Ask AI is in the middle (2nd) position + * - [x] Controls use accessible markup (buttons, ARIA roles) + * + * Toggle Behavior: + * ---------------- + * - [x] Clicking toggle opens menu (adds .open class) + * - [x] Clicking outside closes menu + * - [x] Copy button keeps menu open (stopPropagation) + * + * Copy to Clipboard: + * ------------------ + * - [x] Copy button shows "Copied!" on success + * - [x] Copy button shows success class temporarily + * - [x] Success state reverts after timeout + * + * Fullscreen Mode: + * ---------------- + * - [x] Fullscreen button opens modal + * - [x] Modal contains cloned code content + * - [x] Close button dismisses modal + * - [x] Body scroll is disabled while fullscreen + * + * Ask AI Code: + * ------------ + * - [x] Ask AI button synthesizes ask-ai-open element with query + * - [x] Query includes "Explain this code" prefix and code content + */ + +const TEST_PAGE = '/influxdb3/core/admin/identify-version/'; + +function beforeTest() { + cy.viewport(1440, 900); +} + +describe('Code Controls', function () { + describe('Initialization', function () { + beforeEach(() => { + cy.visit(TEST_PAGE); + beforeTest(); + }); + + it('should wrap code blocks in .codeblock divs', function () { + cy.get('.article--content .codeblock').should('have.length.at.least', 1); + cy.get('.article--content .codeblock > pre').should( + 'have.length.at.least', + 1 + ); + }); + + it('should append code-controls to each codeblock', function () { + cy.get('.article--content .codeblock').each(($block) => { + cy.wrap($block).find('.code-controls').should('exist'); + cy.wrap($block) + .find('.code-controls .code-controls-toggle') + .should('exist'); + cy.wrap($block) + .find('.code-controls .code-control-options') + .should('exist'); + }); + }); + + it('should have copy, Ask AI, and fullscreen items in order', function () { + cy.get('.article--content .codeblock') + .first() + .within(() => { + cy.get('.code-control-options button[role="menuitem"]') + .eq(0) + .should('have.class', 'copy-code'); + cy.get('.code-control-options button[role="menuitem"]') + .eq(1) + .should('have.class', 'ask-ai-code'); + cy.get('.code-control-options button[role="menuitem"]') + .eq(2) + .should('have.class', 'fullscreen-toggle'); + }); + }); + + it('should use accessible markup for controls', function () { + cy.get('.article--content .codeblock') + .first() + .within(() => { + // Toggle is a button with aria attributes + cy.get('.code-controls-toggle') + .should('have.attr', 'aria-label', 'Code block options') + .and('have.attr', 'aria-expanded', 'false'); + + // Menu has role="menu" + cy.get('.code-control-options').should('have.attr', 'role', 'menu'); + + // Menu items are buttons with role="menuitem" + cy.get('.code-control-options button[role="menuitem"]').should( + 'have.length', + 3 + ); + }); + }); + + it('should show toggle and hide menu by default', function () { + cy.get('.article--content .code-controls') + .first() + .should('not.have.class', 'open'); + cy.get('.article--content .code-controls-toggle') + .first() + .should('be.visible'); + }); + }); + + describe('Toggle Behavior', function () { + beforeEach(() => { + cy.visit(TEST_PAGE); + beforeTest(); + }); + + it('should open menu when toggle is clicked', function () { + cy.get('.article--content .code-controls-toggle').first().click(); + cy.get('.article--content .code-controls') + .first() + .should('have.class', 'open'); + cy.get('.article--content .code-control-options') + .first() + .should('be.visible'); + }); + + it('should close menu when clicking outside', function () { + cy.get('.article--content .code-controls-toggle').first().click(); + cy.get('.article--content .code-controls') + .first() + .should('have.class', 'open'); + + // Click a heading element (neutral area, not inside a code block) + cy.get('.article--content h2').first().click({ force: true }); + cy.get('.article--content .code-controls') + .first() + .should('not.have.class', 'open'); + }); + + it('should keep menu open when copy is clicked', function () { + cy.get('.article--content .code-controls-toggle').first().click(); + cy.get('.article--content .code-controls') + .first() + .should('have.class', 'open'); + + // Click copy — menu should stay open (stopPropagation) + cy.get('.article--content .copy-code').first().click(); + cy.get('.article--content .code-controls') + .first() + .should('have.class', 'open'); + }); + }); + + describe('Copy to Clipboard', function () { + beforeEach(() => { + cy.visit(TEST_PAGE); + beforeTest(); + + // Stub navigator.clipboard.writeText to avoid permission issues + cy.window().then((win) => { + cy.stub(win.navigator.clipboard, 'writeText').resolves(); + }); + }); + + it('should show "Copied!" text on successful copy', function () { + // Open the menu + cy.get('.article--content .code-controls-toggle').first().click(); + + // Click copy + cy.get('.article--content .copy-code').first().click(); + + // Verify success lifecycle + cy.get('.article--content .copy-code') + .first() + .should('have.class', 'success'); + cy.get('.article--content .copy-code .message') + .first() + .should('contain', 'Copied!'); + }); + + it('should revert to "Copy" after success timeout', function () { + cy.get('.article--content .code-controls-toggle').first().click(); + cy.get('.article--content .copy-code').first().click(); + + // Verify success state appears + cy.get('.article--content .copy-code') + .first() + .should('have.class', 'success'); + + // Wait for the 2500ms timeout to elapse, then verify revert + cy.get('.article--content .copy-code', { timeout: 4000 }) + .first() + .should('not.have.class', 'success'); + cy.get('.article--content .copy-code .message') + .first() + .should('contain', 'Copy'); + }); + }); + + describe('Fullscreen Mode', function () { + beforeEach(() => { + cy.visit(TEST_PAGE); + beforeTest(); + }); + + it('should open fullscreen modal with code content', function () { + // Get the code text from the first code block + cy.get('.article--content .codeblock pre code') + .first() + .invoke('text') + .then((codeText) => { + // Open menu and click fullscreen + cy.get('.article--content .code-controls-toggle').first().click(); + cy.get('.article--content .fullscreen-toggle').first().click(); + + // Modal should be visible + cy.get('.fullscreen-code').should('be.visible'); + + // Modal should contain the code content + cy.get('.fullscreen-code pre code').should( + 'contain', + codeText.trim() + ); + }); + }); + + it('should disable body scroll when fullscreen is open', function () { + cy.get('.article--content .code-controls-toggle').first().click(); + cy.get('.article--content .fullscreen-toggle').first().click(); + + cy.get('.fullscreen-code').should('be.visible'); + cy.get('body').should('have.css', 'overflow', 'hidden'); + }); + + it('should close fullscreen and restore scroll on close click', function () { + cy.get('.article--content .code-controls-toggle').first().click(); + cy.get('.article--content .fullscreen-toggle').first().click(); + cy.get('.fullscreen-code').should('be.visible'); + + // Click close button + cy.get('.fullscreen-close').click(); + + // Modal should fade out + cy.get('.fullscreen-code').should('not.be.visible'); + cy.get('body').should('have.css', 'overflow', 'auto'); + }); + + it('should replace code with placeholder after closing', function () { + cy.get('.article--content .code-controls-toggle').first().click(); + cy.get('.article--content .fullscreen-toggle').first().click(); + cy.get('.fullscreen-code').should('be.visible'); + + cy.get('.fullscreen-close').click(); + cy.get('.fullscreen-code').should('not.be.visible'); + + // The placeholder should be restored + cy.get('#fullscreen-code-placeholder').should('exist'); + }); + }); + + describe('Ask AI Code Button', function () { + it('should open Ask AI widget when clicked', function () { + cy.visit(TEST_PAGE); + beforeTest(); + + // Open menu and click Ask AI + cy.get('.article--content .code-controls-toggle').first().click(); + cy.get('.article--content .ask-ai-code').first().click(); + + // The Kapa modal should become visible + cy.get('#kapa-modal-content', { + includeShadowDom: true, + timeout: 5000, + }).should('be.visible'); + }); + + it('should synthesize ask-ai-open element with query from code block', function () { + cy.visit(TEST_PAGE); + beforeTest(); + + // Capture the data-query from the synthesized ask-ai-open element + // by observing DOM mutations before code-controls removes it + cy.window().then((win) => { + const capturedQueries = []; + + // MutationObserver catches the transient + // that code-controls appends to body then removes + const observer = new win.MutationObserver((mutations) => { + for (const mutation of mutations) { + for (const node of mutation.addedNodes) { + if ( + node.nodeType === 1 && + node.classList?.contains('ask-ai-open') + ) { + capturedQueries.push(node.getAttribute('data-query')); + } + } + } + }); + observer.observe(win.document.body, { childList: true }); + + // Get first code block text for comparison + cy.get('.article--content .codeblock pre') + .first() + .invoke('text') + .then((codeText) => { + const firstLine = codeText.trim().split('\n')[0]; + + // Open menu and click Ask AI + cy.get('.article--content .code-controls-toggle').first().click(); + cy.get('.article--content .ask-ai-code').first().click(); + + // Verify the query was constructed correctly + cy.wrap(capturedQueries, { timeout: 3000 }).should( + 'have.length.at.least', + 1 + ); + cy.then(() => { + observer.disconnect(); + const query = capturedQueries[0]; + expect(query).to.include('Explain this code'); + expect(query).to.include(firstLine); + }); + }); + }); + }); + }); +}); From 7603f82471e7a0e5123fda1c2eb7526180d5425e Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Tue, 17 Mar 2026 12:07:19 -0500 Subject: [PATCH 24/27] fix(influxdb3): correct broken links causing 404s (#6958) - Fix Power BI links in visualization-tools.md for cloud-dedicated, cloud-serverless, and clustered to use new visualize-data/ path instead of old process-data/visualize/ path - Fix influxctl cluster list link in cloud-dedicated/admin/clusters/list.md to include missing cluster/ path segment https://claude.ai/code/session_01SV14CdHN4GGVuATt9n7STn Co-authored-by: Claude --- content/influxdb3/cloud-dedicated/admin/clusters/list.md | 2 +- .../query-data/execute-queries/visualization-tools.md | 2 +- .../query-data/execute-queries/visualization-tools.md | 2 +- .../clustered/query-data/execute-queries/visualization-tools.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/content/influxdb3/cloud-dedicated/admin/clusters/list.md b/content/influxdb3/cloud-dedicated/admin/clusters/list.md index 7fc250ee6..9a6a174e9 100644 --- a/content/influxdb3/cloud-dedicated/admin/clusters/list.md +++ b/content/influxdb3/cloud-dedicated/admin/clusters/list.md @@ -15,7 +15,7 @@ aliases: - /influxdb3/cloud-dedicated/admin/clusters/list/ --- -Use the Admin UI or the [`influxctl cluster list` CLI command](/influxdb3/cloud-dedicated/reference/cli/influxctl/list/) +Use the Admin UI or the [`influxctl cluster list` CLI command](/influxdb3/cloud-dedicated/reference/cli/influxctl/cluster/list/) to view information about all {{< product-name omit=" Clustered" >}} clusters associated with your account ID. {{< tabs-wrapper >}} diff --git a/content/influxdb3/cloud-dedicated/query-data/execute-queries/visualization-tools.md b/content/influxdb3/cloud-dedicated/query-data/execute-queries/visualization-tools.md index 96e8be6e7..55c82d0b2 100644 --- a/content/influxdb3/cloud-dedicated/query-data/execute-queries/visualization-tools.md +++ b/content/influxdb3/cloud-dedicated/query-data/execute-queries/visualization-tools.md @@ -27,7 +27,7 @@ Use visualization tools to query data stored in {{% product-name %}} with SQL. The following visualization tools support querying InfluxDB with SQL: - [Grafana](/influxdb3/cloud-dedicated/process-data/visualize/grafana/) -- [Power BI](/influxdb3/cloud-dedicated/process-data/visualize/powerbi/) +- [Power BI](/influxdb3/cloud-dedicated/visualize-data/powerbi/) - [Superset](/influxdb3/cloud-dedicated/process-data/visualize/superset/) - [Tableau](/influxdb3/cloud-dedicated/process-data/visualize/tableau/) diff --git a/content/influxdb3/cloud-serverless/query-data/execute-queries/visualization-tools.md b/content/influxdb3/cloud-serverless/query-data/execute-queries/visualization-tools.md index 039134e2e..7b4a0cd87 100644 --- a/content/influxdb3/cloud-serverless/query-data/execute-queries/visualization-tools.md +++ b/content/influxdb3/cloud-serverless/query-data/execute-queries/visualization-tools.md @@ -27,7 +27,7 @@ Use visualization tools to query data stored in {{% product-name %}}. The following visualization tools support querying InfluxDB with SQL: - [Grafana](/influxdb3/cloud-serverless/process-data/visualize/grafana/) -- [Power BI](/influxdb3/cloud-serverless/process-data/visualize/powerbi/) +- [Power BI](/influxdb3/cloud-serverless/visualize-data/powerbi/) - [Superset](/influxdb3/cloud-serverless/process-data/visualize/superset/) - [Tableau](/influxdb3/cloud-serverless/process-data/visualize/tableau/) diff --git a/content/influxdb3/clustered/query-data/execute-queries/visualization-tools.md b/content/influxdb3/clustered/query-data/execute-queries/visualization-tools.md index e942ded97..b8ff5dee8 100644 --- a/content/influxdb3/clustered/query-data/execute-queries/visualization-tools.md +++ b/content/influxdb3/clustered/query-data/execute-queries/visualization-tools.md @@ -27,7 +27,7 @@ Use visualization tools to query data stored in {{% product-name %}} with SQL. The following visualization tools support querying InfluxDB with SQL: - [Grafana](/influxdb3/clustered/process-data/visualize/grafana/) -- [Power BI](/influxdb3/clustered/process-data/visualize/powerbi/) +- [Power BI](/influxdb3/clustered/visualize-data/powerbi/) - [Superset](/influxdb3/clustered/process-data/visualize/superset/) - [Tableau](/influxdb3/clustered/process-data/visualize/tableau/) From e1f83584e25fdd60189c8dbeb2487692decb8127 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Wed, 18 Mar 2026 11:25:49 -0500 Subject: [PATCH 25/27] fix(influxdb3): backfill missing product URLs in localStorage (#6961) * fix(influxdb3): backfill missing product URLs in localStorage Returning visitors with stale localStorage (created before core/enterprise products were added) had undefined URL values for new products. The updateUrls() function then replaced Hugo-rendered hostnames like localhost:8181 with the string "undefined" in api-endpoint blocks. Fix by merging DEFAULT_STORAGE_URLS as fallbacks when reading from localStorage, so new product keys are always present. closes #6960 https://claude.ai/code/session_01GJZ2yMR5DBk1feqTD5LeHW * test(influxdb3): add Cypress tests for localStorage URL backfill Adds 2 E2E tests for the fix in #6960: 1. Stale localStorage (missing `core` key) should not cause "undefined" to appear in api-endpoint or code blocks on the plugins page. 2. Fresh localStorage should be initialized with all expected product URL keys (oss, cloud, core, enterprise, serverless, dedicated, clustered). Run with: node cypress/support/run-e2e-specs.js --spec "cypress/e2e/influxdb-url.cy.js" --no-mapping https://claude.ai/code/session_01GJZ2yMR5DBk1feqTD5LeHW --------- Co-authored-by: Claude --- assets/js/services/local-storage.js | 9 ++-- cypress/e2e/influxdb-url.cy.js | 80 +++++++++++++++++++++++++++++ 2 files changed, 86 insertions(+), 3 deletions(-) create mode 100644 cypress/e2e/influxdb-url.cy.js diff --git a/assets/js/services/local-storage.js b/assets/js/services/local-storage.js index 8efccde12..22b778733 100644 --- a/assets/js/services/local-storage.js +++ b/assets/js/services/local-storage.js @@ -117,7 +117,10 @@ function getInfluxDBUrls() { initializeStorageItem('urls', JSON.stringify(DEFAULT_STORAGE_URLS)); } - return JSON.parse(localStorage.getItem(urlStorageKey)); + const storedUrls = JSON.parse(localStorage.getItem(urlStorageKey)); + // Backfill any new default keys missing from stored data (e.g., when new + // products like core/enterprise are added after a user's first visit). + return { ...DEFAULT_STORAGE_URLS, ...storedUrls }; } // Get the current or previous URL for a specific product or a custom url @@ -131,8 +134,8 @@ function getInfluxDBUrl(product) { const urlsString = localStorage.getItem(urlStorageKey); const urlsObj = JSON.parse(urlsString); - // Return the URL of the specified product - return urlsObj[product]; + // Return the URL of the specified product, falling back to the default + return urlsObj[product] ?? DEFAULT_STORAGE_URLS[product]; } /* diff --git a/cypress/e2e/influxdb-url.cy.js b/cypress/e2e/influxdb-url.cy.js new file mode 100644 index 000000000..7203e69d8 --- /dev/null +++ b/cypress/e2e/influxdb-url.cy.js @@ -0,0 +1,80 @@ +/// + +/** + * InfluxDB URL localStorage E2E Test Suite + * + * Tests that the InfluxDB URL replacement logic in influxdb-url.js handles + * localStorage correctly, including stale data from returning visitors. + * + * Regression tests for https://github.com/influxdata/docs-v2/issues/6960 + * where stale localStorage missing the `core` key caused JavaScript to + * replace rendered hostnames with "undefined" in code blocks. + */ + +const STORAGE_KEY = 'influxdata_docs_urls'; +const TEST_PAGE = '/influxdb3/core/plugins/'; +const EXPECTED_PRODUCT_KEYS = [ + 'oss', + 'cloud', + 'core', + 'enterprise', + 'serverless', + 'dedicated', + 'clustered', +]; + +describe('InfluxDB URL - localStorage', function () { + it('should not render "undefined" in code blocks when localStorage is missing product keys', function () { + // Simulate a returning visitor whose localStorage was created before + // core/enterprise products were added — missing those keys entirely. + const staleUrls = { + oss: 'http://localhost:8086', + cloud: 'https://us-west-2-1.aws.cloud2.influxdata.com', + prev_oss: 'http://localhost:8086', + prev_cloud: 'https://us-west-2-1.aws.cloud2.influxdata.com', + custom: '', + }; + + cy.visit(TEST_PAGE, { + onBeforeLoad(win) { + win.localStorage.setItem(STORAGE_KEY, JSON.stringify(staleUrls)); + }, + }); + + // The api-endpoint block should show the default Core host, not "undefined" + cy.get('.article--content pre.api-endpoint') + .first() + .should('contain', 'localhost:8181') + .and('not.contain', 'undefined'); + + // No code block in the article should contain "undefined" as a bare host + cy.get('.article--content pre:not(.preserve)').each(($el) => { + cy.wrap($el).invoke('text').should('not.match', /undefined\/api\//); + }); + }); + + it('should backfill all expected product URL keys into localStorage', function () { + cy.visit(TEST_PAGE, { + onBeforeLoad(win) { + // Start with no stored URLs — forces initialization + win.localStorage.removeItem(STORAGE_KEY); + }, + }); + + // After the page loads and JS initializes, localStorage should contain + // all expected product keys with non-empty URL values. + cy.window().then((win) => { + const stored = JSON.parse(win.localStorage.getItem(STORAGE_KEY)); + expect(stored).to.be.an('object'); + + EXPECTED_PRODUCT_KEYS.forEach((key) => { + expect(stored, `stored URLs should have key "${key}"`).to.have.property( + key + ); + expect(stored[key], `"${key}" should be a non-empty string`).to.be.a( + 'string' + ).and.not.be.empty; + }); + }); + }); +}); From 04f6b973bc311a551a925f2e185cf0dc9a0746c5 Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Wed, 18 Mar 2026 16:09:00 -0500 Subject: [PATCH 26/27] Remove `>` CLI prompts from runnable code blocks in InfluxQL/Flux/MongoDB docs (#6948) * Initial plan * fix(docs): remove > prompt from runnable code blocks Remove leading `>` CLI prompt characters from code blocks that are meant to be executed by users. Only keep `>` in code blocks that demonstrate console output (showing both the command at the prompt AND the result output). Changes affect 34 files across InfluxDB v1, Enterprise InfluxDB, shared influxql-v3 reference, and Telegraf content: - InfluxQL queries and management commands (sql/bash/no-lang blocks) - Flux REPL examples (js blocks) - MongoDB shell commands (shell blocks) Preserved (unchanged): - Console session blocks showing command + output (Type B: mixed > and non-> lines) - Telegraf metric output blocks (text language with > measurement,tags format) - diff blocks with < and > diff markers Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> * Apply suggestions from code review * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * Apply suggestions from code review * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * Update content/enterprise_influxdb/v1/query_language/continuous_queries.md --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> Co-authored-by: Jason Stirnaman Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --- .../manage/clusters/rebalance.md | 4 +- .../authorization-influxql.md | 22 +++---- .../v1/flux/get-started/syntax-basics.md | 8 +-- .../v1/guides/downsample_and_retain.md | 6 +- .../v1/query_language/continuous_queries.md | 3 +- .../v1/query_language/explore-data.md | 25 ++++---- .../v1/query_language/manage-database.md | 58 +++++++++---------- .../v1/query_language/sample-data.md | 6 +- .../v1/query_language/spec.md | 2 +- .../v1/tools/influx-cli/use-influx-cli.md | 4 +- .../v1/troubleshooting/errors.md | 12 ++-- .../frequently-asked-questions.md | 18 +++--- .../line_protocol_reference.md | 22 +++---- .../write_protocols/line_protocol_tutorial.md | 6 +- .../authentication_and_authorization.md | 36 ++++++------ .../v1/flux/get-started/syntax-basics.md | 8 +-- .../v1/guides/downsample_and_retain.md | 6 +- .../v1/introduction/get-started/_index.md | 12 ++-- .../v1/query_language/continuous_queries.md | 4 +- .../v1/query_language/explore-data.md | 26 ++++----- .../v1/query_language/manage-database.md | 52 ++++++++--------- .../influxdb/v1/query_language/sample-data.md | 4 +- content/influxdb/v1/query_language/spec.md | 2 +- .../v1/tools/influx-cli/use-influx-cli.md | 4 +- content/influxdb/v1/troubleshooting/errors.md | 12 ++-- .../frequently-asked-questions.md | 18 +++--- .../line_protocol_reference.md | 22 +++---- .../write_protocols/line_protocol_tutorial.md | 6 +- .../upgrade/v1-to-v2/automatic-upgrade.md | 4 +- .../explore-data/time-and-timezone.md | 2 +- .../query-data/influxql/manage-data.md | 4 +- .../reference/syntax/influxql/spec.md | 2 +- .../shared/influxql-v3-reference/_index.md | 2 +- .../v1/input-plugins/mongodb/_index.md | 2 +- 34 files changed, 211 insertions(+), 213 deletions(-) diff --git a/content/enterprise_influxdb/v1/administration/manage/clusters/rebalance.md b/content/enterprise_influxdb/v1/administration/manage/clusters/rebalance.md index 020133649..75bc3778c 100644 --- a/content/enterprise_influxdb/v1/administration/manage/clusters/rebalance.md +++ b/content/enterprise_influxdb/v1/administration/manage/clusters/rebalance.md @@ -289,8 +289,8 @@ Run the query on any data node for each retention policy and database. Here, we use InfluxDB's [CLI](/enterprise_influxdb/v1/tools/influx-cli/use-influx/) to execute the query: ``` -> ALTER RETENTION POLICY "" ON "" REPLICATION 3 -> +ALTER RETENTION POLICY "" ON "" REPLICATION 3 + ``` A successful `ALTER RETENTION POLICY` query returns no results. diff --git a/content/enterprise_influxdb/v1/administration/manage/users-and-permissions/authorization-influxql.md b/content/enterprise_influxdb/v1/administration/manage/users-and-permissions/authorization-influxql.md index f9bcf1bf6..a132289b7 100644 --- a/content/enterprise_influxdb/v1/administration/manage/users-and-permissions/authorization-influxql.md +++ b/content/enterprise_influxdb/v1/administration/manage/users-and-permissions/authorization-influxql.md @@ -124,11 +124,11 @@ CREATE USER WITH PASSWORD '' ###### CLI example ```js -> CREATE USER todd WITH PASSWORD 'influxdb41yf3' -> CREATE USER alice WITH PASSWORD 'wonder\'land' -> CREATE USER "rachel_smith" WITH PASSWORD 'asdf1234!' -> CREATE USER "monitoring-robot" WITH PASSWORD 'XXXXX' -> CREATE USER "$savyadmin" WITH PASSWORD 'm3tr1cL0v3r' +CREATE USER todd WITH PASSWORD 'influxdb41yf3' +CREATE USER alice WITH PASSWORD 'wonder\'land' +CREATE USER "rachel_smith" WITH PASSWORD 'asdf1234!' +CREATE USER "monitoring-robot" WITH PASSWORD 'XXXXX' +CREATE USER "$savyadmin" WITH PASSWORD 'm3tr1cL0v3r' ``` {{% note %}} @@ -169,13 +169,13 @@ CLI examples: `GRANT` `READ` access to `todd` on the `NOAA_water_database` database: ```sql -> GRANT READ ON "NOAA_water_database" TO "todd" +GRANT READ ON "NOAA_water_database" TO "todd" ``` `GRANT` `ALL` access to `todd` on the `NOAA_water_database` database: ```sql -> GRANT ALL ON "NOAA_water_database" TO "todd" +GRANT ALL ON "NOAA_water_database" TO "todd" ``` ##### `REVOKE` `READ`, `WRITE`, or `ALL` database privileges from an existing user @@ -189,13 +189,13 @@ CLI examples: `REVOKE` `ALL` privileges from `todd` on the `NOAA_water_database` database: ```sql -> REVOKE ALL ON "NOAA_water_database" FROM "todd" +REVOKE ALL ON "NOAA_water_database" FROM "todd" ``` `REVOKE` `WRITE` privileges from `todd` on the `NOAA_water_database` database: ```sql -> REVOKE WRITE ON "NOAA_water_database" FROM "todd" +REVOKE WRITE ON "NOAA_water_database" FROM "todd" ``` {{% note %}} @@ -230,7 +230,7 @@ SET PASSWORD FOR = '' CLI example: ```sql -> SET PASSWORD FOR "todd" = 'password4todd' +SET PASSWORD FOR "todd" = 'password4todd' ``` {{% note %}} @@ -250,6 +250,6 @@ DROP USER CLI example: ```sql -> DROP USER "todd" +DROP USER "todd" ``` diff --git a/content/enterprise_influxdb/v1/flux/get-started/syntax-basics.md b/content/enterprise_influxdb/v1/flux/get-started/syntax-basics.md index e48c0b79b..710cbb2bb 100644 --- a/content/enterprise_influxdb/v1/flux/get-started/syntax-basics.md +++ b/content/enterprise_influxdb/v1/flux/get-started/syntax-basics.md @@ -28,9 +28,9 @@ For example, simple addition: Assign an expression to a variable using the assignment operator, `=`. ```js -> s = "this is a string" -> i = 1 // an integer -> f = 2.0 // a floating point number +s = "this is a string" +i = 1 // an integer +f = 2.0 // a floating point number ``` Type the name of a variable to print its value: @@ -48,7 +48,7 @@ this is a string Flux also supports records. Each value in a record can be a different data type. ```js -> o = {name:"Jim", age: 42, "favorite color": "red"} +o = {name:"Jim", age: 42, "favorite color": "red"} ``` Use **dot notation** to access a properties of a record: diff --git a/content/enterprise_influxdb/v1/guides/downsample_and_retain.md b/content/enterprise_influxdb/v1/guides/downsample_and_retain.md index c544c276e..81c4238fd 100644 --- a/content/enterprise_influxdb/v1/guides/downsample_and_retain.md +++ b/content/enterprise_influxdb/v1/guides/downsample_and_retain.md @@ -70,7 +70,7 @@ the CQ has no `FOR` clause. #### 1. Create the database ```sql -> CREATE DATABASE "food_data" +CREATE DATABASE "food_data" ``` #### 2. Create a two-hour `DEFAULT` retention policy @@ -85,7 +85,7 @@ Use the statement to create a `DEFAULT` RP: ```sql -> CREATE RETENTION POLICY "two_hours" ON "food_data" DURATION 2h REPLICATION 1 DEFAULT +CREATE RETENTION POLICY "two_hours" ON "food_data" DURATION 2h REPLICATION 1 DEFAULT ``` That query creates an RP called `two_hours` that exists in the database @@ -116,7 +116,7 @@ Use the statement to create a non-`DEFAULT` retention policy: ```sql -> CREATE RETENTION POLICY "a_year" ON "food_data" DURATION 52w REPLICATION 1 +CREATE RETENTION POLICY "a_year" ON "food_data" DURATION 52w REPLICATION 1 ``` That query creates a retention policy (RP) called `a_year` that exists in the database diff --git a/content/enterprise_influxdb/v1/query_language/continuous_queries.md b/content/enterprise_influxdb/v1/query_language/continuous_queries.md index 1ca7d56b7..76cb98168 100644 --- a/content/enterprise_influxdb/v1/query_language/continuous_queries.md +++ b/content/enterprise_influxdb/v1/query_language/continuous_queries.md @@ -839,8 +839,7 @@ DROP CONTINUOUS QUERY ON Drop the `idle_hands` CQ from the `telegraf` database: ```sql -> DROP CONTINUOUS QUERY "idle_hands" ON "telegraf"` -> +DROP CONTINUOUS QUERY "idle_hands" ON "telegraf" ``` ### Altering continuous queries diff --git a/content/enterprise_influxdb/v1/query_language/explore-data.md b/content/enterprise_influxdb/v1/query_language/explore-data.md index a4b880ed7..1cf896f9b 100644 --- a/content/enterprise_influxdb/v1/query_language/explore-data.md +++ b/content/enterprise_influxdb/v1/query_language/explore-data.md @@ -380,8 +380,7 @@ The following query returns no data because it specifies a single tag key (`loca the `SELECT` clause: ```sql -> SELECT "location" FROM "h2o_feet" -> +SELECT "location" FROM "h2o_feet" ``` To return any data associated with the `location` tag key, the query's `SELECT` @@ -597,7 +596,7 @@ separating logic with parentheses. #### Select data that have specific timestamps ```sql -> SELECT * FROM "h2o_feet" WHERE time > now() - 7d +SELECT * FROM "h2o_feet" WHERE time > now() - 7d ``` The query returns data from the `h2o_feet` measurement that have [timestamps](/enterprise_influxdb/v1/concepts/glossary/#timestamp) @@ -1592,8 +1591,8 @@ the query's time range. Note that `fill(800)` has no effect on the query results. ```sql -> SELECT MEAN("water_level") FROM "h2o_feet" WHERE "location" = 'coyote_creek' AND time >= '2015-09-18T22:00:00Z' AND time <= '2015-09-18T22:18:00Z' GROUP BY time(12m) fill(800) -> +SELECT MEAN("water_level") FROM "h2o_feet" WHERE "location" = 'coyote_creek' AND time >= '2015-09-18T22:00:00Z' AND time <= '2015-09-18T22:18:00Z' GROUP BY time(12m) fill(800) + ``` ##### Queries with `fill(previous)` when the previous result falls outside the query's time range @@ -2639,7 +2638,7 @@ The whitespace between `-` or `+` and the [duration literal](/enterprise_influxd #### Specify a time range with relative time ```sql -> SELECT "water_level" FROM "h2o_feet" WHERE time > now() - 1h +SELECT "water_level" FROM "h2o_feet" WHERE time > now() - 1h ``` The query returns data with timestamps that occur within the past hour. @@ -2686,7 +2685,7 @@ a `GROUP BY time()` clause must provide an alternative upper bound in the Use the [CLI](/enterprise_influxdb/v1/tools/influx-cli/use-influx/) to write a point to the `NOAA_water_database` that occurs after `now()`: ```sql -> INSERT h2o_feet,location=santa_monica water_level=3.1 1587074400000000000 +INSERT h2o_feet,location=santa_monica water_level=3.1 1587074400000000000 ``` Run a `GROUP BY time()` query that covers data with timestamps between @@ -2722,8 +2721,8 @@ the lower bound to `now()` such that the query's time range is between `now()` and `now()`: ```sql -> SELECT MEAN("water_level") FROM "h2o_feet" WHERE "location"='santa_monica' AND time >= now() GROUP BY time(12m) fill(none) -> +SELECT MEAN("water_level") FROM "h2o_feet" WHERE "location"='santa_monica' AND time >= now() GROUP BY time(12m) fill(none) + ``` ### Configuring the returned timestamps @@ -2831,8 +2830,8 @@ includes an `m` and `water_level` is greater than three. #### Use a regular expression to specify a tag with no value in the WHERE clause ```sql -> SELECT * FROM "h2o_feet" WHERE "location" !~ /./ -> +SELECT * FROM "h2o_feet" WHERE "location" !~ /./ + ``` The query selects all data from the `h2o_feet` measurement where the `location` @@ -2989,8 +2988,8 @@ The query returns the integer form of `water_level`'s float [field values](/ente #### Cast float field values to strings (this functionality is not supported) ```sql -> SELECT "water_level"::string FROM "h2o_feet" LIMIT 4 -> +SELECT "water_level"::string FROM "h2o_feet" LIMIT 4 + ``` The query returns no data as casting a float field value to a string is not diff --git a/content/enterprise_influxdb/v1/query_language/manage-database.md b/content/enterprise_influxdb/v1/query_language/manage-database.md index d57aa6efd..45b5848fe 100644 --- a/content/enterprise_influxdb/v1/query_language/manage-database.md +++ b/content/enterprise_influxdb/v1/query_language/manage-database.md @@ -87,8 +87,8 @@ If you attempt to create a database that already exists, InfluxDB does nothing a ##### Create a database ``` -> CREATE DATABASE "NOAA_water_database" -> +CREATE DATABASE "NOAA_water_database" + ``` The query creates a database called `NOAA_water_database`. @@ -97,8 +97,8 @@ The query creates a database called `NOAA_water_database`. ##### Create a database with a specific retention policy ``` -> CREATE DATABASE "NOAA_water_database" WITH DURATION 3d REPLICATION 1 SHARD DURATION 1h NAME "liquid" -> +CREATE DATABASE "NOAA_water_database" WITH DURATION 3d REPLICATION 1 SHARD DURATION 1h NAME "liquid" + ``` The query creates a database called `NOAA_water_database`. @@ -114,8 +114,8 @@ DROP DATABASE Drop the database NOAA_water_database: ```bash -> DROP DATABASE "NOAA_water_database" -> +DROP DATABASE "NOAA_water_database" + ``` A successful `DROP DATABASE` query returns an empty result. @@ -135,19 +135,19 @@ DROP SERIES FROM WHERE =' DROP SERIES FROM "h2o_feet" +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 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' +DROP SERIES WHERE "location" = 'santa_monica' ``` A successful `DROP SERIES` query returns an empty result. @@ -168,25 +168,25 @@ DELETE FROM WHERE [=''] | [