Skip to content

Commit

Permalink
[exporter/awskinesis] do not expose method (#27057)
Browse files Browse the repository at this point in the history
**Description:** 
Do not export the functions `NewTracesExporter`, `NewMetricsExporter`,
`NewLogsExporter` and pass checkapi.

**Link to tracking Issue:** 

#26304

**Testing:**
go run cmd/checkapi/main.go .
make chlog-validate
go test for awskinesisexporter

**Documentation:**
  • Loading branch information
sakulali committed Sep 21, 2023
1 parent 8b835a2 commit a7e468e
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 14 deletions.
27 changes: 27 additions & 0 deletions .chloggen/awskinesisexporter-checkapi-26304.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: breaking

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

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Do not export the functions `NewTracesExporter`, `NewMetricsExporter`, `NewLogsExporter` and pass checkapi.

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

# (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: [api]
1 change: 0 additions & 1 deletion cmd/checkapi/allowlist.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
connector/servicegraphconnector
exporter/awskinesisexporter
exporter/coralogixexporter
exporter/dynatraceexporter
exporter/kafkaexporter
Expand Down
7 changes: 0 additions & 7 deletions exporter/awskinesisexporter/exporter_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,6 @@ import (
"go.uber.org/zap/zaptest"
)

func MustTestGeneric[T any](t T, err error) T {
if err != nil {
panic(err)
}
return t
}

func applyConfigChanges(fn func(conf *Config)) *Config {
conf := createDefaultConfig().(*Config)
fn(conf)
Expand Down
12 changes: 6 additions & 6 deletions exporter/awskinesisexporter/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ func NewFactory() exporter.Factory {
return exporter.NewFactory(
metadata.Type,
createDefaultConfig,
exporter.WithTraces(NewTracesExporter, metadata.TracesStability),
exporter.WithMetrics(NewMetricsExporter, metadata.MetricsStability),
exporter.WithLogs(NewLogsExporter, metadata.LogsStability),
exporter.WithTraces(newTracesExporter, metadata.TracesStability),
exporter.WithMetrics(newMetricsExporter, metadata.MetricsStability),
exporter.WithLogs(newLogsExporter, metadata.LogsStability),
)
}

Expand All @@ -49,7 +49,7 @@ func createDefaultConfig() component.Config {
}
}

func NewTracesExporter(ctx context.Context, params exporter.CreateSettings, conf component.Config) (exporter.Traces, error) {
func newTracesExporter(ctx context.Context, params exporter.CreateSettings, conf component.Config) (exporter.Traces, error) {
exp, err := createExporter(ctx, conf, params.Logger)
if err != nil {
return nil, err
Expand All @@ -67,7 +67,7 @@ func NewTracesExporter(ctx context.Context, params exporter.CreateSettings, conf
)
}

func NewMetricsExporter(ctx context.Context, params exporter.CreateSettings, conf component.Config) (exporter.Metrics, error) {
func newMetricsExporter(ctx context.Context, params exporter.CreateSettings, conf component.Config) (exporter.Metrics, error) {
exp, err := createExporter(ctx, conf, params.Logger)
if err != nil {
return nil, err
Expand All @@ -85,7 +85,7 @@ func NewMetricsExporter(ctx context.Context, params exporter.CreateSettings, con
)
}

func NewLogsExporter(ctx context.Context, params exporter.CreateSettings, conf component.Config) (exporter.Logs, error) {
func newLogsExporter(ctx context.Context, params exporter.CreateSettings, conf component.Config) (exporter.Logs, error) {
exp, err := createExporter(ctx, conf, params.Logger)
if err != nil {
return nil, err
Expand Down

0 comments on commit a7e468e

Please sign in to comment.