summaryrefslogtreecommitdiff
path: root/vendor/go.opentelemetry.io/otel/sdk/metric/doc.go
diff options
context:
space:
mode:
authorLibravatar Terin Stock <terinjokes@gmail.com>2025-03-09 17:47:56 +0100
committerLibravatar Terin Stock <terinjokes@gmail.com>2025-03-10 01:59:49 +0100
commit3ac1ee16f377d31a0fb80c8dae28b6239ac4229e (patch)
treef61faa581feaaeaba2542b9f2b8234a590684413 /vendor/go.opentelemetry.io/otel/sdk/metric/doc.go
parent[chore] update URLs to forked source (diff)
downloadgotosocial-3ac1ee16f377d31a0fb80c8dae28b6239ac4229e.tar.xz
[chore] remove vendor
Diffstat (limited to 'vendor/go.opentelemetry.io/otel/sdk/metric/doc.go')
-rw-r--r--vendor/go.opentelemetry.io/otel/sdk/metric/doc.go47
1 files changed, 0 insertions, 47 deletions
diff --git a/vendor/go.opentelemetry.io/otel/sdk/metric/doc.go b/vendor/go.opentelemetry.io/otel/sdk/metric/doc.go
deleted file mode 100644
index 90a4ae16c..000000000
--- a/vendor/go.opentelemetry.io/otel/sdk/metric/doc.go
+++ /dev/null
@@ -1,47 +0,0 @@
-// Copyright The OpenTelemetry Authors
-// SPDX-License-Identifier: Apache-2.0
-
-// Package metric provides an implementation of the OpenTelemetry metrics SDK.
-//
-// See https://opentelemetry.io/docs/concepts/signals/metrics/ for information
-// about the concept of OpenTelemetry metrics and
-// https://opentelemetry.io/docs/concepts/components/ for more information
-// about OpenTelemetry SDKs.
-//
-// The entry point for the metric package is the MeterProvider. It is the
-// object that all API calls use to create Meters, instruments, and ultimately
-// make metric measurements. Also, it is an object that should be used to
-// control the life-cycle (start, flush, and shutdown) of the SDK.
-//
-// A MeterProvider needs to be configured to export the measured data, this is
-// done by configuring it with a Reader implementation (using the WithReader
-// MeterProviderOption). Readers take two forms: ones that push to an endpoint
-// (NewPeriodicReader), and ones that an endpoint pulls from. See
-// [go.opentelemetry.io/otel/exporters] for exporters that can be used as
-// or with these Readers.
-//
-// Each Reader, when registered with the MeterProvider, can be augmented with a
-// View. Views allow users that run OpenTelemetry instrumented code to modify
-// the generated data of that instrumentation.
-//
-// The data generated by a MeterProvider needs to include information about its
-// origin. A MeterProvider needs to be configured with a Resource, using the
-// WithResource MeterProviderOption, to include this information. This Resource
-// should be used to describe the unique runtime environment instrumented code
-// is being run on. That way when multiple instances of the code are collected
-// at a single endpoint their origin is decipherable.
-//
-// To avoid leaking memory, the SDK returns the same instrument for calls to
-// create new instruments with the same Name, Unit, and Description.
-// Importantly, callbacks provided using metric.WithFloat64Callback or
-// metric.WithInt64Callback will only apply for the first instrument created
-// with a given Name, Unit, and Description. Instead, use
-// Meter.RegisterCallback and Registration.Unregister to add and remove
-// callbacks without leaking memory.
-//
-// See [go.opentelemetry.io/otel/metric] for more information about
-// the metric API.
-//
-// See [go.opentelemetry.io/otel/sdk/metric/internal/x] for information about
-// the experimental features.
-package metric // import "go.opentelemetry.io/otel/sdk/metric"