Skip to content

Commit

Permalink
docs(outputs.quix): Fix README long line linting
Browse files Browse the repository at this point in the history
  • Loading branch information
stereosky committed Nov 19, 2024
1 parent f32b854 commit 42b8264
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions plugins/outputs/quix/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,23 @@

This plugin writes metrics to a [Quix](https://quix.io/) endpoint.

Please consult Quix's [official documentation](https://quix.io/docs/) for more details on the Quix platform architecture and concepts.
Please consult Quix's [official documentation](https://quix.io/docs/) for more
details on the Quix platform architecture and concepts.

⭐ Telegraf v1.32.2 🏷️ cloud, messaging 💻 all

## Quix Authentication

This plugin uses an SDK token for authentication with Quix. You can generate one in the settings under the `API and tokens` section by clicking on `SDK Token`.
This plugin uses an SDK token for authentication with Quix. You can generate
one in the settings under the `API and tokens` section by clicking on
`SDK Token`.

## Global configuration options <!-- @/docs/includes/plugin_config.md -->

In addition to the plugin-specific configuration settings, plugins support additional global and plugin configuration settings. These settings are used to modify metrics, tags, and field or create aliases and configure ordering, etc. See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
In addition to the plugin-specific configuration settings, plugins support
additional global and plugin configuration settings. These settings are used to
modify metrics, tags, and field or create aliases and configure ordering, etc.
See the [CONFIGURATION.md][CONFIGURATION.md] for more details.

[CONFIGURATION.md]: ../../../docs/CONFIGURATION.md#plugins

Expand All @@ -37,11 +43,15 @@ configured.

### workspace

The workspace is the environment of your Quix project and is the `Workspace ID` or the `Environment ID` used to target your environment. It can be found in the settings under the `General settings` section.
The workspace is the environment of your Quix project and is the `Workspace ID`
or the `Environment ID` used to target your environment. It can be found in the
settings under the `General settings` section.

### auth_token

The auth_token is the `SDK Token` used to authenticate against your Quix environment and is limited to that environment. It can be found in the settings under the `API and tokens` section.
The auth_token is the `SDK Token` used to authenticate against your Quix
environment and is limited to that environment. It can be found in the settings
under the `API and tokens` section.

### topic

Expand Down

0 comments on commit 42b8264

Please sign in to comment.