Skip to content

Commit

Permalink
[exporter/kafka] do not expose method (open-telemetry#27583)
Browse files Browse the repository at this point in the history
Do not export function WithTracesMarshalers, WithMetricsMarshalers,
WithLogsMarshalers and pass checkapi

open-telemetry#26304

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


Co-authored-by: Alex Boten <aboten@lightstep.com>
  • Loading branch information
2 people authored and jmsnll committed Nov 12, 2023
1 parent 93d3647 commit c4752be
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 10 deletions.
27 changes: 27 additions & 0 deletions .chloggen/kafkaexporter-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: 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]
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/kafkaexporter
extension/observer
processor/servicegraphprocessor
receiver/carbonreceiver
Expand Down
12 changes: 6 additions & 6 deletions exporter/kafkaexporter/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,26 +41,26 @@ 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
}
}
}

// 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
}
}
}

// 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
Expand Down
6 changes: 3 additions & 3 deletions exporter/kafkaexporter/factory_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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(),
Expand Down Expand Up @@ -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(),
Expand Down Expand Up @@ -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(),
Expand Down

0 comments on commit c4752be

Please sign in to comment.