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

Update AzureEventsHubReceiver with new resource logs translator #35357

27 changes: 27 additions & 0 deletions .chloggen/azure-events-receiver-translator.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: azureeventshubreceiver

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Updates the Azure Event Hub receiver to use the new Resource Logs translator.

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

# (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: []
1 change: 1 addition & 0 deletions cmd/otelcontribcol/builder-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -469,6 +469,7 @@ replaces:
- github.com/openshift/api v3.9.0+incompatible => github.com/openshift/api v0.0.0-20180801171038-322a19404e37
- github.com/outcaste-io/ristretto v0.2.0 => github.com/outcaste-io/ristretto v0.2.1
- github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/azure => ../../pkg/translator/azure
- github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/azurelogs => ../../pkg/translator/azurelogs
- github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/skywalking => ../../pkg/translator/skywalking
- github.com/open-telemetry/opentelemetry-collector-contrib/internal/collectd => ../../internal/collectd
- github.com/open-telemetry/opentelemetry-collector-contrib/extension/encoding => ../../extension/encoding
Expand Down
3 changes: 3 additions & 0 deletions cmd/otelcontribcol/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -664,6 +664,7 @@ require (
github.com/open-telemetry/opentelemetry-collector-contrib/pkg/resourcetotelemetry v0.109.0 // indirect
github.com/open-telemetry/opentelemetry-collector-contrib/pkg/sampling v0.109.0 // indirect
github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/azure v0.109.0 // indirect
github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/azurelogs v0.109.0 // indirect
github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/jaeger v0.109.0 // indirect
github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/loki v0.109.0 // indirect
github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/opencensus v0.109.0 // indirect
Expand Down Expand Up @@ -1324,6 +1325,8 @@ replace github.com/outcaste-io/ristretto v0.2.0 => github.com/outcaste-io/ristre

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

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

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

replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/collectd => ../../internal/collectd
Expand Down
18 changes: 15 additions & 3 deletions receiver/azureeventhubreceiver/azureresourcelogs_unmarshaler.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,26 @@ import (
"go.uber.org/zap"

"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/azure"
"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/azurelogs"
)

type AzureResourceLogsEventUnmarshaler struct {
unmarshaler *azure.ResourceLogsUnmarshaler
type logsUnmarshaler interface {
UnmarshalLogs([]byte) (plog.Logs, error)
}

func newAzureResourceLogsUnmarshaler(buildInfo component.BuildInfo, logger *zap.Logger) eventLogsUnmarshaler {
type AzureResourceLogsEventUnmarshaler struct {
unmarshaler logsUnmarshaler
}

func newAzureResourceLogsUnmarshaler(buildInfo component.BuildInfo, logger *zap.Logger, applySemanticConventions bool) eventLogsUnmarshaler {
if applySemanticConventions {
return AzureResourceLogsEventUnmarshaler{
unmarshaler: &azurelogs.ResourceLogsUnmarshaler{
Version: buildInfo.Version,
Logger: logger,
},
}
}
return AzureResourceLogsEventUnmarshaler{
unmarshaler: &azure.ResourceLogsUnmarshaler{
Version: buildInfo.Version,
Expand Down
13 changes: 7 additions & 6 deletions receiver/azureeventhubreceiver/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,13 @@ var (
)

type Config struct {
Connection string `mapstructure:"connection"`
Partition string `mapstructure:"partition"`
Offset string `mapstructure:"offset"`
StorageID *component.ID `mapstructure:"storage"`
Format string `mapstructure:"format"`
ConsumerGroup string `mapstructure:"group"`
Connection string `mapstructure:"connection"`
Partition string `mapstructure:"partition"`
Offset string `mapstructure:"offset"`
StorageID *component.ID `mapstructure:"storage"`
Format string `mapstructure:"format"`
ConsumerGroup string `mapstructure:"group"`
ApplySemanticConventions bool `mapstructure:"apply_semantic_conventions"`
MikeGoldsmith marked this conversation as resolved.
Show resolved Hide resolved
}

func isValidFormat(format string) bool {
Expand Down
2 changes: 2 additions & 0 deletions receiver/azureeventhubreceiver/config_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,14 @@ func TestLoadConfig(t *testing.T) {
assert.Equal(t, "", r0.(*Config).Offset)
assert.Equal(t, "", r0.(*Config).Partition)
assert.Equal(t, defaultLogFormat, logFormat(r0.(*Config).Format))
assert.False(t, r0.(*Config).ApplySemanticConventions)

r1 := cfg.Receivers[component.NewIDWithName(metadata.Type, "all")]
assert.Equal(t, "Endpoint=sb://namespace.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=superSecret1234=;EntityPath=hubName", r1.(*Config).Connection)
assert.Equal(t, "1234-5566", r1.(*Config).Offset)
assert.Equal(t, "foo", r1.(*Config).Partition)
assert.Equal(t, rawLogFormat, logFormat(r1.(*Config).Format))
assert.True(t, r1.(*Config).ApplySemanticConventions)
}

func TestMissingConnection(t *testing.T) {
Expand Down
2 changes: 1 addition & 1 deletion receiver/azureeventhubreceiver/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ func (f *eventhubReceiverFactory) getReceiver(
if logFormat(receiverConfig.Format) == rawLogFormat {
logsUnmarshaler = newRawLogsUnmarshaler(settings.Logger)
} else {
logsUnmarshaler = newAzureResourceLogsUnmarshaler(settings.BuildInfo, settings.Logger)
logsUnmarshaler = newAzureResourceLogsUnmarshaler(settings.BuildInfo, settings.Logger, receiverConfig.ApplySemanticConventions)
}
case component.DataTypeMetrics:
if logFormat(receiverConfig.Format) == rawLogFormat {
Expand Down
3 changes: 3 additions & 0 deletions receiver/azureeventhubreceiver/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ require (
github.com/open-telemetry/opentelemetry-collector-contrib/internal/sharedcomponent v0.109.0
github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza v0.109.0
github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/azure v0.109.0
github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/azurelogs v0.109.0
github.com/relvacode/iso8601 v1.4.0
github.com/stretchr/testify v1.9.0
go.opentelemetry.io/collector/component v0.109.1-0.20240918193345-a3c0565031b0
Expand Down Expand Up @@ -161,6 +162,8 @@ replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/share

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

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

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

replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/common => ../../internal/common
1 change: 1 addition & 0 deletions receiver/azureeventhubreceiver/testdata/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ receivers:
partition: foo
offset: "1234-5566"
format: "raw"
apply_semantic_conventions: true

processors:
nop:
Expand Down