Package: contrib.go.opencensus.io/exporter/prometheus

package prometheus Import Path contrib.go.opencensus.io/exporter/prometheus (on go.dev) Dependency Relation imports 12 packages, and imported by one package

Involved Source Files d➜ prometheus.go Package prometheus contains a Prometheus exporter that supports exporting OpenCensus views as Prometheus metrics. sanitize.go

Code Examples package main import ( "contrib.go.opencensus.io/exporter/prometheus" "log" "net/http" ) func main() { exporter, err := prometheus.NewExporter(prometheus.Options{}) if err != nil { log.Fatal(err) } // Serve the scrape endpoint on port 9999. http.Handle("/metrics", exporter) log.Fatal(http.ListenAndServe(":9999", nil)) }

Package-Level Type Names (total 5, in which 2 are exported)

/* sort exporteds by: alphabet | popularity */

type Exporter (struct) Exporter exports stats to Prometheus, users need to register the exporter as an http.Handler to be able to export. Fields (total 4, none are exported) /* 4 unexporteds ... *//* 4 unexporteds: */ c *collector g prometheus.Gatherer handler http.Handler opts Options Methods (total 2, both are exported) (*T) ExportView(vd *view.Data) ExportView exports to the Prometheus if view data has one or more rows. Each OpenCensus AggregationData will be converted to corresponding Prometheus Metric: SumData will be converted to Untyped Metric, CountData will be a Counter Metric, DistributionData will be a Histogram Metric. Deprecated in lieu of metricexport.Reader interface. (*T) ServeHTTP(w http.ResponseWriter, r *http.Request) ServeHTTP serves the Prometheus endpoint. Implements (at least 2, both are exported) *T : go.opencensus.io/stats/view.Exporter *T : net/http.Handler As Outputs Of (at least one exported) func NewExporter(o Options) (*Exporter, error)

type Options (struct) Options contains options for configuring the exporter. Fields (total 4, all are exported) ConstLabels prometheus.Labels // ConstLabels will be set as labels on all views. Namespace string OnError func(err error) Registry *prometheus.Registry Methods (only one, which is unexported) /* one unexported ... *//* one unexported: */ (*T) onError(err error) As Inputs Of (at least 2, in which 1 are exported) func NewExporter(o Options) (*Exporter, error) /* at least one unexported ... *//* at least one unexported: */ func newCollector(opts Options, registrar *prometheus.Registry) *collector

/* 3 unexporteds ... *//* 3 unexporteds: */

type collector (struct) collector implements prometheus.Collector Fields (total 5, none are exported) /* 5 unexporteds ... *//* 5 unexporteds: */ mu sync.Mutex // mu guards all the fields. opts Options reader *metricexport.Reader reader reads metrics from all registered producers. reg *prometheus.Registry reg helps collector register views dynamically. registerOnce sync.Once Methods (total 4, in which 2 are exported) (*T) Collect(ch chan<- prometheus.Metric) Collect fetches the statistics from OpenCensus and delivers them as Prometheus Metrics. Collect is invoked every time a prometheus.Gatherer is run for example when the HTTP endpoint is invoked by Prometheus. (*T) Describe(ch chan<- *prometheus.Desc) /* 2 unexporteds ... *//* 2 unexporteds: */ (*T) ensureRegisteredOnce() ensureRegisteredOnce invokes reg.Register on the collector itself exactly once to ensure that we don't get errors such as cannot register the collector: descriptor Desc{fqName: *} already exists with the same fully-qualified name and const label values which is documented by Prometheus at https://github.com/prometheus/client_golang/blob/fcc130e101e76c5d303513d0e28f4b6d732845c7/prometheus/registry.go#L89-L101 (*T) toDesc(metric *metricdata.Metric) *prometheus.Desc Implements (at least one exported) *T : github.com/prometheus/client_golang/prometheus.Collector As Outputs Of (at least one unexported) /* at least one unexported ... *//* at least one unexported: */ func newCollector(opts Options, registrar *prometheus.Registry) *collector

type descExporter (struct) Fields (total 2, neither is exported) /* 2 unexporteds ... *//* 2 unexporteds: */ c *collector descCh chan<- *prometheus.Desc Methods (only one, which is exported) (*T) ExportMetrics(ctx context.Context, metrics []*metricdata.Metric) error ExportMetrics exports descriptor to the Prometheus. It is invoked when request to scrape descriptors is received. Implements (at least one exported) *T : go.opencensus.io/metric/metricexport.Exporter

type metricExporter (struct) Fields (total 2, neither is exported) /* 2 unexporteds ... *//* 2 unexporteds: */ c *collector metricCh chan<- prometheus.Metric Methods (only one, which is exported) (*T) ExportMetrics(ctx context.Context, metrics []*metricdata.Metric) error ExportMetrics exports to the Prometheus. Each OpenCensus Metric will be converted to corresponding Prometheus Metric: TypeCumulativeInt64 and TypeCumulativeFloat64 will be a Counter Metric, TypeCumulativeDistribution will be a Histogram Metric. TypeGaugeFloat64 and TypeGaugeInt64 will be a Gauge Metric Implements (at least one exported) *T : go.opencensus.io/metric/metricexport.Exporter

Package-Level Functions (total 10, in which 1 are exported)

func NewExporter(o Options) (*Exporter, error) NewExporter returns an exporter that exports stats to Prometheus.

/* 9 unexporteds ... *//* 9 unexporteds: */

func metricName(namespace string, m *metricdata.Metric) string

func newCollector(opts Options, registrar *prometheus.Registry) *collector

func sanitize(s string) string sanitize returns a string that is trunacated to 100 characters if it's too long, and replaces non-alphanumeric characters to underscores.

func sanitizeRune(r rune) rune converts anything that is not a letter or digit to an underscore

func toLabelValues(labelValues []metricdata.LabelValue) (values []string)

func toPromLabels(mls []metricdata.LabelKey) (labels []string)

func toPromMetric(desc *prometheus.Desc, metric *metricdata.Metric, point metricdata.Point, labelValues []string) (prometheus.Metric, error)

func toPromValue(point metricdata.Point) (float64, error)

func typeMismatchError(point metricdata.Point) error

Package-Level Constants (only one, which is unexported) /* one unexported ... *//* one unexported: */

const labelKeySizeLimit = 100