cloudflared-mirror/vendor/go.opentelemetry.io/otel/sdk/resource/doc.go

21 lines
933 B
Go
Raw Normal View History

2022-04-06 23:20:29 +00:00
// Copyright The OpenTelemetry Authors
2024-05-07 10:19:58 +00:00
// SPDX-License-Identifier: Apache-2.0
2022-04-06 23:20:29 +00:00
// Package resource provides detecting and representing resources.
//
// The fundamental struct is a Resource which holds identifying information
// about the entities for which telemetry is exported.
//
// To automatically construct Resources from an environment a Detector
// interface is defined. Implementations of this interface can be passed to
// the Detect function to generate a Resource from the merged information.
//
// To load a user defined Resource from the environment variable
// OTEL_RESOURCE_ATTRIBUTES the FromEnv Detector can be used. It will interpret
// the value as a list of comma delimited key/value pairs
// (e.g. `<key1>=<value1>,<key2>=<value2>,...`).
//
// While this package provides a stable API,
// the attributes added by resource detectors may change.
2022-04-06 23:20:29 +00:00
package resource // import "go.opentelemetry.io/otel/sdk/resource"