Merge branch 'main' into add-splunk-rolling-restart-metric

Author: juanhotencoding

pkg/ottl/boolean_value.go

@@ -11,10 +11,12 @@ import (
 // boolExpressionEvaluator is a function that returns the result.
 type boolExpressionEvaluator[K any] func(ctx context.Context, tCtx K) (bool, error)
 
+// BoolExpr represents a condition in OTTL
 type BoolExpr[K any] struct {
 	boolExpressionEvaluator[K]
 }
 
+// Eval evaluates an OTTL condition
 func (e BoolExpr[K]) Eval(ctx context.Context, tCtx K) (bool, error) {
 	return e.boolExpressionEvaluator(ctx, tCtx)
 }

pkg/ottl/config.go

@@ -8,12 +8,16 @@ import (
 	"strings"
 )
 
+// ErrorMode is the way OTTL should handle errors.
 type ErrorMode string
 
 const (
-	IgnoreError    ErrorMode = "ignore"
+	// IgnoreError means OTTL will only log errors.
+	IgnoreError ErrorMode = "ignore"
+	// PropagateError means OTTL will log and return errors.
 	PropagateError ErrorMode = "propagate"
-	SilentError    ErrorMode = "silent"
+	// SilentError means OTTL will not log or return errors.
+	SilentError ErrorMode = "silent"
 )
 
 func (e *ErrorMode) UnmarshalText(text []byte) error {
@@ -27,13 +31,17 @@ func (e *ErrorMode) UnmarshalText(text []byte) error {
 	}
 }
 
+// LogicOperation represents the logical operations OTTL understands.
 type LogicOperation string
 
 const (
+	// And is the logical operator "and".
 	And LogicOperation = "and"
-	Or  LogicOperation = "or"
+	// Or is the logical operator "or".
+	Or LogicOperation = "or"
 )
 
+// UnmarshalText unmarshals a string into a LogicOperation. It errors if the string is not "and" or "or".
 func (l *LogicOperation) UnmarshalText(text []byte) error {
 	str := LogicOperation(strings.ToLower(string(text)))
 	switch str {

pkg/ottl/contexts/ottldatapoint/datapoint.go

@@ -22,6 +22,7 @@ import (
 	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/ottl/contexts/internal/logging"
 )
 
+// ContextName is the name of the context for datapoints.
 // Experimental: *NOTE* this constant is subject to change or removal in the future.
 const ContextName = ctxdatapoint.Name
 
@@ -32,6 +33,7 @@ var (
 	_ zapcore.ObjectMarshaler = (*TransformContext)(nil)
 )
 
+// TransformContext represents a Datapoint and all its hierarchy.
 type TransformContext struct {
 	dataPoint            any
 	metric               pmetric.Metric
@@ -43,6 +45,7 @@ type TransformContext struct {
 	resourceMetrics      pmetric.ResourceMetrics
 }
 
+// MarshalLogObject serializes the TransformContext into a zapcore.ObjectEncoder for logging.
 func (tCtx TransformContext) MarshalLogObject(encoder zapcore.ObjectEncoder) error {
 	err := encoder.AddObject("resource", logging.Resource(tCtx.resource))
 	err = errors.Join(err, encoder.AddObject("scope", logging.InstrumentationScope(tCtx.instrumentationScope)))
@@ -65,6 +68,7 @@ func (tCtx TransformContext) MarshalLogObject(encoder zapcore.ObjectEncoder) err
 
 type TransformContextOption func(*TransformContext)
 
+// NewTransformContext creates a new TransformContext with the provided parameters.
 func NewTransformContext(dataPoint any, metric pmetric.Metric, metrics pmetric.MetricSlice, instrumentationScope pcommon.InstrumentationScope, resource pcommon.Resource, scopeMetrics pmetric.ScopeMetrics, resourceMetrics pmetric.ResourceMetrics, options ...TransformContextOption) TransformContext {
 	tc := TransformContext{
 		dataPoint:            dataPoint,
@@ -82,35 +86,42 @@ func NewTransformContext(dataPoint any, metric pmetric.Metric, metrics pmetric.M
 	return tc
 }
 
+// GetDataPoint returns the datapoint from the TransformContext.
 func (tCtx TransformContext) GetDataPoint() any {
 	return tCtx.dataPoint
 }
 
+// GetInstrumentationScope returns the instrumentation scope from the TransformContext.
 func (tCtx TransformContext) GetInstrumentationScope() pcommon.InstrumentationScope {
 	return tCtx.instrumentationScope
 }
 
+// GetResource returns the resource from the TransformContext.
 func (tCtx TransformContext) GetResource() pcommon.Resource {
 	return tCtx.resource
 }
 
+// GetMetric returns the metric from the TransformContext.
 func (tCtx TransformContext) GetMetric() pmetric.Metric {
 	return tCtx.metric
 }
 
+// GetMetrics returns the metric slice from the TransformContext.
 func (tCtx TransformContext) GetMetrics() pmetric.MetricSlice {
 	return tCtx.metrics
 }
 
+// GetScopeSchemaURLItem returns the scope schema URL item from the TransformContext.
 func (tCtx TransformContext) GetScopeSchemaURLItem() ctxcommon.SchemaURLItem {
 	return tCtx.scopeMetrics
 }
 
+// GetResourceSchemaURLItem returns the resource schema URL item from the TransformContext.
 func (tCtx TransformContext) GetResourceSchemaURLItem() ctxcommon.SchemaURLItem {
 	return tCtx.resourceMetrics
 }
 
-// EnablePathContextNames enables the support to path's context names on statements.
+// EnablePathContextNames enables the support for 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.
 //
@@ -128,12 +139,14 @@ func EnablePathContextNames() ottl.Option[TransformContext] {
 
 type StatementSequenceOption func(*ottl.StatementSequence[TransformContext])
 
+// WithStatementSequenceErrorMode sets the error mode for a statement sequence.
 func WithStatementSequenceErrorMode(errorMode ottl.ErrorMode) StatementSequenceOption {
 	return func(s *ottl.StatementSequence[TransformContext]) {
 		ottl.WithStatementSequenceErrorMode[TransformContext](errorMode)(s)
 	}
 }
 
+// NewStatementSequence creates a new statement sequence with the provided statements and options.
 func NewStatementSequence(statements []*ottl.Statement[TransformContext], telemetrySettings component.TelemetrySettings, options ...StatementSequenceOption) ottl.StatementSequence[TransformContext] {
 	s := ottl.NewStatementSequence(statements, telemetrySettings)
 	for _, op := range options {
@@ -144,12 +157,14 @@ func NewStatementSequence(statements []*ottl.Statement[TransformContext], teleme
 
 type ConditionSequenceOption func(*ottl.ConditionSequence[TransformContext])
 
+// WithConditionSequenceErrorMode sets the error mode for a condition sequence.
 func WithConditionSequenceErrorMode(errorMode ottl.ErrorMode) ConditionSequenceOption {
 	return func(c *ottl.ConditionSequence[TransformContext]) {
 		ottl.WithConditionSequenceErrorMode[TransformContext](errorMode)(c)
 	}
 }
 
+// NewConditionSequence creates a new condition sequence with the provided conditions and options.
 func NewConditionSequence(conditions []*ottl.Condition[TransformContext], telemetrySettings component.TelemetrySettings, options ...ConditionSequenceOption) ottl.ConditionSequence[TransformContext] {
 	c := ottl.NewConditionSequence(conditions, telemetrySettings)
 	for _, op := range options {
@@ -158,6 +173,7 @@ func NewConditionSequence(conditions []*ottl.Condition[TransformContext], teleme
 	return c
 }
 
+// NewParser creates a new Datapoint parser with the provided functions and options.
 func NewParser(
 	functions map[string]ottl.Factory[TransformContext],
 	telemetrySettings component.TelemetrySettings,

pkg/ottl/contexts/ottllog/log.go

@@ -22,6 +22,7 @@ import (
 	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/ottl/contexts/internal/logging"
 )
 
+// ContextName is the name of the context for logs.
 // Experimental: *NOTE* this constant is subject to change or removal in the future.
 const ContextName = ctxlog.Name
 
@@ -31,6 +32,7 @@ var (
 	_ zapcore.ObjectMarshaler = (*TransformContext)(nil)
 )
 
+// TransformContext represents a log and its associated hierarchy.
 type TransformContext struct {
 	logRecord            plog.LogRecord
 	instrumentationScope pcommon.InstrumentationScope
@@ -42,6 +44,7 @@ type TransformContext struct {
 
 type logRecord plog.LogRecord
 
+// MarshalLogObject serializes the log into a zapcore.ObjectEncoder for logging.
 func (l logRecord) MarshalLogObject(encoder zapcore.ObjectEncoder) error {
 	lr := plog.LogRecord(l)
 	spanID := lr.SpanID()
@@ -59,6 +62,7 @@ func (l logRecord) MarshalLogObject(encoder zapcore.ObjectEncoder) error {
 	return err
 }
 
+// MarshalLogObject serializes the TransformContext into a zapcore.ObjectEncoder for logging.
 func (tCtx TransformContext) MarshalLogObject(encoder zapcore.ObjectEncoder) error {
 	err := encoder.AddObject("resource", logging.Resource(tCtx.resource))
 	err = errors.Join(err, encoder.AddObject("scope", logging.InstrumentationScope(tCtx.instrumentationScope)))
@@ -67,8 +71,10 @@ func (tCtx TransformContext) MarshalLogObject(encoder zapcore.ObjectEncoder) err
 	return err
 }
 
+// TransformContextOption represents an option for configuring a TransformContext.
 type TransformContextOption func(*TransformContext)
 
+// NewTransformContext creates a new TransformContext with the provided parameters.
 func NewTransformContext(logRecord plog.LogRecord, instrumentationScope pcommon.InstrumentationScope, resource pcommon.Resource, scopeLogs plog.ScopeLogs, resourceLogs plog.ResourceLogs, options ...TransformContextOption) TransformContext {
 	tc := TransformContext{
 		logRecord:            logRecord,
@@ -84,27 +90,32 @@ func NewTransformContext(logRecord plog.LogRecord, instrumentationScope pcommon.
 	return tc
 }
 
+// GetLogRecord returns the log record from the TransformContext.
 func (tCtx TransformContext) GetLogRecord() plog.LogRecord {
 	return tCtx.logRecord
 }
 
+// GetInstrumentationScope returns the instrumentation scope from the TransformContext.
 func (tCtx TransformContext) GetInstrumentationScope() pcommon.InstrumentationScope {
 	return tCtx.instrumentationScope
 }
 
+// GetResource returns the resource from the TransformContext.
 func (tCtx TransformContext) GetResource() pcommon.Resource {
 	return tCtx.resource
 }
 
+// GetScopeSchemaURLItem returns the scope schema URL item from the TransformContext.
 func (tCtx TransformContext) GetScopeSchemaURLItem() ctxcommon.SchemaURLItem {
 	return tCtx.scopeLogs
 }
 
+// GetResourceSchemaURLItem returns the resource schema URL item from the TransformContext.
 func (tCtx TransformContext) GetResourceSchemaURLItem() ctxcommon.SchemaURLItem {
 	return tCtx.resourceLogs
 }
 
-// EnablePathContextNames enables the support to path's context names on statements.
+// EnablePathContextNames enables the support for 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.
 //
@@ -119,14 +130,17 @@ func EnablePathContextNames() ottl.Option[TransformContext] {
 	}
 }
 
+// StatementSequenceOption represents an option for configuring a statement sequence.
 type StatementSequenceOption func(*ottl.StatementSequence[TransformContext])
 
+// WithStatementSequenceErrorMode sets the error mode for a statement sequence.
 func WithStatementSequenceErrorMode(errorMode ottl.ErrorMode) StatementSequenceOption {
 	return func(s *ottl.StatementSequence[TransformContext]) {
 		ottl.WithStatementSequenceErrorMode[TransformContext](errorMode)(s)
 	}
 }
 
+// NewStatementSequence creates a new statement sequence with the provided statements and options.
 func NewStatementSequence(statements []*ottl.Statement[TransformContext], telemetrySettings component.TelemetrySettings, options ...StatementSequenceOption) ottl.StatementSequence[TransformContext] {
 	s := ottl.NewStatementSequence(statements, telemetrySettings)
 	for _, op := range options {
@@ -135,14 +149,17 @@ func NewStatementSequence(statements []*ottl.Statement[TransformContext], teleme
 	return s
 }
 
+// ConditionSequenceOption represents an option for configuring a condition sequence.
 type ConditionSequenceOption func(*ottl.ConditionSequence[TransformContext])
 
+// WithConditionSequenceErrorMode sets the error mode for a condition sequence.
 func WithConditionSequenceErrorMode(errorMode ottl.ErrorMode) ConditionSequenceOption {
 	return func(c *ottl.ConditionSequence[TransformContext]) {
 		ottl.WithConditionSequenceErrorMode[TransformContext](errorMode)(c)
 	}
 }
 
+// NewConditionSequence creates a new condition sequence with the provided conditions and options.
 func NewConditionSequence(conditions []*ottl.Condition[TransformContext], telemetrySettings component.TelemetrySettings, options ...ConditionSequenceOption) ottl.ConditionSequence[TransformContext] {
 	c := ottl.NewConditionSequence(conditions, telemetrySettings)
 	for _, op := range options {
@@ -151,6 +168,7 @@ func NewConditionSequence(conditions []*ottl.Condition[TransformContext], teleme
 	return c
 }
 
+// NewParser creates a new log parser with the provided functions and options.
 func NewParser(
 	functions map[string]ottl.Factory[TransformContext],
 	telemetrySettings component.TelemetrySettings,