types

Documentation

Overview

Package types exists to avoid circular references between things that need to reference common types

Index

• type DimProperties
• type Dimension
• type MonitorID
• type Output

Types

type DimProperties

type DimProperties struct {
	Dimension
	// Properties to be set on the dimension
	Properties map[string]string
	// Tags to apply to the dimension value
	Tags map[string]bool
}

DimProperties represents a set of properties associated with a given dimension value

type Dimension

type Dimension struct {
	// Name of the dimension
	Name string
	// Value of the dimension
	Value string
}

Dimension represents a specific dimension value

type MonitorID

type MonitorID string

MonitorID is a unique identifier for a specific instance of a monitor

type Output

type Output interface {
	SendDatapoint(*datapoint.Datapoint)
	SendEvent(*event.Event)
	SendSpan(*trace.Span)
	SendDimensionProps(*DimProperties)
	AddExtraDimension(key, value string)
	RemoveExtraDimension(key string)
}

Output is the interface that monitors should use to send data to the agent core. It handles adding the proper dimensions and metadata to datapoints so that monitors don't have to worry about it themselves.