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

[extension/encoding/awscloudwatchmetricstreams_encoding] Support unmarshalling JSON-formatted CloudWatch Metric Streams #38419

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
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
27 changes: 27 additions & 0 deletions .chloggen/add-json-cw-metric-stream.yaml
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: enhancement

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

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Add unmarshaler for JSON cloudwatch metric stream

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

# (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: [user]
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
"fmt"

"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/extension"
"go.opentelemetry.io/collector/pdata/pmetric"

"github.com/open-telemetry/opentelemetry-collector-contrib/extension/encoding"
Expand All @@ -19,12 +20,15 @@ type encodingExtension struct {
pmetric.Unmarshaler
}

func newExtension(cfg *Config) (*encodingExtension, error) {
func newExtension(cfg *Config, settings extension.Settings) (*encodingExtension, error) {
switch cfg.Format {
case formatJSON:
return &encodingExtension{Unmarshaler: formatJSONUnmarshaler{}}, nil
return &encodingExtension{&formatJSONUnmarshaler{
buildInfo: settings.BuildInfo,
logger: settings.Logger,
}}, nil
case formatOpenTelemetry10:
return &encodingExtension{Unmarshaler: formatOpenTelemetry10Unmarshaler{}}, nil
return &encodingExtension{Unmarshaler: &formatOpenTelemetry10Unmarshaler{}}, nil
default:
// Format will have been validated by Config.Validate,
// so we'll only get here if we haven't handled a valid
Expand All @@ -40,17 +44,3 @@ func (*encodingExtension) Start(_ context.Context, _ component.Host) error {
func (*encodingExtension) Shutdown(_ context.Context) error {
return nil
}

type formatJSONUnmarshaler struct{}

func (formatJSONUnmarshaler) UnmarshalMetrics([]byte) (pmetric.Metrics, error) {
// TODO implement
return pmetric.Metrics{}, fmt.Errorf("UnmarshalMetrics unimplemented for format %q", formatJSON)
}

type formatOpenTelemetry10Unmarshaler struct{}

func (formatOpenTelemetry10Unmarshaler) UnmarshalMetrics([]byte) (pmetric.Metrics, error) {
// TODO implement
return pmetric.Metrics{}, fmt.Errorf("UnmarshalMetrics unimplemented for format %q", formatOpenTelemetry10)
}
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,20 @@ import (

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"go.opentelemetry.io/collector/extension/extensiontest"
)

func TestNew_JSON(t *testing.T) {
e, err := newExtension(&Config{Format: formatJSON})
e, err := newExtension(&Config{Format: formatJSON}, extensiontest.NewNopSettings(extensiontest.NopType))
require.NoError(t, err)
require.NotNil(t, e)

_, err = e.UnmarshalMetrics([]byte{})
assert.EqualError(t, err, `UnmarshalMetrics unimplemented for format "json"`)
assert.EqualError(t, err, errEmptyRecord.Error())
}

func TestNew_OpenTelemetry10(t *testing.T) {
e, err := newExtension(&Config{Format: formatOpenTelemetry10})
e, err := newExtension(&Config{Format: formatOpenTelemetry10}, extensiontest.NewNopSettings(extensiontest.NopType))
require.NoError(t, err)
require.NotNil(t, e)

Expand All @@ -29,7 +30,7 @@ func TestNew_OpenTelemetry10(t *testing.T) {
}

func TestNew_Unimplemented(t *testing.T) {
e, err := newExtension(&Config{Format: "invalid"})
e, err := newExtension(&Config{Format: "invalid"}, extensiontest.NewNopSettings(extensiontest.NopType))
require.Error(t, err)
require.Nil(t, e)
assert.EqualError(t, err, `unimplemented format "invalid"`)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ func NewFactory() extension.Factory {
)
}

func createExtension(_ context.Context, _ extension.Settings, cfg component.Config) (extension.Extension, error) {
return newExtension(cfg.(*Config))
func createExtension(_ context.Context, settings extension.Settings, cfg component.Config) (extension.Extension, error) {
return newExtension(cfg.(*Config), settings)
}

func createDefaultConfig() component.Config {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ module github.com/open-telemetry/opentelemetry-collector-contrib/extension/encod
go 1.23.0

require (
github.com/json-iterator/go v1.1.12
github.com/open-telemetry/opentelemetry-collector-contrib/extension/encoding v0.121.0
github.com/open-telemetry/opentelemetry-collector-contrib/pkg/golden v0.121.0
github.com/open-telemetry/opentelemetry-collector-contrib/pkg/pdatatest v0.121.0
github.com/stretchr/testify v1.10.0
go.opentelemetry.io/collector/component v1.27.0
go.opentelemetry.io/collector/component/componenttest v0.121.0
Expand All @@ -12,24 +15,27 @@ require (
go.opentelemetry.io/collector/extension v1.27.0
go.opentelemetry.io/collector/extension/extensiontest v0.121.0
go.opentelemetry.io/collector/pdata v1.27.0
go.opentelemetry.io/collector/semconv v0.121.0
go.uber.org/goleak v1.3.0
go.uber.org/zap v1.27.0
)

require (
github.com/cespare/xxhash/v2 v2.3.0 // indirect
github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
github.com/go-logr/logr v1.4.2 // indirect
github.com/go-logr/stdr v1.2.2 // indirect
github.com/go-viper/mapstructure/v2 v2.2.1 // indirect
github.com/gogo/protobuf v1.3.2 // indirect
github.com/google/uuid v1.6.0 // indirect
github.com/json-iterator/go v1.1.12 // indirect
github.com/knadh/koanf/maps v0.1.1 // indirect
github.com/knadh/koanf/providers/confmap v0.1.0 // indirect
github.com/knadh/koanf/v2 v2.1.2 // indirect
github.com/mitchellh/copystructure v1.2.0 // indirect
github.com/mitchellh/reflectwalk v1.0.2 // indirect
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
github.com/modern-go/reflect2 v1.0.2 // indirect
github.com/open-telemetry/opentelemetry-collector-contrib/pkg/pdatautil v0.121.0 // indirect
github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
go.opentelemetry.io/auto/sdk v1.1.0 // indirect
go.opentelemetry.io/collector/pdata/pprofile v0.121.0 // indirect
Expand All @@ -39,10 +45,9 @@ require (
go.opentelemetry.io/otel/sdk/metric v1.34.0 // indirect
go.opentelemetry.io/otel/trace v1.34.0 // indirect
go.uber.org/multierr v1.11.0 // indirect
go.uber.org/zap v1.27.0 // indirect
golang.org/x/net v0.33.0 // indirect
golang.org/x/sys v0.29.0 // indirect
golang.org/x/text v0.21.0 // indirect
golang.org/x/net v0.35.0 // indirect
golang.org/x/sys v0.30.0 // indirect
golang.org/x/text v0.22.0 // indirect
google.golang.org/genproto/googleapis/rpc v0.0.0-20241202173237-19429a94021a // indirect
google.golang.org/grpc v1.70.0 // indirect
google.golang.org/protobuf v1.36.5 // indirect
Expand Down

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

Loading