Documentation
¶
Overview ¶
Package resource provides detecting and representing resources.
This package is currently in a pre-GA phase. Backwards incompatible changes may be introduced in subsequent minor version releases as we work to track the evolving OpenTelemetry specification and user feedback.
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>,...`).
Index ¶
- Variables
- type Detector
- type FromEnv
- type Host
- type Option
- type Resource
- func (r *Resource) Attributes() []label.KeyValue
- func (r *Resource) Encoded(enc label.Encoder) string
- func (r *Resource) Equal(eq *Resource) bool
- func (r *Resource) Equivalent() label.Distinct
- func (r *Resource) Iter() label.Iterator
- func (r *Resource) LabelSet() *label.Set
- func (r *Resource) Len() int
- func (r *Resource) MarshalJSON() ([]byte, error)
- func (r *Resource) String() string
- type TelemetrySDK
Constants ¶
This section is empty.
Variables ¶
var ( // ErrPartialResource is returned by a detector when complete source // information for a Resource is unavailable or the source information // contains invalid values that are omitted from the returned Resource. ErrPartialResource = errors.New("partial resource") )
Functions ¶
This section is empty.
Types ¶
type Detector ¶
type Detector interface {
// Detect returns an initialized Resource based on gathered information.
// If the source information to construct a Resource contains invalid
// values, a Resource is returned with the valid parts of the source
// information used for initialization along with an appropriately
// wrapped ErrPartialResource error.
Detect(ctx context.Context) (*Resource, error)
}
Detector detects OpenTelemetry resource information
type FromEnv ¶
type FromEnv struct{}
FromEnv is a Detector that implements the Detector and collects resources from environment. This Detector is included as a builtin. If these resource attributes are not wanted, use the WithFromEnv(nil) or WithoutBuiltin() options to explicitly disable them.
type Host ¶ added in v0.14.0
type Host struct{}
Host is a Detector that provides information about the host being run on. This Detector is included as a builtin. If these resource attributes are not wanted, use the WithHost(nil) or WithoutBuiltin() options to explicitly disable them.
type Option ¶ added in v0.14.0
type Option interface {
// Apply sets the Option value of a config.
Apply(*config)
}
Option is the interface that applies a configuration option.
func WithAttributes ¶ added in v0.14.0
WithAttributes adds attributes to the configured Resource.
func WithDetectors ¶ added in v0.14.0
WithDetectors adds detectors to be evaluated for the configured resource.
func WithFromEnv ¶ added in v0.14.0
WithFromEnv overrides the builtin detector for OTEL_RESOURCE_ATTRIBUTES. Use nil to disable environment checking.
func WithHost ¶ added in v0.14.0
WithHost overrides the builtin `host.*` attributes. Use nil to disable these attributes entirely.
func WithTelemetrySDK ¶ added in v0.14.0
WithTelemetrySDK overrides the builtin `telemetry.sdk.*` attributes. Use nil to disable these attributes entirely.
func WithoutBuiltin ¶ added in v0.14.0
func WithoutBuiltin() Option
WithoutBuiltin disables all the builtin detectors, including the telemetry.sdk.*, host.*, and the environment detector.
type Resource ¶
type Resource struct {
// contains filtered or unexported fields
}
Resource describes an entity about which identifying information and metadata is exposed. Resource is an immutable object, equivalent to a map from key to unique value.
Resources should be passed and stored as pointers (`*resource.Resource`). The `nil` value is equivalent to an empty Resource.
func Detect ¶
Detect calls all input detectors sequentially and merges each result with the previous one. It returns the merged error too.
func Empty ¶
func Empty() *Resource
Empty returns an instance of Resource with no attributes. It is equivalent to a `nil` Resource.
func Merge ¶
Merge creates a new resource by combining resource a and b.
If there are common keys between resource a and b, then the value from resource b will overwrite the value from resource a, even if resource b's value is empty.
func New ¶
New returns a Resource combined from the provided attributes, user-provided detectors and builtin detectors.
func NewWithAttributes ¶ added in v0.14.0
NewWithAttributes creates a resource from a set of attributes. If there are duplicate keys present in the list of attributes, then the last value found for the key is preserved.
func (*Resource) Attributes ¶
Attributes returns a copy of attributes from the resource in a sorted order. To avoid allocating a new slice, use an iterator.
func (*Resource) Encoded ¶
Encoded returns an encoded representation of the resource by applying a label encoder. The result is cached by the underlying label set.
func (*Resource) Equivalent ¶
Equivalent returns an object that can be compared for equality between two resources. This value is suitable for use as a key in a map.
func (*Resource) Iter ¶
Iter returns an interator of the Resource attributes. This is ideal to use if you do not want a copy of the attributes.
func (*Resource) MarshalJSON ¶
MarshalJSON encodes labels as a JSON list of { "Key": "...", "Value": ... } pairs in order sorted by key.
type TelemetrySDK ¶ added in v0.14.0
type TelemetrySDK struct{}
TelemetrySDK is a Detector that provides information about the OpenTelemetry SDK used. This Detector is included as a builtin. If these resource attributes are not wanted, use the WithTelemetrySDK(nil) or WithoutBuiltin() options to explicitly disable them.
Source Files