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.

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] Add GCP PubSub metricset #2309

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
52 changes: 22 additions & 30 deletions packages/gcp/_dev/build/docs/README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,22 @@
# Google Cloud Integration

The Google Cloud integration collects and parses Google Cloud audit, VPC flow,
and firewall logs that have been exported from Stackdriver to a Google Pub/Sub topic sink.

## Logs

### Audit

This is the `audit` dataset.

{{event "audit"}}

{{fields "audit"}}

### Firewall

This is the `firewall` dataset.

{{event "firewall"}}

{{fields "firewall"}}

### VPC Flow

This is the `VPC Flow` dataset.

{{event "vpcflow"}}

{{fields "vpcflow"}}
# Google Cloud Platform Integration

This integration is used to fetches logs and metrics from
[Google Cloud Platform](https://cloud.google.com/).

## GCP Credentials
GCP credentials are required for running GCP integration.

### Configuration parameters
* *project_id*: ID of the GCP project.
* *credentials_file*: Path to JSON file with GCP credentials. Required when not using `credentials_json`.
* *credentials_json*: Raw JSON text of GCP Credentials. Required when not using `credentials_file`.

#### Data stream specific configuration parameters
* *period*: How often the data stream is executed.
* *region*: Specify which GCP regions to query metrics from. If the `region`
is not set in the config, then by default, the integration will query metrics
from all available GCP regions. If both `region` and `zone` is set, `region` takes precedent.
* *zone*: Specify which GCP zones to query metrics from. If the `zone`
is not set in the config, then by default, the integration will query metrics
from all available GCP zone. If both `region` and `zone` is set, `region` takes precedent.
* *exclude_labels*: Exclude additional labels from metrics. Defaults to false.
12 changes: 12 additions & 0 deletions packages/gcp/_dev/build/docs/audit.md
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"}}
9 changes: 9 additions & 0 deletions packages/gcp/_dev/build/docs/billing.md
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"}}
9 changes: 9 additions & 0 deletions packages/gcp/_dev/build/docs/compute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Compute

## Metrics

This is the `compute` dataset.

{{event "compute"}}

{{fields "compute"}}
12 changes: 12 additions & 0 deletions packages/gcp/_dev/build/docs/firewall.md
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"}}
9 changes: 9 additions & 0 deletions packages/gcp/_dev/build/docs/pubsub.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Pub Sub

## Metrics

This is the `pubsub` dataset.

{{event "pubsub"}}

{{fields "pubsub"}}
13 changes: 13 additions & 0 deletions packages/gcp/_dev/build/docs/vpcflow.md
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"}}
11 changes: 11 additions & 0 deletions packages/gcp/changelog.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
# newer versions go on top
- version: "1.2.0"
changes:
- description: Add GCP Billing Metricset
type: enhancement
link: https://github.com/elastic/integrations/pull/2141
- description: Add GCP Compute Metricset
type: enhancement
link: https://github.com/elastic/integrations/pull/2301
- description: Add GCP PubSub Metricset
type: enhancement
link: https://github.com/elastic/integrations/pull/2309
- version: "1.1.2"
changes:
- description: Update Title and Description.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
service: gcppubsub-emulator
input: gcp-pubsub
vars:
alternative_host: "{{Hostname}}:{{Port}}"
credentials_json: '{\"fake\":\"creds\"}'
project_id: audit
data_stream:
vars:
subscription_name: subscription
topic: topic
alternative_host: "{{Hostname}}:{{Port}}"
7 changes: 7 additions & 0 deletions packages/gcp/data_stream/audit/manifest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ streams:
required: true
show_user: false
default: false
- name: alternative_host
type: text
title: Alternative host
multi: false
required: false
show_user: false
description: "GCP Alternative host"
- name: tags
type: text
title: Tags
Expand Down
12 changes: 12 additions & 0 deletions packages/gcp/data_stream/billing/agent/stream/stream.yml.hbs
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: {{credentials_file}}
{{/if}}
{{#if credentials_json}}
credentials_json: {{credentials_json}}
{{/if}}
dataset_id: {{dataset_id}}
table_pattern: {{table_pattern}}
cost_type: {{cost_type}}
198 changes: 198 additions & 0 deletions packages/gcp/data_stream/billing/fields/agent.yml
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.

Loading