Skip to content
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

Jump to bottom

[pkg/ottl] Remove tracing from OTTL #34910

Merged
merged 6 commits into from
Aug 29, 2024
Merged

[pkg/ottl] Remove tracing from OTTL #34910

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
bbf066a
Revert "[processor/transform] Instrument the transform processor to e…
TylerHelmuth Aug 28, 2024
84a6c11
temp
TylerHelmuth Aug 28, 2024
eaa3c7f
Fix go.mod
TylerHelmuth Aug 28, 2024
cd019a6
Fix go.mod
TylerHelmuth Aug 28, 2024
9b6050f
changelog
TylerHelmuth Aug 28, 2024
c8636f0
Fix changelog
TylerHelmuth Aug 28, 2024
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
27 changes: 27 additions & 0 deletions .chloggen/ottl-remove-tracing.yaml
View file
Open in desktop
TylerHelmuth marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Use this changelog template to create an entry for release notes.

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

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

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Remove tracing from OTTL due to performance concerns

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

# (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:

# 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: []
18 changes: 0 additions & 18 deletions pkg/ottl/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,21 +151,3 @@ service:
2024-05-29T16:38:09.600-0600 debug ottl@v0.101.0/parser.go:268 TransformContext after statement execution {"kind": "processor", "name": "transform", "pipeline": "logs", "statement": "set(instrumentation_scope.attributes[\"test\"], [\"pass\"])", "condition matched": true, "TransformContext": {"resource": {"attributes": {"test": "pass"}, "dropped_attribute_count": 0}, "scope": {"attributes": {"test": ["pass"]}, "dropped_attribute_count": 0, "name": "", "version": ""}, "log_record": {"attributes": {"log.file.name": "test.log"}, "body": "test", "dropped_attribute_count": 0, "flags": 0, "observed_time_unix_nano": 1717022289500721000, "severity_number": 0, "severity_text": "", "span_id": "", "time_unix_nano": 0, "trace_id": ""}, "cache": {}}}
2024-05-29T16:38:09.601-0600 debug ottl@v0.101.0/parser.go:268 TransformContext after statement execution {"kind": "processor", "name": "transform", "pipeline": "logs", "statement": "set(attributes[\"test\"], true)", "condition matched": true, "TransformContext": {"resource": {"attributes": {"test": "pass"}, "dropped_attribute_count": 0}, "scope": {"attributes": {"test": ["pass"]}, "dropped_attribute_count": 0, "name": "", "version": ""}, "log_record": {"attributes": {"log.file.name": "test.log", "test": true}, "body": "test", "dropped_attribute_count": 0, "flags": 0, "observed_time_unix_nano": 1717022289500721000, "severity_number": 0, "severity_text": "", "span_id": "", "time_unix_nano": 0, "trace_id": ""}, "cache": {}}}
```

If configured to do so, the collector also emits traces for the execution of OTTL statement sequences.
These traces contain spans for the execution of each statement, including the statement itself and whether it has
been applied or not. To make use of this, enable the self monitoring of the collector by setting the
`--feature-gates=telemetry.useOtelWithSDKConfigurationForInternalTelemetry` flag, and using the following configuration
to export the traces to e.g. an OTLP API endpoint:

```yaml
service:
telemetry:
traces:
processors:
- batch:
exporter:
otlp:
protocol: http/protobuf
endpoint: ${env:OTLP_ENDPOINT}/v1/traces
```
6 changes: 3 additions & 3 deletions pkg/ottl/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ require (
go.opentelemetry.io/collector/component v0.108.1
go.opentelemetry.io/collector/pdata v1.14.1
go.opentelemetry.io/collector/semconv v0.108.1
go.opentelemetry.io/otel v1.29.0
go.opentelemetry.io/otel/sdk v1.29.0
go.opentelemetry.io/otel/trace v1.29.0
go.uber.org/goleak v1.3.0
go.uber.org/zap v1.27.0
Expand Down Expand Up @@ -45,11 +43,13 @@ require (
github.com/prometheus/common v0.55.0 // indirect
github.com/prometheus/procfs v0.15.1 // indirect
go.opentelemetry.io/collector/config/configtelemetry v0.108.1 // indirect
go.opentelemetry.io/otel v1.29.0 // indirect
go.opentelemetry.io/otel/exporters/prometheus v0.50.0 // indirect
go.opentelemetry.io/otel/metric v1.29.0 // indirect
go.opentelemetry.io/otel/sdk v1.28.0 // indirect
go.opentelemetry.io/otel/sdk/metric v1.28.0 // indirect
go.uber.org/multierr v1.11.0 // indirect
golang.org/x/sys v0.24.0 // indirect
golang.org/x/sys v0.23.0 // indirect
golang.org/x/text v0.17.0 // indirect
google.golang.org/genproto/googleapis/rpc v0.0.0-20240701130421-f6361c86f094 // indirect
google.golang.org/grpc v1.65.0 // indirect
Expand Down
8 changes: 4 additions & 4 deletions pkg/ottl/go.sum
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

64 changes: 4 additions & 60 deletions pkg/ottl/parser.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,9 @@ import (

"github.com/alecthomas/participle/v2"
"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/codes"
"go.opentelemetry.io/otel/trace"
"go.opentelemetry.io/otel/trace/noop"
"go.uber.org/zap"
)

const (
logAttributeTraceID = "trace_id"
logAttributeSpanID = "span_id"
)

// Statement holds a top level Statement for processing telemetry data. A Statement is a combination of a function
// invocation and the boolean expression to match telemetry for invoking the function.
type Statement[K any] struct {
Expand Down Expand Up @@ -240,7 +231,6 @@ type StatementSequence[K any] struct {
statements []*Statement[K]
errorMode ErrorMode
telemetrySettings component.TelemetrySettings
tracer trace.Tracer
}

type StatementSequenceOption[K any] func(*StatementSequence[K])
Expand All @@ -260,10 +250,6 @@ func NewStatementSequence[K any](statements []*Statement[K], telemetrySettings c
statements: statements,
errorMode: PropagateError,
telemetrySettings: telemetrySettings,
tracer: &noop.Tracer{},
}
if telemetrySettings.TracerProvider != nil {
s.tracer = telemetrySettings.TracerProvider.Tracer("ottl")
}
for _, op := range options {
op(&s)
Expand All @@ -276,62 +262,20 @@ func NewStatementSequence[K any](statements []*Statement[K], telemetrySettings c
// When the ErrorMode of the StatementSequence is `ignore`, errors are logged and execution continues to the next statement.
// When the ErrorMode of the StatementSequence is `silent`, errors are not logged and execution continues to the next statement.
func (s *StatementSequence[K]) Execute(ctx context.Context, tCtx K) error {
ctx, sequenceSpan := s.tracer.Start(ctx, "ottl/StatementSequenceExecution")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of removing it, can we put all this logic behind a feature flag? Doing this we can still use the feature if needed and do some research about how to reduce its impact.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@iblancasa for now I'd rather completely remove additional logic from this hot path execution while we work on performance management.

defer sequenceSpan.End()
s.telemetrySettings.Logger.Debug(
"initial TransformContext",
zap.Any("TransformContext", tCtx),
zap.String(logAttributeTraceID, sequenceSpan.SpanContext().TraceID().String()),
zap.String(logAttributeSpanID, sequenceSpan.SpanContext().SpanID().String()),
)
s.telemetrySettings.Logger.Debug("initial TransformContext", zap.Any("TransformContext", tCtx))
for _, statement := range s.statements {
statementCtx, statementSpan := s.tracer.Start(ctx, "ottl/StatementExecution")
statementSpan.SetAttributes(
attribute.KeyValue{
Key: "statement",
Value: attribute.StringValue(statement.origText),
},
)
_, condition, err := statement.Execute(statementCtx, tCtx)
statementSpan.SetAttributes(
attribute.KeyValue{
Key: "condition.matched",
Value: attribute.BoolValue(condition),
},
)
s.telemetrySettings.Logger.Debug(
"TransformContext after statement execution",
zap.String("statement", statement.origText),
zap.Bool("condition matched", condition),
zap.Any("TransformContext", tCtx),
zap.String(logAttributeTraceID, statementSpan.SpanContext().TraceID().String()),
zap.String(logAttributeSpanID, statementSpan.SpanContext().SpanID().String()),
)
_, condition, err := statement.Execute(ctx, tCtx)
s.telemetrySettings.Logger.Debug("TransformContext after statement execution", zap.String("statement", statement.origText), zap.Bool("condition matched", condition), zap.Any("TransformContext", tCtx))
if err != nil {
statementSpan.RecordError(err)
errMsg := fmt.Sprintf("failed to execute statement '%s': %v", statement.origText, err)
statementSpan.SetStatus(codes.Error, errMsg)
if s.errorMode == PropagateError {
sequenceSpan.SetStatus(codes.Error, errMsg)
statementSpan.End()
err = fmt.Errorf("failed to execute statement: %v, %w", statement.origText, err)
return err
}
if s.errorMode == IgnoreError {
s.telemetrySettings.Logger.Warn(
"failed to execute statement",
zap.Error(err),
zap.String("statement", statement.origText),
zap.String(logAttributeTraceID, statementSpan.SpanContext().TraceID().String()),
zap.String(logAttributeSpanID, statementSpan.SpanContext().SpanID().String()),
)
s.telemetrySettings.Logger.Warn("failed to execute statement", zap.Error(err), zap.String("statement", statement.origText))
}
} else {
statementSpan.SetStatus(codes.Ok, "statement executed successfully")
}
statementSpan.End()
}
sequenceSpan.SetStatus(codes.Ok, "statement sequence executed successfully")
return nil
}

Expand Down
Loading