From 860de43c46f3026d4848d3160ecb1061136bbe71 Mon Sep 17 00:00:00 2001 From: Nathan Slaughter <28688390+nslaughter@users.noreply.github.com> Date: Thu, 14 Mar 2024 13:05:41 -0500 Subject: [PATCH] [receiver/azuremonitor] reduce public api (#30224) Resolves #24850 --- ...educe-public-api-azuremonitorreceiver.yaml | 27 +++++++++++++++++++ receiver/azuremonitorreceiver/scraper.go | 18 ++++++------- 2 files changed, 36 insertions(+), 9 deletions(-) create mode 100755 .chloggen/nslaughter_reduce-public-api-azuremonitorreceiver.yaml diff --git a/.chloggen/nslaughter_reduce-public-api-azuremonitorreceiver.yaml b/.chloggen/nslaughter_reduce-public-api-azuremonitorreceiver.yaml new file mode 100755 index 000000000000..13eda01ea0be --- /dev/null +++ b/.chloggen/nslaughter_reduce-public-api-azuremonitorreceiver.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: azuremonitorreceiver + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: Reduce the public API for this receiver. + +# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. +issues: [24850] + +# (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: This unexports the following types ArmClient, MetricsDefinitionsClientInterface, MetricsValuesClient. + +# 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/receiver/azuremonitorreceiver/scraper.go b/receiver/azuremonitorreceiver/scraper.go index 76492a47c55c..8aa4598c4364 100644 --- a/receiver/azuremonitorreceiver/scraper.go +++ b/receiver/azuremonitorreceiver/scraper.go @@ -95,9 +95,9 @@ func newScraper(conf *Config, settings receiver.CreateSettings) *azureScraper { type azureScraper struct { cred azcore.TokenCredential - clientResources ArmClient - clientMetricsDefinitions MetricsDefinitionsClientInterface - clientMetricsValues MetricsValuesClient + clientResources armClient + clientMetricsDefinitions metricsDefinitionsClientInterface + clientMetricsValues metricsValuesClient cfg *Config settings component.TelemetrySettings @@ -113,7 +113,7 @@ type azureScraper struct { mutex *sync.Mutex } -type ArmClient interface { +type armClient interface { NewListPager(options *armresources.ClientListOptions) *runtime.Pager[armresources.ClientListResponse] } @@ -134,27 +134,27 @@ func (s *azureScraper) getArmClientOptions() *arm.ClientOptions { return &options } -func (s *azureScraper) getArmClient() ArmClient { +func (s *azureScraper) getArmClient() armClient { client, _ := s.armClientFunc(s.cfg.SubscriptionID, s.cred, s.armClientOptions) return client } -type MetricsDefinitionsClientInterface interface { +type metricsDefinitionsClientInterface interface { NewListPager(resourceURI string, options *armmonitor.MetricDefinitionsClientListOptions) *runtime.Pager[armmonitor.MetricDefinitionsClientListResponse] } -func (s *azureScraper) getMetricsDefinitionsClient() MetricsDefinitionsClientInterface { +func (s *azureScraper) getMetricsDefinitionsClient() metricsDefinitionsClientInterface { client, _ := s.armMonitorDefinitionsClientFunc(s.cfg.SubscriptionID, s.cred, s.armClientOptions) return client } -type MetricsValuesClient interface { +type metricsValuesClient interface { List(ctx context.Context, resourceURI string, options *armmonitor.MetricsClientListOptions) ( armmonitor.MetricsClientListResponse, error, ) } -func (s *azureScraper) GetMetricsValuesClient() MetricsValuesClient { +func (s *azureScraper) GetMetricsValuesClient() metricsValuesClient { client, _ := s.armMonitorMetricsClientFunc(s.cfg.SubscriptionID, s.cred, s.armClientOptions) return client }