Google Cloud Platform (GCP) GKE metrics
Collect gke metrics from Google Cloud Platform (GCP) with Elastic Agent
What is an Elastic integration?
This integration is powered by Elastic Agent. Elastic Agent is a single, unified way to add monitoring for logs, metrics, and other types of data to a host. It can also protect hosts from security threats, query data from operating systems, forward data from remote services or hardware, and more. Refer to our documentation for a detailed comparison between Beats and Elastic Agent.
Prefer to use Beats for this use case? See Filebeat modules for logs or Metricbeat modules for metrics.
See the integrations quick start guides to get started:
Metrics
The gke
dataset fetches metrics from GKE in Google Cloud Platform. It contains all GA metrics exported from the GCP GKE Monitoring API.
You can specify a single region to fetch metrics like us-central1
. Be aware that GCP GKE does not use zones so us-central1-a
will return nothing. If no region is specified, it will return metrics from all regions.
Sample Event
An example event for gke
looks as following:
{
"@timestamp": "2017-10-12T08:05:34.853Z",
"cloud": {
"account": {
"id": "elastic-obs-integrations-dev",
"name": "elastic-obs-integrations-dev"
},
"instance": {
"id": "4751091017865185079",
"name": "gke-cluster-1-default-pool-6617a8aa-5clh"
},
"machine": {
"type": "e2-medium"
},
"provider": "gcp",
"availability_zone": "us-central1-c",
"region": "us-central1"
},
"event": {
"dataset": "gcp.gke",
"duration": 115000,
"module": "gcp"
},
"gcp": {
"gke": {
"container": {
"cpu": {
"core_usage_time": {
"sec": 15
}
}
}
},
"labels": {
"user": {
"goog-gke-node": ""
}
}
},
"host": {
"id": "4751091017865185079",
"name": "gke-cluster-1-default-pool-6617a8aa-5clh"
},
"metricset": {
"name": "gke",
"period": 10000
},
"service": {
"type": "gcp"
}
}
Exported fields
Exported fields
Field | Description | Type | Metric Type |
---|---|---|---|
@timestamp | Event timestamp. | date | |
cloud | Fields related to the cloud or infrastructure the events are coming from. | group | |
cloud.account.id | 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. | keyword | |
cloud.account.name | The cloud account name or alias used to identify different entities in a multi-tenant environment. Examples: AWS account name, Google Cloud ORG display name. | keyword | |
cloud.availability_zone | Availability zone in which this host, resource, or service is located. | keyword | |
cloud.image.id | Image ID for the cloud instance. | keyword | |
cloud.instance.id | Instance ID of the host machine. | keyword | |
cloud.instance.name | Instance name of the host machine. | keyword | |
cloud.machine.type | Machine type of the host machine. | keyword | |
cloud.project.id | Name of the project in Google Cloud. | keyword | |
cloud.provider | Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean. | keyword | |
cloud.region | Region in which this host, resource, or service is located. | keyword | |
container.id | Unique container id. | keyword | |
container.image.name | Name of the image the container was built on. | keyword | |
container.labels | Image labels. | object | |
container.name | Container name. | keyword | |
data_stream.dataset | Data stream dataset. | constant_keyword | |
data_stream.namespace | Data stream namespace. | constant_keyword | |
data_stream.type | Data stream type. | constant_keyword | |
ecs.version | ECS version this event conforms to. ecs.version is a required field and must exist in all events. When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events. | keyword | |
error | These fields can represent errors of any kind. Use them for errors that happen while fetching events or in cases where the event itself contains an error. | group | |
error.message | Error message. | match_only_text | |
event.dataset | Event dataset | constant_keyword | |
event.module | Event module | constant_keyword | |
gcp.gke.container.cpu.core_usage_time.sec | Cumulative CPU usage on all cores used by the container in seconds. Sampled every 60 seconds. | double | counter |
gcp.gke.container.cpu.limit_cores.value | CPU cores limit of the container. Sampled every 60 seconds. | double | gauge |
gcp.gke.container.cpu.limit_utilization.pct | The fraction of the CPU limit that is currently in use on the instance. This value cannot exceed 1 as usage cannot exceed the limit. Sampled every 60 seconds. After sampling, data is not visible for up to 240 seconds. | double | gauge |
gcp.gke.container.cpu.request_cores.value | Number of CPU cores requested by the container. Sampled every 60 seconds. After sampling, data is not visible for up to 120 seconds. | double | gauge |
gcp.gke.container.cpu.request_utilization.pct | The fraction of the requested CPU that is currently in use on the instance. This value can be greater than 1 as usage can exceed the request. Sampled every 60 seconds. After sampling, data is not visible for up to 240 seconds. | double | gauge |
gcp.gke.container.ephemeral_storage.limit.bytes | Local ephemeral storage limit in bytes. Sampled every 60 seconds. | long | gauge |
gcp.gke.container.ephemeral_storage.request.bytes | Local ephemeral storage request in bytes. Sampled every 60 seconds. | long | gauge |
gcp.gke.container.ephemeral_storage.used.bytes | Local ephemeral storage usage in bytes. Sampled every 60 seconds. | long | gauge |
gcp.gke.container.memory.limit.bytes | Memory limit of the container in bytes. Sampled every 60 seconds. | long | gauge |
gcp.gke.container.memory.limit_utilization.pct | The fraction of the memory limit that is currently in use on the instance. This value cannot exceed 1 as usage cannot exceed the limit. Sampled every 60 seconds. After sampling, data is not visible for up to 120 seconds. | double | gauge |
gcp.gke.container.memory.page_fault.count | Number of page faults, broken down by type, major and minor. | long | counter |
gcp.gke.container.memory.request.bytes | Memory request of the container in bytes. Sampled every 60 seconds. After sampling, data is not visible for up to 120 seconds. | long | gauge |
gcp.gke.container.memory.request_utilization.pct | The fraction of the requested memory that is currently in use on the instance. This value can be greater than 1 as usage can exceed the request. Sampled every 60 seconds. After sampling, data is not visible for up to 240 seconds. | double | gauge |
gcp.gke.container.memory.used.bytes | Memory usage in bytes. Sampled every 60 seconds. | long | gauge |
gcp.gke.container.restart.count | Number of times the container has restarted. Sampled every 60 seconds. After sampling, data is not visible for up to 120 seconds. | long | counter |
gcp.gke.container.uptime.sec | Time in seconds that the container has been running. Sampled every 60 seconds. | double | gauge |
gcp.gke.node.cpu.allocatable_cores.value | Number of allocatable CPU cores on the node. Sampled every 60 seconds. | double | gauge |
gcp.gke.node.cpu.allocatable_utilization.pct | The fraction of the allocatable CPU that is currently in use on the instance. Sampled every 60 seconds. After sampling, data is not visible for up to 240 seconds. | double | gauge |
gcp.gke.node.cpu.core_usage_time.sec | Cumulative CPU usage on all cores used on the node in seconds. Sampled every 60 seconds. | double | counter |
gcp.gke.node.cpu.total_cores.value | Total number of CPU cores on the node. Sampled every 60 seconds. | double | gauge |
gcp.gke.node.ephemeral_storage.allocatable.bytes | Local ephemeral storage bytes allocatable on the node. Sampled every 60 seconds. | long | gauge |
gcp.gke.node.ephemeral_storage.inodes_free.value | Free number of inodes on local ephemeral storage. Sampled every 60 seconds. | long | gauge |
gcp.gke.node.ephemeral_storage.inodes_total.value | Total number of inodes on local ephemeral storage. Sampled every 60 seconds. | long | gauge |
gcp.gke.node.ephemeral_storage.total.bytes | Total ephemeral storage bytes on the node. Sampled every 60 seconds. | long | gauge |
gcp.gke.node.ephemeral_storage.used.bytes | Local ephemeral storage bytes used by the node. Sampled every 60 seconds. | long | gauge |
gcp.gke.node.memory.allocatable.bytes | Cumulative memory bytes used by the node. Sampled every 60 seconds. | long | gauge |
gcp.gke.node.memory.allocatable_utilization.pct | The fraction of the allocatable memory that is currently in use on the instance. This value cannot exceed 1 as usage cannot exceed allocatable memory bytes. Sampled every 60 seconds. After sampling, data is not visible for up to 120 seconds. | double | gauge |
gcp.gke.node.memory.total.bytes | Number of bytes of memory allocatable on the node. Sampled every 60 seconds. | long | gauge |
gcp.gke.node.memory.used.bytes | Cumulative memory bytes used by the node. Sampled every 60 seconds. | long | gauge |
gcp.gke.node.network.received_bytes.count | Cumulative number of bytes received by the node over the network. Sampled every 60 seconds. | long | counter |
gcp.gke.node.network.sent_bytes.count | Cumulative number of bytes transmitted by the node over the network. Sampled every 60 seconds. | long | counter |
gcp.gke.node.pid_limit.value | The max PID of OS on the node. Sampled every 60 seconds. | long | gauge |
gcp.gke.node.pid_used.value | The number of running process in the OS on the node. Sampled every 60 seconds. | long | gauge |
gcp.gke.node_daemon.cpu.core_usage_time.sec | Cumulative CPU usage on all cores used by the node level system daemon in seconds. Sampled every 60 seconds. | double | counter |
gcp.gke.node_daemon.memory.used.bytes | Memory usage by the system daemon in bytes. Sampled every 60 seconds. | long | gauge |
gcp.gke.pod.network.received.bytes | Cumulative number of bytes received by the pod over the network. Sampled every 60 seconds. | long | counter |
gcp.gke.pod.network.sent.bytes | Cumulative number of bytes transmitted by the pod over the network. Sampled every 60 seconds. | long | counter |
gcp.gke.pod.volume.total.bytes | Total number of disk bytes available to the pod. Sampled every 60 seconds. After sampling, data is not visible for up to 120 seconds. | long | gauge |
gcp.gke.pod.volume.used.bytes | Number of disk bytes used by the pod. Sampled every 60 seconds. | long | gauge |
gcp.gke.pod.volume.utilization.pct | The fraction of the volume that is currently being used by the instance. This value cannot be greater than 1 as usage cannot exceed the total available volume space. Sampled every 60 seconds. After sampling, data is not visible for up to 120 seconds. | double | gauge |
gcp.labels.metadata.* | object | ||
gcp.labels.metrics.* | object | ||
gcp.labels.resource.* | object | ||
gcp.labels.system.* | object | ||
gcp.labels.user.* | object | ||
gcp.metrics.*.*.*.* | Metrics that returned from Google Cloud API query. | object | |
host.architecture | Operating system architecture. | keyword | |
host.containerized | If the host is a container. | boolean | |
host.domain | 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. | keyword | |
host.hostname | Hostname of the host. It normally contains what the hostname command returns on the host machine. | keyword | |
host.id | Unique host id. As hostname is not always unique, use values that are meaningful in your environment. Example: The current usage of beat.name . | keyword | |
host.ip | Host ip addresses. | ip | |
host.mac | Host mac addresses. | keyword | |
host.name | 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. | keyword | |
host.os.build | OS build information. | keyword | |
host.os.codename | OS codename, if any. | keyword | |
host.os.family | OS family (such as redhat, debian, freebsd, windows). | keyword | |
host.os.kernel | Operating system kernel version as a raw string. | keyword | |
host.os.name | Operating system name, without the version. | keyword | |
host.os.name.text | Multi-field of host.os.name . | text | |
host.os.platform | Operating system platform (such centos, ubuntu, windows). | keyword | |
host.os.version | Operating system version as a raw string. | keyword | |
host.type | 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. | keyword | |
service.type | The type of the service data is collected from. The type can be used to group and correlate logs and metrics from one service type. Example: If logs or metrics are collected from Elasticsearch, service.type would be elasticsearch . | keyword |
Changelog
Version | Details |
---|---|
2.30.1 | Bug fix View pull request Fix mappings of group fields |
2.30.0 | Enhancement View pull request Add tags.yml file so that integration's dashboards and saved searches are tagged with "Security Solution" and displayed in the Security Solution UI. Enhancement View pull request Upgrade package spec to 3.0.0. Bug fix View pull request Fix orphan dashboard references. Bug fix View pull request Add missing dashboard filters. |
2.29.1 | Bug fix View pull request Add null checks and ignore_missing checks to the rename processor |
2.29.0 | Bug fix View pull request Remove GCP CloudSQL deprecated, alpha or beta metrics and fix field types. |
2.28.5 | Enhancement View pull request Set metric type for GKE, Load Balancing, PubSub, Redis and Storage data streams. |
2.28.4 | Enhancement View pull request Migrate GCP Load Balancing HTTPS Overview dashboard to lens. |
2.28.3 | Enhancement View pull request Set metric type for Cloud Run, Compute, Dataproc and Firestore data streams. |
2.28.2 | Enhancement View pull request Migrate GCP Load Balancing TCP SSL Proxy Overview dashboard to lens. |
2.28.1 | Enhancement View pull request Set metric type for CloudSQL data streams. |
2.28.0 | Enhancement View pull request Migrate GCP Load Balancing L3 Overview dashboard to lens. |
2.27.0 | Enhancement View pull request Add GCP CloudSQL MySQL, SQL Server and PostgreSQL dashboards. |
2.26.0 | Bug fix View pull request Fix GCP loadbalancing_metrics fields prefix. |
2.25.1 | Bug fix View pull request Fix check on gcp.audit.authorization_info[].granted. |
2.25.0 | Enhancement View pull request Migrate GCP Billing input control to new control panel. |
2.24.0 | Enhancement View pull request Add GCP CloudSQL MySQL, Postgres, SQLServer data streams |
2.23.0 | Enhancement View pull request Convert security dashboards to lens. |
2.22.1 | Enhancement View pull request Change ownership in manifest. |
2.22.0 | Enhancement View pull request Ensure event.kind is correctly set for pipeline errors. |
2.21.0 | Enhancement View pull request Update package to ECS 8.8.0. |
2.20.1 | Bug fix View pull request Fix invalid TSDS metric type for persistence.rdb.bgsave_in_progress field |
2.20.0 | Enhancement View pull request Update package to ECS 8.7.0. |
2.19.1 | Enhancement View pull request Migrate compute dashboard to lens and add datastream filter. |
2.19.0 | Enhancement View pull request Add Cloud Run metrics datastream. |
2.18.0 | Enhancement View pull request Support subscription_num_goroutines and subscription_max_outstanding_messages for GCP PubSub input |
2.17.2 | Bug fix View pull request Fix IP Convert processor in Audit ingest pipeline. |
2.17.1 | Enhancement View pull request Added categories and/or subcategories. |
2.17.0 | Enhancement View pull request Add Audit Log Overview dashboard Enhancement View pull request Add GKE Overview dashboard Enhancement View pull request Add PubSub Overview dashboard Enhancement View pull request Add Storage Overview dashboard |
2.16.2 | Bug fix View pull request Add logic to handle scalar request.policy values on audit |
2.16.1 | Bug fix View pull request Replace missing input control panel with new-style control. |
2.16.0 | Enhancement View pull request Update package to ECS 8.6.0. |
2.15.2 | Enhancement View pull request Update documentation. |
2.15.1 | Enhancement View pull request Add GCP Compute pipeline test. |
2.15.0 | Enhancement View pull request Remove support for Kibana 7.17.x Enhancement View pull request Support multiple regions for metrics data streams |
2.14.0 | Enhancement View pull request Update package to ECS 8.5.0. |
2.13.0 | Enhancement View pull request Migrate dashboard by values |
2.12.1 | Bug fix View pull request Remove duplicate fields. |
2.12.0 | Enhancement View pull request Add GCP Redis |
2.11.12 | Bug fix View pull request Add GKE ingest pipeline. |
2.11.11 | Bug fix View pull request Fix type of dns.answers.ttl. |
2.11.10 | Enhancement View pull request Add ingest pipeline for dataproc. Enhancement View pull request Add GCP loadbalancing ingest pipeline Enhancement View pull request Add GCP PubSub ingest pipeline Enhancement View pull request Add GCP Storage ingest pipeline Enhancement View pull request Add GCP Firestore ingest pipeline Enhancement View pull request Add GCP Compute ingest pipeline |
2.11.10-beta.6 | Enhancement View pull request Add ingest pipeline for dataproc. |
2.11.10-beta.5 | Enhancement View pull request Add GCP loadbalancing ingest pipeline |
2.11.10-beta.4 | Enhancement View pull request Add GCP PubSub ingest pipeline |
2.11.10-beta.3 | Enhancement View pull request Add GCP Storage ingest pipeline |
2.11.10-beta.2 | Enhancement View pull request Add GCP Firestore ingest pipeline |
2.11.10-beta.1 | Enhancement View pull request Add GCP Compute ingest pipeline |
2.11.9 | Bug fix View pull request Fix GKE kubernetes.io indentation. |
2.11.8 | Enhancement View pull request Remove duplicate fields. |
2.11.7 | Enhancement View pull request Move Dataproc lightweight module config into integration |
2.11.6 | Enhancement View pull request Move LoadBalancing lightweight module config into integration |
2.11.5 | Enhancement View pull request Move Storage lightweight module config into integration |
2.11.4 | Enhancement View pull request Move PubSub lightweight module config into integration |
2.11.3 | Enhancement View pull request Move GKE lightweight module config into integration |
2.11.2 | Enhancement View pull request Move Firestore lightweight module config into integration |
2.11.1 | Enhancement View pull request Use ECS geo.location definition. |
2.11.0 | Enhancement View pull request Move Compute lightweight module config into integration |
2.10.0 | Enhancement View pull request Add GCP PubSub Data stream |
2.9.0 | Enhancement View pull request Add GCP Dataproc Data stream |
2.8.0 | Enhancement View pull request Add GCP GKE Data Stream |
2.7.0 | Enhancement View pull request Add GCP Storage Data Stream |
2.6.0 | Enhancement View pull request Add Load Balancing logs datastream |
2.5.0 | Enhancement View pull request Add GCP Load Balancing Metricset Bug fix View pull request Fix credentials_json escaping in loadbalancing_metrics Bug fix View pull request Update loadbalancing_metrics default period to 60s Bug fix View pull request Fix event.dataset for loadbalancing_metrics Enhancement View pull request Add loadbalancing_metrics distribution fields |
2.4.0 | Enhancement View pull request Update package to ECS 8.4.0 |
2.3.0 | Enhancement View pull request Add additional parsing for DNS Public Zone Query Logs |
2.2.1 | Enhancement View pull request Fix Billing policy template title and default period for gcp.compute |
2.2.0 | Enhancement View pull request Remove fields duplicated in ECS fields |
2.1.0 | Enhancement View pull request restore compatibility with 7.17 release track |
2.0.0 | Breaking change View pull request Move configurations to support metrics. This change is breaking, as it moves |
some configuration from the top level variables to data stream variables. |
This change involves project_id
, credentials_file
and credentials_json
variables that are moved from input level configuration to package level
configuration (as those variables are reused across all inputs/data streams).
Users with GCP integration enabled will need to input values for these
variables again when upgrading the policies to this version.
Enhancement View pull request
Add GCP Billing Data Stream
Enhancement View pull request
Add GCP Compute Data Stream
Enhancement View pull request
Add GCP Firestore Data stream |
| 1.10.0 | Enhancement View pull request
Update package to ECS 8.3.0. |
| 1.9.2 | Bug fix View pull request
Fix GCP auditlog parsing issue on response status |
| 1.9.1 | Enhancement View pull request
Update readme |
| 1.9.0 | Enhancement View pull request
Preserve request and response in flattened fields. |
| 1.8.0 | Enhancement View pull request
Add missing cloud.provider
field. |
| 1.7.0 | Enhancement View pull request
Add dashboards for firewall and vpc flow logs.
Bug fix View pull request
Add missing mappings for several event.*
fields. |
| 1.6.1 | Enhancement View pull request
Clarify the GCP privileges required by the Pub/Sub input. |
| 1.6.0 | Enhancement View pull request
Update to ECS 8.2 |
| 1.5.1 | Enhancement View pull request
Add documentation for multi-fields |
| 1.5.0 | Enhancement View pull request
Improve Google Cloud Platform docs. |
| 1.4.2 | Bug fix View pull request
Remove emtpy values, names with only dots, and invalid client IPs. |
| 1.4.1 | Bug fix View pull request
Fix quoting of the credentials_json value in policy templates. |
| 1.4.0 | Enhancement View pull request
Add gcp.dns integration |
| 1.3.1 | Bug fix View pull request
Add Ingest Pipeline script to map IANA Protocol Numbers |
| 1.3.0 | Enhancement View pull request
Update to ECS 8.0 |
| 1.2.2 | Bug fix View pull request
Regenerate test files using the new GeoIP database |
| 1.2.1 | Bug fix View pull request
Change test public IPs to the supported subset |
| 1.2.0 | Enhancement View pull request
Add 8.0.0 version constraint |
| 1.1.2 | Enhancement View pull request
Update Title and Description. |
| 1.1.1 | Bug fix View pull request
Fix logic that checks for the 'forwarded' tag |
| 1.1.0 | Enhancement View pull request
Update to ECS 1.12.0 |
| 1.0.0 | Enhancement View pull request
Move from experimental to GA
Enhancement View pull request
remove experimental from data_sets |
| 0.3.3 | Enhancement View pull request
Convert to generated ECS fields |
| 0.3.2 | Enhancement View pull request
update to ECS 1.11.0 |
| 0.3.1 | Enhancement View pull request
Escape special characters in docs |
| 0.3.0 | Enhancement View pull request
Update integration description |
| 0.2.0 | Enhancement View pull request
Set "event.module" and "event.dataset" |
| 0.1.0 | Enhancement View pull request
update to ECS 1.10.0 and adding event.original options |
| 0.0.2 | Enhancement View pull request
update to ECS 1.9.0 |
| 0.0.1 | Enhancement View pull request
initial release |