telemetry

Documentation

Index

• Variables
• func GaugeMillisecond(ctx context.Context, si64 *stats.Int64Measure, value int64, ...)
• func IncrementInt64Counter(ctx context.Context, si64 *stats.Int64Measure, tagMutator ...tag.Mutator)
• func Init(ctx context.Context, cfg Config, lg log.Logger)
• type Config
• type MessagingTracer
  • func NewMessagingTracer(queueSystem string) *MessagingTracer
  • func (msg MessagingTracer) StartSpan(ctx context.Context, op string, spanAttributes ...trace.Attribute) (context.Context, *trace.Span)
• type PostgresTracer
  • func NewPostgresTracer(url string) (*PostgresTracer, error)
  • func (d PostgresTracer) StartSpan(ctx context.Context, op string, tableName string, ...) (context.Context, *trace.Span)
• type Transport
  • func (t *Transport) RoundTrip(req *http.Request) (*http.Response, error)

Variables

var (
	TagReceiverType  = tag.MustNewKey("receiver_type")
	TagRoutingMethod = tag.MustNewKey("routing_method")
	TagMessageStatus = tag.MustNewKey("status")

	MetricNotificationMessageQueueTime = stats.Int64("notification.message.queue.time", "time of message from enqueued to be picked up", stats.UnitMilliseconds)

	MetricNotificationMessageEnqueue   = stats.Int64("notification.message.enqueue", "enqueued notification messages", stats.UnitDimensionless)
	MetricNotificationMessagePending   = stats.Int64("notification.message.pending", "processed notification messages", stats.UnitDimensionless)
	MetricNotificationMessageFailed    = stats.Int64("notification.message.failed", "failed to publish notification messages", stats.UnitDimensionless)
	MetricNotificationMessagePublished = stats.Int64("notification.message.published", "published notification messages", stats.UnitDimensionless)

	MetricNotificationSubscriberNotFound = stats.Int64("notification.subscriber.notfound", "notification does not match any subscription", stats.UnitDimensionless)

	MetricReceiverPreHookDBFailed     = stats.Int64("receiver.prehookdb.failed", "failed prehook db receiver", stats.UnitDimensionless)
	MetricReceiverPostHookDBFailed    = stats.Int64("receiver.posthookdb.failed", "failed posthook db receiver", stats.UnitDimensionless)
	MetricReceiverPreHookQueueFailed  = stats.Int64("receiver.prehookqueue.failed", "failed prehook queue receiver", stats.UnitDimensionless)
	MetricReceiverPostHookQueueFailed = stats.Int64("receiver.posthookqueue.failed", "failed posthook queue receiver", stats.UnitDimensionless)
)

var Meter = global.MeterProvider().Meter("siren")

Functions

func GaugeMillisecond

func GaugeMillisecond(ctx context.Context, si64 *stats.Int64Measure, value int64, tagMutator ...tag.Mutator)

func IncrementInt64Counter

func IncrementInt64Counter(ctx context.Context, si64 *stats.Int64Measure, tagMutator ...tag.Mutator)

func Init

func Init(ctx context.Context, cfg Config, lg log.Logger)

Init initialises OpenCensus based async-telemetry processes and returns (i.e., it does not block).

Types

type Config

type Config struct {
	// Debug sets the bind address for pprof & zpages server.
	Debug string `mapstructure:"debug_addr" yaml:"debug_addr" default:"localhost:8081"`

	// OpenCensus trace & metrics configurations.
	EnableCPU        bool    `mapstructure:"enable_cpu" yaml:"enable_cpu" default:"true"`
	EnableMemory     bool    `mapstructure:"enable_memory" yaml:"enable_memory" default:"true"`
	SamplingFraction float64 `mapstructure:"sampling_fraction" yaml:"sampling_fraction" default:"1"`

	// OpenCensus exporter configurations.
	ServiceName string `mapstructure:"service_name" yaml:"service_name" default:"siren"`

	// NewRelic exporter.
	EnableNewrelic  bool   `mapstructure:"enable_newrelic" yaml:"enable_newrelic" default:"false"`
	NewRelicAppName string `mapstructure:"newrelic_app_name" yaml:"newrelic_app_name"`
	NewRelicAPIKey  string `mapstructure:"newrelic_api_key" yaml:"newrelic_api_key" default:"____LICENSE_STRING_OF_40_CHARACTERS_____"`

	// OpenTelemetry Agent exporter.
	EnableOtelAgent  bool   `mapstructure:"enable_otel_agent" yaml:"enable_otel_agent" default:"false"`
	OpenTelAgentAddr string `mapstructure:"otel_agent_addr" yaml:"otel_agent_addr" default:"localhost:55678"`
}

type MessagingTracer

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

func NewMessagingTracer

func NewMessagingTracer(queueSystem string) *MessagingTracer

func (MessagingTracer) StartSpan

func (msg MessagingTracer) StartSpan(ctx context.Context, op string, spanAttributes ...trace.Attribute) (context.Context, *trace.Span)

type PostgresTracer

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

func NewPostgresTracer

func NewPostgresTracer(url string) (*PostgresTracer, error)

func (PostgresTracer) StartSpan

func (d PostgresTracer) StartSpan(ctx context.Context, op string, tableName string, spanAttributes ...trace.Attribute) (context.Context, *trace.Span)

type Transport

type Transport struct {
	Base http.RoundTripper
}

func (*Transport) RoundTrip

func (t *Transport) RoundTrip(req *http.Request) (*http.Response, error)