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

[receiver/carbon] do not expose method #28872

Merged
merged 1 commit into from
Nov 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .chloggen/carbonreceiver-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: carbonreceiver

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Do not export function New 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
Expand Up @@ -2,7 +2,6 @@ connector/servicegraphconnector
extension/encoding
extension/observer
processor/servicegraphprocessor
receiver/carbonreceiver
receiver/collectdreceiver
receiver/dockerstatsreceiver
receiver/journaldreceiver
Expand Down
2 changes: 1 addition & 1 deletion receiver/carbonreceiver/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,5 @@ func createMetricsReceiver(
) (receiver.Metrics, error) {

rCfg := cfg.(*Config)
return New(params, *rCfg, consumer)
return newMetricsReceiver(params, *rCfg, consumer)
}
4 changes: 2 additions & 2 deletions receiver/carbonreceiver/receiver.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ type carbonReceiver struct {

var _ receiver.Metrics = (*carbonReceiver)(nil)

// New creates the Carbon receiver with the given configuration.
func New(
// newMetricsReceiver creates the Carbon receiver with the given configuration.
func newMetricsReceiver(
set receiver.CreateSettings,
config Config,
nextConsumer consumer.Metrics,
Expand Down
6 changes: 3 additions & 3 deletions receiver/carbonreceiver/receiver_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ func Test_carbonreceiver_New(t *testing.T) {
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := New(receivertest.NewNopCreateSettings(), tt.args.config, tt.args.nextConsumer)
got, err := newMetricsReceiver(receivertest.NewNopCreateSettings(), tt.args.config, tt.args.nextConsumer)
assert.Equal(t, tt.wantErr, err)
if err == nil {
require.NotNil(t, got)
Expand Down Expand Up @@ -157,7 +157,7 @@ func Test_carbonreceiver_Start(t *testing.T) {
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := New(receivertest.NewNopCreateSettings(), tt.args.config, tt.args.nextConsumer)
got, err := newMetricsReceiver(receivertest.NewNopCreateSettings(), tt.args.config, tt.args.nextConsumer)
require.NoError(t, err)
err = got.Start(context.Background(), componenttest.NewNopHost())
assert.Equal(t, tt.wantErr, err)
Expand Down Expand Up @@ -218,7 +218,7 @@ func Test_carbonreceiver_EndToEnd(t *testing.T) {
rt := sdktrace.NewTracerProvider(sdktrace.WithSpanProcessor(recorder))
cs := receivertest.NewNopCreateSettings()
cs.TracerProvider = rt
rcv, err := New(cs, *cfg, sink)
rcv, err := newMetricsReceiver(cs, *cfg, sink)
require.NoError(t, err)
r := rcv.(*carbonReceiver)

Expand Down