circonus

Documentation

Overview

Package circonus contains methods for interfacing with circonus

Index

• Constants
• type Check
  • func NewCheck(parentLogger zerolog.Logger, cfg *config.Circonus) (*Check, error)
  • func (c *Check) DebugSubmissions() bool
  • func (c *Check) QueueMetricSample(metrics map[string]MetricSample, metricName, metricType string, ...) error
  • func (c *Check) ResetSubmitStats()
  • func (c *Check) StreamMetrics() bool
  • func (c *Check) SubmitQueue(ctx context.Context, metrics map[string]MetricSample, ...) error
  • func (c *Check) SubmitStats() Stats
  • func (c *Check) SubmitStream(ctx context.Context, metrics io.Reader, resultLogger zerolog.Logger) error
  • func (c *Check) UseCompression() bool
  • func (c *Check) WriteMetricSample(metricDest io.Writer, metricName, metricType string, ...) error
• type MetricSample
• type Stats
• type Tag
• type Tags
• type TrapResult

Constants

const (
	// MetricTypeInt32 reconnoiter
	MetricTypeInt32 = "i"

	// MetricTypeUint32 reconnoiter
	MetricTypeUint32 = "I"

	// MetricTypeInt64 reconnoiter
	MetricTypeInt64 = "l"

	// MetricTypeUint64 reconnoiter
	MetricTypeUint64 = "L"

	// MetricTypeFloat64 reconnoiter
	MetricTypeFloat64 = "n"

	// MetricTypeString reconnoiter
	MetricTypeString = "s"

	// MetricTypeHistogram reconnoiter
	MetricTypeHistogram = "h"

	// MetricTypeCumulativeHistogram reconnoiter
	MetricTypeCumulativeHistogram = "H"

	// MaxTags reconnoiter will accept in stream tagged metric name
	MaxTags = 256 // sync w/MAX_TAGS https://github.com/circonus-labs/reconnoiter/blob/master/src/noit_metric.h#L41

	// MaxMetricNameLen reconnoiter will accept (name+stream tags)
	MaxMetricNameLen = 4096 // sync w/MAX_METRIC_TAGGED_NAME https://github.com/circonus-labs/reconnoiter/blob/master/src/noit_metric.h#L40
)

Types

type Check

type Check struct {
	// contains filtered or unexported fields
}

func NewCheck

func NewCheck(parentLogger zerolog.Logger, cfg *config.Circonus) (*Check, error)

func (*Check) DebugSubmissions

func (c *Check) DebugSubmissions() bool

DebugSubmissions will dump the submission request to stdout

func (*Check) QueueMetricSample

func (c *Check) QueueMetricSample(
	metrics map[string]MetricSample,
	metricName,
	metricType string,
	streamTags,
	measurementTags []string,
	value interface{},
	timestamp *time.Time) error

QueueMetricSample to queue for submission

func (*Check) ResetSubmitStats

func (c *Check) ResetSubmitStats()

func (*Check) StreamMetrics

func (c *Check) StreamMetrics() bool

StreamMetrics indicates whether to stream metrics (use when multiple samples for same metric name with different timestamps)

func (*Check) SubmitQueue

func (c *Check) SubmitQueue(ctx context.Context, metrics map[string]MetricSample, resultLogger zerolog.Logger) error

func (*Check) SubmitStats

func (c *Check) SubmitStats() Stats

func (*Check) SubmitStream

func (c *Check) SubmitStream(ctx context.Context, metrics io.Reader, resultLogger zerolog.Logger) error

SubmitStream sends metrics to a circonus trap

func (*Check) UseCompression

func (c *Check) UseCompression() bool

UseCompression indicates whether the data being sent should be compressed

func (*Check) WriteMetricSample

func (c *Check) WriteMetricSample(
	metricDest io.Writer,
	metricName,
	metricType string,
	streamTags,
	measurementTags []string,
	value interface{},
	timestamp *time.Time) error

WriteMetricSample to queue for submission

type MetricSample

type MetricSample struct {
	Value     interface{} `json:"_value"`
	Type      string      `json:"_type"`
	Timestamp uint64      `json:"_ts,omitempty"`
}

type Stats

type Stats struct {
	Metrics   uint64
	SentBytes uint64
	SentSize  string
}

type Tag

type Tag struct {
	Category string
	Value    string
}

Tag defines an individual tag

type Tags

type Tags []Tag

Tags defines a list of tags

type TrapResult

type TrapResult struct {
	CheckUUID  string
	SubmitUUID uuid.UUID
	Stats      uint64 `json:"stats"`
	Error      string `json:"error,omitempty"`
}