From 7c0e8ba037a6c2ef79396e9fd0a757f4a0c7e848 Mon Sep 17 00:00:00 2001 From: sakulali Date: Wed, 20 Sep 2023 20:38:37 +0800 Subject: [PATCH] [receiver/mongodb] do not expose method --- .chloggen/mongodbreceiver-checkapi-26304.yaml | 27 +++++++++++++++++++ cmd/checkapi/allowlist.txt | 1 - receiver/mongodbreceiver/client.go | 4 +-- receiver/mongodbreceiver/scraper.go | 2 +- 4 files changed, 30 insertions(+), 4 deletions(-) create mode 100755 .chloggen/mongodbreceiver-checkapi-26304.yaml diff --git a/.chloggen/mongodbreceiver-checkapi-26304.yaml b/.chloggen/mongodbreceiver-checkapi-26304.yaml new file mode 100755 index 000000000000..ea2b291db871 --- /dev/null +++ b/.chloggen/mongodbreceiver-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: 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] \ No newline at end of file diff --git a/cmd/checkapi/allowlist.txt b/cmd/checkapi/allowlist.txt index 8b72c5272f87..52f1e70ef4f5 100644 --- a/cmd/checkapi/allowlist.txt +++ b/cmd/checkapi/allowlist.txt @@ -23,7 +23,6 @@ receiver/jaegerreceiver receiver/journaldreceiver receiver/kafkareceiver receiver/mongodbatlasreceiver -receiver/mongodbreceiver receiver/podmanreceiver receiver/pulsarreceiver receiver/windowseventlogreceiver diff --git a/receiver/mongodbreceiver/client.go b/receiver/mongodbreceiver/client.go index 9b5b3dd2de9d..c9da17fb49d0 100644 --- a/receiver/mongodbreceiver/client.go +++ b/receiver/mongodbreceiver/client.go @@ -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 diff --git a/receiver/mongodbreceiver/scraper.go b/receiver/mongodbreceiver/scraper.go index 7f37f4868949..7557e66136a5 100644 --- a/receiver/mongodbreceiver/scraper.go +++ b/receiver/mongodbreceiver/scraper.go @@ -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) }