diff --git a/content/influxdb3/cloud-dedicated/guides/api-compatibility/v1/_index.md b/content/influxdb3/cloud-dedicated/guides/api-compatibility/v1/_index.md index 8861c1bdbd..0a8264bca0 100644 --- a/content/influxdb3/cloud-dedicated/guides/api-compatibility/v1/_index.md +++ b/content/influxdb3/cloud-dedicated/guides/api-compatibility/v1/_index.md @@ -78,7 +78,7 @@ username and password to authenticate database reads and writes by passing a When authenticating requests to the v1 API `/write` and `/query` endpoints, {{% product-name %}} checks that the `password` (`p`) value is an authorized [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens). {{% product-name %}} ignores the `username` (`u`) parameter in the request. -Use one of the following authentication schemes with clients that support Basic authentication or query parameters (that don't support [token authentication](#authenticate-with-a-token)): +Use one of the following authentication schemes with clients that support Basic authentication or query parameters (that don't support [token authentication](#authenticate-with-a-token-scheme)): - [Basic authentication](#basic-authentication) - [Query string authentication](#query-string-authentication) @@ -260,7 +260,7 @@ Write data with your existing workloads that already use the InfluxDB v1 or v1.x {{% api-endpoint endpoint="https://{{< influxdb/host >}}/write" method="post" %}} -- [`/api/v2/write` parameters](#v1-api-write-parameters) +- [`/write` parameters](#v1-api-write-parameters) - [Tools for writing to the v1 API](#tools-for-writing-to-the-v1-api) #### v1 API /write parameters @@ -302,7 +302,7 @@ The following tools work with the {{% product-name %}} `/write` endpoint: #### Telegraf If you have existing v1 workloads that use Telegraf, -you can use the [InfluxDB v1.x `influxdb` Telegraf output plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) to write data. +you can use the [InfluxDB v1.x `influxdb` Telegraf output plugin](/telegraf/v1/output-plugins/influxdb/) to write data. > [!Note] > See how to [use Telegraf and the v2 API](/influxdb3/cloud-dedicated/write-data/use-telegraf/) for new workloads that don't already use the v1 API. @@ -344,7 +344,7 @@ Replace the following: `influx_uint_support`: supported in InfluxDB 3. -For more plugin options, see [`influxdb`](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) on GitHub. +For more plugin options, see [`influxdb`](/telegraf/v1/output-plugins/influxdb/) on GitHub. #### Interactive clients @@ -355,7 +355,7 @@ Include the following in your request: - A `db` query string parameter with the name of the database to write to. - A request body that contains a string of data in [line protocol](/influxdb3/cloud-dedicated/reference/syntax/line-protocol/) syntax. - A [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) in - one of the following authentication schemes: [Basic authentication](#basic-authentication), [query string authentication](#query-string-authentication), or [token authentication](#authenticate-with-a-token). + one of the following authentication schemes: [Basic authentication](#basic-authentication), [query string authentication](#query-string-authentication), or [token authentication](#authenticate-with-a-token-scheme). - Optional [parameters](#v1-api-write-parameters). The following example shows how to use the **cURL** command line tool and the {{% product-name %}} v1 API to write line protocol data to a database: diff --git a/content/influxdb3/cloud-dedicated/write-data/csv/telegraf.md b/content/influxdb3/cloud-dedicated/write-data/csv/telegraf.md index 729840361b..509c2daea6 100644 --- a/content/influxdb3/cloud-dedicated/write-data/csv/telegraf.md +++ b/content/influxdb3/cloud-dedicated/write-data/csv/telegraf.md @@ -69,7 +69,7 @@ metrics from different sources and writes them to specified destinations. ## Configure Telegraf to write to InfluxDB To send data to {{< product-name >}}, enable the -[`influxdb_v2` output plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb_v2/README.md) +[`influxdb_v2` output plugin](/telegraf/v1/output-plugins/influxdb_v2/) in the `telegraf.conf`. {{% code-placeholders "DATABASE_NAME" %}} @@ -145,4 +145,4 @@ The preceding examples describe Telegraf configurations necessary for writing to The output plugin provides several other options for configuring the Telegraf client: - `influx_uint_support`: supported by the InfluxDB 3 storage engine. -- See [`influxdb_v2` plugin options](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb_v2/README.md) on GitHub. +- See [`influxdb_v2` plugin options](/telegraf/v1/output-plugins/influxdb_v2/) on GitHub. diff --git a/content/influxdb3/cloud-dedicated/write-data/use-telegraf/configure/_index.md b/content/influxdb3/cloud-dedicated/write-data/use-telegraf/configure/_index.md index 3f7181e7da..a9e4b7b598 100644 --- a/content/influxdb3/cloud-dedicated/write-data/use-telegraf/configure/_index.md +++ b/content/influxdb3/cloud-dedicated/write-data/use-telegraf/configure/_index.md @@ -67,7 +67,7 @@ To add any of the available [Telegraf plugins](/telegraf/v1/plugins/), follow th ### Enable and configure the InfluxDB v2 output plugin To send data to {{< product-name >}}, enable the -[`influxdb_v2` output plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb_v2/README.md) +[`influxdb_v2` output plugin](/telegraf/v1/output-plugins/influxdb_v2/) in the `telegraf.conf`. {{% code-placeholders "DATABASE_NAME" %}} @@ -124,7 +124,7 @@ The name of the {{% product-name %}} database to write data to. `influx_uint_support`: supported in InfluxDB 3. -For more plugin options, see [`influxdb`](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) on GitHub. +For more plugin options, see [`influxdb`](/telegraf/v1/output-plugins/influxdb/) on GitHub. ## Start Telegraf diff --git a/content/influxdb3/cloud-serverless/guides/api-compatibility/v1/_index.md b/content/influxdb3/cloud-serverless/guides/api-compatibility/v1/_index.md index 88d24f7a81..be12caec23 100644 --- a/content/influxdb3/cloud-serverless/guides/api-compatibility/v1/_index.md +++ b/content/influxdb3/cloud-serverless/guides/api-compatibility/v1/_index.md @@ -64,7 +64,7 @@ username and password to authenticate bucket reads and writes by passing an [API When authenticating requests to the v1 API `/write` and `/query` endpoints, {{% product-name %}} checks that the `password` (`p`) value is an authorized [API token](/influxdb3/cloud-serverless/admin/tokens/). {{% product-name %}} ignores the `username` (`u`) parameter in the request. -Use one of the following authentication schemes with clients that support Basic authentication or query parameters (that don't support [token authentication](#authenticate-with-a-token)): +Use one of the following authentication schemes with clients that support Basic authentication or query parameters (that don't support [token authentication](#authenticate-with-a-token-scheme)): - [Basic authentication](#basic-authentication) - [Query string authentication](#query-string-authentication) @@ -144,8 +144,8 @@ curl --get "https://{{< influxdb/host >}}/query" \ Replace the following: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the [database](#map-databases-and-retention-policies-to-buckets) -- {{% code-placeholder-key %}}`RETENTION_POLICY`{{% /code-placeholder-key %}}: the [retention policy](#map-databases-and-retention-policies-to-buckets) +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the [database](#map-v1-databases-and-retention-policies-to-buckets) +- {{% code-placeholder-key %}}`RETENTION_POLICY`{{% /code-placeholder-key %}}: the [retention policy](#map-v1-databases-and-retention-policies-to-buckets) - {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) with sufficient permissions to the mapped bucket ### Authenticate with a token scheme @@ -187,8 +187,8 @@ influx bucket delete -n DATABASE_NAME/RETENTION_POLICY_NAME Replace the following: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the [database](#map-databases-and-retention-policies-to-buckets) -- {{% code-placeholder-key %}}`RETENTION_POLICY`{{% /code-placeholder-key %}}: the [retention policy](#map-databases-and-retention-policies-to-buckets) +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the [database](#map-v1-databases-and-retention-policies-to-buckets) +- {{% code-placeholder-key %}}`RETENTION_POLICY`{{% /code-placeholder-key %}}: the [retention policy](#map-v1-databases-and-retention-policies-to-buckets) - {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) with sufficient permissions to the mapped bucket ## Responses @@ -228,7 +228,7 @@ Response body messages may differ across {{% product-name %}} v1 API, v2 API, In ``` The `?precision=` parameter contains an unknown value. - Provide a [timestamp precision](#timestamp-precision). + Provide a [timestamp precision]/influxdb3/cloud-serverless/reference/glossary/#timestamp-precision). ## Map v1 databases and retention policies to buckets @@ -336,7 +336,7 @@ Include the following: {{< req type="key" >}} -- {{< req "\*" >}} a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization). +- {{< req "\*" >}} a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket. - {{< req "\*" >}} the **database name** to map - {{< req "\*" >}} the **retention policy** name to map - {{< req "\*" >}} the [bucket ID](/influxdb3/cloud-serverless/admin/buckets/view-buckets/#view-buckets-in-the-influxdb-ui) to map to @@ -376,7 +376,7 @@ influx v1 dbrp delete --id $test_dbrp Replace the following: -- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization) +- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the database name to map to the bucket - {{% code-placeholder-key %}}`RETENTION_POLICY_NAME`{{% /code-placeholder-key %}}: the retention policy name to map to the bucket - {{% code-placeholder-key %}}`BUCKET_ID`{{% /code-placeholder-key %}}: the [bucket ID](/influxdb3/cloud-serverless/admin/buckets/view-buckets/) to map to @@ -395,7 +395,7 @@ Include the following: - **Request method:** `POST` - **Headers:** - - **Authorization:** `Token` scheme with a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization) + - **Authorization:** `Token` scheme with a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket - **Content-type:** `application/json` - **Request body:** JSON object with the following fields: @@ -485,7 +485,7 @@ Include the following: - **Request method:** `GET` - **Headers:** - - **Authorization:** `Token` scheme with your [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization) + - **Authorization:** `Token` scheme with your [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket - **Query parameters:** {{< req type="key" >}} - {{< req "\*" >}} **orgID:** your [organization ID](/influxdb3/cloud-serverless/admin/organizations/view-orgs/#view-your-organization-id) @@ -545,7 +545,7 @@ Use the [`influx v1 dbrp update` command](/influxdb3/cloud-serverless/reference/ to update a DBRP mapping. Include the following: -- a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization) +- a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket - **DBRP mapping ID** to update - Optional: **Retention policy** name to update to - Optional: **Default flag** to set the retention policy as the [default DBRP mapping](#default-dbrp) for the database name. @@ -577,7 +577,7 @@ influx v1 dbrp update \ Replace the following: -- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization) +- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket - {{% code-placeholder-key %}}`DBRP_ID`{{% /code-placeholder-key %}}: the DBRP ID to update - {{% code-placeholder-key %}}`RETENTION_POLICY_NAME`{{% /code-placeholder-key %}}: a retention policy name to map to the bucket @@ -596,7 +596,7 @@ Include the following: - **Request method:** `PATCH` - **Headers:** - - {{< req "\*" >}} the **Authorization:** `Token` scheme with a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization) + - {{< req "\*" >}} the **Authorization:** `Token` scheme with a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket - **Path parameters:** - {{< req "\*" >}} **id:** the DBRP mapping ID to update - **Query parameters:** @@ -622,7 +622,7 @@ curl --request PATCH \ Replace the following: -- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization) +- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket - {{% code-placeholder-key %}}`DBRP_ID`{{% /code-placeholder-key %}}: the DBRP ID to update - {{% code-placeholder-key %}}`RETENTION_POLICY_NAME`{{% /code-placeholder-key %}}: a retention policy name to map to the bucket @@ -648,7 +648,7 @@ Include the following: {{< req type="key" >}} -- {{< req "\*" >}} a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization) +- {{< req "\*" >}} a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket - {{< req "\*" >}} **DBRP mapping ID** to delete @@ -689,7 +689,7 @@ Include the following: - **Request method:** `DELETE` - **Headers:** - - {{< req "\*" >}} the **Authorization:** `Token` scheme with a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization) + - {{< req "\*" >}} the **Authorization:** `Token` scheme with a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket - **Path parameters:** - {{< req "\*" >}} **id:** DBRP mapping ID to update - **Query parameters:** @@ -708,7 +708,7 @@ curl --request DELETE \ Replace the following: -- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization) +- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket - {{% code-placeholder-key %}}`DBRP_ID`{{% /code-placeholder-key %}}: the DBRP ID to update - {{% code-placeholder-key %}}`ORG_ID`{{% /code-placeholder-key %}}: the [organization ID](/influxdb3/cloud-serverless/admin/organizations/view-orgs/#view-your-organization-id) diff --git a/content/influxdb3/cloud-serverless/write-data/api/v1-http.md b/content/influxdb3/cloud-serverless/write-data/api/v1-http.md index 0f0088dd92..fd3393215b 100644 --- a/content/influxdb3/cloud-serverless/write-data/api/v1-http.md +++ b/content/influxdb3/cloud-serverless/write-data/api/v1-http.md @@ -26,18 +26,18 @@ list_code_example: | Use the InfluxDB v1 HTTP API `/write` endpoint and InfluxQL to write data stored in {{< product-name >}}. The `/write` endpoint provides compatibility for InfluxDB 1.x workloads that you bring to InfluxDB 3. -_The v1 write and query APIs require [mapping databases and retention policies to buckets](#map-databases-and-retention-policies-to-buckets)._ +_The v1 write and query APIs require [mapping databases and retention policies to buckets](#map-v1-databases-and-retention-policies-to-buckets)._ -- [Map databases and retention policies to buckets](#map-databases-and-retention-policies-to-buckets) +- [Map v1 databases and retention policies to buckets](#map-v1-databases-and-retention-policies-to-buckets) - [Autogenerate a bucket and DBRP mapping](#autogenerate-a-bucket-and-dbrp-mapping) - [Create a bucket and DBRP mapping](#create-a-bucket-and-dbrp-mapping) - [Write to the v1 HTTP `/write` endpoint](#write-to-the-v1-http-write-endpoint) - - [Parameters](#parameters) + - [Parameters](#v1-api-write-parameters) - [Data](#data) - [Authorization](#authorization) - [Tools for writing to the v1 API](#tools-for-writing-to-the-v1-api) -## Map databases and retention policies to buckets +## Map v1 databases and retention policies to buckets The v1 write and query APIs require mapping databases and retention policies to buckets. @@ -53,7 +53,7 @@ To let InfluxDB autogenerate a bucket and an associated DBRP mapping, pass the f If no bucket exists with the name `DATABASE_NAME/RETENTION_POLICY_NAME`, InfluxDB creates a bucket and a DBRP before writing the data to the bucket. -To learn more about DBRP mapping, see the [v1 API compatibility guide](/influxdb3/cloud-serverless/guides/api-compatibility/v1/#map-v1-databases-and-retention-policies-to-buckets). +To learn more about DBRP mapping, see the [v1 API compatibility guide](#map-v1-databases-and-retention-policies-to-buckets). ### Create a bucket and DBRP mapping @@ -69,19 +69,19 @@ If the `db=DATABASE_NAME` and `rp=RETENTION_POLICY` parameters in your `/write` {{% api-endpoint endpoint="https://{{< influxdb/host >}}/write" method="post" %}} -- [`/api/v2/write` parameters](#v1-api-write-parameters) +- [`/write` parameters](#v1-api-write-parameters) - [Tools for writing to the v1 API](#tools-for-writing-to-the-v1-api) -### Parameters +### v1 API /write parameters For {{% product-name %}} v1 API `/write` requests, set parameters as listed in the following table: Parameter | Allowed in | Ignored | Value -----------------------|--------------|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- `consistency` | Query string | Ignored | N/A -`db` {{% req " \*" %}} | Query string | Honored | Database (see how to [map databases and retention policies to buckets](#map-databases-and-retention-policies-to-buckets)) +`db` {{% req " \*" %}} | Query string | Honored | Database (see how to [map databases and retention policies to buckets](#map-v1-databases-and-retention-policies-to-buckets)) `precision` | Query string | Honored | [Timestamp precision](#timestamp-precision) -`rp` | Query string | Honored | Retention policy (see how to [map databases and retention policies to buckets](#map-databases-and-retention-policies-to-buckets)) +`rp` | Query string | Honored | Retention policy (see how to [map databases and retention policies to buckets](#map-v1-databases-and-retention-policies-to-buckets)) [`Authorization` header or `u` and `p`](#authorization) | | | [Token](#authorization) {{% caption %}}{{% req " \*" %}} = {{% req "Required" %}}{{% /caption %}} @@ -121,7 +121,7 @@ The following tools work with the {{% product-name %}} `/write` endpoint: #### Telegraf If you have existing v1 workloads that use Telegraf, -you can use the [InfluxDB v1.x `influxdb` Telegraf output plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) to write data. +you can use the [InfluxDB v1.x `influxdb` Telegraf output plugin](/telegraf/v1/output-plugins/influxdb/) to write data. > [!Note] > See how to [use Telegraf and the v2 API](/influxdb3/cloud-serverless/write-data/use-telegraf/) for new workloads that don't already use the v1 API. @@ -154,15 +154,15 @@ To configure the v1.x output plugin for writing to {{% product-name %}}, add the Replace the following: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the [database](#map-databases-and-retention-policies-to-buckets) -- {{% code-placeholder-key %}}`RETENTION_POLICY`{{% /code-placeholder-key %}}: the [retention policy](#map-databases-and-retention-policies-to-buckets) +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the [database](#map-v1-databases-and-retention-policies-to-buckets) +- {{% code-placeholder-key %}}`RETENTION_POLICY`{{% /code-placeholder-key %}}: the [retention policy](#map-v1-databases-and-retention-policies-to-buckets) - {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) with sufficient permissions to the mapped bucket ##### Other Telegraf configuration options `influx_uint_support`: supported in InfluxDB 3. -For more plugin options, see [`influxdb`](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) on GitHub. +For more plugin options, see [`influxdb`](/telegraf/v1/output-plugins/influxdb/) on GitHub. #### Interactive clients @@ -212,8 +212,8 @@ curl -i "https://{{< influxdb/host >}}/write?db=DATABASE_NAME&rp=RETENTION_POLIC Replace the following: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the [database](#map-databases-and-retention-policies-to-buckets) -- {{% code-placeholder-key %}}`RETENTION_POLICY`{{% /code-placeholder-key %}}: the [retention policy](#map-databases-and-retention-policies-to-buckets) +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the [database](#map-v1-databases-and-retention-policies-to-buckets) +- {{% code-placeholder-key %}}`RETENTION_POLICY`{{% /code-placeholder-key %}}: the [retention policy](#map-v1-databases-and-retention-policies-to-buckets) - {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) with sufficient permissions to the mapped bucket #### v1 influx CLI (not supported) @@ -287,6 +287,6 @@ client = InfluxDBClient( Replace the following: -- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the [database](#map-databases-and-retention-policies-to-buckets) -- {{% code-placeholder-key %}}`RETENTION_POLICY`{{% /code-placeholder-key %}}: the [retention policy](#map-databases-and-retention-policies-to-buckets) +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the [database](#map-v1-databases-and-retention-policies-to-buckets) +- {{% code-placeholder-key %}}`RETENTION_POLICY`{{% /code-placeholder-key %}}: the [retention policy](#map-v1-databases-and-retention-policies-to-buckets) - {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) with sufficient permissions to the specified bucket diff --git a/content/influxdb3/cloud-serverless/write-data/csv/telegraf.md b/content/influxdb3/cloud-serverless/write-data/csv/telegraf.md index 4081bd21b1..c2ed95914c 100644 --- a/content/influxdb3/cloud-serverless/write-data/csv/telegraf.md +++ b/content/influxdb3/cloud-serverless/write-data/csv/telegraf.md @@ -69,7 +69,7 @@ metrics from different sources and writes them to specified destinations. ## Configure Telegraf to write to InfluxDB To send data to {{< product-name >}}, enable the -[`influxdb_v2` output plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb_v2/README.md) +[`influxdb_v2` output plugin](/telegraf/v1/output-plugins/influxdb_v2/) in the `telegraf.conf`. {{% code-placeholders "BUCKET_NAME" %}} @@ -145,4 +145,4 @@ The preceding examples describe Telegraf configurations necessary for writing to The output plugin provides several other options for configuring the Telegraf client: - `influx_uint_support`: supported by the InfluxDB 3 storage engine. -- See [`influxdb_v2` plugin options](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb_v2/README.md) on GitHub. \ No newline at end of file +- See [`influxdb_v2` plugin options](/telegraf/v1/output-plugins/influxdb_v2/) on GitHub. \ No newline at end of file diff --git a/content/influxdb3/cloud-serverless/write-data/use-telegraf/configure/_index.md b/content/influxdb3/cloud-serverless/write-data/use-telegraf/configure/_index.md index 2e45a57e03..927925883b 100644 --- a/content/influxdb3/cloud-serverless/write-data/use-telegraf/configure/_index.md +++ b/content/influxdb3/cloud-serverless/write-data/use-telegraf/configure/_index.md @@ -66,7 +66,7 @@ To add any of the available [Telegraf plugins](/telegraf/v1/plugins/), follow th ### Enable and configure the InfluxDB v2 output plugin To send data to {{< product-name >}}, enable the -[`influxdb_v2` output plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb_v2/README.md) +[`influxdb_v2` output plugin](/telegraf/v1/output-plugins/influxdb_v2/) in the `telegraf.conf`. {{% code-placeholders "BUCKET_NAME" %}} diff --git a/content/influxdb3/clustered/guides/api-compatibility/v1/_index.md b/content/influxdb3/clustered/guides/api-compatibility/v1/_index.md index 924dc28459..62c2ba811a 100644 --- a/content/influxdb3/clustered/guides/api-compatibility/v1/_index.md +++ b/content/influxdb3/clustered/guides/api-compatibility/v1/_index.md @@ -76,7 +76,7 @@ username and password to authenticate database reads and writes by passing a [da When authenticating requests to the v1 API `/write` and `/query` endpoints, {{% product-name %}} checks that the `password` (`p`) value is an authorized [database token](/influxdb3/clustered/admin/tokens/#database-tokens). {{% product-name %}} ignores the `username` (`u`) parameter in the request. -Use one of the following authentication schemes with clients that support Basic authentication or query parameters (that don't support [token authentication](#authenticate-with-a-token)): +Use one of the following authentication schemes with clients that support Basic authentication or query parameters (that don't support [token authentication](#authenticate-with-a-token-scheme)): - [Basic authentication](#basic-authentication) - [Query string authentication](#query-string-authentication) @@ -246,7 +246,7 @@ Write data with your existing workloads that already use the InfluxDB v1 or v1.x {{% api-endpoint endpoint="https://{{< influxdb/host >}}/write" method="post" %}} -- [`/api/v2/write` parameters](#v1-api-write-parameters) +- [`/write` parameters](#v1-api-write-parameters) - [Tools for writing to the v1 API](#tools-for-writing-to-the-v1-api) #### v1 API /write parameters @@ -288,7 +288,7 @@ The following tools work with the {{% product-name %}} `/write` endpoint: #### Telegraf If you have existing v1 workloads that use Telegraf, -you can use the [InfluxDB v1.x `influxdb` Telegraf output plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) to write data. +you can use the [InfluxDB v1.x `influxdb` Telegraf output plugin](/telegraf/v1/output-plugins/influxdb/) to write data. > [!Note] > See how to [use Telegraf and the v2 API](/influxdb3/clustered/write-data/use-telegraf/) for new workloads that don't already use the v1 API. @@ -328,7 +328,7 @@ Replace the following: `influx_uint_support`: supported in InfluxDB 3. -For more plugin options, see [`influxdb`](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) on GitHub. +For more plugin options, see [`influxdb`](/telegraf/v1/output-plugins/influxdb/) on GitHub. #### Interactive clients @@ -338,7 +338,7 @@ Include the following in your request: - A `db` query string parameter with the name of the database to write to. - A request body that contains a string of data in [line protocol](/influxdb3/clustered/reference/syntax/line-protocol/) syntax. -- A [database token](/influxdb3/clustered/admin/tokens/#database-tokens) in one of the following authentication schemes: [Basic authentication](#basic-authentication), [query string authentication](#query-string-authentication), or [token authentication](#authenticate-with-a-token). +- A [database token](/influxdb3/clustered/admin/tokens/#database-tokens) in one of the following authentication schemes: [Basic authentication](#basic-authentication), [query string authentication](#query-string-authentication), or [token authentication](#authenticate-with-a-token-scheme). - Optional [parameters](#v1-api-write-parameters). The following example shows how to use the **cURL** command line tool and the {{% product-name %}} v1 API to write line protocol data to a database: diff --git a/content/influxdb3/clustered/write-data/csv/telegraf.md b/content/influxdb3/clustered/write-data/csv/telegraf.md index 5977d929e7..ced0fb91e9 100644 --- a/content/influxdb3/clustered/write-data/csv/telegraf.md +++ b/content/influxdb3/clustered/write-data/csv/telegraf.md @@ -69,7 +69,7 @@ metrics from different sources and writes them to specified destinations. ## Configure Telegraf to write to InfluxDB To send data to {{< product-name >}}, enable the -[`influxdb_v2` output plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb_v2/README.md) +[`influxdb_v2` output plugin](/telegraf/v1/output-plugins/influxdb_v2/) in the `telegraf.conf`. {{% code-placeholders "DATABASE_NAME" %}} @@ -145,4 +145,4 @@ The preceding examples describe Telegraf configurations necessary for writing to The output plugin provides several other options for configuring the Telegraf client: - `influx_uint_support`: supported by the InfluxDB 3 storage engine. -- See [`influxdb_v2` plugin options](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb_v2/README.md) on GitHub. +- See [`influxdb_v2` plugin options](/telegraf/v1/output-plugins/influxdb_v2/) on GitHub. diff --git a/content/influxdb3/clustered/write-data/use-telegraf/configure/_index.md b/content/influxdb3/clustered/write-data/use-telegraf/configure/_index.md index f6d3c681e5..534e2aa258 100644 --- a/content/influxdb3/clustered/write-data/use-telegraf/configure/_index.md +++ b/content/influxdb3/clustered/write-data/use-telegraf/configure/_index.md @@ -67,7 +67,7 @@ To add any of the available [Telegraf plugins](/telegraf/v1/plugins/), follow th ### Enable and configure the InfluxDB v2 output plugin To send data to {{< product-name >}}, enable the -[`influxdb_v2` output plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb_v2/README.md) +[`influxdb_v2` output plugin](/telegraf/v1/output-plugins/influxdb_v2/) in the `telegraf.conf`. {{% code-placeholders "DATABASE_NAME" %}} @@ -121,7 +121,7 @@ The name of the {{% product-name %}} database to write data to. `influx_uint_support`: supported in InfluxDB 3. -For more plugin options, see [`influxdb`](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) on GitHub. +For more plugin options, see [`influxdb`](/telegraf/v1/output-plugins/influxdb/) on GitHub. ## Start Telegraf diff --git a/content/shared/influxdb3-write-guides/_index.md b/content/shared/influxdb3-write-guides/_index.md index 5882872c65..87dcd4fe38 100644 --- a/content/shared/influxdb3-write-guides/_index.md +++ b/content/shared/influxdb3-write-guides/_index.md @@ -23,16 +23,16 @@ is the text-based format used to write data to InfluxDB. > #### Choose the write endpoint for your workload > > When creating new write workloads, use the -> [InfluxDB HTTP API `/api/v3/write_lp` endpoint](influxdb3/version/write-data/http-api/v3-write-lp/) +> [InfluxDB HTTP API `/api/v3/write_lp` endpoint](/influxdb3/version/write-data/http-api/v3-write-lp/) > and [client libraries](/influxdb3/version/write-data/client-libraries/). > > When bringing existing _v1_ write workloads, use the {{% product-name %}} > HTTP API [`/write` endpoint](/influxdb3/core/api/v3/#operation/PostV1Write). > > When bringing existing _v2_ write workloads, use the {{% product-name %}} -> HTTP API [`/api/v2/write` endpoint]([/influxdb3/version/api/v3/#operation/PostV1Write](/influxdb3/version/api/v3/#operation/PostV2Write)). +> HTTP API [`/api/v2/write` endpoint](/influxdb3/version/api/v3/#operation/PostV2Write). > -> **For Telegraf**, use the InfluxDB v1.x [`outputs.influxdb`](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) or v2.x [`outputs.influxdb_v2`](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb_v2/README.md) output plugins. +> **For Telegraf**, use the InfluxDB v1.x [`outputs.influxdb`](/telegraf/v1/output-plugins/influxdb/) or v2.x [`outputs.influxdb_v2`](/telegraf/v1/output-plugins/influxdb_v2/) output plugins. > See how to [use Telegraf to write data](/influxdb3/version/write-data/use-telegraf/). ## Timestamp precision across write APIs diff --git a/content/shared/influxdb3-write-guides/http-api/_index.md b/content/shared/influxdb3-write-guides/http-api/_index.md index 044a90e7e2..454185b6b8 100644 --- a/content/shared/influxdb3-write-guides/http-api/_index.md +++ b/content/shared/influxdb3-write-guides/http-api/_index.md @@ -6,16 +6,16 @@ Different APIs are available depending on your integration method. > #### Choose the write endpoint for your workload > > When creating new write workloads, use the -> [InfluxDB HTTP API `/api/v3/write_lp` endpoint](influxdb3/version/write-data/http-api/v3-write-lp/) +> [InfluxDB HTTP API `/api/v3/write_lp` endpoint](/influxdb3/version/write-data/http-api/v3-write-lp/) > and [client libraries](/influxdb3/version/write-data/client-libraries/). > > When bringing existing _v1_ write workloads, use the {{% product-name %}} > HTTP API [`/write` endpoint](/influxdb3/core/api/v3/#operation/PostV1Write). > > When bringing existing _v2_ write workloads, use the {{% product-name %}} -> HTTP API [`/api/v2/write` endpoint]([/influxdb3/version/api/v3/#operation/PostV1Write](/influxdb3/version/api/v3/#operation/PostV2Write)). +> HTTP API [`/api/v2/write` endpoint](/influxdb3/version/api/v3/#operation/PostV2Write). > -> **For Telegraf**, use the InfluxDB v1.x [`outputs.influxdb`](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) or v2.x [`outputs.influxdb_v2`](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb_v2/README.md) output plugins. +> **For Telegraf**, use the InfluxDB v1.x [`outputs.influxdb`](/telegraf/v1/output-plugins/influxdb/) or v2.x [`outputs.influxdb_v2`](/telegraf/v1/output-plugins/influxdb_v2/) output plugins. > See how to [use Telegraf to write data](/influxdb3/version/write-data/use-telegraf/). {{% /show-in %}} diff --git a/content/shared/influxdb3-write-guides/http-api/compatibility-apis.md b/content/shared/influxdb3-write-guides/http-api/compatibility-apis.md index 6a7f0d586a..dbd292032e 100644 --- a/content/shared/influxdb3-write-guides/http-api/compatibility-apis.md +++ b/content/shared/influxdb3-write-guides/http-api/compatibility-apis.md @@ -9,16 +9,16 @@ to write points as line protocol data to {{% product-name %}}. > #### Choose the write endpoint for your workload > > When creating new write workloads, use the -> [InfluxDB HTTP API `/api/v3/write_lp` endpoint](influxdb3/version/write-data/http-api/v3-write-lp/) +> [InfluxDB HTTP API `/api/v3/write_lp` endpoint](/influxdb3/version/write-data/http-api/v3-write-lp/) > and [client libraries](/influxdb3/version/write-data/client-libraries/). > > When bringing existing v1 write workloads, use the {{% product-name %}} > HTTP API [`/write` endpoint](/influxdb3/core/api/v3/#operation/PostV1Write). > > When bringing existing v2 write workloads, use the {{% product-name %}} -> HTTP API [`/api/v2/write` endpoint]([/influxdb3/version/api/v3/#operation/PostV1Write](/influxdb3/version/api/v3/#operation/PostV2Write)). +> HTTP API [`/api/v2/write` endpoint](/influxdb3/version/api/v3/#operation/PostV2Write). > -> **For Telegraf**, use the InfluxDB v1.x [`outputs.influxdb`](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) or v2.x [`outputs.influxdb_v2`](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb_v2/README.md) output plugins. +> **For Telegraf**, use the InfluxDB v1.x [`outputs.influxdb`](/telegraf/v1/output-plugins/influxdb/) or v2.x [`outputs.influxdb_v2`](/telegraf/v1/output-plugins/influxdb_v2/) output plugins. > See how to [use Telegraf to write data](/influxdb3/version/write-data/use-telegraf/). > [!Note] @@ -267,8 +267,8 @@ v1 client libraries send data in [line protocol](/influxdb3/version/reference/sy {{< tabs-wrapper >}} {{% tabs %}} -[Node.js](#nodejs) -[Python](#python) +[Node.js](#) +[Python](#) {{% /tabs %}} {{% tab-content %}} @@ -327,7 +327,7 @@ For more information about using v2 client libraries, see [v2 client libraries]( ## Telegraf configuration If you have existing v1 workloads that use Telegraf, -you can use the [InfluxDB v1.x `influxdb` Telegraf output plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) to write data. +you can use the [InfluxDB v1.x `influxdb` Telegraf output plugin](/telegraf/v1/output-plugins/influxdb/) to write data. The following table shows `outputs.influxdb` plugin parameters and values for writing to the {{< product-name >}} v1 API: diff --git a/content/shared/influxdb3-write-guides/use-telegraf/configure.md b/content/shared/influxdb3-write-guides/use-telegraf/configure.md index 0e04adaac9..afaafa1e33 100644 --- a/content/shared/influxdb3-write-guides/use-telegraf/configure.md +++ b/content/shared/influxdb3-write-guides/use-telegraf/configure.md @@ -1,5 +1,5 @@ -Use the Telegraf [`influxdb_v2` output plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb_v2/README.md) +Use the Telegraf [`influxdb_v2` output plugin](/telegraf/v1/output-plugins/influxdb_v2/) to collect and write metrics to {{< product-name >}}. This plugin uses the InfluxDB v2 HTTP API write endpoint available with {{% product-name %}}. @@ -47,7 +47,7 @@ the steps below. ### Enable and configure the InfluxDB v2 output plugin To send data to {{< product-name >}}, enable the -[`influxdb_v2` output plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb_v2/README.md) +[`influxdb_v2` output plugin](/telegraf/v1/output-plugins/influxdb_v2/) in the `telegraf.conf`. {{% code-placeholders "AUTH_TOKEN|DATABASE_NAME" %}} @@ -113,7 +113,7 @@ The name of the {{% product-name %}} database to write data to. ### Other Telegraf configuration options For more plugin configuration options, see the -[`influxdb_v2` output plugin README](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb_v2/README.md) +[`influxdb_v2` output plugin README](/telegraf/v1/output-plugins/influxdb_v2/) on GitHub. ## Start Telegraf diff --git a/content/shared/influxdb3-write-guides/use-telegraf/csv.md b/content/shared/influxdb3-write-guides/use-telegraf/csv.md index 41967996a3..39cd6fbfd4 100644 --- a/content/shared/influxdb3-write-guides/use-telegraf/csv.md +++ b/content/shared/influxdb3-write-guides/use-telegraf/csv.md @@ -123,5 +123,5 @@ CSV data to {{% product-name %}}. The preceding examples describe Telegraf configurations necessary for writing to {{% product-name %}}. The `influxdb_v2` output plugin provides several other configuration options. For more information, see the -[`influxdb_v2` plugin options](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb_v2/README.md) +[`influxdb_v2` plugin options](/telegraf/v1/output-plugins/influxdb_v2/) on GitHub. diff --git a/content/shared/influxdb3-write-guides/use-telegraf/dual-write.md b/content/shared/influxdb3-write-guides/use-telegraf/dual-write.md index 71f3fa52d0..0ac15391cc 100644 --- a/content/shared/influxdb3-write-guides/use-telegraf/dual-write.md +++ b/content/shared/influxdb3-write-guides/use-telegraf/dual-write.md @@ -44,8 +44,8 @@ Specifically, it uses the following: ``` Telegraf lets you dual write data to any version of InfluxDB using the -[`influxdb` (InfluxDB v1)](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) -and [`influxdb_v2` output plugins](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb_v2/README.md). +[`influxdb` (InfluxDB v1)](/telegraf/v1/output-plugins/influxdb/ +and [`influxdb_v2` output plugins](/telegraf/v1/output-plugins/influxdb_v2/). A single Telegraf agent sends identical data sets to all target outputs. You cannot filter data based on the output.