metrics

type CWEmbeddedMetricsManager ¶ added in v1.16.0

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

func NewCWEmbeddedMetrics(writer io.Writer) *CWEmbeddedMetricsManager

func (c *CWEmbeddedMetricsManager) NewCounter(name, unit string) Counter

func (c *CWEmbeddedMetricsManager) Run(ctx context.Context, interval time.Duration)

func (c *CWEmbeddedMetricsManager) Sync() error

type Counter ¶ added in v1.16.0

type Counter interface {
	With(dimensionValues ...string) Counter
	Add(delta float64)
}

type Dimension ¶

type Dimension struct {
	Name  string
	Value string
}

Dimension represents the name and value of a given dimension. Each dimension must have its name in at least one DimensionSet to be recognized as a dimension.

type DimensionSet ¶

type DimensionSet = []string

DimensionSet is a slice of strings containing the dimension names that will be applied to all metrics logged. The values within this slice MUST also be members on the root node, referred to as the Target Members

A DimensionSet MUST NOT contain more than 9 dimension keys.

The target member defines a dimension that will be published as part of the metric identity. Every DimensionSet used creates a new metric in CloudWatch.

type DimensionValues ¶ added in v1.16.0

type DimensionValues []string

DimensionValues is a type alias that provides validation on its With method. Metrics may include it as a member to help them satisfy With semantics and save some code duplication.

func (lvs DimensionValues) With(dvs ...string) DimensionValues

type DimensionsCounter ¶ added in v1.16.0

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

Counter is a counter. Observations are forwarded to a node object, and aggregated (summed) per timeseries.

func (d *DimensionsCounter) Add(delta float64)

func (d *DimensionsCounter) With(dvs ...string) Counter

type EmbeddedMetric ¶

type EmbeddedMetric struct {
	// A slice of MetricDirectiveObjects used to instruct CloudWatch to extract metrics from the
	// root node of the LogEvent.
	CloudWatchMetrics []MetricDirectiveObject

	// A number representing the time stamp used for metrics extracted from the event. Values MUST
	// be expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
	Timestamp int64
}

EmbeddedMetric is the value mapped to the required top level member of the root node `_aws` in the AWS embedded metric format.

type Logger ¶

type Logger interface {
	Log(dimensions []Dimension, values ...Metric)
}

func MustLogger(dimensionSets []DimensionSet) Logger

func NewLogger(dimensionSets []DimensionSet) (Logger, error)

type Manager ¶ added in v1.16.0

type Manager interface {
	// Runs the metric manager
	// It will sync the metrics every `interval` duration
	Run(ctx context.Context, interval time.Duration)
	// Returns a new Counter
	NewCounter(name, unit string) Counter
	// Sync the metrics to the underlying system
	Sync() error
}

Metrics manager

type Metric ¶

type Metric struct {
	// A reference to a metric Target Member. Each Metric Name must also be a top level member.
	Name string

	// Valid Unit values (defaults to None):
	// Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes
	// Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Count | Bytes/Second |
	// Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second |
	// Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second | None
	Unit string

	// This value is not marshalled to JSON as it is not part of the AWS embedded metric format. We
	// simply include it here for convenience when calling the loggers defined here, so that it is
	// not required to consider the value of a metric separate from its Name and Unit.
	Value interface{} `json:"-"`
}

Metric contains a name and a unit used to describe a particular metric value

type MetricDirectiveObject ¶

type MetricDirectiveObject struct {
	// A string representing the CloudWatch namespace for the metric.
	Namespace string

	// A slice representing the collection of DimensionSets for the metric
	Dimensions []DimensionSet

	// A slice of Metric values and units. This slice MUST NOT contain more than 100 Metrics.
	Metrics []Metric
}

MetricDirectiveObject instructs downstream services that the LogEvent contains metrics that will be extracted and published to CloudWatch.

type Space ¶ added in v1.16.0

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

Space represents an N-dimensional vector space. Each name and unique label value pair establishes a new dimension and point within that dimension. Order matters, i.e. [a=1 b=2] identifies a different timeseries than [b=2 a=1].

func NewSpace() *Space

func (s *Space) Observe(name, unit string, dvs DimensionValues, value float64)

func (s *Space) Reset() *Space

func (s *Space) Walk(fn func(name, unit string, dvs DimensionValues, sum float64, count int64) bool)

type StaticLogger ¶

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

StaticLogger conveniently stores repeatedly used embedded metric format configurations such as dimensionSets and metric name/unit so that they do not need to be specified each time. StaticLogger only supports one dimension set and one metric which must be set at initialization.

These limitations still allow for 90% of use cases, and are more suitable for performance critical parts of the code than the Logger.

func MustStaticLogger(dimensionSets []DimensionSet, metrics []Metric) *StaticLogger

func NewStaticLogger(dimensionSets []DimensionSet, metrics []Metric) (*StaticLogger, error)

func (l *StaticLogger) Log(metrics []Metric, dimensions ...Dimension)

func (l *StaticLogger) LogSingle(value interface{}, dimensions ...Dimension)