From 3fcf00f93bec808b31893178a0074bdf07c7ec83 Mon Sep 17 00:00:00 2001 From: sakulali Date: Tue, 10 Oct 2023 17:06:10 +0800 Subject: [PATCH] [exporter/kafka] do not expose method --- .chloggen/kafkaexporter-checkapi-26304.yaml | 27 +++++++++++++++++++++ cmd/checkapi/allowlist.txt | 1 - exporter/kafkaexporter/factory.go | 12 ++++----- exporter/kafkaexporter/factory_test.go | 6 ++--- 4 files changed, 36 insertions(+), 10 deletions(-) create mode 100755 .chloggen/kafkaexporter-checkapi-26304.yaml diff --git a/.chloggen/kafkaexporter-checkapi-26304.yaml b/.chloggen/kafkaexporter-checkapi-26304.yaml new file mode 100755 index 000000000000..6e8cd86c061a --- /dev/null +++ b/.chloggen/kafkaexporter-checkapi-26304.yaml @@ -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: kafkaexporter + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: Do not export function WithTracesMarshalers, WithMetricsMarshalers, WithLogsMarshalers 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] diff --git a/cmd/checkapi/allowlist.txt b/cmd/checkapi/allowlist.txt index 9d2c2cf55614..19348e5c81e5 100644 --- a/cmd/checkapi/allowlist.txt +++ b/cmd/checkapi/allowlist.txt @@ -1,5 +1,4 @@ connector/servicegraphconnector -exporter/kafkaexporter extension/observer processor/servicegraphprocessor receiver/carbonreceiver diff --git a/exporter/kafkaexporter/factory.go b/exporter/kafkaexporter/factory.go index 15d317652048..37f0bc074be8 100644 --- a/exporter/kafkaexporter/factory.go +++ b/exporter/kafkaexporter/factory.go @@ -41,8 +41,8 @@ const ( // FactoryOption applies changes to kafkaExporterFactory. type FactoryOption func(factory *kafkaExporterFactory) -// WithTracesMarshalers adds tracesMarshalers. -func WithTracesMarshalers(tracesMarshalers ...TracesMarshaler) FactoryOption { +// withTracesMarshalers adds tracesMarshalers. +func withTracesMarshalers(tracesMarshalers ...TracesMarshaler) FactoryOption { return func(factory *kafkaExporterFactory) { for _, marshaler := range tracesMarshalers { factory.tracesMarshalers[marshaler.Encoding()] = marshaler @@ -50,8 +50,8 @@ func WithTracesMarshalers(tracesMarshalers ...TracesMarshaler) FactoryOption { } } -// WithMetricsMarshalers adds additional metric marshalers to the exporter factory. -func WithMetricsMarshalers(metricMarshalers ...MetricsMarshaler) FactoryOption { +// withMetricsMarshalers adds additional metric marshalers to the exporter factory. +func withMetricsMarshalers(metricMarshalers ...MetricsMarshaler) FactoryOption { return func(factory *kafkaExporterFactory) { for _, marshaler := range metricMarshalers { factory.metricsMarshalers[marshaler.Encoding()] = marshaler @@ -59,8 +59,8 @@ func WithMetricsMarshalers(metricMarshalers ...MetricsMarshaler) FactoryOption { } } -// WithLogMarshalers adds additional log marshalers to the exporter factory. -func WithLogsMarshalers(logsMarshalers ...LogsMarshaler) FactoryOption { +// withLogsMarshalers adds additional log marshalers to the exporter factory. +func withLogsMarshalers(logsMarshalers ...LogsMarshaler) FactoryOption { return func(factory *kafkaExporterFactory) { for _, marshaler := range logsMarshalers { factory.logsMarshalers[marshaler.Encoding()] = marshaler diff --git a/exporter/kafkaexporter/factory_test.go b/exporter/kafkaexporter/factory_test.go index 4451dbb4de68..74f11af33836 100644 --- a/exporter/kafkaexporter/factory_test.go +++ b/exporter/kafkaexporter/factory_test.go @@ -117,7 +117,7 @@ func TestCreateMetricExporter(t *testing.T) { t.Run(tc.name, func(t *testing.T) { t.Parallel() - f := NewFactory(WithMetricsMarshalers(tc.marshalers...)) + f := NewFactory(withMetricsMarshalers(tc.marshalers...)) exporter, err := f.CreateMetricsExporter( context.Background(), exportertest.NewNopCreateSettings(), @@ -191,7 +191,7 @@ func TestCreateLogExporter(t *testing.T) { t.Run(tc.name, func(t *testing.T) { t.Parallel() - f := NewFactory(WithLogsMarshalers(tc.marshalers...)) + f := NewFactory(withLogsMarshalers(tc.marshalers...)) exporter, err := f.CreateLogsExporter( context.Background(), exportertest.NewNopCreateSettings(), @@ -265,7 +265,7 @@ func TestCreateTraceExporter(t *testing.T) { t.Run(tc.name, func(t *testing.T) { t.Parallel() - f := NewFactory(WithTracesMarshalers(tc.marshalers...)) + f := NewFactory(withTracesMarshalers(tc.marshalers...)) exporter, err := f.CreateTracesExporter( context.Background(), exportertest.NewNopCreateSettings(),