Skip to content

Commit 607912c

Browse files
[chore] update awscloudwatchlogs exporter to pass apicheck (#26366)
**Description:** CWL Logs exporter was using an alias for the exporter package to avoid a naming conflict. I renamed the internal struct to resolve the error and remove the need for the alias. I did not create a breaking changelog entry for this as no api surface was changed. **Link to tracking Issue:** #26304
1 parent fb9f011 commit 607912c

File tree

3 files changed

+12
-13
lines changed

3 files changed

+12
-13
lines changed

cmd/checkapi/allowlist.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
connector/servicegraphconnector
2-
exporter/awscloudwatchlogsexporter
32
exporter/awskinesisexporter
43
exporter/azuremonitorexporter
54
exporter/coralogixexporter
@@ -33,4 +32,4 @@ receiver/mysqlreceiver
3332
receiver/nsxtreceiver
3433
receiver/podmanreceiver
3534
receiver/pulsarreceiver
36-
receiver/windowseventlogreceiver
35+
receiver/windowseventlogreceiver

exporter/awscloudwatchlogsexporter/exporter.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import (
2626
"github.com/open-telemetry/opentelemetry-collector-contrib/internal/aws/cwlogs"
2727
)
2828

29-
type exporter struct {
29+
type cwlExporter struct {
3030
Config *Config
3131
logger *zap.Logger
3232
retryCount int
@@ -47,7 +47,7 @@ type emfMetadata struct {
4747
LogStreamName string `json:"log_stream_name,omitempty"`
4848
}
4949

50-
func newCwLogsPusher(expConfig *Config, params exp.CreateSettings) (*exporter, error) {
50+
func newCwLogsPusher(expConfig *Config, params exp.CreateSettings) (*cwlExporter, error) {
5151
if expConfig == nil {
5252
return nil, errors.New("awscloudwatchlogs exporter config is nil")
5353
}
@@ -79,7 +79,7 @@ func newCwLogsPusher(expConfig *Config, params exp.CreateSettings) (*exporter, e
7979

8080
pusherMap[pusherKey] = pusher
8181

82-
logsExporter := &exporter{
82+
logsExporter := &cwlExporter{
8383
svcStructuredLog: svcStructuredLog,
8484
Config: expConfig,
8585
logger: params.Logger,
@@ -108,7 +108,7 @@ func newCwLogsExporter(config component.Config, params exp.CreateSettings) (exp.
108108
)
109109
}
110110

111-
func (e *exporter) consumeLogs(_ context.Context, ld plog.Logs) error {
111+
func (e *cwlExporter) consumeLogs(_ context.Context, ld plog.Logs) error {
112112
logEvents, _ := logsToCWLogs(e.logger, ld, e.Config)
113113
if len(logEvents) == 0 {
114114
return nil
@@ -146,7 +146,7 @@ func (e *exporter) consumeLogs(_ context.Context, ld plog.Logs) error {
146146
return nil
147147
}
148148

149-
func (e *exporter) getLogPusher(logEvent *cwlogs.Event) cwlogs.Pusher {
149+
func (e *cwlExporter) getLogPusher(logEvent *cwlogs.Event) cwlogs.Pusher {
150150
e.pusherMapLock.Lock()
151151
defer e.pusherMapLock.Unlock()
152152
pusherKey := cwlogs.PusherKey{
@@ -160,7 +160,7 @@ func (e *exporter) getLogPusher(logEvent *cwlogs.Event) cwlogs.Pusher {
160160
return e.pusherMap[pusherKey]
161161
}
162162

163-
func (e *exporter) shutdown(_ context.Context) error {
163+
func (e *cwlExporter) shutdown(_ context.Context) error {
164164
if e.pusherMap != nil {
165165
for _, pusher := range e.pusherMap {
166166
pusher.ForceFlush()

exporter/awscloudwatchlogsexporter/factory.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,18 @@ import (
1212
"errors"
1313

1414
"go.opentelemetry.io/collector/component"
15-
exp "go.opentelemetry.io/collector/exporter"
15+
"go.opentelemetry.io/collector/exporter"
1616
"go.opentelemetry.io/collector/exporter/exporterhelper"
1717

1818
"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/awscloudwatchlogsexporter/internal/metadata"
1919
"github.com/open-telemetry/opentelemetry-collector-contrib/internal/aws/awsutil"
2020
)
2121

22-
func NewFactory() exp.Factory {
23-
return exp.NewFactory(
22+
func NewFactory() exporter.Factory {
23+
return exporter.NewFactory(
2424
metadata.Type,
2525
createDefaultConfig,
26-
exp.WithLogs(createLogsExporter, metadata.LogsStability))
26+
exporter.WithLogs(createLogsExporter, metadata.LogsStability))
2727
}
2828

2929
func createDefaultConfig() component.Config {
@@ -36,7 +36,7 @@ func createDefaultConfig() component.Config {
3636
}
3737
}
3838

39-
func createLogsExporter(_ context.Context, params exp.CreateSettings, config component.Config) (exp.Logs, error) {
39+
func createLogsExporter(_ context.Context, params exporter.CreateSettings, config component.Config) (exporter.Logs, error) {
4040
expConfig, ok := config.(*Config)
4141
if !ok {
4242
return nil, errors.New("invalid configuration type; can't cast to awscloudwatchlogsexporter.Config")

0 commit comments

Comments
 (0)