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.
var ErrPartialResource = errors.New("partial resource")
Detector detects OpenTelemetry resource information.
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)
}
func StringDetector(schemaURL string, k attribute.Key, f func() (string, error)) Detector
StringDetector returns a Detector that will produce a *Resource containing the string as a value corresponding to k. The resulting Resource will have the specified schemaURL.
Option is the interface that applies a configuration option.
type Option interface {
// contains filtered or unexported methods
}
func WithAttributes(attributes ...attribute.KeyValue) Option
WithAttributes adds attributes to the configured Resource.
func WithContainer() Option
WithContainer adds all the Container attributes to the configured Resource. See individual WithContainer* functions to configure specific attributes.
func WithContainerID() Option
WithContainerID adds an attribute with the id of the container to the configured Resource. Note: WithContainerID will not extract the correct container ID in an ECS environment. Please use the ECS resource detector instead (https://pkg.go.dev/go.opentelemetry.io/contrib/detectors/aws/ecs).
func WithDetectors(detectors ...Detector) Option
WithDetectors adds detectors to be evaluated for the configured resource.
func WithFromEnv() Option
WithFromEnv adds attributes from environment variables to the configured resource.
func WithHost() Option
WithHost adds attributes from the host to the configured resource.
func WithHostID() Option
WithHostID adds host ID information to the configured resource.
func WithOS() Option
WithOS adds all the OS attributes to the configured Resource. See individual WithOS* functions to configure specific attributes.
func WithOSDescription() Option
WithOSDescription adds an attribute with the operating system description to the configured Resource. The formatted string is equivalent to the output of the `uname -snrvm` command.
func WithOSType() Option
WithOSType adds an attribute with the operating system type to the configured Resource.
func WithProcess() Option
WithProcess adds all the Process attributes to the configured Resource.
Warning! This option will include process command line arguments. If these contain sensitive information it will be included in the exported resource.
This option is equivalent to calling WithProcessPID, WithProcessExecutableName, WithProcessExecutablePath, WithProcessCommandArgs, WithProcessOwner, WithProcessRuntimeName, WithProcessRuntimeVersion, and WithProcessRuntimeDescription. See each option function for information about what resource attributes each includes.
func WithProcessCommandArgs() Option
WithProcessCommandArgs adds an attribute with all the command arguments (including the command/executable itself) as received by the process to the configured Resource.
Warning! This option will include process command line arguments. If these contain sensitive information it will be included in the exported resource.
func WithProcessExecutableName() Option
WithProcessExecutableName adds an attribute with the name of the process executable to the configured Resource.
func WithProcessExecutablePath() Option
WithProcessExecutablePath adds an attribute with the full path to the process executable to the configured Resource.
func WithProcessOwner() Option
WithProcessOwner adds an attribute with the username of the user that owns the process to the configured Resource.
func WithProcessPID() Option
WithProcessPID adds an attribute with the process identifier (PID) to the configured Resource.
func WithProcessRuntimeDescription() Option
WithProcessRuntimeDescription adds an attribute with an additional description about the runtime of the process to the configured Resource.
func WithProcessRuntimeName() Option
WithProcessRuntimeName adds an attribute with the name of the runtime of this process to the configured Resource.
func WithProcessRuntimeVersion() Option
WithProcessRuntimeVersion adds an attribute with the version of the runtime of this process to the configured Resource.
func WithSchemaURL(schemaURL string) Option
WithSchemaURL sets the schema URL for the configured resource.
func WithTelemetrySDK() Option
WithTelemetrySDK adds TelemetrySDK version info to the configured resource.
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.
type Resource struct {
// contains filtered or unexported fields
}
func Default() *Resource
Default returns an instance of Resource with a default "service.name" and OpenTelemetrySDK attributes.
func Detect(ctx context.Context, detectors ...Detector) (*Resource, error)
Detect calls all input detectors sequentially and merges each result with the previous one. It returns the merged error too.
func Empty() *Resource
Empty returns an instance of Resource with no attributes. It is equivalent to a `nil` Resource.
func Environment() *Resource
Environment returns an instance of Resource with attributes extracted from the OTEL_RESOURCE_ATTRIBUTES environment variable.
func Merge(a, b *Resource) (*Resource, error)
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.
The SchemaURL of the resources will be merged according to the spec rules: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.20.0/specification/resource/sdk.md#merge If the resources have different non-empty schemaURL an empty resource and an error will be returned.
func New(ctx context.Context, opts ...Option) (*Resource, error)
New returns a Resource combined from the user-provided detectors.
func NewSchemaless(attrs ...attribute.KeyValue) *Resource
NewSchemaless creates a resource from attrs. If attrs contains duplicate keys, the last value will be used. If attrs contains any invalid items those items will be dropped. The resource will not be associated with a schema URL. If the schema of the attrs is known use NewWithAttributes instead.
func NewWithAttributes(schemaURL string, attrs ...attribute.KeyValue) *Resource
NewWithAttributes creates a resource from attrs and associates the resource with a schema URL. If attrs contains duplicate keys, the last value will be used. If attrs contains any invalid items those items will be dropped. The attrs are assumed to be in a schema identified by schemaURL.
func (r *Resource) Attributes() []attribute.KeyValue
Attributes returns a copy of attributes from the resource in a sorted order. To avoid allocating a new slice, use an iterator.
func (r *Resource) Encoded(enc attribute.Encoder) string
Encoded returns an encoded representation of the resource.
func (r *Resource) Equal(eq *Resource) bool
Equal returns true when a Resource is equivalent to this Resource.
func (r *Resource) Equivalent() attribute.Distinct
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 (r *Resource) Iter() attribute.Iterator
Iter returns an iterator of the Resource attributes. This is ideal to use if you do not want a copy of the attributes.
func (r *Resource) Len() int
Len returns the number of unique key-values in this Resource.
func (r *Resource) MarshalJSON() ([]byte, error)
MarshalJSON encodes the resource attributes as a JSON list of { "Key": "...", "Value": ... } pairs in order sorted by key.
func (r *Resource) MarshalLog() interface{}
MarshalLog is the marshaling function used by the logging system to represent this exporter.
func (r *Resource) SchemaURL() string
SchemaURL returns the schema URL associated with Resource r.
func (r *Resource) Set() *attribute.Set
Set returns the equivalent *attribute.Set of this resource's attributes.
func (r *Resource) String() string
String implements the Stringer interface and provides a human-readable form of the resource.
Avoid using this representation as the key in a map of resources, use Equivalent() as the key instead.