feat(googlecloudmonitoring): support monitoring filters (#37264)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes part of
#36898

<!--Describe what testing was performed and which tests were added.-->
#### Testing

<!--Describe the documentation added.-->
#### Documentation

<!--Please delete paragraphs that you did not use before submitting.-->

Author: chenlujjj

.chloggen/feat-googlecloudmonitoring-filter.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: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: googlecloudmonitoringreceiver
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: support use [monitoring filters](https://cloud.google.com/monitoring/api/v3/filters) to filter metrics
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [36898]
+
+# (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: []

receiver/googlecloudmonitoringreceiver/README.md

@@ -41,8 +41,10 @@ receivers:
 
 Each single metric can have the following configuration:
 
-- `metric_name` (Required): The specific metric name to collect.
+- `metric_name` (Optional): The specific metric name to collect.
+- `metric_descriptor_filter` (Optional): Filter for [listing metric descriptors](https://cloud.google.com/monitoring/api/v3/filters#metric-descriptor-filter). Only support `project` and `metric.type` as filter objects.
 
+One of `metric_name` and `metric_descriptor_filter` MUST be specified, but MUST not be specified at the same time.
 
 ## Authentication with Google Cloud
 

receiver/googlecloudmonitoringreceiver/config.go

@@ -26,6 +26,9 @@ type Config struct {
 
 type MetricConfig struct {
 	MetricName string `mapstructure:"metric_name"`
+	// Filter for listing metric descriptors. Only support `project` and `metric.type` as filter objects.
+	// See https://cloud.google.com/monitoring/api/v3/filters#metric-descriptor-filter for more details.
+	MetricDescriptorFilter string `mapstructure:"metric_descriptor_filter"`
 }
 
 func (config *Config) Validate() error {
@@ -47,8 +50,12 @@ func (config *Config) Validate() error {
 }
 
 func (metric MetricConfig) Validate() error {
-	if metric.MetricName == "" {
-		return errors.New("field \"metric_name\" is required and cannot be empty for metric configuration")
+	if metric.MetricName != "" && metric.MetricDescriptorFilter != "" {
+		return errors.New("fields \"metric_name\" and \"metric_descriptor_filter\" cannot both have value")
+	}
+
+	if metric.MetricName == "" && metric.MetricDescriptorFilter == "" {
+		return errors.New("fields \"metric_name\" and \"metric_descriptor_filter\" cannot both be empty")
 	}
 
 	return nil

receiver/googlecloudmonitoringreceiver/config_test.go

@@ -41,6 +41,9 @@ func TestLoadConfig(t *testing.T) {
 				{
 					MetricName: "connectors.googleapis.com/flex/instance/cpu/usage_time",
 				},
+				{
+					MetricDescriptorFilter: "metric.type = starts_with(\"compute.googleapis.com\")",
+				},
 			},
 		},
 		cfg,

receiver/googlecloudmonitoringreceiver/receiver.go

@@ -30,7 +30,7 @@ type monitoringReceiver struct {
 	client            *monitoring.MetricClient
 	metricsBuilder    *internal.MetricsBuilder
 	mutex             sync.RWMutex
-	metricDescriptors map[string]*metric.MetricDescriptor
+	metricDescriptors map[string]*metric.MetricDescriptor // key is the Type of MetricDescriptor
 }
 
 func newGoogleCloudMonitoringReceiver(cfg *Config, logger *zap.Logger) *monitoringReceiver {
@@ -78,7 +78,7 @@ func (mr *monitoringReceiver) Shutdown(context.Context) error {
 
 func (mr *monitoringReceiver) Scrape(ctx context.Context) (pmetric.Metrics, error) {
 	var (
-		gInternal    time.Duration
+		gInterval    time.Duration
 		gDelay       time.Duration
 		calStartTime time.Time
 		calEndTime   time.Time
@@ -89,20 +89,13 @@ func (mr *monitoringReceiver) Scrape(ctx context.Context) (pmetric.Metrics, erro
 	metrics := pmetric.NewMetrics()
 
 	// Iterate over each metric in the configuration to calculate start/end times and construct the filter query.
-	for _, metric := range mr.config.MetricsList {
-		// Acquire read lock to safely read metricDescriptors
-		mr.mutex.RLock()
-		metricDesc, exists := mr.metricDescriptors[metric.MetricName]
-		mr.mutex.RUnlock()
-		if !exists {
-			mr.logger.Warn("Metric descriptor not found", zap.String("metric_name", metric.MetricName))
-			continue
-		}
-
+	mr.mutex.RLock()
+	defer mr.mutex.RUnlock()
+	for metricType, metricDesc := range mr.metricDescriptors {
 		// Set interval and delay times, using defaults if not provided
-		gInternal = mr.config.CollectionInterval
-		if gInternal <= 0 {
-			gInternal = defaultCollectionInterval
+		gInterval = mr.config.CollectionInterval
+		if gInterval <= 0 {
+			gInterval = defaultCollectionInterval
 		}
 
 		gDelay = metricDesc.GetMetadata().GetIngestDelay().AsDuration()
@@ -111,10 +104,10 @@ func (mr *monitoringReceiver) Scrape(ctx context.Context) (pmetric.Metrics, erro
 		}
 
 		// Calculate the start and end times
-		calStartTime, calEndTime = calculateStartEndTime(gInternal, gDelay)
+		calStartTime, calEndTime = calculateStartEndTime(gInterval, gDelay)
 
 		// Get the filter query for the metric
-		filterQuery = getFilterQuery(metric)
+		filterQuery = fmt.Sprintf(`metric.type = "%s"`, metricType)
 
 		// Define the request to list time series data
 		tsReq := &monitoringpb.ListTimeSeriesRequest{
@@ -241,10 +234,14 @@ func calculateStartEndTime(interval, delay time.Duration) (time.Time, time.Time)
 // getFilterQuery constructs a filter query string based on the provided metric.
 func getFilterQuery(metric MetricConfig) string {
 	var filterQuery string
-	const baseQuery = `metric.type =`
 
-	// If a specific metric name is provided, use it in the filter query
-	filterQuery = fmt.Sprintf(`%s "%s"`, baseQuery, metric.MetricName)
+	// see https://cloud.google.com/monitoring/api/v3/filters
+	if metric.MetricName != "" {
+		filterQuery = fmt.Sprintf(`metric.type = "%s"`, metric.MetricName)
+	} else {
+		filterQuery = metric.MetricDescriptorFilter
+	}
+
 	return filterQuery
 }
 
@@ -322,7 +319,7 @@ func (mr *monitoringReceiver) convertGCPTimeSeriesToMetrics(metrics pmetric.Metr
 	// TODO: Add support for EXPONENTIAL_HISTOGRAM
 	default:
 		metricError := fmt.Sprintf("\n Unsupported metric kind: %v\n", timeSeries.GetMetricKind())
-		mr.logger.Info(metricError)
+		mr.logger.Warn(metricError)
 	}
 }
 

receiver/googlecloudmonitoringreceiver/testdata/config.yaml

@@ -4,3 +4,4 @@ googlecloudmonitoring:
   metrics_list:
     - metric_name: "compute.googleapis.com/instance/cpu/usage_time"
     - metric_name: "connectors.googleapis.com/flex/instance/cpu/usage_time"
+    - metric_descriptor_filter: "metric.type = starts_with(\"compute.googleapis.com\")"