-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Make Kafka payload encoding configurable (#1584)
* Make Kafka payload encoding configurable Signed-off-by: Pavol Loffay <ploffay@redhat.com> * Expose marshalers in factory Signed-off-by: Pavol Loffay <ploffay@redhat.com> * Remove zipkin from exporter readme Signed-off-by: Pavol Loffay <ploffay@redhat.com> * Make custom encodings optional in the factory Signed-off-by: Pavol Loffay <ploffay@redhat.com>
- Loading branch information
1 parent
b13392b
commit 7f13eb6
Showing
29 changed files
with
1,003 additions
and
127 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| // Copyright 2020 The OpenTelemetry Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package kafkaexporter | ||
|
|
||
| import ( | ||
| "bytes" | ||
|
|
||
| "github.com/gogo/protobuf/jsonpb" | ||
| jaegerproto "github.com/jaegertracing/jaeger/model" | ||
|
|
||
| "go.opentelemetry.io/collector/component/componenterror" | ||
| "go.opentelemetry.io/collector/consumer/pdata" | ||
| jaegertranslator "go.opentelemetry.io/collector/translator/trace/jaeger" | ||
| ) | ||
|
|
||
| type jaegerMarshaller struct { | ||
| marshaller jaegerSpanMarshaller | ||
| } | ||
|
|
||
| var _ Marshaller = (*jaegerMarshaller)(nil) | ||
|
|
||
| func (j jaegerMarshaller) Marshal(traces pdata.Traces) ([]Message, error) { | ||
| batches, err := jaegertranslator.InternalTracesToJaegerProto(traces) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| var messages []Message | ||
| var errs []error | ||
| for _, batch := range batches { | ||
| for _, span := range batch.Spans { | ||
| span.Process = batch.Process | ||
| bts, err := j.marshaller.marshall(span) | ||
| // continue to process spans that can be serialized | ||
| if err != nil { | ||
| errs = append(errs, err) | ||
| continue | ||
| } | ||
| messages = append(messages, Message{Value: bts}) | ||
| } | ||
| } | ||
| return messages, componenterror.CombineErrors(errs) | ||
| } | ||
|
|
||
| func (j jaegerMarshaller) Encoding() string { | ||
| return j.marshaller.encoding() | ||
| } | ||
|
|
||
| type jaegerSpanMarshaller interface { | ||
| marshall(span *jaegerproto.Span) ([]byte, error) | ||
| encoding() string | ||
| } | ||
|
|
||
| type jaegerProtoSpanMarshaller struct { | ||
| } | ||
|
|
||
| var _ jaegerSpanMarshaller = (*jaegerProtoSpanMarshaller)(nil) | ||
|
|
||
| func (p jaegerProtoSpanMarshaller) marshall(span *jaegerproto.Span) ([]byte, error) { | ||
| return span.Marshal() | ||
| } | ||
|
|
||
| func (p jaegerProtoSpanMarshaller) encoding() string { | ||
| return "jaeger_proto" | ||
| } | ||
|
|
||
| type jaegerJSONSpanMarshaller struct { | ||
| pbMarshaller *jsonpb.Marshaler | ||
| } | ||
|
|
||
| var _ jaegerSpanMarshaller = (*jaegerJSONSpanMarshaller)(nil) | ||
|
|
||
| func newJaegerJSONMarshaller() *jaegerJSONSpanMarshaller { | ||
| return &jaegerJSONSpanMarshaller{ | ||
| pbMarshaller: &jsonpb.Marshaler{}, | ||
| } | ||
| } | ||
|
|
||
| func (p jaegerJSONSpanMarshaller) marshall(span *jaegerproto.Span) ([]byte, error) { | ||
| out := new(bytes.Buffer) | ||
| err := p.pbMarshaller.Marshal(out, span) | ||
| return out.Bytes(), err | ||
| } | ||
|
|
||
| func (p jaegerJSONSpanMarshaller) encoding() string { | ||
| return "jaeger_json" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| // Copyright 2020 The OpenTelemetry Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package kafkaexporter | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "testing" | ||
|
|
||
| "github.com/gogo/protobuf/jsonpb" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
|
|
||
| "go.opentelemetry.io/collector/consumer/pdata" | ||
| jaegertranslator "go.opentelemetry.io/collector/translator/trace/jaeger" | ||
| ) | ||
|
|
||
| func TestJaegerMarshaller(t *testing.T) { | ||
| td := pdata.NewTraces() | ||
| td.ResourceSpans().Resize(1) | ||
| td.ResourceSpans().At(0).InstrumentationLibrarySpans().Resize(1) | ||
| td.ResourceSpans().At(0).InstrumentationLibrarySpans().At(0).Spans().Resize(1) | ||
| td.ResourceSpans().At(0).InstrumentationLibrarySpans().At(0).Spans().At(0).SetName("foo") | ||
| td.ResourceSpans().At(0).InstrumentationLibrarySpans().At(0).Spans().At(0).SetStartTime(pdata.TimestampUnixNano(10)) | ||
| td.ResourceSpans().At(0).InstrumentationLibrarySpans().At(0).Spans().At(0).SetEndTime(pdata.TimestampUnixNano(20)) | ||
| td.ResourceSpans().At(0).InstrumentationLibrarySpans().At(0).Spans().At(0).SetTraceID(pdata.NewTraceID([]byte{1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16})) | ||
| td.ResourceSpans().At(0).InstrumentationLibrarySpans().At(0).Spans().At(0).SetSpanID(pdata.NewSpanID([]byte{1, 2, 3, 4, 5, 6, 7, 8})) | ||
| batches, err := jaegertranslator.InternalTracesToJaegerProto(td) | ||
| require.NoError(t, err) | ||
|
|
||
| batches[0].Spans[0].Process = batches[0].Process | ||
| jaegerProtoBytes, err := batches[0].Spans[0].Marshal() | ||
| require.NoError(t, err) | ||
| require.NotNil(t, jaegerProtoBytes) | ||
|
|
||
| jsonMarshaller := &jsonpb.Marshaler{} | ||
| jsonByteBuffer := new(bytes.Buffer) | ||
| require.NoError(t, jsonMarshaller.Marshal(jsonByteBuffer, batches[0].Spans[0])) | ||
|
|
||
| tests := []struct { | ||
| unmarshaller Marshaller | ||
| encoding string | ||
| messages []Message | ||
| }{ | ||
| { | ||
| unmarshaller: jaegerMarshaller{ | ||
| marshaller: jaegerProtoSpanMarshaller{}, | ||
| }, | ||
| encoding: "jaeger_proto", | ||
| messages: []Message{{Value: jaegerProtoBytes}}, | ||
| }, | ||
| { | ||
| unmarshaller: jaegerMarshaller{ | ||
| marshaller: jaegerJSONSpanMarshaller{ | ||
| pbMarshaller: &jsonpb.Marshaler{}, | ||
| }, | ||
| }, | ||
| encoding: "jaeger_json", | ||
| messages: []Message{{Value: jsonByteBuffer.Bytes()}}, | ||
| }, | ||
| } | ||
| for _, test := range tests { | ||
| t.Run(test.encoding, func(t *testing.T) { | ||
| messages, err := test.unmarshaller.Marshal(td) | ||
| require.NoError(t, err) | ||
| assert.Equal(t, test.messages, messages) | ||
| assert.Equal(t, test.encoding, test.unmarshaller.Encoding()) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestJaegerMarshaller_error_covert_traceID(t *testing.T) { | ||
| marshaller := jaegerMarshaller{ | ||
| marshaller: jaegerProtoSpanMarshaller{}, | ||
| } | ||
| td := pdata.NewTraces() | ||
| td.ResourceSpans().Resize(1) | ||
| td.ResourceSpans().At(0).InstrumentationLibrarySpans().Resize(1) | ||
| td.ResourceSpans().At(0).InstrumentationLibrarySpans().At(0).Spans().Resize(1) | ||
| // fails in zero traceID | ||
| messages, err := marshaller.Marshal(td) | ||
| require.Error(t, err) | ||
| assert.Nil(t, messages) | ||
| } |
Oops, something went wrong.