csv

Documentation

Index

• func IsStringInSlice(slice []string, str string) bool
• func MakeHeader(tags []string) []string
• func New(params output.Params) (output.Output, error)
• func SampleToRow(sample *metrics.Sample, resTags []string, ignoredTags []string, row []string) []string
• type Config
  • func GetConsolidatedConfig(jsonRawConf json.RawMessage, env map[string]string, arg string, ...) (Config, error)
  • func NewConfig() Config
  • func ParseArg(arg string, logger *logrus.Logger) (Config, error)
  • func (c Config) Apply(cfg Config) Config
• type Output
  • func (o *Output) Description() string
  • func (o *Output) Start() error
  • func (o *Output) Stop() error

Functions

func IsStringInSlice

func IsStringInSlice(slice []string, str string) bool

IsStringInSlice returns whether the string is contained within a string slice

func MakeHeader

func MakeHeader(tags []string) []string

MakeHeader creates list of column names for csv file

func New

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

New Creates new instance of CSV output

func SampleToRow

func SampleToRow(sample *metrics.Sample, resTags []string, ignoredTags []string, row []string) []string

SampleToRow converts sample into array of strings

Types

type Config

type Config struct {
	// Samples.
	FileName     null.String        `json:"file_name" envconfig:"K6_CSV_FILENAME"`
	SaveInterval types.NullDuration `json:"save_interval" envconfig:"K6_CSV_SAVE_INTERVAL"`
}

Config is the config for the csv output

func GetConsolidatedConfig

func GetConsolidatedConfig(
	jsonRawConf json.RawMessage, env map[string]string, arg string, logger *logrus.Logger,
) (Config, error)

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

func NewConfig

func NewConfig() Config

NewConfig creates a new Config instance with default values for some fields.

func ParseArg

func ParseArg(arg string, logger *logrus.Logger) (Config, error)

ParseArg takes an arg string and converts it to a config

func (Config) Apply

func (c Config) Apply(cfg Config) Config

Apply merges two configs by overwriting properties in the old config

type Output

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

Output implements the lib.Output interface for saving to CSV files.

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 writes the csv header and starts a new output.PeriodicFlusher

func (*Output) Stop

func (o *Output) Stop() error

Stop flushes any remaining metrics and stops the goroutine.