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/mongodb] do not expose method #27021

Merged
merged 8 commits into from
Sep 20, 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/mongodbreceiver-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: mongodbreceiver

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Do not export the function `NewClient` 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 @@ -23,7 +23,6 @@ receiver/jaegerreceiver
receiver/journaldreceiver
receiver/kafkareceiver
receiver/mongodbatlasreceiver
receiver/mongodbreceiver
receiver/podmanreceiver
receiver/pulsarreceiver
receiver/windowseventlogreceiver
4 changes: 2 additions & 2 deletions receiver/mongodbreceiver/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ type mongodbClient struct {
*mongo.Client
}

// NewClient creates a new client to connect and query mongo for the
// newClient creates a new client to connect and query mongo for the
// mongodbreceiver
func NewClient(ctx context.Context, config *Config, logger *zap.Logger) (client, error) {
func newClient(ctx context.Context, config *Config, logger *zap.Logger) (client, error) {
driver, err := mongo.Connect(ctx, config.ClientOptions())
if err != nil {
return nil, err
Expand Down
2 changes: 1 addition & 1 deletion receiver/mongodbreceiver/scraper.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ func newMongodbScraper(settings receiver.CreateSettings, config *Config) *mongod
}

func (s *mongodbScraper) start(ctx context.Context, _ component.Host) error {
c, err := NewClient(ctx, s.config, s.logger)
c, err := newClient(ctx, s.config, s.logger)
if err != nil {
return fmt.Errorf("create mongo client: %w", err)
}
Expand Down