-
Notifications
You must be signed in to change notification settings - Fork 456
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[GCP] Add firestore data_stream (#2704)
* gcp: stub logs and metrics doc files * [GCP] Add GCP Billing Metricset (#2141) * [GCP] Add GCP Compute Metricset (#2301) * [GCP] Add GCP Billing Metricset (#2141) * [GCP] Add GCP Compute Metricset (#2301) * Add firestore data_stream * Fix formatting issue * Add gcp tests env vars in Jenkinsfile * Add missing env fields * Update terraform deployer * Update system test * Fix credentials json field * Format & add period * Update docs * Update default period for firestoer * Update terraform deployer * Remove period from system test * Update manifest version * Update manifest file * Add default project id * Fix owner * Update audit docs * Fix terraform deployer * Remove redundant alternative host * Fix project variable * Remove default project string * Remove firestore datastream tests * Revert "Add gcp tests env vars in Jenkinsfile" This reverts commit ceea735. Co-authored-by: Edoardo Tenani <[email protected]> Co-authored-by: Alex Resnick <[email protected]>
- Loading branch information
1 parent
2511f40
commit aaab6bd
Showing
20 changed files
with
1,401 additions
and
1 deletion.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Audit | ||
|
||
Google Cloud services write audit logs that record administrative activities and accesses within your Google Cloud resources. | ||
More information on the type of data included in the audit logs can be found in the [documentation](https://cloud.google.com/logging/docs/audit) | ||
|
||
## Logs | ||
|
||
This is the `audit` dataset. | ||
|
||
{{event "audit"}} | ||
|
||
{{fields "audit"}} |
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,9 @@ | ||
# Billing | ||
|
||
## Metrics | ||
|
||
This is the `billing` dataset. | ||
|
||
{{event "billing"}} | ||
|
||
{{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,9 @@ | ||
# Firestore | ||
|
||
## Metrics | ||
|
||
This is the `firestore` dataset. | ||
|
||
{{event "firestore"}} | ||
|
||
{{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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Firewall | ||
|
||
Firewall Rules Logging lets you audit, verify, and analyze the effects of your firewall rules. | ||
More information on the type of data included in the firewall logs can be found in the [documentation](https://cloud.google.com/vpc/docs/firewall-rules-logging) | ||
|
||
## Logs | ||
|
||
This is the `firewall` dataset. | ||
|
||
{{event "firewall"}} | ||
|
||
{{fields "firewall"}} |
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,13 @@ | ||
# VPC Flow | ||
|
||
VPC Flow Logs records a sample of network flows sent from and received by VM instances, including instances used as GKE nodes. | ||
These logs can be used for network monitoring, forensics, real-time security analysis, and expense optimization. | ||
More information on the type of data included in the firewall logs can be found in the [documentation](https://cloud.google.com/vpc/docs/using-flow-logs) | ||
|
||
## Logs | ||
|
||
This is the `vpcflow` dataset. | ||
|
||
{{event "vpcflow"}} | ||
|
||
{{fields "vpcflow"}} |
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
16 changes: 16 additions & 0 deletions
16
packages/gcp/data_stream/firestore/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,16 @@ | ||
metricsets: ["firestore"] | ||
period: {{period}} | ||
project_id: {{project_id}} | ||
{{#if credentials_file}} | ||
credentials_file_path: {{credentials_file}} | ||
{{/if}} | ||
{{#if credentials_json}} | ||
credentials_json: '{{credentials_json}}' | ||
{{/if}} | ||
{{#if region}} | ||
region: {{region}} | ||
{{/if}} | ||
{{#if zone}} | ||
zone: {{zone}} | ||
{{/if}} | ||
exclude_labels: {{exclude_labels}} |
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 GCP Compute VM 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.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
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 |
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,13 @@ | ||
- name: gcp.firestore | ||
description: Google Cloud Firestore metrics | ||
type: group | ||
fields: | ||
- name: document.delete.count | ||
type: long | ||
description: The number of successful document deletes. | ||
- name: document.read.count | ||
type: long | ||
description: The number of successful document reads from queries or lookups. | ||
- name: document.write.count | ||
type: long | ||
description: The number of successful document writes. |
31 changes: 31 additions & 0 deletions
31
packages/gcp/data_stream/firestore/fields/package-fields.yml
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,31 @@ | ||
- name: gcp | ||
description: >- | ||
GCP module | ||
fields: | ||
- name: labels | ||
type: object | ||
description: >- | ||
GCP monitoring metrics labels | ||
fields: | ||
- name: user.* | ||
type: object | ||
object_type: keyword | ||
- name: metadata.* | ||
type: object | ||
object_type: keyword | ||
- name: metrics.* | ||
type: object | ||
object_type: keyword | ||
- name: system.* | ||
type: object | ||
object_type: keyword | ||
- name: resource.* | ||
type: object | ||
object_type: keyword | ||
- name: "metrics.*.*.*.*" | ||
type: object | ||
object_type: double | ||
object_type_mapping_type: "*" | ||
description: > | ||
Metrics that returned from Google Cloud API query. | ||
Oops, something went wrong.