json

Documentation

Index

• func New(params output.Params) (output.Output, error)
• type Envelope
  • func WrapSample(sample stats.Sample) Envelope
• type Output
  • func (o *Output) Description() string
  • func (o *Output) Start() error
  • func (o *Output) Stop() error
• type Sample

Functions

func New

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

New returns a new JSON output.

Types

type Envelope

type Envelope struct {
	Type   string      `json:"type"`
	Data   interface{} `json:"data"`
	Metric string      `json:"metric,omitempty"`
}

Envelope is the data format we use to export both metrics and metric samples to the JSON file.

func WrapSample

func WrapSample(sample stats.Sample) Envelope

WrapSample is used to package a metric sample in a way that's nice to export to JSON.

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

type Sample

type Sample struct {
	Time  time.Time         `json:"time"`
	Value float64           `json:"value"`
	Tags  *stats.SampleTags `json:"tags"`
}

Sample is the data format for metric sample data in the JSON file.