metrics

Documentation

Overview

Package metrics declares metrics names and labels that pomerium exposes as constants that could be referred to from other projects

Index

• Constants

Constants

const (
	AutocertRenewalsTotal                 = "autocert_renewals_total"
	AutocertCertificatesTotal             = "autocert_certificates_total"
	AutocertCertificateNextExpiresSeconds = "autocert_certificate_next_expires_seconds"
	// ConfigLastReloadTimestampSeconds is unix timestamp when configuration was last reloaded
	ConfigLastReloadTimestampSeconds = "config_last_reload_success_timestamp"
	// ConfigLastReloadSuccess is set to 1 if last configuration was successfully reloaded
	ConfigLastReloadSuccess = "config_last_reload_success"
	// IdentityManagerLastRefreshTimestamp is IdP sync timestamp
	IdentityManagerLastRefreshTimestamp = "identity_manager_last_refresh_timestamp"

	// IdentityManagerLastUserRefreshSuccessTimestamp is a timestamp of last user refresh
	IdentityManagerLastUserRefreshSuccessTimestamp = "identity_manager_last_user_refresh_success_timestamp"
	// IdentityManagerLastUserRefreshErrorTimestamp is a timestamp of last user refresh error
	IdentityManagerLastUserRefreshErrorTimestamp = "identity_manager_last_user_refresh_error_timestamp"
	// IdentityManagerLastUserRefreshError is a counter of last user refresh errors
	IdentityManagerLastUserRefreshError = "identity_manager_last_user_refresh_errors"
	// IdentityManagerLastUserRefreshSuccess is a counter of last user refresh success
	IdentityManagerLastUserRefreshSuccess = "identity_manager_last_user_refresh_success"

	// IdentityManagerLastUserGroupRefreshSuccessTimestamp is a timestamp of last user group refresh
	IdentityManagerLastUserGroupRefreshSuccessTimestamp = "identity_manager_last_user_group_refresh_success_timestamp"
	// IdentityManagerLastUserGroupRefreshErrorTimestamp is a timestamp of last user group refresh error
	IdentityManagerLastUserGroupRefreshErrorTimestamp = "identity_manager_last_user_group_refresh_error_timestamp"
	// IdentityManagerLastUserGroupRefreshError is a counter of last user group refresh errors
	IdentityManagerLastUserGroupRefreshError = "identity_manager_last_user_group_refresh_errors"
	// IdentityManagerLastUserGroupRefreshSuccess is a counter of last user group refresh success
	IdentityManagerLastUserGroupRefreshSuccess = "identity_manager_last_user_group_refresh_success"

	// IdentityManagerLastSessionRefreshSuccessTimestamp is a timestamp of last session refresh
	IdentityManagerLastSessionRefreshSuccessTimestamp = "identity_manager_last_session_refresh_success_timestamp"
	// IdentityManagerLastSessionRefreshErrorTimestamp is a timestamp of last session refresh error
	IdentityManagerLastSessionRefreshErrorTimestamp = "identity_manager_last_session_refresh_error_timestamp"
	// IdentityManagerLastSessionRefreshError is a counter of last session refresh errors
	IdentityManagerLastSessionRefreshError = "identity_manager_last_session_refresh_errors"
	// IdentityManagerLastSessionRefreshSuccess is a counter of last session refresh success
	IdentityManagerLastSessionRefreshSuccess = "identity_manager_last_session_refresh_success"

	// EnvoyOverloadActionState tracks the current state of envoy overload actions
	EnvoyOverloadActionState = "envoy_overload_action_state"
	// EnvoyOverloadActionThreshold tracks container memory usage minimum thresholds for envoy overload actions
	EnvoyOverloadActionThreshold = "envoy_overload_action_threshold"
	// EnvoyCgroupMemorySaturation tracks the memory usage percent (0.0-1.0) of the cgroup in which envoy is running.
	// This metric is computed by pomerium and used as an injected resource in envoy's overload manager.
	EnvoyCgroupMemorySaturation = "envoy_cgroup_memory_saturation"

	// BuildInfo is a gauge that may be used to detect whether component is live, and also has version
	BuildInfo = "build_info"
	// PolicyCountTotal is total amount of routes currently configured
	PolicyCountTotal = "policy_count_total"
	// ConfigChecksumDecimal should only be used to compare config on a single node, it will be different in multi-node environment
	ConfigChecksumDecimal = "config_checksum_decimal"
	// ConfigDBVersion sets currently loaded databroker config version config_db_version{service="service",id="config_id"}
	ConfigDBVersion = "config_db_version"
	// ConfigDBVersionHelp is the help text for ConfigDBVersion.
	ConfigDBVersionHelp = "databroker current config record version"
	// ConfigDBErrors sets number of errors while parsing current config that were tolerated
	ConfigDBErrors = "config_db_errors"
	// ConfigDBErrorsHelp is the help text for ConfigDBErrors.
	ConfigDBErrorsHelp = "amount of errors observed while applying databroker config; -1 if validation failed and was rejected altogether"
)

metrics

const (
	InstallationIDLabel = "installation_id"
	HostnameLabel       = "hostname"
	ServiceLabel        = "service"
	ConfigLabel         = "config"
	VersionLabel        = "version"
	EnvoyVersionLabel   = "envoy_version"
	RevisionLabel       = "revision"
	GoVersionLabel      = "goversion"
	HostLabel           = "host"
)

labels