mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-12 10:04:29 +02:00
7674eebf56
* Removed different types of Detectors for Resources. This change simplifies different types of collectors into one list. The order of this list determines how they are applied. Defaults are applied when the user does not supply any detectors. To achieve default behavior and additional behavior a DefaultDetectors struct has been created * missed prometheus test. * Changed behavior around WithDetectors(nil) Added examples of use of WithDetectors. * Added NoOp example * Changed test to reflect acutal default case This changes because WithDetector() no longer is the same as not using WithDetector() * Unexports the noOp detector * Updated changelog * Fixes to spelling mistakes. * Added NewEmptyResouce and unexported builtin detectors * Fix for prometheus example * Resource has two Rs I need to get a new R key it seems. Co-authored-by: Sam Xie <xsambundy@gmail.com> * Replaced NewEmptyResource() with New() * Fix test function name * Comment fixups. * Apply suggestions from code review Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com> Co-authored-by: Sam Xie <xsambundy@gmail.com> Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>
93 lines
2.5 KiB
Go
93 lines
2.5 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package resource // import "go.opentelemetry.io/otel/sdk/resource"
|
|
|
|
import (
|
|
"context"
|
|
|
|
"go.opentelemetry.io/otel/attribute"
|
|
)
|
|
|
|
// config contains configuration for Resource creation.
|
|
type config struct {
|
|
// detectors that will be evaluated.
|
|
detectors []Detector
|
|
}
|
|
|
|
// Option is the interface that applies a configuration option.
|
|
type Option interface {
|
|
// Apply sets the Option value of a config.
|
|
Apply(*config)
|
|
|
|
// A private method to prevent users implementing the
|
|
// interface and so future additions to it will not
|
|
// violate compatibility.
|
|
private()
|
|
}
|
|
|
|
type option struct{}
|
|
|
|
func (option) private() {}
|
|
|
|
// WithAttributes adds attributes to the configured Resource.
|
|
func WithAttributes(attributes ...attribute.KeyValue) Option {
|
|
return WithDetectors(detectAttributes{attributes})
|
|
}
|
|
|
|
type detectAttributes struct {
|
|
attributes []attribute.KeyValue
|
|
}
|
|
|
|
func (d detectAttributes) Detect(context.Context) (*Resource, error) {
|
|
return NewWithAttributes(d.attributes...), nil
|
|
}
|
|
|
|
// WithDetectors adds detectors to be evaluated for the configured resource.
|
|
func WithDetectors(detectors ...Detector) Option {
|
|
return detectorsOption{detectors: detectors}
|
|
}
|
|
|
|
type detectorsOption struct {
|
|
option
|
|
detectors []Detector
|
|
}
|
|
|
|
// Apply implements Option.
|
|
func (o detectorsOption) Apply(cfg *config) {
|
|
cfg.detectors = append(cfg.detectors, o.detectors...)
|
|
}
|
|
|
|
// WithBuiltinDetectors adds the built detectors to the configured resource.
|
|
func WithBuiltinDetectors() Option {
|
|
return WithDetectors(telemetrySDK{},
|
|
host{},
|
|
fromEnv{})
|
|
}
|
|
|
|
// WithFromEnv adds attributes from environment variables to the configured resource.
|
|
func WithFromEnv() Option {
|
|
return WithDetectors(fromEnv{})
|
|
}
|
|
|
|
// WithHost adds attributes from the host to the configured resource.
|
|
func WithHost() Option {
|
|
return WithDetectors(host{})
|
|
}
|
|
|
|
// WithTelemetrySDK adds TelemetrySDK version info to the configured resource.
|
|
func WithTelemetrySDK() Option {
|
|
return WithDetectors(telemetrySDK{})
|
|
}
|