emf

Documentation

Overview

Package emf implements an EMF metrics publisher.

This package is designated as private and is intended for use only by the smithy client runtime. The exported API therein is not considered stable and is subject to breaking changes without notice.

Index

• type Entry
  • func NewEntry(namespace string, serializer metrics.Serializer) Entry
  • func (e *Entry) AddDimension(key string, value string)
  • func (e *Entry) AddMetric(key string, value float64)
  • func (e *Entry) AddProperty(key string, value interface{})
  • func (e *Entry) Build() (string, error)

Types

type Entry

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

Entry represents a log entry in the EMF format.

func NewEntry

func NewEntry(namespace string, serializer metrics.Serializer) Entry

NewEntry creates a new Entry with the specified namespace and serializer.

func (*Entry) AddDimension

func (e *Entry) AddDimension(key string, value string)

AddDimension adds a CW Dimension to the EMF entry.

func (*Entry) AddMetric

func (e *Entry) AddMetric(key string, value float64)

AddMetric adds a CW Metric to the EMF entry.

func (*Entry) AddProperty

func (e *Entry) AddProperty(key string, value interface{})

AddProperty adds a CW Property to the EMF entry. Properties are not published as metrics, but they are available in logs and in CW insights.

func (*Entry) Build

func (e *Entry) Build() (string, error)

Build constructs the EMF log entry as a JSON string.