metrics

Documentation

Overview

Package metrics provides Knative utilities for exporting metrics to Stackdriver backend or Prometheus backend based on config-observability settings.

Index

• Constants
• func ConfigMapName() string
• func Domain() string
• func FlushExporter() bool
• func Record(ctx context.Context, ms stats.Measurement)
• func UpdateExporter(ops ExporterOptions, logger *zap.SugaredLogger) error
• func UpdateExporterFromConfigMap(component string, logger *zap.SugaredLogger) func(configMap *corev1.ConfigMap)
• type ExporterOptions
• type Global
  • func (g *Global) MonitoredResource() (resType string, labels map[string]string)
• type KnativeRevision
  • func (kr *KnativeRevision) MonitoredResource() (resType string, labels map[string]string)

Constants

const (
	DomainEnv        = "METRICS_DOMAIN"
	ConfigMapNameEnv = "CONFIG_OBSERVABILITY_NAME"
)

const (
	// The following keys are used to configure metrics reporting.
	// See https://github.com/knative/serving/blob/master/config/config-observability.yaml
	// for details.
	AllowStackdriverCustomMetricsKey = "metrics.allow-stackdriver-custom-metrics"
	BackendDestinationKey            = "metrics.backend-destination"
	ReportingPeriodKey               = "metrics.reporting-period-seconds"
	StackdriverProjectIDKey          = "metrics.stackdriver-project-id"

	// Stackdriver is used for Stackdriver backend
	Stackdriver metricsBackend = "stackdriver"
	// Prometheus is used for Prometheus backend
	Prometheus metricsBackend = "prometheus"
)

Functions

func ConfigMapName

func ConfigMapName() string

ConfigMapName gets the name of the metrics ConfigMap

func Domain

func Domain() string

Domain holds the metrics domain to use for surfacing metrics.

func FlushExporter

func FlushExporter() bool

FlushExporter waits for exported data to be uploaded. This should be called before the process shuts down or exporter is replaced. Return value indicates whether the exporter is flushable or not.

func Record

func Record(ctx context.Context, ms stats.Measurement)

Record decides whether to record one measurement via OpenCensus based on the following conditions:

1. No package level metrics config. In this case it just proxies to OpenCensus based on the assumption that users expect the metrics to be recorded when they call this function. Users must ensure metrics config are set before using this function to get expected behavior.
2. The backend is not Stackdriver.
3. The backend is Stackdriver and it is allowed to use custom metrics.
4. The backend is Stackdriver and the metric is "knative_revison" built-in metric.

func UpdateExporter

func UpdateExporter(ops ExporterOptions, logger *zap.SugaredLogger) error

UpdateExporter updates the exporter based on the given ExporterOptions.

func UpdateExporterFromConfigMap

func UpdateExporterFromConfigMap(component string, logger *zap.SugaredLogger) func(configMap *corev1.ConfigMap)

UpdateExporterFromConfigMap returns a helper func that can be used to update the exporter when a config map is updated.

Types

type ExporterOptions

type ExporterOptions struct {
	// Domain is the metrics domain. e.g. "knative.dev". Must be present.
	Domain string

	// Component is the name of the component that emits the metrics. e.g.
	// "activator", "queue_proxy". Should only contains alphabets and underscore.
	// Must be present.
	Component string

	// PrometheusPort is the port to expose metrics if metrics backend is Prometheus.
	// It should be between maxPrometheusPort and maxPrometheusPort. 0 value means
	// using the default 9090 value. If is ignored if metrics backend is not
	// Prometheus.
	PrometheusPort int

	// ConfigMap is the data from config map config-observability. Must be present.
	// See https://github.com/knative/serving/blob/master/config/config-observability.yaml
	// for details.
	ConfigMap map[string]string
}

ExporterOptions contains options for configuring the exporter.

type Global

type Global struct{}

func (*Global) MonitoredResource

func (g *Global) MonitoredResource() (resType string, labels map[string]string)

type KnativeRevision

type KnativeRevision struct {
	Project           string
	Location          string
	ClusterName       string
	NamespaceName     string
	ServiceName       string
	ConfigurationName string
	RevisionName      string
}

func (*KnativeRevision) MonitoredResource

func (kr *KnativeRevision) MonitoredResource() (resType string, labels map[string]string)