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

Add encoder/decoder and marshaler/unmarshaler for OTLP protobuf #3401

Merged
merged 1 commit into from
Jun 10, 2021
Merged
Show file tree
Hide file tree
Changes from all 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
21 changes: 18 additions & 3 deletions internal/otlp/marshaler.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,32 @@ import (
"go.opentelemetry.io/collector/internal/model"
)

// NewJSONTracesMarshaler returns a model.TracesMarshaler to decode from OTLP json bytes.
// NewJSONTracesMarshaler returns a model.TracesMarshaler. Marshals to OTLP json bytes.
func NewJSONTracesMarshaler() model.TracesMarshaler {
return model.NewTracesMarshaler(newJSONEncoder(), newFromTranslator())
}

// NewJSONMetricsMarshaler returns a model.MetricsMarshaler to decode from OTLP json bytes.
// NewJSONMetricsMarshaler returns a model.MetricsMarshaler. Marshals to OTLP json bytes.
func NewJSONMetricsMarshaler() model.MetricsMarshaler {
return model.NewMetricsMarshaler(newJSONEncoder(), newFromTranslator())
}

// NewJSONLogsMarshaler returns a model.LogsMarshaler to decode from OTLP json bytes.
// NewJSONLogsMarshaler returns a model.LogsMarshaler. Marshals to OTLP json bytes.
func NewJSONLogsMarshaler() model.LogsMarshaler {
return model.NewLogsMarshaler(newJSONEncoder(), newFromTranslator())
}

// NewProtobufTracesMarshaler returns a model.TracesMarshaler. Marshals to OTLP binary protobuf bytes.
func NewProtobufTracesMarshaler() model.TracesMarshaler {
bogdandrutu marked this conversation as resolved.
Show resolved Hide resolved
return model.NewTracesMarshaler(newPbEncoder(), newFromTranslator())
}

// NewProtobufMetricsMarshaler returns a model.MetricsMarshaler. Marshals to OTLP binary protobuf bytes.
func NewProtobufMetricsMarshaler() model.MetricsMarshaler {
return model.NewMetricsMarshaler(newPbEncoder(), newFromTranslator())
}

// NewProtobufLogsMarshaler returns a model.LogsMarshaler. Marshals to OTLP binary protobuf bytes.
func NewProtobufLogsMarshaler() model.LogsMarshaler {
return model.NewLogsMarshaler(newPbEncoder(), newFromTranslator())
}
45 changes: 45 additions & 0 deletions internal/otlp/pb_decoder.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
// Copyright 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 otlp

import (
otlpcollectorlogs "go.opentelemetry.io/collector/internal/data/protogen/collector/logs/v1"
otlpcollectormetrics "go.opentelemetry.io/collector/internal/data/protogen/collector/metrics/v1"
otlpcollectortrace "go.opentelemetry.io/collector/internal/data/protogen/collector/trace/v1"
)

type pbDecoder struct{}
Copy link
Contributor

Choose a reason for hiding this comment

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

Personally I'd just use protobuf instead of pb throughout.

Copy link
Member Author

Choose a reason for hiding this comment

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

this is internal, so I don't think it is a problem :)


func newPbDecoder() *pbDecoder {
return &pbDecoder{}
}

func (d *pbDecoder) DecodeLogs(buf []byte) (interface{}, error) {
ld := &otlpcollectorlogs.ExportLogsServiceRequest{}
err := ld.Unmarshal(buf)
return ld, err
}

func (d *pbDecoder) DecodeMetrics(buf []byte) (interface{}, error) {
md := &otlpcollectormetrics.ExportMetricsServiceRequest{}
err := md.Unmarshal(buf)
return md, err
}

func (d *pbDecoder) DecodeTraces(buf []byte) (interface{}, error) {
td := &otlpcollectortrace.ExportTraceServiceRequest{}
err := td.Unmarshal(buf)
return td, err
}
52 changes: 52 additions & 0 deletions internal/otlp/pb_encoder.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
// Copyright 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 otlp

import (
otlpcollectorlogs "go.opentelemetry.io/collector/internal/data/protogen/collector/logs/v1"
otlpcollectormetrics "go.opentelemetry.io/collector/internal/data/protogen/collector/metrics/v1"
otlpcollectortrace "go.opentelemetry.io/collector/internal/data/protogen/collector/trace/v1"
"go.opentelemetry.io/collector/internal/model"
)

type pbEncoder struct{}

func newPbEncoder() *pbEncoder {
return &pbEncoder{}
}

func (e *pbEncoder) EncodeLogs(modelData interface{}) ([]byte, error) {
ld, ok := modelData.(*otlpcollectorlogs.ExportLogsServiceRequest)
if !ok {
return nil, model.NewErrIncompatibleType(&otlpcollectorlogs.ExportLogsServiceRequest{}, modelData)
}
return ld.Marshal()
}

func (e *pbEncoder) EncodeMetrics(modelData interface{}) ([]byte, error) {
md, ok := modelData.(*otlpcollectormetrics.ExportMetricsServiceRequest)
if !ok {
return nil, model.NewErrIncompatibleType(&otlpcollectormetrics.ExportMetricsServiceRequest{}, modelData)
}
return md.Marshal()
}

func (e *pbEncoder) EncodeTraces(modelData interface{}) ([]byte, error) {
td, ok := modelData.(*otlpcollectortrace.ExportTraceServiceRequest)
if !ok {
return nil, model.NewErrIncompatibleType(&otlpcollectortrace.ExportTraceServiceRequest{}, modelData)
}
return td.Marshal()
}
39 changes: 39 additions & 0 deletions internal/otlp/pb_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
// Copyright 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 otlp

import (
"testing"

"github.com/stretchr/testify/assert"
)

func TestProtobufLogsUnmarshaler_error(t *testing.T) {
p := NewProtobufLogsUnmarshaler()
_, err := p.Unmarshal([]byte("+$%"))
assert.Error(t, err)
}

func TestProtobufMetricsUnmarshaler_error(t *testing.T) {
p := NewProtobufMetricsUnmarshaler()
_, err := p.Unmarshal([]byte("+$%"))
assert.Error(t, err)
}

func TestProtobufTracesUnmarshaler_error(t *testing.T) {
p := NewProtobufTracesUnmarshaler()
_, err := p.Unmarshal([]byte("+$%"))
assert.Error(t, err)
}
21 changes: 18 additions & 3 deletions internal/otlp/unmarshaler.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,32 @@ import (
"go.opentelemetry.io/collector/internal/model"
)

// NewJSONTracesUnmarshaler returns a model.TracesUnmarshaler to decode from OTLP json bytes.
// NewJSONTracesUnmarshaler returns a model.TracesUnmarshaler. Unmarshals from OTLP json bytes.
func NewJSONTracesUnmarshaler() model.TracesUnmarshaler {
return model.NewTracesUnmarshaler(newJSONDecoder(), newToTranslator())
}

// NewJSONMetricsUnmarshaler returns a model.MetricsUnmarshaler to decode from OTLP json bytes.
// NewJSONMetricsUnmarshaler returns a model.MetricsUnmarshaler. Unmarshals from OTLP json bytes.
func NewJSONMetricsUnmarshaler() model.MetricsUnmarshaler {
return model.NewMetricsUnmarshaler(newJSONDecoder(), newToTranslator())
}

// NewJSONLogsUnmarshaler returns a model.LogsUnmarshaler to decode from OTLP json bytes.
// NewJSONLogsUnmarshaler returns a model.LogsUnmarshaler. Unmarshals from OTLP json bytes.
func NewJSONLogsUnmarshaler() model.LogsUnmarshaler {
return model.NewLogsUnmarshaler(newJSONDecoder(), newToTranslator())
}

// NewProtobufTracesUnmarshaler returns a model.TracesUnmarshaler. Unmarshals from OTLP binary protobuf bytes.
func NewProtobufTracesUnmarshaler() model.TracesUnmarshaler {
return model.NewTracesUnmarshaler(newPbDecoder(), newToTranslator())
}

// NewProtobufMetricsUnmarshaler returns a model.MetricsUnmarshaler. Unmarshals from OTLP binary protobuf bytes.
func NewProtobufMetricsUnmarshaler() model.MetricsUnmarshaler {
return model.NewMetricsUnmarshaler(newPbDecoder(), newToTranslator())
}

// NewProtobufLogsUnmarshaler returns a model.LogsUnmarshaler. Unmarshals from OTLP binary protobuf bytes.
func NewProtobufLogsUnmarshaler() model.LogsUnmarshaler {
return model.NewLogsUnmarshaler(newPbDecoder(), newToTranslator())
}