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 storage data stream #3785

Merged
merged 16 commits into from
Aug 24, 2022
Merged
Show file tree
Hide file tree
Changes from 10 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
15 changes: 15 additions & 0 deletions packages/gcp/_dev/build/docs/storage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Storage

## Metrics

The `storage` dataset fetches metrics from [Storage](https://cloud.google.com/storage/) in Google Cloud Platform. It contains all metrics exported from the [GCP Storage Monitoring API](https://cloud.google.com/monitoring/api/metrics_gcp#gcp-storage).

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 "storage"}}

## Exported fields

{{fields "storage"}}
5 changes: 5 additions & 0 deletions packages/gcp/changelog.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# newer versions go on top
- version: "2.7.0"
changes:
- description: Add GCP Storage Data Stream
type: enhancement
link: https://github.com/elastic/integrations/pull/3785
- version: "2.5.0"
changes:
- description: Add GCP Load Balancing Metricset
Expand Down
16 changes: 16 additions & 0 deletions packages/gcp/data_stream/storage/agent/stream/stream.yml.hbs
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
metricsets: ["storage"]
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}}
198 changes: 198 additions & 0 deletions packages/gcp/data_stream/storage/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 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.

20 changes: 20 additions & 0 deletions packages/gcp/data_stream/storage/fields/base-fields.yml
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.storage
24 changes: 24 additions & 0 deletions packages/gcp/data_stream/storage/fields/ecs.yml
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
31 changes: 31 additions & 0 deletions packages/gcp/data_stream/storage/fields/fields.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
- name: gcp.storage
description: Google Cloud Storage metrics
type: group
fields:
- name: api.request.count
type: long
description: Delta count of API calls, grouped by the API method name and response code.
- name: authz.acl_based_object_access_.ount
tommyers-elastic marked this conversation as resolved.
Show resolved Hide resolved
type: long
description: Delta count of requests that result in an object being granted access solely due to object ACLs.
- name: authz.acl_operations.count
type: long
description: Usage of ACL operations broken down by type.
- name: authz.object_specific_acl_mutation.count
type: long
description: Delta count of changes made to object specific ACLs.
- name: network.received.bytes
type: long
description: Delta count of bytes received over the network, grouped by the API method name and response code.
- name: network.sent.bytes
type: long
description: Delta count of bytes sent over the network, grouped by the API method name and response code.
- name: storage.object.count
type: long
description: Total number of objects per bucket, grouped by storage class. This value is measured once per day, and the value is repeated at each sampling interval throughout the day.
- name: storage.total_byte_seconds.bytes
type: long
description: Delta count of bytes received over the network, grouped by the API method name and response code.
- name: storage.total.bytes
type: long
description: Total size of all objects in the bucket, grouped by storage class. This value is measured once per day, and the value is repeated at each sampling interval throughout the day.
31 changes: 31 additions & 0 deletions packages/gcp/data_stream/storage/fields/package-fields.yml
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.

31 changes: 31 additions & 0 deletions packages/gcp/data_stream/storage/manifest.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
title: "GCP Storage Metrics"
type: metrics
streams:
- input: gcp/metrics
title: GCP Storage Metrics
description: Collect GCP Storage Metrics
vars:
- name: zone
type: text
title: GCP Zone
multi: false
required: false
show_user: true
- name: region
type: text
title: GCP Region
multi: false
required: false
show_user: true
- name: period
type: text
title: Period
default: 60s
required: true
- name: exclude_labels
type: bool
title: Exclude Labels
description: Exclude additional labels from metrics
multi: false
required: false
show_user: true
Loading