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

Do not collect Google Cloud metadata #15806

Merged
merged 2 commits into from
Jan 24, 2020
+9 −5
Merged

Do not collect Google Cloud metadata #15806

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3613973
Do not collect Google Cloud metadata
Jan 24, 2020
dd2ef7d
Update docs
Jan 24, 2020
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
2 changes: 1 addition & 1 deletion x-pack/metricbeat/module/googlecloud/_meta/docs.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ You can play in IAM pretty much with your service accounts and Instance level ac

Google Cloud Platform offers the https://cloud.google.com/monitoring/api/metrics_gcp[Stackdriver Monitoring API] to fetch metrics from its services. *Those metrics are retrieved one by one*.

If you also want to *extract service metadata and labels* (by setting `exclude_labels` to false, which is the default state). You also make a new API check on the corresponding service. Service labels requires a new API call to extract those metrics. In the worst case the number of API calls will be doubled. In the best case, all metrics come from the same GCP entity and 100% of the required information is included in the first API call (which is cached for subsequent calls).
If you also want to *extract service labels* (by setting `exclude_labels` to false, which is the default state). You also make a new API check on the corresponding service. Service labels requires a new API call to extract those metrics. In the worst case the number of API calls will be doubled. In the best case, all metrics come from the same GCP entity and 100% of the required information is included in the first API call (which is cached for subsequent calls).

A recommended `period` value between fetches is between 5 and 10 minutes, depending on how granular you want your metrics. GCP restricts information for less than 5 minutes.

Expand Down
10 changes: 7 additions & 3 deletions x-pack/metricbeat/module/googlecloud/stackdriver/compute/metadata.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,13 @@ func (s *metadataCollector) Metadata(ctx context.Context, resp *monitoringpb.Tim
metadataCollectorData.Labels[googlecloud.LabelUser] = s.computeMetadata.User
}

if s.computeMetadata.Metadata != nil {
metadataCollectorData.Labels[googlecloud.LabelMetadata] = s.computeMetadata.Metadata
}
/*
Do not collect meta for now, as it can contain sensitive info
TODO revisit this and make meta available through whitelisting
if s.computeMetadata.Metadata != nil {
metadataCollectorData.Labels[googlecloud.LabelMetadata] = s.computeMetadata.Metadata
}
*/

return metadataCollectorData, nil
}
Expand Down