AWS ElastiCache
Introduction
Amazon ElastiCache is a web service that makes it easy to set up, manage, and scale a distributed in-memory data store or cache environment in the cloud.
Getting Started
Compatibility
vuSmartMaps support Redis Serverless Cache type AWS Elasticache with Engine Version 7.1 and above.
Data Collection Method
vuSmartMaps collects health and performance data for AWS ElastiCache using VuNet's Internal Data Collector.
Prerequisites
Dependent Configuration
To configure this O11ySource, create a 'credential' of type 'aws' under the 'Definition' tab.
Inputs for Configuring Data Source
- Data Source Name: The AWS ElastiCache data source that will uniqly identify the source.
- AWS Region: AWS Region where the instance of this component is running. For eg: Asia Pacific (Mumbai), the region would be ap-south-1.
- AWS Credential: AWS credential that provides Access key and Secret key to access Cloudwatch.
- Period (in minutes): Specifies the interval in minutes at which data is collected. Data collection occurs once every specified period. The period should be between 1 - 60 minutes.
Firewall Requirement
To collect data from this O11ySource, ensure the following ports are opened:
| Source IP | Destination IP | Destination Port | Protocol | Direction |
|---|---|---|---|---|
| vuSmartMaps IP | AWS CloudWatch IPs | 443* | TCP | Outbound |
*Before providing the firewall requirements, please update the port based on the customer environment.
Configuring the Target
Health and Performance metrics of AWS ElastiCache is collected through AWS CloudWatch service. So AWS CloudWatch services must be enabled in your AWS account. AWS ElastiCache should have some Caches available for which monitoring is enabled.
An IAM role or user with the following permissions to access CloudWatch metrics:
- cloudwatch:GetMetricData
- cloudwatch:ListMetrics
Configuration Steps
Enablethe O11ySource.- Select the sources tab and press the
+button to add a new instance that has to be monitored. - Provide the required configurations:
- *Data Source Name
- *AWS Region
- *Credential
- *Period
- Click
Saveto close the data source window.
Metrics Collected
| Name | Description | Data Type |
|---|---|---|
| BytesUsedForCache | The total number of bytes used by the data stored in your cache. | Float64 |
| BytesUsedForCache | The total number of bytes used by the data stored in your cache. | Float64 |
| CacheHitRate | Indicates the hit rate of your cache. | Float64 |
| CacheHitRate | Indicates the hit rate of your cache. | Float64 |
| CacheHits | The number of successful read-only key lookups in the cache | Float64 |
| CacheHits | The number of successful read-only key lookups in the cache | UInt64 |
| CacheMisses | The number of failed read requests from the cache | Float64 |
| CacheMisses | The number of failed read requests from the cache | UInt64 |
| SuccessfulReadRequestLatency | Latency of successful read requests. | Float64 |
| SuccessfulReadRequestLatency | Latency of successful read requests. | UInt64 |
| SuccessfulWriteRequestLatency | Latency of successful write requests | Float64 |
| SuccessfulWriteRequestLatency | Latency of successful write requests | UInt64 |
| TotalCmdsCount | Total count of all commands executed on your cache | Float64 |
| TotalCmdsCount | Total count of all commands executed on your cache | UInt64 |
| CurrConnections | The number of client connections to your cache. | Float64 |
| CurrConnections | The number of client connections to your cache. | UInt64 |
| ChannelAuthorizationFailures | The total number of failed attempts to authenticate to Redis using the AUTH command | Float64 |
| ChannelAuthorizationFailures | The total number of failed attempts to authenticate to Redis using the AUTH command | UInt64 |
| CommandAuthorizationFailures | The total number of failed attempts by users to run commands they don’t have permission to call. Used to identify unauthorized access | Float64 |
| CommandAuthorizationFailures | The total number of failed attempts by users to run commands they don’t have permission to call. Used to identify unauthorized access | UInt64 |
| CurrItems | The number of items in the cache. | Float64 |
| CurrItems | The number of items in the cache. | UInt64 |
| CurrVolatileItems | The number of items in the cache with TTL | Float64 |
| CurrVolatileItems | The number of items in the cache with TTL | UInt64 |
| Evictions | The count of keys evicted by the cache | Float64 |
| Evictions | The count of keys evicted by the cache | UInt64 |
| IamAuthenticationExpirations | The total number of expired IAM-authenticated Redis connections. | Float64 |
| IamAuthenticationExpirations | The total number of expired IAM-authenticated Redis connections. | UInt64 |
| IamAuthenticationThrottling | The total number of throttled IAM-authenticated Redis AUTH or HELLO requests. | Float64 |
| IamAuthenticationThrottling | The total number of throttled IAM-authenticated Redis AUTH or HELLO requests. | UInt64 |
| KeyAuthorizationFailures | The total number of failed attempts by users to access keys they don’t have permission to access. | Float64 |
| KeyAuthorizationFailures | The total number of failed attempts by users to access keys they don’t have permission to access. | UInt64 |
| Reclaimed | The total number of key expiration events. | Float64 |
| Reclaimed | The total number of key expiration events. | UInt64 |
| ThrottledCmds | The number of requests that were throttled by ElastiCache because the workload was scaling faster than ElastiCache can scale. | Float64 |
| ThrottledCmds | The number of requests that were throttled by ElastiCache because the workload was scaling faster than ElastiCache can scale. | UInt64 |
| NetworkBytesIn | Total bytes transferred in to cache | UInt64 |
| NetworkBytesOut | Total bytes transferred out of cache | UInt64 |
| NetworkBytesIn | Average bytes transferred in to cache | Float64 |
| NetworkBytesOut | Average bytes transferred out of cache | Float64 |
| ECPUnits | Average of Elastic Cache Processing Units (EPC) used | Float64 |
| ECPUnits | Total Elastic Cache Processing Units (EPC) used | Float64 |
| DB0AverageTTL | Exposes avg_ttl of DBO from the keyspace statistic of Redis INFO command | Float64 |
| DB0AverageTTL | Exposes avg_ttl of DBO from the keyspace statistic of Redis INFO command | UInt64 |
| NewConnections | Average new connections | Float64 |
| NewConnections | Total new connection | UInt64 |
| NonKeyTypeCmds | Average number of Non-Key type commands | Float64 |
| NonKeyTypeCmds | Average ECP units spent on Non-Key type commands | Float64 |
| NonKeyTypeCmds | Total number of Non-Key type commands | Float64 |
| NonKeyTypeCmds | Total ECP units spent on Non-Key type commands | Float64 |
| GetTypeCmds | Average number of Get type commands | Float64 |
| GetTypeCmdsEcpUs | Average ECP units spent on Get type commands | Float64 |
| GetTypeCmds | Total number of Get type commands | Float64 |
| GetTypeCmdsEcpUs | Total ECP units spent on Get type commands | Float64 |
| SetTypeCmds | Average number of Set type commands | Float64 |
| SetTypeCmdsEcpUs | Average ECP units spent on Set type commands | Float64 |
| SetTypeCmds | Total number of Set type commands | Float64 |
| SetTypeCmdsEcpUs | Total ECP units spent on Set type commands | Float64 |
| StringBasedCmds | Average number of String based commands | Float64 |
| StringBasedCmdsEcpUs | Average ECP units spent on String based commands | Float64 |
| StringBasedCmds | Total number of String based commands | Float64 |
| StringBasedCmdsEcpUs | Total ECP units spent on String based commands | Float64 |
| ClusterId | AWS ElastiCache name | String |
| Region | AWS Region | String |
| Target | Target server | String |
| Host | Host server | String |
| Timestamp | Timestamp of the data | DateTime64 |
| Tenand ID | Tenant Id | LowCardinality(String) |
| BU Id | BU Id | LowCardinality(String) |
