diff options
Diffstat (limited to 'vendor/go.opentelemetry.io/contrib/bridges/prometheus/doc.go')
| -rw-r--r-- | vendor/go.opentelemetry.io/contrib/bridges/prometheus/doc.go | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/vendor/go.opentelemetry.io/contrib/bridges/prometheus/doc.go b/vendor/go.opentelemetry.io/contrib/bridges/prometheus/doc.go new file mode 100644 index 000000000..44145a103 --- /dev/null +++ b/vendor/go.opentelemetry.io/contrib/bridges/prometheus/doc.go @@ -0,0 +1,22 @@ +// Copyright The OpenTelemetry Authors +// SPDX-License-Identifier: Apache-2.0 + +// Package prometheus provides a bridge from Prometheus to OpenTelemetry. +// +// The Prometheus Bridge allows using the [Prometheus Golang client library] +// with the OpenTelemetry SDK. This enables prometheus instrumentation libraries +// to be used with OpenTelemetry exporters, including OTLP. +// +// Prometheus histograms are translated to OpenTelemetry exponential histograms +// when native histograms are enabled in the Prometheus client. To enable +// Prometheus native histograms, set the (currently experimental) NativeHistogram... +// options of the prometheus [HistogramOpts] when creating prometheus histograms. +// +// While the Prometheus Bridge has some overhead, it can significantly reduce the +// combined overall CPU and Memory footprint when sending to an OpenTelemetry +// Collector. See the [benchmarks] for more details. +// +// [Prometheus Golang client library]: https://github.com/prometheus/client_golang +// [HistogramOpts]: https://pkg.go.dev/github.com/prometheus/client_golang/prometheus#HistogramOpts +// [benchmarks]: https://github.com/open-telemetry/opentelemetry-go-contrib/blob/main/bridges/prometheus/BENCHMARKS.md +package prometheus // import "go.opentelemetry.io/contrib/bridges/prometheus" |