x-pack/metricbeat/module/gcp: Override GCP API endpoint in metric client

CHANGELOG.next.asciidoc

@@ -59,6 +59,7 @@ https://github.com/elastic/beats/compare/v8.8.1\...main[Check the HEAD diff]
 - Mark system process metricsets as running if metrics are partially available {pull}40565[40565]
 - Added back `elasticsearch.node.stats.jvm.mem.pools.*` to the `node_stats` metricset {pull}40571[40571]
 - Add GCP organization and project details to ECS cloud fields. {pull}40461[40461]
+- Add `endpoint` field to the GCP configuration in order to append it to the metric client. {issue}40848[40848] {pull}40918[40918]
 
 *Osquerybeat*
 

metricbeat/docs/modules/gcp.asciidoc

@@ -52,6 +52,8 @@ and metadata information from metricsets and fetch metrics only. At the moment,
 
 * *period*: A single time duration specified for this module collection frequency.
 
+* *endpoint*: A custom endpoint to use for the GCP API calls. If not specified, the default endpoint will be used.
+
 [float]
 == Example configuration
 * `compute` metricset is enabled to collect metrics from `us-central1-a` zone
@@ -379,6 +381,16 @@ metricbeat.modules:
   credentials_file_path: "your JSON credentials file path"
   dataset_id: "dataset id"
   table_pattern: "table pattern"
+
+ - module: gcp
+  metricsets:
+    - compute
+  region: "us-"
+  project_id: "your project id"
+  credentials_file_path: "your JSON credentials file path"
+  endpoint: http://your-endpoint
+  exclude_labels: false
+  period: 1m 
 ----
 
 [float]

x-pack/metricbeat/metricbeat.reference.yml

@@ -644,6 +644,16 @@ metricbeat.modules:
   dataset_id: "dataset id"
   table_pattern: "table pattern"
 
+ - module: gcp
+  metricsets:
+    - compute
+  region: "us-"
+  project_id: "your project id"
+  credentials_file_path: "your JSON credentials file path"
+  endpoint: http://your-endpoint
+  exclude_labels: false
+  period: 1m 
+
 #-------------------------------- Golang Module --------------------------------
 - module: golang
   #metricsets:

x-pack/metricbeat/module/gcp/_meta/config.yml

@@ -69,3 +69,13 @@
   credentials_file_path: "your JSON credentials file path"
   dataset_id: "dataset id"
   table_pattern: "table pattern"
+
+ - module: gcp
+  metricsets:
+    - compute
+  region: "us-"
+  project_id: "your project id"
+  credentials_file_path: "your JSON credentials file path"
+  endpoint: http://your-endpoint
+  exclude_labels: false
+  period: 1m 

x-pack/metricbeat/module/gcp/_meta/docs.asciidoc

@@ -40,6 +40,8 @@ and metadata information from metricsets and fetch metrics only. At the moment,
 
 * *period*: A single time duration specified for this module collection frequency.
 
+* *endpoint*: A custom endpoint to use for the GCP API calls. If not specified, the default endpoint will be used.
+
 [float]
 == Example configuration
 * `compute` metricset is enabled to collect metrics from `us-central1-a` zone

x-pack/metricbeat/module/gcp/metrics/metricset.go

@@ -107,12 +107,12 @@ type config struct {
 	ExcludeLabels       bool     `config:"exclude_labels"`
 	CredentialsFilePath string   `config:"credentials_file_path"`
 	CredentialsJSON     string   `config:"credentials_json"`
-
-	opt              []option.ClientOption
-	period           *durationpb.Duration
-	organizationID   string
-	organizationName string
-	projectName      string
+	Endpoint            string   `config:"endpoint"`
+	opt                 []option.ClientOption
+	period              *durationpb.Duration
+	organizationID      string
+	organizationName    string
+	projectName         string
 }
 
 // New creates a new instance of the MetricSet. New is responsible for unpacking
@@ -143,6 +143,10 @@ func New(base mb.BaseMetricSet) (mb.MetricSet, error) {
 	} else {
 		return m, fmt.Errorf("no credentials_file_path or credentials_json specified")
 	}
+	if m.config.Endpoint != "" {
+		m.Logger().Warnf("You are using a custom endpoint '%s' for the GCP API calls.", m.config.Endpoint)
+		m.config.opt = append(m.config.opt, option.WithEndpoint(m.config.Endpoint))
+	}
 
 	m.config.period = &durationpb.Duration{
 		Seconds: int64(m.Module().Config().Period.Seconds()),

x-pack/metricbeat/modules.d/gcp.yml.disabled

@@ -72,3 +72,13 @@
   credentials_file_path: "your JSON credentials file path"
   dataset_id: "dataset id"
   table_pattern: "table pattern"
+
+ - module: gcp
+  metricsets:
+    - compute
+  region: "us-"
+  project_id: "your project id"
+  credentials_file_path: "your JSON credentials file path"
+  endpoint: http://your-endpoint
+  exclude_labels: false
+  period: 1m