telemetry

Documentation

Index

• Constants
• type MetricsMiddleware
  • func NewMetricsMiddleware(t *Telemetry) *MetricsMiddleware
  • func (m *MetricsMiddleware) InstrumentHTTPEndpointStats(h http.Handler) http.Handler
• type Telemetry
  • func CreateTelemetry(addr string) (*Telemetry, error)

Constants

const (
	// Prepended to metrics
	Service = "sharkey"

	// metrics related to github, should be used with other tags
	GitHub = "github"

	// metrics related to background sync jobs, should be used with a broader tag such as "github"
	SyncJob = "sync_job"

	// metrics related to fetching, should be used with a broader tag such as "github"
	Fetch = "fetch"

	// tags that describe the metric being fetched, should be used with other tags
	Calls   = "calls"
	Latency = "latency"
	Count   = "count"
	Success = "success"
)

Types

type MetricsMiddleware

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

func NewMetricsMiddleware

func NewMetricsMiddleware(t *Telemetry) *MetricsMiddleware

func (*MetricsMiddleware) InstrumentHTTPEndpointStats

func (m *MetricsMiddleware) InstrumentHTTPEndpointStats(h http.Handler) http.Handler

type Telemetry

type Telemetry struct {
	Metrics *metrics.Metrics
}

func CreateTelemetry

func CreateTelemetry(addr string) (*Telemetry, error)