Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 5 commits into from
Sep 21, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
57afc6e
override endpoint to etric client
Linu-Elias Sep 20, 2024
8f51a21
config and changelog
Linu-Elias Sep 20, 2024
bbca3b2
doc
Linu-Elias Sep 20, 2024
fd7a7b8
resolved comments
Linu-Elias Sep 20, 2024
a76e14f
lint fix
Linu-Elias Sep 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.next.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 support for specifying a custom endpoint for GCP service clients. {issue}40848[40848] {pull}40918[40918]

*Osquerybeat*

Expand Down
3 changes: 3 additions & 0 deletions metricbeat/docs/modules/gcp.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -377,6 +379,7 @@ metricbeat.modules:
period: 24h
project_id: "your project id"
credentials_file_path: "your JSON credentials file path"
endpoint: http://your-endpoint
dataset_id: "dataset id"
table_pattern: "table pattern"
----
Expand Down
1 change: 1 addition & 0 deletions x-pack/metricbeat/metricbeat.reference.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -641,6 +641,7 @@ metricbeat.modules:
period: 24h
project_id: "your project id"
credentials_file_path: "your JSON credentials file path"
endpoint: http://your-endpoint
dataset_id: "dataset id"
table_pattern: "table pattern"

Expand Down
1 change: 1 addition & 0 deletions x-pack/metricbeat/module/gcp/_meta/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,5 +67,6 @@
period: 24h
project_id: "your project id"
credentials_file_path: "your JSON credentials file path"
endpoint: http://your-endpoint
dataset_id: "dataset id"
table_pattern: "table pattern"
2 changes: 2 additions & 0 deletions x-pack/metricbeat/module/gcp/_meta/docs.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions x-pack/metricbeat/module/gcp/metrics/metricset.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ type config struct {
ExcludeLabels bool `config:"exclude_labels"`
CredentialsFilePath string `config:"credentials_file_path"`
CredentialsJSON string `config:"credentials_json"`
Endpoint string `config:"endpoint"`

opt []option.ClientOption
period *durationpb.Duration
Expand Down Expand Up @@ -144,6 +145,11 @@ func New(base mb.BaseMetricSet) (mb.MetricSet, error) {
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))
}
Comment on lines +148 to +151
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a new line to improve readability.

Suggested change
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))
}
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()),
}
Expand Down
1 change: 1 addition & 0 deletions x-pack/metricbeat/modules.d/gcp.yml.disabled
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,5 +70,6 @@
period: 24h
project_id: "your project id"
credentials_file_path: "your JSON credentials file path"
endpoint: http://your-endpoint
dataset_id: "dataset id"
table_pattern: "table pattern"
Loading