metrics

Documentation

Index

• Constants
• Variables
• func AugmentWithResponse(baseCtx context.Context, responseCode int) context.Context
• func AugmentWithResponseAndRouteTag(baseCtx context.Context, responseCode int, routeTag string) context.Context
• func AugmentWithRevision(baseCtx context.Context, ns, svc, cfg, rev string) context.Context
• func PodContext(pod, container string) (context.Context, error)
• func PodRevisionContext(pod, container, ns, svc, cfg, rev string) (context.Context, error)
• func RevisionContext(ns, svc, cfg, rev string) context.Context

Constants

const (
	// ResourceTypeKnativeRevision is the resource type for Knative revision
	ResourceTypeKnativeRevision = "knative_revision"

	// LabelServiceName is the label for the deployed service name
	LabelServiceName = "service_name"

	// LabelRouteName is the label for immutable name of the route that receives the request
	LabelRouteName = "route_name"

	// LabelRouteTag is the label for immutable name of the route tag that receives the request
	LabelRouteTag = "route_tag"

	// LabelConfigurationName is the label for the configuration which created the monitored revision
	LabelConfigurationName = "configuration_name"

	// LabelRevisionName is the label for the monitored revision
	LabelRevisionName = "revision_name"

	// LabelNamespaceName is the label for immutable name of the namespace that the service is deployed
	LabelNamespaceName = metricskey.LabelNamespaceName

	// LabelContainerName is the container for which the metric is reported.
	LabelContainerName = metricskey.ContainerName

	// LabelPodName is the name of the pod for which the metric is reported.
	LabelPodName = metricskey.PodName

	// LabelResponseCode is the label for the HTTP response status code.
	LabelResponseCode = metricskey.LabelResponseCode

	// LabelResponseCodeClass is the label for the HTTP response status code class. For example, "2xx", "3xx", etc.
	LabelResponseCodeClass = metricskey.LabelResponseCodeClass

	// LabelResponseError is the label for client error. For HTTP, A non-2xx status code doesn't cause an error.
	LabelResponseError = metricskey.LabelResponseError

	// LabelResponseTimeout is the label timeout.
	LabelResponseTimeout = metricskey.LabelResponseTimeout

	// ValueUnknown is the default value if the field is unknown, e.g. project will be unknown if Knative
	// is not running on GKE.
	ValueUnknown = metricskey.ValueUnknown
)

Variables

var (
	PodKey               = tag.MustNewKey(LabelPodName)
	ContainerKey         = tag.MustNewKey(LabelContainerName)
	ResponseCodeKey      = tag.MustNewKey(LabelResponseCode)
	ResponseCodeClassKey = tag.MustNewKey(LabelResponseCodeClass)
	RouteTagKey          = tag.MustNewKey(LabelRouteTag)
)

Create the tag keys that will be used to add tags to our measurements. Tag keys must conform to the restrictions described in go.opencensus.io/tag/validate.go. Currently those restrictions are: - length between 1 and 255 inclusive - characters are printable US-ASCII

Functions

func AugmentWithResponse

func AugmentWithResponse(baseCtx context.Context, responseCode int) context.Context

AugmentWithResponse augments the given context with response-code specific tags.

func AugmentWithResponseAndRouteTag

func AugmentWithResponseAndRouteTag(baseCtx context.Context, responseCode int, routeTag string) context.Context

AugmentWithResponseAndRouteTag augments the given context with response-code and route-tag specific tags.

func AugmentWithRevision

func AugmentWithRevision(baseCtx context.Context, ns, svc, cfg, rev string) context.Context

AugmentWithRevision augments the given context with a knative_revision resource.

func PodContext

func PodContext(pod, container string) (context.Context, error)

PodContext generate a new base metric reporting context containing the respective pod specific tags.

func PodRevisionContext

func PodRevisionContext(pod, container, ns, svc, cfg, rev string) (context.Context, error)

PodRevisionContext generates a new base metric reporting context containing the respective pod and revision specific tags.

func RevisionContext

func RevisionContext(ns, svc, cfg, rev string) context.Context

RevisionContext generates a new base metric reporting context containing the respective revision specific tags.