Skip to content

fix(ottl): enforce valid types for setters in contexts #43505

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix(ottl): enforce valid types for setters in contexts #43505

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
34947d7
fix(ottl): enforce valid types for setters in contexts
jsvd Oct 13, 2025
554df8d
add changelog entry
jsvd Oct 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .chloggen/fix_40198_simple.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: bug_fix

# The name of the component, or a single word describing the area of concern, (e.g. receiver/filelog)
component: pkg/ottl

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Return errors when OTTL context setters receive values of the wrong type

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [40198]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext: |
Introduces `ctxutil.ExpectType` and updates log, metric, and scope setters to surface type assertion failures.

# If your change doesn't affect end users or the exported elements of any package,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: [api, user]
100 changes: 64 additions & 36 deletions pkg/ottl/contexts/internal/ctxlog/log.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,11 @@ func accessTimeUnixNano[K Context]() ottl.StandardGetSetter[K] {
return tCtx.GetLogRecord().Timestamp().AsTime().UnixNano(), nil
},
Setter: func(_ context.Context, tCtx K, val any) error {
if i, ok := val.(int64); ok {
tCtx.GetLogRecord().SetTimestamp(pcommon.NewTimestampFromTime(time.Unix(0, i)))
i, err := ctxutil.ExpectType[int64](val)
if err != nil {
return err
}
tCtx.GetLogRecord().SetTimestamp(pcommon.NewTimestampFromTime(time.Unix(0, i)))
return nil
},
}
Expand All @@ -102,9 +104,11 @@ func accessObservedTimeUnixNano[K Context]() ottl.StandardGetSetter[K] {
return tCtx.GetLogRecord().ObservedTimestamp().AsTime().UnixNano(), nil
},
Setter: func(_ context.Context, tCtx K, val any) error {
if i, ok := val.(int64); ok {
tCtx.GetLogRecord().SetObservedTimestamp(pcommon.NewTimestampFromTime(time.Unix(0, i)))
i, err := ctxutil.ExpectType[int64](val)
if err != nil {
return err
}
tCtx.GetLogRecord().SetObservedTimestamp(pcommon.NewTimestampFromTime(time.Unix(0, i)))
return nil
},
}
Expand All @@ -116,9 +120,11 @@ func accessTime[K Context]() ottl.StandardGetSetter[K] {
return tCtx.GetLogRecord().Timestamp().AsTime(), nil
},
Setter: func(_ context.Context, tCtx K, val any) error {
if i, ok := val.(time.Time); ok {
tCtx.GetLogRecord().SetTimestamp(pcommon.NewTimestampFromTime(i))
i, err := ctxutil.ExpectType[time.Time](val)
if err != nil {
return err
}
tCtx.GetLogRecord().SetTimestamp(pcommon.NewTimestampFromTime(i))
return nil
},
}
Expand All @@ -130,9 +136,11 @@ func accessObservedTime[K Context]() ottl.StandardGetSetter[K] {
return tCtx.GetLogRecord().ObservedTimestamp().AsTime(), nil
},
Setter: func(_ context.Context, tCtx K, val any) error {
if i, ok := val.(time.Time); ok {
tCtx.GetLogRecord().SetObservedTimestamp(pcommon.NewTimestampFromTime(i))
i, err := ctxutil.ExpectType[time.Time](val)
if err != nil {
return err
}
tCtx.GetLogRecord().SetObservedTimestamp(pcommon.NewTimestampFromTime(i))
return nil
},
}
Expand All @@ -144,9 +152,11 @@ func accessSeverityNumber[K Context]() ottl.StandardGetSetter[K] {
return int64(tCtx.GetLogRecord().SeverityNumber()), nil
},
Setter: func(_ context.Context, tCtx K, val any) error {
if i, ok := val.(int64); ok {
tCtx.GetLogRecord().SetSeverityNumber(plog.SeverityNumber(i))
i, err := ctxutil.ExpectType[int64](val)
if err != nil {
return err
}
tCtx.GetLogRecord().SetSeverityNumber(plog.SeverityNumber(i))
return nil
},
}
Expand All @@ -158,9 +168,11 @@ func accessSeverityText[K Context]() ottl.StandardGetSetter[K] {
return tCtx.GetLogRecord().SeverityText(), nil
},
Setter: func(_ context.Context, tCtx K, val any) error {
if s, ok := val.(string); ok {
tCtx.GetLogRecord().SetSeverityText(s)
s, err := ctxutil.ExpectType[string](val)
if err != nil {
return err
}
tCtx.GetLogRecord().SetSeverityText(s)
return nil
},
}
Expand Down Expand Up @@ -210,9 +222,11 @@ func accessStringBody[K Context]() ottl.StandardGetSetter[K] {
return tCtx.GetLogRecord().Body().AsString(), nil
},
Setter: func(_ context.Context, tCtx K, val any) error {
if str, ok := val.(string); ok {
tCtx.GetLogRecord().Body().SetStr(str)
str, err := ctxutil.ExpectType[string](val)
if err != nil {
return err
}
tCtx.GetLogRecord().Body().SetStr(str)
return nil
},
}
Expand Down Expand Up @@ -246,9 +260,11 @@ func accessDroppedAttributesCount[K Context]() ottl.StandardGetSetter[K] {
return int64(tCtx.GetLogRecord().DroppedAttributesCount()), nil
},
Setter: func(_ context.Context, tCtx K, val any) error {
if i, ok := val.(int64); ok {
tCtx.GetLogRecord().SetDroppedAttributesCount(uint32(i))
i, err := ctxutil.ExpectType[int64](val)
if err != nil {
return err
}
tCtx.GetLogRecord().SetDroppedAttributesCount(uint32(i))
return nil
},
}
Expand All @@ -260,9 +276,11 @@ func accessFlags[K Context]() ottl.StandardGetSetter[K] {
return int64(tCtx.GetLogRecord().Flags()), nil
},
Setter: func(_ context.Context, tCtx K, val any) error {
if i, ok := val.(int64); ok {
tCtx.GetLogRecord().SetFlags(plog.LogRecordFlags(i))
i, err := ctxutil.ExpectType[int64](val)
if err != nil {
return err
}
tCtx.GetLogRecord().SetFlags(plog.LogRecordFlags(i))
return nil
},
}
Expand All @@ -274,9 +292,11 @@ func accessTraceID[K Context]() ottl.StandardGetSetter[K] {
return tCtx.GetLogRecord().TraceID(), nil
},
Setter: func(_ context.Context, tCtx K, val any) error {
if newTraceID, ok := val.(pcommon.TraceID); ok {
tCtx.GetLogRecord().SetTraceID(newTraceID)
newTraceID, err := ctxutil.ExpectType[pcommon.TraceID](val)
if err != nil {
return err
}
tCtx.GetLogRecord().SetTraceID(newTraceID)
return nil
},
}
Expand All @@ -289,13 +309,15 @@ func accessStringTraceID[K Context]() ottl.StandardGetSetter[K] {
return hex.EncodeToString(id[:]), nil
},
Setter: func(_ context.Context, tCtx K, val any) error {
if str, ok := val.(string); ok {
id, err := ctxcommon.ParseTraceID(str)
if err != nil {
return err
}
tCtx.GetLogRecord().SetTraceID(id)
str, err := ctxutil.ExpectType[string](val)
if err != nil {
return err
}
id, err := ctxcommon.ParseTraceID(str)
if err != nil {
return err
}
tCtx.GetLogRecord().SetTraceID(id)
return nil
},
}
Expand All @@ -307,9 +329,11 @@ func accessSpanID[K Context]() ottl.StandardGetSetter[K] {
return tCtx.GetLogRecord().SpanID(), nil
},
Setter: func(_ context.Context, tCtx K, val any) error {
if newSpanID, ok := val.(pcommon.SpanID); ok {
tCtx.GetLogRecord().SetSpanID(newSpanID)
newSpanID, err := ctxutil.ExpectType[pcommon.SpanID](val)
if err != nil {
return err
}
tCtx.GetLogRecord().SetSpanID(newSpanID)
return nil
},
}
Expand All @@ -322,13 +346,15 @@ func accessStringSpanID[K Context]() ottl.StandardGetSetter[K] {
return hex.EncodeToString(id[:]), nil
},
Setter: func(_ context.Context, tCtx K, val any) error {
if str, ok := val.(string); ok {
id, err := ctxcommon.ParseSpanID(str)
if err != nil {
return err
}
tCtx.GetLogRecord().SetSpanID(id)
str, err := ctxutil.ExpectType[string](val)
if err != nil {
return err
}
id, err := ctxcommon.ParseSpanID(str)
if err != nil {
return err
}
tCtx.GetLogRecord().SetSpanID(id)
return nil
},
}
Expand All @@ -340,9 +366,11 @@ func accessEventName[K Context]() ottl.StandardGetSetter[K] {
return tCtx.GetLogRecord().EventName(), nil
},
Setter: func(_ context.Context, tCtx K, val any) error {
if v, ok := val.(string); ok {
tCtx.GetLogRecord().SetEventName(v)
v, err := ctxutil.ExpectType[string](val)
if err != nil {
return err
}
tCtx.GetLogRecord().SetEventName(v)
return nil
},
}
Expand Down
82 changes: 51 additions & 31 deletions pkg/ottl/contexts/internal/ctxmetric/metric.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,11 @@ func accessName[K Context]() ottl.StandardGetSetter[K] {
return tCtx.GetMetric().Name(), nil
},
Setter: func(_ context.Context, tCtx K, val any) error {
if str, ok := val.(string); ok {
tCtx.GetMetric().SetName(str)
str, err := ctxutil.ExpectType[string](val)
if err != nil {
return err
}
tCtx.GetMetric().SetName(str)
return nil
},
}
Expand All @@ -62,9 +64,11 @@ func accessDescription[K Context]() ottl.StandardGetSetter[K] {
return tCtx.GetMetric().Description(), nil
},
Setter: func(_ context.Context, tCtx K, val any) error {
if str, ok := val.(string); ok {
tCtx.GetMetric().SetDescription(str)
str, err := ctxutil.ExpectType[string](val)
if err != nil {
return err
}
tCtx.GetMetric().SetDescription(str)
return nil
},
}
Expand All @@ -76,9 +80,11 @@ func accessUnit[K Context]() ottl.StandardGetSetter[K] {
return tCtx.GetMetric().Unit(), nil
},
Setter: func(_ context.Context, tCtx K, val any) error {
if str, ok := val.(string); ok {
tCtx.GetMetric().SetUnit(str)
str, err := ctxutil.ExpectType[string](val)
if err != nil {
return err
}
tCtx.GetMetric().SetUnit(str)
return nil
},
}
Expand Down Expand Up @@ -112,16 +118,18 @@ func accessAggTemporality[K Context]() ottl.StandardGetSetter[K] {
return nil, nil
},
Setter: func(_ context.Context, tCtx K, val any) error {
if newAggTemporality, ok := val.(int64); ok {
metric := tCtx.GetMetric()
switch metric.Type() {
case pmetric.MetricTypeSum:
metric.Sum().SetAggregationTemporality(pmetric.AggregationTemporality(newAggTemporality))
case pmetric.MetricTypeHistogram:
metric.Histogram().SetAggregationTemporality(pmetric.AggregationTemporality(newAggTemporality))
case pmetric.MetricTypeExponentialHistogram:
metric.ExponentialHistogram().SetAggregationTemporality(pmetric.AggregationTemporality(newAggTemporality))
}
newAggTemporality, err := ctxutil.ExpectType[int64](val)
if err != nil {
return err
}
metric := tCtx.GetMetric()
switch metric.Type() {
case pmetric.MetricTypeSum:
metric.Sum().SetAggregationTemporality(pmetric.AggregationTemporality(newAggTemporality))
case pmetric.MetricTypeHistogram:
metric.Histogram().SetAggregationTemporality(pmetric.AggregationTemporality(newAggTemporality))
case pmetric.MetricTypeExponentialHistogram:
metric.ExponentialHistogram().SetAggregationTemporality(pmetric.AggregationTemporality(newAggTemporality))
}
return nil
},
Expand All @@ -138,11 +146,13 @@ func accessIsMonotonic[K Context]() ottl.StandardGetSetter[K] {
return nil, nil
},
Setter: func(_ context.Context, tCtx K, val any) error {
if newIsMonotonic, ok := val.(bool); ok {
metric := tCtx.GetMetric()
if metric.Type() == pmetric.MetricTypeSum {
metric.Sum().SetIsMonotonic(newIsMonotonic)
}
newIsMonotonic, err := ctxutil.ExpectType[bool](val)
if err != nil {
return err
}
metric := tCtx.GetMetric()
if metric.Type() == pmetric.MetricTypeSum {
metric.Sum().SetIsMonotonic(newIsMonotonic)
}
return nil
},
Expand Down Expand Up @@ -171,25 +181,35 @@ func accessDataPoints[K Context]() ottl.StandardGetSetter[K] {
metric := tCtx.GetMetric()
switch metric.Type() {
case pmetric.MetricTypeSum:
if newDataPoints, ok := val.(pmetric.NumberDataPointSlice); ok {
newDataPoints.CopyTo(metric.Sum().DataPoints())
newDataPoints, err := ctxutil.ExpectType[pmetric.NumberDataPointSlice](val)
if err != nil {
return err
}
newDataPoints.CopyTo(metric.Sum().DataPoints())
case pmetric.MetricTypeGauge:
if newDataPoints, ok := val.(pmetric.NumberDataPointSlice); ok {
newDataPoints.CopyTo(metric.Gauge().DataPoints())
newDataPoints, err := ctxutil.ExpectType[pmetric.NumberDataPointSlice](val)
if err != nil {
return err
}
newDataPoints.CopyTo(metric.Gauge().DataPoints())
case pmetric.MetricTypeHistogram:
if newDataPoints, ok := val.(pmetric.HistogramDataPointSlice); ok {
newDataPoints.CopyTo(metric.Histogram().DataPoints())
newDataPoints, err := ctxutil.ExpectType[pmetric.HistogramDataPointSlice](val)
if err != nil {
return err
}
newDataPoints.CopyTo(metric.Histogram().DataPoints())
case pmetric.MetricTypeExponentialHistogram:
if newDataPoints, ok := val.(pmetric.ExponentialHistogramDataPointSlice); ok {
newDataPoints.CopyTo(metric.ExponentialHistogram().DataPoints())
newDataPoints, err := ctxutil.ExpectType[pmetric.ExponentialHistogramDataPointSlice](val)
if err != nil {
return err
}
newDataPoints.CopyTo(metric.ExponentialHistogram().DataPoints())
case pmetric.MetricTypeSummary:
if newDataPoints, ok := val.(pmetric.SummaryDataPointSlice); ok {
newDataPoints.CopyTo(metric.Summary().DataPoints())
newDataPoints, err := ctxutil.ExpectType[pmetric.SummaryDataPointSlice](val)
if err != nil {
return err
}
newDataPoints.CopyTo(metric.Summary().DataPoints())
}
return nil
},
Expand Down
Loading