json

Documentation

Overview

Package json is implements an output to put metrics in a json file. Actually a multi line json file.

Index

• func New(params output.Params) (output.Output, error)
• type Output
  • func (o *Output) Description() string
  • func (o *Output) SetThresholds(thresholds map[string]metrics.Thresholds)
  • func (o *Output) Start() error
  • func (o *Output) Stop() error

Functions

func New

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

New returns a new JSON output.

Types

type Output

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

Output funnels all passed metrics to an (optionally gzipped) JSON file.

func (*Output) Description

func (o *Output) Description() string

Description returns a human-readable description of the output.

func (*Output) SetThresholds

func (o *Output) SetThresholds(thresholds map[string]metrics.Thresholds)

SetThresholds receives the thresholds before the output is Start()-ed.

func (*Output) Start

func (o *Output) Start() error

Start tries to open the specified JSON file and starts the goroutine for metric flushing. If gzip encoding is specified, it also handles that.

func (*Output) Stop

func (o *Output) Stop() error

Stop flushes any remaining metrics and stops the goroutine.