-
Notifications
You must be signed in to change notification settings - Fork 458
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.
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
[gcp] Migrate some gcp beat metricset to data streams #2707
Merged
Merged
Changes from all commits
Commits
Show all changes
22 commits
Select commit
Hold shift + click to select a range
25c29cd
[GCP] Add GCP Billing Metricset (#2141)
legoguy1000 fa41120
[GCP] Add GCP Compute Metricset (#2301)
legoguy1000 2e35e13
remove edits to firewall and vpcflow data streams
endorama c937dbd
Revert "remove edits to firewall and vpcflow data streams"
endorama d51d2bf
gcp: add alternative_host to audit and dns
endorama c114d14
gcp: define alternative_host at data stream level
endorama 0c6df43
CHANGELOG
endorama 89c82b3
add GCP compute test
endorama c8f00a8
[GCP] Add firestore data_stream (#2704)
gpop63 dba820d
firestore changelog
endorama 51552e4
update docs
endorama 7b51b6b
billing,compute: fix credentials_json escaping
endorama 42af224
gcp.compute: remove system tests
endorama 5e354b0
gcp: update changelog with more details on breaking change
endorama a3da559
Update changelog.yml
endorama 6b97c3a
Update packages/gcp/changelog.yml
endorama 826b985
update kibana constraint
endorama dec0dc1
remove support for 7.17.x
endorama dc10062
add metrics datasets docs
endorama 7257e23
update docs
endorama 8d43275
fix typos
endorama 71facbc
improve details on alterative_host usage
endorama File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Billing | ||
|
||
## Metrics | ||
|
||
The `billing` dataset collects [Cloud Billing Reports](https://cloud.google.com/billing/docs/reports) information from Google Cloud BigQuery daily cost detail table. BigQuery is a fully-managed, serverless data warehouse. Cloud Billing export to BigQuery enables you to export detailed Google Cloud billing data (such as usage, cost estimates, and pricing data) automatically throughout the day to a BigQuery dataset that you specify. Then you can access your Cloud Billing data from BigQuery for detailed analysis. | ||
|
||
Please see [export cloud billing data to BigQuery](https://cloud.google.com/billing/docs/how-to/export-data-bigquery) for more details on how to export billing data. | ||
|
||
In BigQuery dataset, detailed Google Cloud daily cost data is loaded into a data table named `gcp_billing_export_v1_<BILLING_ACCOUNT_ID>`. There is a defined schema for Google Cloud daily cost data that is exported to BigQuery. Please see [daily cost detail data schema](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#data-schema) for more details. | ||
|
||
## Sample Event | ||
|
||
{{event "billing"}} | ||
|
||
## Exported fields | ||
|
||
{{fields "billing"}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Compute | ||
|
||
## Metrics | ||
|
||
The `compute` dataset is designed to fetch metrics for [Compute Engine](https://cloud.google.com/compute/) Virtual Machines in Google Cloud Platform. It contains all metrics exported from the [GCP Cloud Monitoring API](https://cloud.google.com/monitoring/api/metrics_gcp#gcp-compute). | ||
|
||
Extra labels and metadata are also extracted using the [Compute API](https://cloud.google.com/compute/docs/reference/rest/v1/instances/get). This is enough to get most of the info associated with a metric like Compute labels and metadata and metric specific Labels. | ||
|
||
## Sample Event | ||
|
||
{{event "compute"}} | ||
|
||
## Exported fields | ||
|
||
{{fields "compute"}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Firestore | ||
|
||
## Metrics | ||
|
||
The `firestore` dataset fetches metrics from [Firestore](https://cloud.google.com/firestore/) in Google Cloud Platform. It contains all metrics exported from the [GCP Firestore Monitoring API](https://cloud.google.com/monitoring/api/metrics_gcp#gcp-firestore). | ||
|
||
You can specify a single region to fetch metrics like `us-central1`. Be aware that GCP Storage does not use zones so `us-central1-a` will return nothing. If no region is specified, it will return metrics from all buckets. | ||
|
||
## Sample Event | ||
|
||
{{event "firestore"}} | ||
|
||
## Exported fields | ||
|
||
{{fields "firestore"}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
12 changes: 12 additions & 0 deletions
12
packages/gcp/data_stream/billing/agent/stream/stream.yml.hbs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
metricsets: ["billing"] | ||
period: {{period}} | ||
project_id: {{project_id}} | ||
{{#if credentials_file}} | ||
credentials_file_path: {{credentials_file}} | ||
{{/if}} | ||
{{#if credentials_json}} | ||
credentials_json: '{{credentials_json}}' | ||
{{/if}} | ||
dataset_id: {{dataset_id}} | ||
table_pattern: {{table_pattern}} | ||
cost_type: {{cost_type}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,198 @@ | ||
- name: cloud | ||
title: Cloud | ||
group: 2 | ||
description: Fields related to the cloud or infrastructure the events are coming from. | ||
footnote: 'Examples: If Metricbeat is running on an EC2 host and fetches data from its host, the cloud info contains the data about this machine. If Metricbeat runs on a remote machine outside the cloud and fetches data from a service running in the cloud, the field contains cloud data from the machine the service is running on.' | ||
type: group | ||
fields: | ||
- name: account.id | ||
level: extended | ||
type: keyword | ||
ignore_above: 1024 | ||
description: 'The cloud account or organization id used to identify different entities in a multi-tenant environment. | ||
Examples: AWS account id, Google Cloud ORG Id, or other unique identifier.' | ||
example: 666777888999 | ||
- name: availability_zone | ||
level: extended | ||
type: keyword | ||
ignore_above: 1024 | ||
description: Availability zone in which this host is running. | ||
example: us-east-1c | ||
- name: instance.id | ||
level: extended | ||
type: keyword | ||
ignore_above: 1024 | ||
description: Instance ID of the host machine. | ||
example: i-1234567890abcdef0 | ||
- name: instance.name | ||
level: extended | ||
type: keyword | ||
ignore_above: 1024 | ||
description: Instance name of the host machine. | ||
- name: machine.type | ||
level: extended | ||
type: keyword | ||
ignore_above: 1024 | ||
description: Machine type of the host machine. | ||
example: t2.medium | ||
- name: provider | ||
level: extended | ||
type: keyword | ||
ignore_above: 1024 | ||
description: Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean. | ||
example: aws | ||
- name: region | ||
level: extended | ||
type: keyword | ||
ignore_above: 1024 | ||
description: Region in which this host is running. | ||
example: us-east-1 | ||
- name: project.id | ||
type: keyword | ||
description: Name of the project in Google Cloud. | ||
- name: image.id | ||
type: keyword | ||
description: Image ID for the cloud instance. | ||
- name: container | ||
title: Container | ||
group: 2 | ||
description: 'Container fields are used for meta information about the specific container that is the source of information. | ||
These fields help correlate data based containers from any runtime.' | ||
type: group | ||
fields: | ||
- name: id | ||
level: core | ||
type: keyword | ||
ignore_above: 1024 | ||
description: Unique container id. | ||
- name: image.name | ||
level: extended | ||
type: keyword | ||
ignore_above: 1024 | ||
description: Name of the image the container was built on. | ||
- name: labels | ||
level: extended | ||
type: object | ||
object_type: keyword | ||
description: Image labels. | ||
- name: name | ||
level: extended | ||
type: keyword | ||
ignore_above: 1024 | ||
description: Container name. | ||
- name: host | ||
title: Host | ||
group: 2 | ||
description: 'A host is defined as a general computing instance. | ||
ECS host.* fields should be populated with details about the host on which the event happened, or from which the measurement was taken. Host types include hardware, virtual machines, Docker containers, and Kubernetes nodes.' | ||
type: group | ||
fields: | ||
- name: architecture | ||
level: core | ||
type: keyword | ||
ignore_above: 1024 | ||
description: Operating system architecture. | ||
example: x86_64 | ||
- name: domain | ||
level: extended | ||
type: keyword | ||
ignore_above: 1024 | ||
description: 'Name of the domain of which the host is a member. | ||
For example, on Windows this could be the host''s Active Directory domain or NetBIOS domain name. For Linux this could be the domain of the host''s LDAP provider.' | ||
example: CONTOSO | ||
default_field: false | ||
- name: hostname | ||
level: core | ||
type: keyword | ||
ignore_above: 1024 | ||
description: 'Hostname of the host. | ||
It normally contains what the `hostname` command returns on the host machine.' | ||
- name: id | ||
level: core | ||
type: keyword | ||
ignore_above: 1024 | ||
description: 'Unique host id. | ||
As hostname is not always unique, use values that are meaningful in your environment. | ||
Example: The current usage of `beat.name`.' | ||
- name: ip | ||
level: core | ||
type: ip | ||
description: Host ip addresses. | ||
- name: mac | ||
level: core | ||
type: keyword | ||
ignore_above: 1024 | ||
description: Host mac addresses. | ||
- name: name | ||
level: core | ||
type: keyword | ||
ignore_above: 1024 | ||
description: 'Name of the host. | ||
It can contain what `hostname` returns on Unix systems, the fully qualified domain name, or a name specified by the user. The sender decides which value to use.' | ||
- name: os.family | ||
level: extended | ||
type: keyword | ||
ignore_above: 1024 | ||
description: OS family (such as redhat, debian, freebsd, windows). | ||
example: debian | ||
- name: os.kernel | ||
level: extended | ||
type: keyword | ||
ignore_above: 1024 | ||
description: Operating system kernel version as a raw string. | ||
example: 4.4.0-112-generic | ||
- name: os.name | ||
level: extended | ||
type: keyword | ||
ignore_above: 1024 | ||
multi_fields: | ||
- name: text | ||
type: text | ||
norms: false | ||
default_field: false | ||
description: Operating system name, without the version. | ||
example: Mac OS X | ||
- name: os.platform | ||
level: extended | ||
type: keyword | ||
ignore_above: 1024 | ||
description: Operating system platform (such centos, ubuntu, windows). | ||
example: darwin | ||
- name: os.version | ||
level: extended | ||
type: keyword | ||
ignore_above: 1024 | ||
description: Operating system version as a raw string. | ||
example: 10.14.1 | ||
- name: type | ||
level: core | ||
type: keyword | ||
ignore_above: 1024 | ||
description: 'Type of host. | ||
For Cloud providers this can be the machine type like `t2.medium`. If vm, this could be the container, for example, or other information meaningful in your environment.' | ||
- name: containerized | ||
type: boolean | ||
description: > | ||
If the host is a container. | ||
- name: os.build | ||
type: keyword | ||
example: "18D109" | ||
description: > | ||
OS build information. | ||
- name: os.codename | ||
type: keyword | ||
example: "stretch" | ||
description: > | ||
OS codename, if any. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
- name: data_stream.type | ||
type: constant_keyword | ||
description: Data stream type. | ||
- name: data_stream.dataset | ||
type: constant_keyword | ||
description: Data stream dataset. | ||
- name: data_stream.namespace | ||
type: constant_keyword | ||
description: Data stream namespace. | ||
- name: '@timestamp' | ||
type: date | ||
description: Event timestamp. | ||
- name: event.module | ||
type: constant_keyword | ||
description: Event module | ||
value: gcp | ||
- name: event.dataset | ||
type: constant_keyword | ||
description: Event dataset | ||
value: gcp.billing |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
- external: ecs | ||
name: cloud | ||
- external: ecs | ||
name: cloud.account.id | ||
- external: ecs | ||
name: cloud.account.name | ||
- external: ecs | ||
name: cloud.availability_zone | ||
- external: ecs | ||
name: cloud.instance.id | ||
- external: ecs | ||
name: cloud.machine.type | ||
- external: ecs | ||
name: cloud.provider | ||
- external: ecs | ||
name: cloud.region | ||
- external: ecs | ||
name: ecs.version | ||
- external: ecs | ||
name: error | ||
- external: ecs | ||
name: error.message | ||
- external: ecs | ||
name: service.type |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are there docs for this data stream? (if adding, it would be worth including a link to https://cloud.google.com/billing/docs/reports since there are a lot of details that help understand the documents).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added documentation in dc10062
Thank you for pointing this out!