Cherry-pick #17913 to 7.x: [Metricbeat] allow partial region and zone in googlecloud module config

[kaiyan-sheng]

Cherry-pick of PR #17913 to 7.x branch. Original message:

What does this PR do?

This PR is to enable partial region and partial zone in googlecloud module config. User can choose to use wildcard * or not. For example:

- module: googlecloud
  metricsets:
    - compute
  region: "us-west"
  project_id: "elastic-observability"
  credentials_file_path: "your JSON credentials file path"
  exclude_labels: false
  period: 60s

This config will enable data collection from all regions start with us-west, which includes us-west1, us-west2, us-west3 and us-west4.

- module: googlecloud
  metricsets:
    - compute
  region: "us-*"
  project_id: "elastic-observability"
  credentials_file_path: "your JSON credentials file path"
  exclude_labels: false
  period: 60s

Similarly this config will enable data collection from all regions start with us-, which includes all regions starts with us-west, us-east and us-central.

Why is it important?

This will allow users to not copy paste region/zone names when they want to monitor several regions/zones. If user wants to monitor all regions in both US and Europe, they still need to copy paste but that's very minimum. For example:

- module: googlecloud
  metricsets:
    - compute
  region: "us-*"
  project_id: "elastic-observability"
  credentials_file_path: "your JSON credentials file path"
  exclude_labels: false
  period: 60s
- module: googlecloud
  metricsets:
    - compute
  region: "europe-*"
  project_id: "elastic-observability"
  credentials_file_path: "your JSON credentials file path"
  exclude_labels: false
  period: 60s

Checklist

• My code follows the style guidelines of this project
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• I have made corresponding change to the default configuration files
• I have added tests that prove my fix is effective or that my feature works
• I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

How to test this PR locally

There are two parts need to be tested. One for regions and another for zones.

• Test for regions:
  Enable googlecloud with this config and you should see metrics collection from all regions start with us-.

- module: googlecloud
  metricsets:
    - compute
  region: "us-"
  project_id: "elastic-observability"
  credentials_file_path: "your JSON credentials file path"
  exclude_labels: false
  period: 60s

• Test for zones:
  Enable googlecloud with this config and you should see metrics collection from all zones start with europe-west3-, which includes europe-west3-a, europe-west3-b and europe-west3-c.

- module: googlecloud
  metricsets:
    - compute
  zone: "europe-west3-"
  project_id: "elastic-observability"
  credentials_file_path: "your JSON credentials file path"
  exclude_labels: false
  period: 60s

Related issues

• Relates [Metricbeat] Allow to specify more than one regions in googlecloud module #17835

[ycombinator]

LGTM.

Looks like there are some additional changes in metricbeat/docs/modules/googlecloud.asciidoc but they look like cleanup. Just wondering if you intend to make these same changes in master too — in that case, it might be better to remove them from this PR and backport them on their own?

[kaiyan-sheng]

@ycombinator I'm wondering the same thing hmmm I tried to run mage fmt update in master branch but nothing got updated. But there is definitely a difference between metricbeat/docs/modules/googlecloud.asciidoc and x-pack/metricbeat/module/googlecloud/_meta/docs.asciidoc. Am I running the wrong command under elastic/beats/metricbeat?

[ycombinator]

I think you're running the right command. I'm guessing there is some difference in the doc toolchains between master and 7.x. Anyway the changes are cosmetic so I'd just go ahead and merge this.

[botelastic]

This pull request doesn't have a Team:<team> label.