ottlscope

README

Instrumentation Scope Context

[!NOTE] This documentation applies only to version 0.120.0 and later. For information on earlier versions, please refer to the previous documentation.

The Instrumentation Scope Context is a Context implementation for pdata Instrumentation Scope, the Collector's internal representation for OTLP instrumentation scope data. This Context should be used when interacting only with OTLP instrumentation scope.

Paths

In general, the Instrumentation Scope Context supports accessing pdata using the field names from the instrumentation section in the common proto. All integers are returned and set via int64. All doubles are returned and set via float64.

The following paths are supported.

path	field accessed	type
scope.cache	the value of the current transform context's temporary cache. cache can be used as a temporary placeholder for data during complex transformations	pcommon.Map
scope.cache[""]	the value of an item in cache. Supports multiple indexes to access nested fields.	string, bool, int64, float64, pcommon.Map, pcommon.Slice, []byte or nil
resource	resource of the instrumentation scope being processed	pcommon.Resource
resource.attributes	resource attributes of the instrumentation scope being processed	pcommon.Map
resource.attributes[""]	the value of the resource attribute of the instrumentation scope being processed. Supports multiple indexes to access nested fields.	string, bool, int64, float64, pcommon.Map, pcommon.Slice, []byte or nil
resource.dropped_attributes_count	number of dropped attributes of the resource of the instrumentation scope being processed	int64
scope.name	name of the instrumentation scope of the scope being processed	string
scope.version	version of the instrumentation scope of the scope being processed	string
scope.dropped_attributes_count	number of dropped attributes of the instrumentation scope of the scope being processed	int64
scope.attributes	instrumentation scope attributes of the scope being processed	pcommon.Map
scope.attributes[""]	the value of the instrumentation scope attribute of the scope being processed. Supports multiple indexes to access nested fields.	string, bool, int64, float64, pcommon.Map, pcommon.Slice, []byte or nil

Enums

The Instrumentation Scope Context does not define any Enums at this time.

Documentation

Index

• Constants
• func NewConditionSequence(conditions []*ottl.Condition[TransformContext], ...) ottl.ConditionSequence[TransformContext]
• func NewParser(functions map[string]ottl.Factory[TransformContext], ...) (ottl.Parser[TransformContext], error)
• func NewStatementSequence(statements []*ottl.Statement[TransformContext], ...) ottl.StatementSequence[TransformContext]
• type ConditionSequenceOption
  • func WithConditionSequenceErrorMode(errorMode ottl.ErrorMode) ConditionSequenceOption
• type Option
  • func EnablePathContextNames() Option
• type StatementSequenceOption
  • func WithStatementSequenceErrorMode(errorMode ottl.ErrorMode) StatementSequenceOption
• type TransformContext
  • func NewTransformContext(instrumentationScope pcommon.InstrumentationScope, resource pcommon.Resource, ...) TransformContext
  • func (tCtx TransformContext) GetInstrumentationScope() pcommon.InstrumentationScope
  • func (tCtx TransformContext) GetResource() pcommon.Resource
  • func (tCtx TransformContext) GetResourceSchemaURLItem() internal.SchemaURLItem
  • func (tCtx TransformContext) GetScopeSchemaURLItem() internal.SchemaURLItem
  • func (tCtx TransformContext) MarshalLogObject(encoder zapcore.ObjectEncoder) error
• type TransformContextOption
  • func WithCache(cache *pcommon.Map) TransformContextOption

Constants

const (
	// Experimental: *NOTE* this constant is subject to change or removal in the future.
	ContextName = internal.ScopeContextName
)

Functions

func NewConditionSequence

func NewConditionSequence(conditions []*ottl.Condition[TransformContext], telemetrySettings component.TelemetrySettings, options ...ConditionSequenceOption) ottl.ConditionSequence[TransformContext]

func NewParser

func NewParser(functions map[string]ottl.Factory[TransformContext], telemetrySettings component.TelemetrySettings, options ...Option) (ottl.Parser[TransformContext], error)

func NewStatementSequence

func NewStatementSequence(statements []*ottl.Statement[TransformContext], telemetrySettings component.TelemetrySettings, options ...StatementSequenceOption) ottl.StatementSequence[TransformContext]

Types

type ConditionSequenceOption

type ConditionSequenceOption func(*ottl.ConditionSequence[TransformContext])

func WithConditionSequenceErrorMode

func WithConditionSequenceErrorMode(errorMode ottl.ErrorMode) ConditionSequenceOption

type Option

type Option func(*ottl.Parser[TransformContext])

func EnablePathContextNames

func EnablePathContextNames() Option

EnablePathContextNames enables the support to path's context names on statements. When this option is configured, all statement's paths must have a valid context prefix, otherwise an error is reported.

Experimental: *NOTE* this option is subject to change or removal in the future.

type StatementSequenceOption

type StatementSequenceOption func(*ottl.StatementSequence[TransformContext])

func WithStatementSequenceErrorMode

func WithStatementSequenceErrorMode(errorMode ottl.ErrorMode) StatementSequenceOption

type TransformContext

type TransformContext struct {
	// contains filtered or unexported fields
}

func NewTransformContext

func NewTransformContext(instrumentationScope pcommon.InstrumentationScope, resource pcommon.Resource, schemaURLItem internal.SchemaURLItem, options ...TransformContextOption) TransformContext

func (TransformContext) GetInstrumentationScope

func (tCtx TransformContext) GetInstrumentationScope() pcommon.InstrumentationScope

func (TransformContext) GetResource

func (tCtx TransformContext) GetResource() pcommon.Resource

func (TransformContext) GetResourceSchemaURLItem

func (tCtx TransformContext) GetResourceSchemaURLItem() internal.SchemaURLItem

func (TransformContext) GetScopeSchemaURLItem

func (tCtx TransformContext) GetScopeSchemaURLItem() internal.SchemaURLItem

func (TransformContext) MarshalLogObject

func (tCtx TransformContext) MarshalLogObject(encoder zapcore.ObjectEncoder) error

type TransformContextOption

type TransformContextOption func(*TransformContext)

func WithCache

func WithCache(cache *pcommon.Map) TransformContextOption

Experimental: *NOTE* this option is subject to change or removal in the future.