influxdb

Documentation

Overview

Package influxdb is a k6 output that sends metrics to an InfluxDB v2 database.

Index

• type Config
  • func GetConsolidatedConfig(jsonRawConf json.RawMessage, env map[string]string, url string) (Config, error)
  • func NewConfig() Config
  • func (c Config) Apply(cfg Config) Config
• type FieldKind
• type Output
  • func New(params output.Params) (*Output, error)
  • func (o *Output) Description() string
  • func (o *Output) Start() error
  • func (o *Output) Stop() error

Types

type Config

type Config struct {
	Addr                  null.String        `json:"addr" envconfig:"K6_INFLUXDB_ADDR"`
	Organization          null.String        `json:"organization" envconfig:"K6_INFLUXDB_ORGANIZATION"`
	Bucket                null.String        `json:"bucket" envconfig:"K6_INFLUXDB_BUCKET"`
	Token                 null.String        `json:"token" envconfig:"K6_INFLUXDB_TOKEN"`
	InsecureSkipTLSVerify null.Bool          `json:"insecureSkipTLSVerify,omitempty" envconfig:"K6_INFLUXDB_INSECURE"`
	PushInterval          types.NullDuration `json:"pushInterval,omitempty" envconfig:"K6_INFLUXDB_PUSH_INTERVAL"`
	ConcurrentWrites      null.Int           `json:"concurrentWrites,omitempty" envconfig:"K6_INFLUXDB_CONCURRENT_WRITES"`
	Precision             types.NullDuration `json:"precision,omitempty" envconfig:"K6_INFLUXDB_PRECISION"`
	TagsAsFields          []string           `json:"tagsAsFields,omitempty" envconfig:"K6_INFLUXDB_TAGS_AS_FIELDS"`
}

Config contains the configuration for the Output.

func GetConsolidatedConfig

func GetConsolidatedConfig(
	jsonRawConf json.RawMessage, env map[string]string, url string,
) (Config, error)

GetConsolidatedConfig combines {default config values + JSON config + environment vars + URL config values}, and returns the final result.

func NewConfig

func NewConfig() Config

NewConfig creates a new InfluxDB output config with some default values.

func (Config) Apply

func (c Config) Apply(cfg Config) Config

Apply overrides internal configuration with received values.

type FieldKind

type FieldKind int

FieldKind defines Enum for tag-to-field type conversion

const (
	// String denotes string datatype
	String FieldKind = iota
	// Int denotes integer datatype
	Int
	// Float denotes float datatype
	Float
	// Bool denotes a boolean datatype
	Bool
)

type Output

type Output struct {
	output.SampleBuffer
	// contains filtered or unexported fields
}

Output is the influxdb Output struct

func New

func New(params output.Params) (*Output, error)

New returns new InfluxDB Output

func (*Output) Description

func (o *Output) Description() string

Description returns a human-readable description of the output.

func (*Output) Start

func (o *Output) Start() error

Start initializes the SampleBuffer for collect samples.

func (*Output) Stop

func (o *Output) Stop() error

Stop flushes any remaining metrics and stops the goroutine.