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.

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

[exporterhelper] fix missed metric aggregations #9048

Merged
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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/codeboten_fix-missing-metrics.yaml
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. otlpreceiver)
component: exporterhelper

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: fix missed metric aggregations

# One or more tracking issues or pull requests related to the change
issues: [9048]

# (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: |
This ensures that context cancellation in the exporter doesn't interfere with metric aggregation. The OTel
SDK currently returns if there's an error in the context used in `Add`. This means that if there's a
cancelled context in an export, the metrics are now recorded.

# 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: []
38 changes: 35 additions & 3 deletions exporter/exporterhelper/obsexporter.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

import (
"context"
"time"

"go.opencensus.io/stats"
"go.opencensus.io/tag"
Expand Down Expand Up @@ -154,7 +155,7 @@
// EndTracesOp completes the export operation that was started with StartTracesOp.
func (or *ObsReport) EndTracesOp(ctx context.Context, numSpans int, err error) {
numSent, numFailedToSend := toNumItems(numSpans, err)
or.recordMetrics(ctx, component.DataTypeTraces, numSent, numFailedToSend)
or.recordMetrics(withoutCancel(ctx), component.DataTypeTraces, numSent, numFailedToSend)
endSpan(ctx, err, numSent, numFailedToSend, obsmetrics.SentSpansKey, obsmetrics.FailedToSendSpansKey)
}

Expand All @@ -169,7 +170,7 @@
// StartMetricsOp.
func (or *ObsReport) EndMetricsOp(ctx context.Context, numMetricPoints int, err error) {
numSent, numFailedToSend := toNumItems(numMetricPoints, err)
or.recordMetrics(ctx, component.DataTypeMetrics, numSent, numFailedToSend)
or.recordMetrics(withoutCancel(ctx), component.DataTypeMetrics, numSent, numFailedToSend)
endSpan(ctx, err, numSent, numFailedToSend, obsmetrics.SentMetricPointsKey, obsmetrics.FailedToSendMetricPointsKey)
}

Expand All @@ -183,7 +184,7 @@
// EndLogsOp completes the export operation that was started with StartLogsOp.
func (or *ObsReport) EndLogsOp(ctx context.Context, numLogRecords int, err error) {
numSent, numFailedToSend := toNumItems(numLogRecords, err)
or.recordMetrics(ctx, component.DataTypeLogs, numSent, numFailedToSend)
or.recordMetrics(withoutCancel(ctx), component.DataTypeLogs, numSent, numFailedToSend)
endSpan(ctx, err, numSent, numFailedToSend, obsmetrics.SentLogRecordsKey, obsmetrics.FailedToSendLogRecordsKey)
}

Expand Down Expand Up @@ -313,3 +314,34 @@

enqueueFailedMeasure.Add(ctx, failed, metric.WithAttributes(or.otelAttrs...))
}

func withoutCancel(parent context.Context) context.Context {
codeboten marked this conversation as resolved.
Show resolved Hide resolved
if parent == nil {
panic("cannot create context from nil parent")

Check warning on line 320 in exporter/exporterhelper/obsexporter.go

View check run for this annotation

Codecov / codecov/patch

exporter/exporterhelper/obsexporter.go#L320

Added line #L320 was not covered by tests
}
return withoutCancelCtx{parent}
}

type withoutCancelCtx struct {
c context.Context
}

func (withoutCancelCtx) Deadline() (deadline time.Time, ok bool) {
return

Check warning on line 330 in exporter/exporterhelper/obsexporter.go

View check run for this annotation

Codecov / codecov/patch

exporter/exporterhelper/obsexporter.go#L329-L330

Added lines #L329 - L330 were not covered by tests
}

func (withoutCancelCtx) Done() <-chan struct{} {
return nil

Check warning on line 334 in exporter/exporterhelper/obsexporter.go

View check run for this annotation

Codecov / codecov/patch

exporter/exporterhelper/obsexporter.go#L333-L334

Added lines #L333 - L334 were not covered by tests
}

func (withoutCancelCtx) Err() error {
return nil
}

func (w withoutCancelCtx) Value(key any) any {
return w.c.Value(key)
}

func (w withoutCancelCtx) String() string {
return "withoutCancel"

Check warning on line 346 in exporter/exporterhelper/obsexporter.go

View check run for this annotation

Codecov / codecov/patch

exporter/exporterhelper/obsexporter.go#L345-L346

Added lines #L345 - L346 were not covered by tests
}
Loading