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

Treat PartialSuccess as Success #9260

Merged
merged 4 commits into from
Feb 6, 2024
Merged

Treat PartialSuccess as Success #9260

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5ca1488
Treat PartialSuccess as Success; log a warning, TODO about counting
jmacd Jan 10, 2024
f644b1e
remove TODOs the issue is filed
jmacd Feb 2, 2024
073ed55
fix test
jmacd Feb 2, 2024
a14666b
Merge branch 'main' into jmacd/partial
Feb 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
25 changes: 25 additions & 0 deletions .chloggen/partialsuccess-is-success.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# 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: otlpexporter

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: PartialSuccess is treated as success, logged as warning.

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

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

# 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: [user]
2 changes: 1 addition & 1 deletion exporter/otlpexporter/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ require (
go.opentelemetry.io/otel/metric v1.22.0
go.opentelemetry.io/otel/trace v1.22.0
go.uber.org/goleak v1.3.0
go.uber.org/zap v1.26.0
google.golang.org/genproto/googleapis/rpc v0.0.0-20231127180814-3a041ad873d4
google.golang.org/grpc v1.61.0
google.golang.org/protobuf v1.32.0
Expand Down Expand Up @@ -72,7 +73,6 @@ require (
go.opentelemetry.io/otel/sdk/metric v1.22.0 // indirect
go.opentelemetry.io/proto/otlp v1.0.0 // indirect
go.uber.org/multierr v1.11.0 // indirect
go.uber.org/zap v1.26.0 // indirect
golang.org/x/net v0.20.0 // indirect
golang.org/x/sys v0.16.0 // indirect
golang.org/x/text v0.14.0 // indirect
Expand Down
16 changes: 13 additions & 3 deletions exporter/otlpexporter/otlp.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (
"runtime"
"time"

"go.uber.org/zap"
"google.golang.org/genproto/googleapis/rpc/errdetails"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
Expand Down Expand Up @@ -97,7 +98,10 @@ func (e *baseExporter) pushTraces(ctx context.Context, td ptrace.Traces) error {
}
partialSuccess := resp.PartialSuccess()
if !(partialSuccess.ErrorMessage() == "" && partialSuccess.RejectedSpans() == 0) {
return consumererror.NewPermanent(fmt.Errorf("OTLP partial success: \"%s\" (%d rejected)", resp.PartialSuccess().ErrorMessage(), resp.PartialSuccess().RejectedSpans()))
e.settings.Logger.Warn("Partial success response",
zap.String("message", resp.PartialSuccess().ErrorMessage()),
zap.Int64("dropped_spans", resp.PartialSuccess().RejectedSpans()),
)
}
return nil
}
Expand All @@ -110,7 +114,10 @@ func (e *baseExporter) pushMetrics(ctx context.Context, md pmetric.Metrics) erro
}
partialSuccess := resp.PartialSuccess()
if !(partialSuccess.ErrorMessage() == "" && partialSuccess.RejectedDataPoints() == 0) {
return consumererror.NewPermanent(fmt.Errorf("OTLP partial success: \"%s\" (%d rejected)", resp.PartialSuccess().ErrorMessage(), resp.PartialSuccess().RejectedDataPoints()))
e.settings.Logger.Warn("Partial success response",
zap.String("message", resp.PartialSuccess().ErrorMessage()),
zap.Int64("dropped_data_points", resp.PartialSuccess().RejectedDataPoints()),
)
}
return nil
}
Expand All @@ -123,7 +130,10 @@ func (e *baseExporter) pushLogs(ctx context.Context, ld plog.Logs) error {
}
partialSuccess := resp.PartialSuccess()
if !(partialSuccess.ErrorMessage() == "" && partialSuccess.RejectedLogRecords() == 0) {
return consumererror.NewPermanent(fmt.Errorf("OTLP partial success: \"%s\" (%d rejected)", resp.PartialSuccess().ErrorMessage(), resp.PartialSuccess().RejectedLogRecords()))
e.settings.Logger.Warn("Partial success response",
zap.String("message", resp.PartialSuccess().ErrorMessage()),
zap.Int64("dropped_log_records", resp.PartialSuccess().RejectedLogRecords()),
)
}
return nil
}
Expand Down
29 changes: 26 additions & 3 deletions exporter/otlpexporter/otlp_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ import (

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"go.uber.org/zap"
"go.uber.org/zap/zaptest/observer"
"google.golang.org/genproto/googleapis/rpc/errdetails"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
Expand Down Expand Up @@ -247,6 +249,11 @@ func TestSendTraces(t *testing.T) {
set := exportertest.NewNopCreateSettings()
set.BuildInfo.Description = "Collector"
set.BuildInfo.Version = "1.2.3test"

// For testing the "Partial success" warning.
logger, observed := observer.New(zap.DebugLevel)
set.TelemetrySettings.Logger = zap.New(logger)

exp, err := factory.CreateTracesExporter(context.Background(), set, cfg)
require.NoError(t, err)
require.NotNil(t, exp)
Expand Down Expand Up @@ -310,7 +317,9 @@ func TestSendTraces(t *testing.T) {
td = testdata.GenerateTraces(2)

err = exp.ConsumeTraces(context.Background(), td)
assert.Error(t, err)
assert.NoError(t, err)
assert.Len(t, observed.FilterLevelExact(zap.WarnLevel).All(), 1)
assert.Contains(t, observed.FilterLevelExact(zap.WarnLevel).All()[0].Message, "Partial success")
}

func TestSendTracesWhenEndpointHasHttpScheme(t *testing.T) {
Expand Down Expand Up @@ -412,6 +421,11 @@ func TestSendMetrics(t *testing.T) {
set := exportertest.NewNopCreateSettings()
set.BuildInfo.Description = "Collector"
set.BuildInfo.Version = "1.2.3test"

// For testing the "Partial success" warning.
logger, observed := observer.New(zap.DebugLevel)
set.TelemetrySettings.Logger = zap.New(logger)

exp, err := factory.CreateMetricsExporter(context.Background(), set, cfg)
require.NoError(t, err)
require.NotNil(t, exp)
Expand Down Expand Up @@ -484,7 +498,9 @@ func TestSendMetrics(t *testing.T) {

// Send two metrics.
md = testdata.GenerateMetrics(2)
assert.Error(t, exp.ConsumeMetrics(context.Background(), md))
assert.NoError(t, exp.ConsumeMetrics(context.Background(), md))
assert.Len(t, observed.FilterLevelExact(zap.WarnLevel).All(), 1)
assert.Contains(t, observed.FilterLevelExact(zap.WarnLevel).All()[0].Message, "Partial success")
}

func TestSendTraceDataServerDownAndUp(t *testing.T) {
Expand Down Expand Up @@ -699,6 +715,11 @@ func TestSendLogData(t *testing.T) {
set := exportertest.NewNopCreateSettings()
set.BuildInfo.Description = "Collector"
set.BuildInfo.Version = "1.2.3test"

// For testing the "Partial success" warning.
logger, observed := observer.New(zap.DebugLevel)
set.TelemetrySettings.Logger = zap.New(logger)

exp, err := factory.CreateLogsExporter(context.Background(), set, cfg)
require.NoError(t, err)
require.NotNil(t, exp)
Expand Down Expand Up @@ -770,5 +791,7 @@ func TestSendLogData(t *testing.T) {
ld = testdata.GenerateLogs(2)

err = exp.ConsumeLogs(context.Background(), ld)
assert.Error(t, err)
assert.NoError(t, err)
assert.Len(t, observed.FilterLevelExact(zap.WarnLevel).All(), 1)
assert.Contains(t, observed.FilterLevelExact(zap.WarnLevel).All()[0].Message, "Partial success")
}
27 changes: 18 additions & 9 deletions exporter/otlphttpexporter/otlp.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ func (e *baseExporter) pushTraces(ctx context.Context, td ptrace.Traces) error {
return consumererror.NewPermanent(err)
}

return e.export(ctx, e.tracesURL, request, tracesPartialSuccessHandler)
return e.export(ctx, e.tracesURL, request, e.tracesPartialSuccessHandler)
}

func (e *baseExporter) pushMetrics(ctx context.Context, md pmetric.Metrics) error {
Expand All @@ -101,7 +101,7 @@ func (e *baseExporter) pushMetrics(ctx context.Context, md pmetric.Metrics) erro
if err != nil {
return consumererror.NewPermanent(err)
}
return e.export(ctx, e.metricsURL, request, metricsPartialSuccessHandler)
return e.export(ctx, e.metricsURL, request, e.metricsPartialSuccessHandler)
}

func (e *baseExporter) pushLogs(ctx context.Context, ld plog.Logs) error {
Expand All @@ -111,7 +111,7 @@ func (e *baseExporter) pushLogs(ctx context.Context, ld plog.Logs) error {
return consumererror.NewPermanent(err)
}

return e.export(ctx, e.logsURL, request, logsPartialSuccessHandler)
return e.export(ctx, e.logsURL, request, e.logsPartialSuccessHandler)
}

func (e *baseExporter) export(ctx context.Context, url string, request []byte, partialSuccessHandler partialSuccessHandler) error {
Expand Down Expand Up @@ -259,7 +259,7 @@ func handlePartialSuccessResponse(resp *http.Response, partialSuccessHandler par

type partialSuccessHandler func(bytes []byte, contentType string) error

func tracesPartialSuccessHandler(protoBytes []byte, contentType string) error {
func (e *baseExporter) tracesPartialSuccessHandler(protoBytes []byte, contentType string) error {
if contentType != protobufContentType {
return nil
}
Expand All @@ -270,12 +270,15 @@ func tracesPartialSuccessHandler(protoBytes []byte, contentType string) error {
}
partialSuccess := exportResponse.PartialSuccess()
if !(partialSuccess.ErrorMessage() == "" && partialSuccess.RejectedSpans() == 0) {
return consumererror.NewPermanent(fmt.Errorf("OTLP partial success: %s (%d rejected)", partialSuccess.ErrorMessage(), partialSuccess.RejectedSpans()))
e.logger.Warn("Partial success response",
zap.String("message", exportResponse.PartialSuccess().ErrorMessage()),
zap.Int64("dropped_spans", exportResponse.PartialSuccess().RejectedSpans()),
)
}
return nil
}

func metricsPartialSuccessHandler(protoBytes []byte, contentType string) error {
func (e *baseExporter) metricsPartialSuccessHandler(protoBytes []byte, contentType string) error {
if contentType != protobufContentType {
return nil
}
Expand All @@ -286,12 +289,15 @@ func metricsPartialSuccessHandler(protoBytes []byte, contentType string) error {
}
partialSuccess := exportResponse.PartialSuccess()
if !(partialSuccess.ErrorMessage() == "" && partialSuccess.RejectedDataPoints() == 0) {
return consumererror.NewPermanent(fmt.Errorf("OTLP partial success: %s (%d rejected)", partialSuccess.ErrorMessage(), partialSuccess.RejectedDataPoints()))
e.logger.Warn("Partial success response",
zap.String("message", exportResponse.PartialSuccess().ErrorMessage()),
zap.Int64("dropped_data_points", exportResponse.PartialSuccess().RejectedDataPoints()),
)
}
return nil
}

func logsPartialSuccessHandler(protoBytes []byte, contentType string) error {
func (e *baseExporter) logsPartialSuccessHandler(protoBytes []byte, contentType string) error {
if contentType != protobufContentType {
return nil
}
Expand All @@ -302,7 +308,10 @@ func logsPartialSuccessHandler(protoBytes []byte, contentType string) error {
}
partialSuccess := exportResponse.PartialSuccess()
if !(partialSuccess.ErrorMessage() == "" && partialSuccess.RejectedLogRecords() == 0) {
return consumererror.NewPermanent(fmt.Errorf("OTLP partial success: %s (%d rejected)", partialSuccess.ErrorMessage(), partialSuccess.RejectedLogRecords()))
e.logger.Warn("Partial success response",
zap.String("message", exportResponse.PartialSuccess().ErrorMessage()),
zap.Int64("dropped_log_records", exportResponse.PartialSuccess().RejectedLogRecords()),
)
}
return nil
}