Back to Telegraf

Quix Output Plugin

plugins/outputs/quix/README.md

1.38.31.8 KB
Original Source

Quix Output Plugin

This plugin writes metrics to a Quix endpoint.

Please consult Quix's official documentation for more details on the Quix platform architecture and concepts.

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

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

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 for more details.

Secret-store support

This plugin supports secrets from secret-stores for the token option. See the secret-store documentation for more details on how to use them.

Configuration

toml
# Send metrics to a Quix data processing pipeline
[[outputs.quix]]
  ## Endpoint for providing the configuration
  # url = "https://portal-api.platform.quix.io"

  ## Workspace and topics to send the metrics to
  workspace = "your_workspace"
  topic = "your_topic"

  ## Authentication token created in Quix
  token = "your_auth_token"

  ## Amount of time allowed to complete the HTTP request for fetching the config
  # timeout = "5s"

The plugin requires a SDK token for authentication with Quix. You can generate the token in settings under the API and tokens section.

Furthermore, the workspace parameter must be set to the Workspace ID or the Environment ID of your Quix project. Those values can be found in settings under the General settings section.