resourcedetectionprocessor

README

Resource Detection Processor

Supported pipeline types: metrics, traces, logs

The resource detection processor can be used to detect resource information from the host, in a format that conforms to the OpenTelemetry resource semantic conventions, and append or override the resource value in telemetry data with this information.

Currently supported detectors include:

• Environment Variable: Reads resource information from the OTEL_RESOURCE environment variable. This is expected to be in the format <key1>=<value1>,<key2>=<value2>,..., the details of which are currently pending confirmation in the OpenTelemetry specification.

• GCE Metadata: Uses the Google Cloud Client Libraries for Go to read resource information from the GCE metadata server to retrieve the following resource attributes:

  • cloud.provider (gcp)
  • cloud.account.id
  • cloud.region
  • cloud.zone
  • host.id
  • host.image.id
  • host.type

• AWS EC2: Uses AWS SDK for Go to read resource information from the EC2 instance metadata API to retrieve the following resource attributes:

  • cloud.provider (aws)
  • cloud.account.id
  • cloud.region
  • cloud.zone
  • host.id
  • host.image.id
  • host.type

Configuration

# a list of resource detectors to run, valid options are: "env", "gce", "ec2"
detectors: [ <string> ]
# determines if existing resource attributes should be overridden or preserved, defaults to true
override: <bool>

The full list of settings exposed for this extension are documented here with detailed sample configurations here.

Documentation

Overview

package resourcedetectionprocessor implements a processor for specifying resource labels to be added to OpenCensus trace data and metrics data.

Index

• func NewFactory() component.ProcessorFactory
• type Config

Functions

func NewFactory

func NewFactory() component.ProcessorFactory

NewFactory creates a new factory for ResourceDetection processor.

Types

type Config

type Config struct {
	configmodels.ProcessorSettings `mapstructure:",squash"`
	// Detectors is an ordered list of named detectors that should be
	// run to attempt to detect resource information.
	Detectors []string `mapstructure:"detectors"`
	// Timeout specifies the maximum amount of time that we will wait
	// before assuming a detector has failed. Defaults to 5s.
	Timeout time.Duration `mapstructure:"timeout"`
	// Override indicates whether any existing resource attributes
	// should be overridden or preserved. Defaults to true.
	Override bool `mapstructure:"override"`
}

Config defines configuration for Resource processor.