quix

README

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

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 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

# 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.

Documentation

Index

• type Quix
  • func (q *Quix) Close() error
  • func (q *Quix) Connect() error
  • func (q *Quix) Init() error
  • func (*Quix) SampleConfig() string
  • func (q *Quix) Write(metrics []telegraf.Metric) error

Types

type Quix

type Quix struct {
	APIURL    string          `toml:"url"`
	Workspace string          `toml:"workspace"`
	Topic     string          `toml:"topic"`
	Token     config.Secret   `toml:"token"`
	Log       telegraf.Logger `toml:"-"`
	common_http.HTTPClientConfig
	// contains filtered or unexported fields
}

func (*Quix) Close

func (q *Quix) Close() error

func (*Quix) Connect

func (q *Quix) Connect() error

func (*Quix) Init

func (q *Quix) Init() error

func (*Quix) SampleConfig

func (*Quix) SampleConfig() string

func (*Quix) Write

func (q *Quix) Write(metrics []telegraf.Metric) error