telemetry

Documentation

Overview

Package telemetry defines the telemetry for the Workloadmeta component.

Index

• Variables

Variables

var (
	// StatusSuccess is the value for the "status" tag that represents a successful operation
	StatusSuccess = "success"
	// StatusError is the value for the "status" tag that represents an error
	StatusError = "error"
)

var (
	// StoredEntities tracks how many entities are stored in the workloadmeta store.
	StoredEntities = telemetry.NewGaugeWithOpts(
		subsystem,
		"stored_entities",
		[]string{"kind", "source"},
		"Number of entities in the store.",
		commonOpts,
	)

	// Subscribers tracks the number of subscribers.
	Subscribers = telemetry.NewGaugeWithOpts(
		subsystem,
		"subscribers",
		[]string{},
		"Number of subscribers.",
		commonOpts,
	)

	// EventsReceived tracks the number of events received.
	EventsReceived = telemetry.NewCounterWithOpts(
		subsystem,
		"events_received",
		[]string{"kind", "source"},
		"Number of events received by the workloadmeta store.",
		commonOpts,
	)

	// PullErrors tracks the number of errors that the workloadmeta received
	// when pulling from the collectors.
	PullErrors = telemetry.NewCounterWithOpts(
		subsystem,
		"pull_errors",
		[]string{"collector_id"},
		"Pulls by the workloadmeta to the collectors that returned an error",
		commonOpts,
	)

	// PullDuration measures the time that it takes to pull from the
	// workloadmeta collectors.
	PullDuration = telemetry.NewHistogramWithOpts(
		subsystem,
		"pull_duration",
		[]string{"collector_id"},
		"The time it takes to pull from the collectors (in seconds)",
		[]float64{0.25, 0.5, 0.75, 1, 2, 5, 10, 15, 30, 45, 60},
		commonOpts,
	)

	// NotificationsSent tracks the number of notifications sent from the
	// workloadmeta store to its subscribers. Note that each notification can
	// include multiple events.
	NotificationsSent = telemetry.NewCounterWithOpts(
		subsystem,
		"notifications_sent",
		[]string{"subscriber_name", "status"},
		"Number of notifications sent by workloadmeta to its subscribers",
		commonOpts,
	)

	// RemoteClientErrors tracks the number of errors on the remote workloadmeta
	// client while receiving events.
	RemoteClientErrors = telemetry.NewCounterWithOpts(
		subsystem,
		"remote_client_errors",
		[]string{"collector"},
		"Number of errors on the remote workloadmeta client while receiving events",
		commonOpts,
	)

	// RemoteServerErrors track the number of errors on the remote workloadmeta
	// server while streaming events.
	RemoteServerErrors = telemetry.NewCounterWithOpts(
		subsystem,
		"remote_server_errors",
		[]string{},
		"Number of errors on the remote workloadmeta server while streaming events",
		commonOpts,
	)
)