Bindplane

The Bindplane Developer Hub

Welcome to the Bindplane developer hub. You'll find comprehensive guides and documentation to help you start working with Bindplane as quickly as possible, as well as support if you get stuck. Let's jump right in!

Amazon ElastiCache

Least Privileged User

Navigate to the AWS console and create an IAM user with programmatic access. The user will need the following permissions. You can create a policy specifically for these permissions and apply the permissions to the user.

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "VisualEditor0",
      "Effect": "Allow",
      "Action": [
        "elasticache:DescribeCacheEngineVersions",
        "elasticache:DescribeCacheSubnetGroups",
        "elasticache:DescribeCacheParameters",
        "elasticache:DescribeCacheParameterGroups",
        "elasticache:DescribeCacheClusters",
        "cloudwatch:GetMetricStatistics",
        "cloudwatch:ListMetrics"
      ],
      "Resource": "*"
    }
  ]
}

Connection Parameters

Name
Required?
Description

Region

Access Key ID

Required

Secret Access Key

Required

Additional Threads

The number of additional threads allowed to be utilized during collection.

Request Timeout (seconds)

The number of seconds to allow for the API to return a response.

Collect CloudWatch Metrics

CloudWatch Historic Mode

If enabled, retrieves a history of data points from CloudWatch. Otherwise, collects only the most recent data point for each metric.

Metrics

Cache Cluster

Name
Description

Cache Hit Rate (%)

The percent of successful key lookups.

Cache Hits

The number of successful key lookups.

Cache Misses

The number of unsuccessful key lookups.

Cache Node Type

The name of the compute and memory capacity node type for the cluster.

CAS Bad Values (Requests)

The number of CAS (check and set) requests the cache has received where the CAS value did not match the CAS value stored.

CAS Hit Rate (%)

The percent of CAS requests the cache has received where the requested key was found and the CAS value matched.

CAS Hits (Requests)

The number of CAS requests the cache has received where the requested key was found and the CAS value matched.

CAS Misses (Requests)

The number of CAS requests the cache has received where the key requested was not found.

Command Configuration Gets (Requests)

The cumulative number of config get requests.

Command Configuration Sets (Requests)

The cumulative number of config set requests.

Command Flushes

The number of flush commands the cache has received.

Command Gets

The number of get commands the cache has received.

Command Sets

The number of set commands the cache has received.

Command Touches (Requests)

The cumulative number of touch requests.

CPU Utilization (%)

The CPU utilization.

Current Configuration

The current number of configurations stored.

Current Connections (Connections)

A count of the number of connections connected to the cache at an instant in time. ElastiCache uses two to three of the connections to monitor the cluster in each case.

Current Items

A count of the number of items currently stored in the cache.

Decrement Hit Rate (%)

The percent of decrement requests the cache has received where the requested key was found.

Decrement Hits (Requests)

The number of decrement requests the cache has received where the requested key was found.

Decrement Misses (Requests)

The number of decrement requests the cache has received where the requested key was not found.

Delete Hit Rate (%)

The percent of delete requests the cache has received where the requested key was found.

Delete Hits (Requests)

The number of delete requests the cache has received where the requested key was found.

Delete Misses (Requests)

The number of delete requests the cache has received where the requested key was not found.

Engine

The name of the cache engine (memcached or redis) to be used for this cluster.

Engine Version

The version of the cache engine that is used in this cluster.

Evicted Items

The number of non-expired items the cache evicted to allow space for new writes.

Evicted Unfetched Items

The number of valid items evicted from the least recently used cache (LRU) which were never touched after being set.

Expired Unfetched Items

The number of expired items reclaimed from the LRU which were never touched after being set.

Freeable Memory (Bytes)

The amount of free memory available on the host.

Get Hit Rate (%)

The percent of get requests the cache has received where the key requested was found.

Get Hits (Requests)

The number of get requests the cache has received where the key requested was found.

Get Misses (Requests)

The number of get requests the cache has received where the key requested was not found.

Get Type Commands

The total number of get types of commands. This is derived from the Redis commandstats statistic by summing all of the get types of commands (get, mget, hget, etc.)

Hash Based Commands

The total number of commands that are hash-based. This is derived from the Redis commandstats statistic by summing all of the commands that act upon one or more hashes.

ID

The user-supplied identifier of the cluster.

Increment Hit Rate (%)

The percent of increment requests the cache has received where the key requested was found.

Increment Hits (Requests)

The number of increment requests the cache has received where the key requested was found.

Increment Misses (Requests)

The number of increment requests the cache has received where the key requested was not found.

Key Based Commands

The total number of commands that are key-based. This is derived from the Redis commandstats statistic by summing all of the commands that act upon one or more keys.

List Based Commands

The total number of commands that are list-based. This is derived from the Redis commandstats statistic by summing all of the commands that act upon one or more lists.

Memcached Data Read (Bytes)

The amount of data that has been read from the network by the cache nodes in the cluster.

Memcached Data Written (Bytes)

The amount of space that has been written to the network by the cache nodes in the cluster.

Network In (Bytes)

The amount of data the host has read from the network.

Network Out (Bytes)

The amount of data the host has written to the network.

New Connections (Connections)

The number of new connections the cache has received. This is derived from the memcached total_connections statistic by recording the change in total_connections across a period of time. This will always be at least 1, due to a connection reserved for a ElastiCache.

New Items

The number of new items the cache has stored. This is derived from the memcached total_items statistic by recording the change in total_items across a period of time.

Number of Cache Nodes

The number of cache nodes in the cluster.

Reclaimed items

The number of expired items the cache evicted to allow space for new writes.

Region

The AWS Region this object belongs to.

Replication Data (Bytes)

For primaries with attached replicas, ReplicationBytes reports the amount of data that the primary is sending to all of its replicas. This metric is representative of the write load on the replication group. For replicas and standalone primaries, ReplicationBytes is always 0.

Replication Group ID

The replication group to which this cluster belongs.

Replication Lag (Seconds)

This metric is only applicable for a cluster that has nodes running as a read replica. It represents how far behind the replicas are in applying changes from the primary node.

Save In Progress

This binary metric returns 1 whenever a background save (forked or forkless) is in progress, and 0 otherwise. A background save process is typically used during snapshots and syncs. These operations can cause degraded performance.

Set Based Commands

The total number of commands that are set-based. This is derived from the Redis commandstats statistic by summing all of the commands that act upon one or more sets.

Set Type Commands

The total number of set types of commands. This is derived from the Redis commandstats statistic by summing all of the set types of commands (set, hset, etc.)

Slabs Moved

The total number of slab pages that have been moved.

Snapshot Retention Limit

The number of days for which ElastiCache retains automatic cluster snapshots before deleting them.

Sorted Set Based Commands

The total number of commands that are sorted set-based. This is derived from the Redis commandstats statistic by summing all of the commands that act upon one or more sorted sets.

Status

The current state of this cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cluster nodes, restore-failed, or snapshotting.

Storage Space Used (Bytes)

The total amount of space allocated by Redis.

Storage Space Used For Cache Items (Bytes)

The amount of space used to store cache items.

Storage Space Used For Hash (Bytes)

The amount of space currently used by hash tables.

String Based Commands

The total number of commands that are string-based. This is derived from the Redis commandstats statistic by summing all of the commands that act upon one or more strings.

Swap Usage (Bytes)

The amount of swap used on the host.

Touch Hit Rate (%)

The percent of keys that have been touched and were given a new expiration time.

Touch Hits

The number of keys that have been touched and were given a new expiration time.

Touch Misses

The number of items that have been touched, but were not found.

Unused Memory (Bytes)

The amount of memory not used by data. This is derived from the Memcached statistics limit_maxbytes and bytes by subtracting bytes from limit_maxbytes.

Cache Node

Name
Description

Availability Zone

The Availability Zone where this node was created and now resides.

Cache Hit Rate (%)

The percent of successful key lookups.

Cache Hits

The number of successful key lookups.

Cache Misses

The number of unsuccessful key lookups.

CAS Bad Values (Requests)

The number of CAS (check and set) requests the cache has received where the CAS value did not match the CAS value stored.

CAS Hit Rate (%)

The percent of CAS requests the cache has received where the requested key was found and the CAS value matched.

CAS Hits (Requests)

The number of CAS requests the cache has received where the requested key was found and the CAS value matched.

CAS Misses (Requests)

The number of CAS requests the cache has received where the key requested was not found.

Cluster ID

The ID of the cluster the node is a part of.

Command Configuration Gets (Requests)

The cumulative number of config get requests.

Command Configuration Sets (Requests)

The cumulative number of config set requests.

Command Flushes

The number of flush commands the cache has received.

Command Gets

The number of get commands the cache has received.

Command Sets

The number of set commands the cache has received.

Command Touches (Requests)

The cumulative number of touch requests.

CPU Utilization (%)

The CPU utilization.

Created Time

The date and time when the cache node was created.

Current Configuration

The current number of configurations stored.

Current Connections (Connections)

A count of the number of connections connected to the cache at an instant in time. ElastiCache uses two to three of the connections to monitor the cluster in each case.

Current Items

A count of the number of items currently stored in the cache.

Decrement Hit Rate (%)

The percent of decrement requests the cache has received where the requested key was found.

Decrement Hits (Requests)

The number of decrement requests the cache has received where the requested key was found.

Decrement Misses (Requests)

The number of decrement requests the cache has received where the requested key was not found.

Delete Hit Rate (%)

The percent of delete requests the cache has received where the requested key was found.

Delete Hits (Requests)

The number of delete requests the cache has received where the requested key was found.

Delete Misses (Requests)

The number of delete requests the cache has received where the requested key was not found.

Evicted Items

The number of non-expired items the cache evicted to allow space for new writes.

Evicted Unfetched Items

The number of valid items evicted from the least recently used cache (LRU) which were never touched after being set.

Expired Unfetched Items

The number of expired items reclaimed from the LRU which were never touched after being set.

Freeable Memory (Bytes)

The amount of free memory available on the host.

Get Hit Rate (%)

The percent of get requests the cache has received where the key requested was found.

Get Hits (Requests)

The number of get requests the cache has received where the key requested was found.

Get Misses (Requests)

The number of get requests the cache has received where the key requested was not found.

Get Type Commands

The total number of get types of commands. This is derived from the Redis commandstats statistic by summing all of the get types of commands (get, mget, hget, etc.)

Hash Based Commands

The total number of commands that are hash-based. This is derived from the Redis commandstats statistic by summing all of the commands that act upon one or more hashes.

Hostname

The hostname for connecting to this cache node.

ID

The cache node identifier.

Increment Hit Rate (%)

The percent of increment requests the cache has received where the key requested was found.

Increment Hits (Requests)

The number of increment requests the cache has received where the key requested was found.

Increment Misses (Requests)

The number of increment requests the cache has received where the key requested was not found.

Key Based Commands

The total number of commands that are key-based. This is derived from the Redis commandstats statistic by summing all of the commands that act upon one or more keys.

List Based Commands

The total number of commands that are list-based. This is derived from the Redis commandstats statistic by summing all of the commands that act upon one or more lists.

Memcached Data Read (Bytes)

The amount of data that has been read from the network by the cache node.

Memcached Data Written (Bytes)

The amount of space that has been written to the network by the cache node.

Name

The Cache Cluster ID with the Cache Node ID.

Network In (Bytes)

The amount of data the host has read from the network.

Network Out (Bytes)

The amount of data the host has written to the network.

New Connections (Connections)

The number of new connections the cache has received. This is derived from the memcached total_connections statistic by recording the change in total_connections across a period of time. This will always be at least 1, due to a connection reserved for a ElastiCache.

New Items

The number of new items the cache has stored. This is derived from the memcached total_items statistic by recording the change in total_items across a period of time.

Parameter Group Status

The status of the parameter group applied to this cache node.

Reclaimed items

The number of expired items the cache evicted to allow space for new writes.

Region

The AWS Region this object belongs to.

Replication Data (Bytes)

For primaries with attached replicas, ReplicationBytes reports the amount of data that the primary is sending to all of its replicas. This metric is representative of the write load on the replication group. For replicas and standalone primaries, ReplicationBytes is always 0.

Replication Lag (Seconds)

This metric is only applicable for a node running as a read replica. It represents how far behind the replica is in applying changes from the primary node.

Save In Progress

This binary metric returns 1 whenever a background save (forked or forkless) is in progress, and 0 otherwise. A background save process is typically used during snapshots and syncs. These operations can cause degraded performance.

Set Based Commands

The total number of commands that are set-based. This is derived from the Redis commandstats statistic by summing all of the commands that act upon one or more sets.

Set Type Commands

The total number of set types of commands. This is derived from the Redis commandstats statistic by summing all of the set types of commands (set, hset, etc.)

Slabs Moved

The total number of slab pages that have been moved.

Sorted Set Based Commands

The total number of commands that are sorted set-based. This is derived from the Redis commandstats statistic by summing all of the commands that act upon one or more sorted sets.

Source Cache Node ID

The ID of the primary node to which this read replica node is synchronized.

Status

The current state of this cache node.

Storage Space Used (Bytes)

The total amount of space allocated by Redis.

Storage Space Used For Cache Items (Bytes)

The amount of space used to store cache items.

Storage Space Used For Hash (Bytes)

The amount of space currently used by hash tables.

String Based Commands

The total number of commands that are string-based. This is derived from the Redis commandstats statistic by summing all of the commands that act upon one or more strings.

Swap Usage (Bytes)

The amount of swap used on the host.

Touch Hit Rate (%)

The percent of keys that have been touched and were given a new expiration time.

Touch Hits

The number of keys that have been touched and were given a new expiration time.

Touch Misses

The number of items that have been touched, but were not found.

Unused Memory (Bytes)

The amount of memory not used by data. This is derived from the Memcached statistics limit_maxbytes and bytes by subtracting bytes from limit_maxbytes.

Replication Group

Name
Description

Cache Node Type

The name of the compute and memory capacity node type for each node in the replication group.

Cluster Enabled

A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

Configuration Endpoint

The configuration endpoint for this replication group.

Description

The user supplied description of the replication group.

ID

The identifier for the replication group.

Members

The identifiers of all the nodes that are part of this replication group.

Node Groups

A list of node groups in this replication group.

Region

The AWS Region this object belongs to.

Status

The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.