Added google cloud monitoring receiver

Author: abhishek-at-cloudwerx

.chloggen/googlecloudmonitoringreceiver-phase1.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: new_component
+
+# 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: Adding new component - [Google Cloud monitoring](https://cloud.google.com/monitoring/api/metrics_gcp) receiver to fetch GCP Cloud Metrics and transform to OpenTelemetry compatible format.
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [33762]
+
+# (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: []

.github/CODEOWNERS

@@ -296,6 +296,7 @@ receiver/windowseventlogreceiver/                                   @open-teleme
 receiver/windowsperfcountersreceiver/                               @open-telemetry/collector-contrib-approvers @dashpole @alxbl @pjanotti
 receiver/zipkinreceiver/                                            @open-telemetry/collector-contrib-approvers @MovieStoreGuy @andrzej-stencel @crobert-1
 receiver/zookeeperreceiver/                                         @open-telemetry/collector-contrib-approvers @djaglowski
+receiver/googlecloudmonitoringreceiver/                             @open-telemetry/collector-contrib-approvers @dashpole @TylerHelmuth @abhishek-at-cloudwerx
 
 testbed/                                                            @open-telemetry/collector-contrib-approvers @open-telemetry/collector-approvers
 testbed/mockdatasenders/mockdatadogagentexporter/                   @open-telemetry/collector-contrib-approvers @boostchicken

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -228,6 +228,7 @@ body:
       - receiver/flinkmetrics
       - receiver/fluentforward
       - receiver/gitprovider
+      - receiver/googlecloudmonitoring
       - receiver/googlecloudpubsub
       - receiver/googlecloudspanner
       - receiver/haproxy

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -222,6 +222,7 @@ body:
       - receiver/flinkmetrics
       - receiver/fluentforward
       - receiver/gitprovider
+      - receiver/googlecloudmonitoring
       - receiver/googlecloudpubsub
       - receiver/googlecloudspanner
       - receiver/haproxy

.github/ISSUE_TEMPLATE/other.yaml

@@ -222,6 +222,7 @@ body:
       - receiver/flinkmetrics
       - receiver/fluentforward
       - receiver/gitprovider
+      - receiver/googlecloudmonitoring
       - receiver/googlecloudpubsub
       - receiver/googlecloudspanner
       - receiver/haproxy

.github/ISSUE_TEMPLATE/unmaintained.yaml

@@ -227,6 +227,7 @@ body:
       - receiver/flinkmetrics
       - receiver/fluentforward
       - receiver/gitprovider
+      - receiver/googlecloudmonitoring
       - receiver/googlecloudpubsub
       - receiver/googlecloudspanner
       - receiver/haproxy

cmd/otelcontribcol/go.mod

@@ -4,7 +4,7 @@ module github.com/open-telemetry/opentelemetry-collector-contrib/cmd/otelcontrib
 
 go 1.21.0
 
-toolchain go1.21.12
+toolchain go1.22.4
 
 require (
 	github.com/open-telemetry/opentelemetry-collector-contrib/confmap/provider/s3provider v0.106.1

cmd/oteltestbedcol/go.mod

@@ -4,7 +4,7 @@ module github.com/open-telemetry/opentelemetry-collector-contrib/cmd/oteltestbed
 
 go 1.21.0
 
-toolchain go1.21.12
+toolchain go1.22.4
 
 require (
 	github.com/open-telemetry/opentelemetry-collector-contrib/exporter/carbonexporter v0.106.1

receiver/googlecloudmonitoringreceiver/Makefile

@@ -0,0 +1 @@
+include ../../Makefile.Common

receiver/googlecloudmonitoringreceiver/README.md

@@ -0,0 +1,58 @@
+# Google Cloud Monitoring Receiver
+
+<!-- status autogenerated section -->
+| Status        |           |
+| ------------- |-----------|
+| Stability     | [development]: metrics   |
+| Distributions | [contrib] |
+| Issues        | [![Open issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aopen%20label%3Areceiver%2Fgooglecloudmonitoring%20&label=open&color=orange&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aopen+is%3Aissue+label%3Areceiver%2Fgooglecloudmonitoring) [![Closed issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aclosed%20label%3Areceiver%2Fgooglecloudmonitoring%20&label=closed&color=blue&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aclosed+is%3Aissue+label%3Areceiver%2Fgooglecloudmonitoring) |
+| [Code Owners](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CONTRIBUTING.md#becoming-a-code-owner)    | [@dashpole](https://www.github.com/dashpole), [@TylerHelmuth](https://www.github.com/TylerHelmuth), [@abhishek-at-cloudwerx](https://www.github.com/abhishek-at-cloudwerx) |
+
+[development]: https://github.com/open-telemetry/opentelemetry-collector#development
+[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
+<!-- end autogenerated section -->
+
+The primary objective of the Google Cloud Monitoring Receiver is to gather time series metrics data from all Google services and convert this data into a pipeline format that facilitates further use.
+
+This receiver gets GCP (Google Clout Platform) metrics from [GCP Monitoring REST API] via the [Google SDK for GCP Metrics] and then convert those timeseries data into OTel Format [Pipeline Data].
+
+[GCP Monitoring REST API]: https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list
+[Google SDK for GCP Metrics]: https://pkg.go.dev/cloud.google.com/go/monitoring/apiv3
+[Pipeline Data]: https://pkg.go.dev/go.opentelemetry.io/collector/pdata
+
+## Configuration
+The following configuration options are supported:
+
+```yaml
+receivers:
+  googlecloudmonitoring:
+    collection_interval: 120s
+    region: us-central1
+    project_id: my-project-id
+    service_account_key: "path/to/service_account.json"
+    services:
+      - service_name: "compute"
+        metric_name: "compute.googleapis.com/instance/cpu/usage_time"
+        delay: 60s
+      - service_name: "connectors"
+        metric_name: "connectors.googleapis.com/flex/instance/cpu/usage_time"
+        delay: 60s
+```
+
+- `collection_interval` (Optional): The interval at which metrics are collected. Default is 60s.
+- `region` (Required): The GCP region where the services are located.
+- `project_id` (Required): The GCP project ID.
+- `service_account_key` (Required): The path to the service account key JSON file.
+- `services` (Required): A list of services to monitor.
+
+Each service can have the following configuration:
+
+- `service_name` (Required): The name of the GCP service (e.g., `compute`).
+- `delay` (Optional): The delay before starting the collection of metrics for this service. Default is 0s.
+- `metric_name` (Optional): The specific metric name to collect. If not set, all metrics are collected.
+
+### Filtering
+
+**Metrics Parameters** :
+
+- A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type. For example: `metric_name: "compute.googleapis.com/instance/cpu/usage_time"`

receiver/googlecloudmonitoringreceiver/config.go

@@ -0,0 +1,59 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package googlecloudmonitoringreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/googlecloudmonitoringreceiver"
+
+import (
+	"errors"
+	"fmt"
+	"time"
+
+	"go.opentelemetry.io/collector/receiver/scraperhelper"
+)
+
+const minCollectionIntervalSeconds = 60
+
+type Config struct {
+	scraperhelper.ControllerConfig `mapstructure:",squash"`
+
+	Region            string    `mapstructure:"region"`
+	ProjectID         string    `mapstructure:"project_id"`
+	ServiceAccountKey string    `mapstructure:"service_account_key"`
+	Services          []Service `mapstructure:"services"`
+}
+
+type Service struct {
+	ServiceName string        `mapstructure:"service_name"`
+	MetricName  string        `mapstructure:"metric_name"`
+	Delay       time.Duration `mapstructure:"delay"`
+}
+
+func (config *Config) Validate() error {
+	if config.CollectionInterval.Seconds() < minCollectionIntervalSeconds {
+		return fmt.Errorf("\"collection_interval\" must be not lower than %v seconds, current value is %v seconds", minCollectionIntervalSeconds, config.CollectionInterval.Seconds())
+	}
+
+	if len(config.Services) == 0 {
+		return errors.New("missing required field \"services\" or its value is empty")
+	}
+
+	for _, service := range config.Services {
+		if err := service.Validate(); err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+func (service Service) Validate() error {
+	if service.ServiceName == "" {
+		return errors.New("field \"service_name\" is required and cannot be empty for service configuration")
+	}
+
+	if service.Delay < 0 {
+		return errors.New("field \"delay\" cannot be negative for service configuration")
+	}
+
+	return nil
+}

receiver/googlecloudmonitoringreceiver/config_test.go

@@ -0,0 +1,124 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package googlecloudmonitoringreceiver
+
+import (
+	"path/filepath"
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/confmap/confmaptest"
+	"go.opentelemetry.io/collector/receiver/scraperhelper"
+
+	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/googlecloudmonitoringreceiver/internal/metadata"
+)
+
+func TestLoadConfig(t *testing.T) {
+	cm, err := confmaptest.LoadConf(filepath.Join("testdata", "config.yaml"))
+	require.NoError(t, err)
+	factory := NewFactory()
+	cfg := factory.CreateDefaultConfig()
+
+	sub, err := cm.Sub(component.NewIDWithName(metadata.Type, "").String())
+	require.NoError(t, err)
+	require.NoError(t, sub.Unmarshal(cfg))
+
+	assert.Equal(t,
+		&Config{
+			ControllerConfig: scraperhelper.ControllerConfig{
+				CollectionInterval: 120 * time.Second,
+				InitialDelay:       1 * time.Second,
+			},
+			Region:            "us-central1",
+			ProjectID:         "my-project-id",
+			ServiceAccountKey: "path/to/service_account.json",
+			Services: []Service{
+				{
+					ServiceName: "compute",
+					Delay:       60 * time.Second,
+					MetricName:  "compute.googleapis.com/instance/cpu/usage_time",
+				},
+				{
+					ServiceName: "connectors",
+					Delay:       60 * time.Second,
+					MetricName:  "connectors.googleapis.com/flex/instance/cpu/usage_time",
+				},
+			},
+		},
+		cfg,
+	)
+}
+
+func TestValidateService(t *testing.T) {
+	testCases := map[string]struct {
+		service      Service
+		requireError bool
+	}{
+		"Valid Service": {
+			Service{
+				ServiceName: "service_name",
+				Delay:       0,
+			}, false},
+		"Empty ServiceName": {
+			Service{
+				ServiceName: "",
+				Delay:       0,
+			}, true},
+		"Negative Delay": {
+			Service{
+				ServiceName: "service_name",
+				Delay:       -1,
+			}, true},
+	}
+
+	for name, testCase := range testCases {
+		t.Run(name, func(t *testing.T) {
+			err := testCase.service.Validate()
+			if testCase.requireError {
+				require.Error(t, err)
+			} else {
+				require.NoError(t, err)
+			}
+		})
+	}
+}
+
+func TestValidateConfig(t *testing.T) {
+	validService := Service{
+		ServiceName: "service_name",
+		Delay:       0 * time.Second,
+	}
+
+	testCases := map[string]struct {
+		services           []Service
+		collectionInterval time.Duration
+		requireError       bool
+	}{
+		"Valid Config":                {[]Service{validService}, 60 * time.Second, false},
+		"Empty Services":              {nil, 60 * time.Second, true},
+		"Invalid Service in Services": {[]Service{{}}, 60 * time.Second, true},
+		"Invalid Collection Interval": {[]Service{validService}, 0 * time.Second, true},
+	}
+
+	for name, testCase := range testCases {
+		t.Run(name, func(t *testing.T) {
+			cfg := &Config{
+				ControllerConfig: scraperhelper.ControllerConfig{
+					CollectionInterval: testCase.collectionInterval,
+				},
+				Services: testCase.services,
+			}
+
+			err := cfg.Validate()
+			if testCase.requireError {
+				require.Error(t, err)
+			} else {
+				require.NoError(t, err)
+			}
+		})
+	}
+}

receiver/googlecloudmonitoringreceiver/doc.go

@@ -0,0 +1,6 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+//go:generate mdatagen metadata.yaml
+
+package googlecloudmonitoringreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/googlecloudmonitoringreceiver"

receiver/googlecloudmonitoringreceiver/factory.go

@@ -0,0 +1,49 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package googlecloudmonitoringreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/googlecloudmonitoringreceiver"
+
+import (
+	"context"
+
+	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/consumer"
+	"go.opentelemetry.io/collector/receiver"
+	"go.opentelemetry.io/collector/receiver/scraperhelper"
+
+	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/googlecloudmonitoringreceiver/internal/metadata"
+)
+
+func NewFactory() receiver.Factory {
+	return receiver.NewFactory(
+		metadata.Type,
+		createDefaultConfig,
+		receiver.WithMetrics(createMetricsReceiver, metadata.MetricsStability))
+}
+
+// createDefaultConfig creates the default exporter configuration
+func createDefaultConfig() component.Config {
+	return &Config{
+		ControllerConfig: scraperhelper.NewDefaultControllerConfig(),
+	}
+}
+
+func createMetricsReceiver(
+	_ context.Context,
+	settings receiver.Settings,
+	baseCfg component.Config,
+	consumer consumer.Metrics,
+) (receiver.Metrics, error) {
+
+	rCfg := baseCfg.(*Config)
+	r := newGoogleCloudMonitoringReceiver(rCfg, settings.Logger)
+
+	scraper, err := scraperhelper.NewScraper(metadata.Type.String(), r.Scrape, scraperhelper.WithStart(r.Start),
+		scraperhelper.WithShutdown(r.Shutdown))
+	if err != nil {
+		return nil, err
+	}
+
+	return scraperhelper.NewScraperControllerReceiver(&rCfg.ControllerConfig, settings, consumer,
+		scraperhelper.AddScraper(scraper))
+}