Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 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, api]
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,7 @@ pkg/stanza/fileconsumer/ @open-telemetry
pkg/status/ @open-telemetry/collector-contrib-approvers @jpkrohling @mwear
pkg/translator/azure/ @open-telemetry/collector-contrib-approvers @open-telemetry/collector-approvers @atoulme @cparkins
pkg/translator/azurelogs/ @open-telemetry/collector-contrib-approvers @atoulme @cparkins @MikeGoldsmith
pkg/translator/cloudwatchmetricstream/ @open-telemetry/collector-contrib-approvers @axw
pkg/translator/jaeger/ @open-telemetry/collector-contrib-approvers @open-telemetry/collector-approvers @frzifus
pkg/translator/loki/ @open-telemetry/collector-contrib-approvers @gouthamve @mar4uk
pkg/translator/opencensus/ @open-telemetry/collector-contrib-approvers @open-telemetry/collector-approvers
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,7 @@ body:
- pkg/status
- pkg/translator/azure
- pkg/translator/azurelogs
- pkg/translator/cloudwatchmetricstream
- pkg/translator/jaeger
- pkg/translator/loki
- pkg/translator/opencensus
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,7 @@ body:
- pkg/status
- pkg/translator/azure
- pkg/translator/azurelogs
- pkg/translator/cloudwatchmetricstream
- pkg/translator/jaeger
- pkg/translator/loki
- pkg/translator/opencensus
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/other.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,7 @@ body:
- pkg/status
- pkg/translator/azure
- pkg/translator/azurelogs
- pkg/translator/cloudwatchmetricstream
- pkg/translator/jaeger
- pkg/translator/loki
- pkg/translator/opencensus
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/unmaintained.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,7 @@ body:
- pkg/status
- pkg/translator/azure
- pkg/translator/azurelogs
- pkg/translator/cloudwatchmetricstream
- pkg/translator/jaeger
- pkg/translator/loki
- pkg/translator/opencensus
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,32 +5,43 @@ package awscloudwatchmetricstreamsencodingextension // import "github.com/open-t

import (
"context"
"errors"
"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"
"github.com/open-telemetry/opentelemetry-collector-contrib/extension/encoding/awscloudwatchmetricstreamsencodingextension/internal/metadata"
"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/cloudwatchmetricstream"
)

var _ encoding.MetricsUnmarshalerExtension = (*encodingExtension)(nil)

type encodingExtension struct {
pmetric.Unmarshaler
unmarshaller 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
case formatOpenTelemetry10:
return &encodingExtension{Unmarshaler: formatOpenTelemetry10Unmarshaler{}}, nil
case formatJSON, formatOpenTelemetry10:
default:
// Format will have been validated by Config.Validate,
// so we'll only get here if we haven't handled a valid
// format.
return nil, fmt.Errorf("unimplemented format %q", cfg.Format)
}
unmarshaller, err := cloudwatchmetricstream.NewUnmarshaler(
cfg.Format,
metadata.Type.String(),
settings.BuildInfo,
settings.Logger,
)
if err != nil {
return nil, err
}
return &encodingExtension{unmarshaller: unmarshaller}, nil
}

func (*encodingExtension) Start(_ context.Context, _ component.Host) error {
Expand All @@ -41,16 +52,9 @@ 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)
func (e *encodingExtension) UnmarshalMetrics(buf []byte) (pmetric.Metrics, error) {
if e.unmarshaller == nil {
return pmetric.Metrics{}, errors.New("no unmarshaler defined")
}
return e.unmarshaller.UnmarshalMetrics(buf)
}
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@ 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)

Expand All @@ -20,7 +21,7 @@ func TestNew_JSON(t *testing.T) {
}

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 @@ -4,6 +4,7 @@ go 1.23.0

require (
github.com/open-telemetry/opentelemetry-collector-contrib/extension/encoding v0.121.0
github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/cloudwatchmetricstream v0.0.0-00010101000000-000000000000
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 Down Expand Up @@ -33,20 +34,23 @@ require (
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
go.opentelemetry.io/collector/semconv v0.121.0 // indirect
go.opentelemetry.io/otel v1.34.0 // indirect
go.opentelemetry.io/otel/metric v1.34.0 // indirect
go.opentelemetry.io/otel/sdk v1.34.0 // indirect
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
gopkg.in/yaml.v3 v3.0.1 // indirect
)

replace github.com/open-telemetry/opentelemetry-collector-contrib/extension/encoding => ../

replace github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/cloudwatchmetricstream => ../../../pkg/translator/cloudwatchmetricstream

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

1 change: 1 addition & 0 deletions internal/tidylist/tidylist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,7 @@ extension/basicauthextension
extension/bearertokenauthextension
extension/cgroupruntimeextension
extension/encoding/avrologencodingextension
pkg/translator/cloudwatchmetricstream
extension/encoding/awscloudwatchmetricstreamsencodingextension
extension/encoding/googlecloudlogentryencodingextension
extension/encoding/jaegerencodingextension
Expand Down
1 change: 1 addition & 0 deletions pkg/translator/cloudwatchmetricstream/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
include ../../../Makefile.Common
8 changes: 8 additions & 0 deletions pkg/translator/cloudwatchmetricstream/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Cloudwatch metric stream translator

The translator for [cloudwatch metric stream](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html)
extracts the OpenTelemetry metrics from a record containing cloudwatch metric streams.

The record can contain several metrics, each split by a new line.

Currently, there is support for records in JSON format.
Loading