You are viewing docs on Elastic's new documentation system, currently in technical preview. For all other Elastic docs, visit elastic.co/guide.
Last updated: Mar 20th, 2023

Google Cloud Platform (GCP) Redis metrics

Collect Redis 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.

Metrics

The redis dataset fetches metrics from GCP Memorystore for Redis in Google Cloud Platform. It contains all metrics exported from the GCP Redis Monitoring API.

Sample Event

An example event for redis 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.redis",
        "duration": 115000,
        "module": "gcp"
    },
    "gcp": {
        "redis": {
            "clients": {
                "blocked": {
                    "count": 4
                }
            }
        },
        "labels": {
            "user": {
                "goog-gke-node": ""
            }
        }
    },
    "host": {
        "id": "4751091017865185079",
        "name": "gke-cluster-1-default-pool-6617a8aa-5clh"
    },
    "metricset": {
        "name": "metrics",
        "period": 10000
    },
    "service": {
        "type": "gcp"
    }
}

Exported fields

Exported fields

FieldDescriptionTypeUnitMetric 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.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
gcp.redis.clients.blocked.count
Number of blocked clients.
long
gauge
gcp.redis.clients.connected.count
Number of client connections.
long
gauge
gcp.redis.commands.calls.count
Total number of calls for this command in one minute.
long
counter
gcp.redis.commands.total_time.us
The amount of time in microseconds that this command took in the last second.
long
micros
counter
gcp.redis.commands.usec_per_call.sec
Average time per call over 1 minute by command.
double
s
gauge
gcp.redis.keyspace.avg_ttl.sec
Average TTL for keys in this database.
double
s
gauge
gcp.redis.keyspace.keys.count
Number of keys stored in this database.
long
gauge
gcp.redis.keyspace.keys_with_expiration.count
Number of keys with an expiration in this database.
long
gauge
gcp.redis.persistence.rdb.bgsave_in_progress
Flag indicating a RDB save is on-going.
boolean
gauge
gcp.redis.replication.master.slaves.lag.sec
The number of seconds that replica is lagging behind primary.
long
s
gauge
gcp.redis.replication.master.slaves.offset.bytes
The number of bytes that have been acknowledged by replicas.
long
byte
gauge
gcp.redis.replication.master_repl_offset.bytes
The number of bytes that master has produced and sent to replicas.
long
byte
gauge
gcp.redis.replication.offset_diff.bytes
The largest number of bytes that have not been replicated across all replicas. This is the biggest difference between replication byte offset (master) and replication byte offset (replica) of all replicas.
long
byte
gauge
gcp.redis.replication.role
Returns a value indicating the node role. 1 indicates primary and 0 indicates replica.
long
gauge
gcp.redis.server.uptime.sec
Uptime in seconds.
long
s
gauge
gcp.redis.stats.cache_hit_ratio
Cache Hit ratio as a fraction.
double
gauge
gcp.redis.stats.connections.total.count
Total number of connections accepted by the server.
long
counter
gcp.redis.stats.cpu_utilization.sec
CPU-seconds consumed by the Redis server, broken down by system/user space and parent/child relationship.
double
s
gauge
gcp.redis.stats.evicted_keys.count
Number of evicted keys due to maxmemory limit.
long
counter
gcp.redis.stats.expired_keys.count
Total number of key expiration events.
long
counter
gcp.redis.stats.keyspace_hits.count
Number of successful lookup of keys in the main dictionary.
long
counter
gcp.redis.stats.keyspace_misses.count
Number of failed lookup of keys in the main dictionary.
long
counter
gcp.redis.stats.memory.maxmemory.mb
Maximum amount of memory Redis can consume.
long
m
gauge
gcp.redis.stats.memory.system_memory_overload_duration.us
The amount of time in microseconds the instance is in system memory overload mode.
long
micros
gauge
gcp.redis.stats.memory.system_memory_usage_ratio
Memory usage as a ratio of maximum system memory.
double
gauge
gcp.redis.stats.memory.usage.bytes
Total number of bytes allocated by Redis.
long
byte
gauge
gcp.redis.stats.memory.usage_ratio
Memory usage as a ratio of maximum memory.
double
gauge
gcp.redis.stats.network_traffic.bytes
Total number of bytes sent to/from redis (includes bytes from commands themselves, payload data, and delimiters).
long
byte
counter
gcp.redis.stats.pubsub.channels.count
Global number of pub/sub channels with client subscriptions.
long
gauge
gcp.redis.stats.pubsub.patterns.count
Global number of pub/sub pattern with client subscriptions.
long
gauge
gcp.redis.stats.reject_connections.count
Number of connections rejected because of maxclients limit.
long
gauge
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