Skip to main content

Amazon ElastiCache

Pack Assets​

Templates​

The Centreon Monitoring Connector Amazon ElastiCache brings 3 different host templates:

  • Cloud-Aws-ElastiCache-custom
  • Cloud-Aws-ElastiCache-Memcached-custom
  • Cloud-Aws-ElastiCache-Redis-custom

It brings the following service templates:

Service AliasService TemplateService DescriptionDefault
ElastiCache-CommandsCloud-Aws-ElastiCache-Commands-Memcached-ApiCheck Memcached performancesX
ElastiCache-CommandsCloud-Aws-ElastiCache-Commands-Redis-ApiCheck Redis performancesX
ElastiCache-ConnectionsCloud-Aws-ElastiCache-Connections-ApiCheck connections numberX
ElastiCache-CpuCloud-Aws-ElastiCache-Cpu-ApiCheck CPU utilizationX
ElastiCache-EvictionsCloud-Aws-ElastiCache-Evictions-ApiCheck evictions numberX
ElastiCache-ItemsCloud-Aws-ElastiCache-Items-ApiCheck items numberX
ElastiCache-NetworkCloud-Aws-ElastiCache-Network-ApiCheck network usageX
ElastiCache-ReplicationCloud-Aws-ElastiCache-Replication-ApiCheck replication performancesX
ElastiCache-RequestsCloud-Aws-ElastiCache-Requests-Memcached-ApiCheck Memcached performancesX
ElastiCache-RequestsCloud-Aws-ElastiCache-Requests-Redis-ApiCheck Redis performancesX
ElastiCache-UsageCloud-Aws-ElastiCache-Usage-Memcached-ApiCheck Memcached space usageX
ElastiCache-UsageCloud-Aws-ElastiCache-Usage-Redis-ApiCheck Redis space usageX

Discovery rules​

The pack provides a discovery rule to automatically discover Elasticache resources.

More information about the Host Discovery module is available in the Centreon documentation: Host Discovery

Collected metrics & status​

Metric nameDescriptionUnit
CPUUtilizationThe percentage of CPU utilization.Percent

Prerequisites​

AWS Configuration​

Configure a service account (access/secret key combo) for which the following privileges have to be granted:

AWS PrivilegeDescription
elasticache:describeCacheClustersReturns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied.
cloudwatch:getMetricStatisticsGet metrics from the AWS/EC2 namespace on Cloudwatch.

Plugin dependencies​

To interact with Amazon APIs, you can use either use the awscli binary provided by Amazon or paws, a Perl AWS SDK (recommended). You must install it on every poller expected to monitor AWS resources.

For now, it is not possible to use paws if you are using a proxy to reach AWS Cloudwatch APIs.

yum install perl-Paws

Setup​

Monitoring Pack​

If the platform uses an online license, you can skip the package installation instruction below as it is not required to have the pack displayed within the Configuration > Monitoring Connector Manager menu. If the platform uses an offline license, install the package on the central server with the command corresponding to the operating system's package manager:

dnf install centreon-pack-cloud-aws-elasticache

Whatever the license type (online or offline), install the Amazon ElastiCache Pack through the Configuration > Monitoring Connector Manager menu.

Plugin​

Since Centreon 22.04, you can benefit from the 'Automatic plugin installation' feature. When this feature is enabled, you can skip the installation part below.

You still have to manually install the plugin on the poller(s) when:

  • Automatic plugin installation is turned off
  • You want to run a discovery job from a poller that doesn't monitor any resource of this kind yet

More information in the Installing the plugin section.

Use the commands below according to your operating system's package manager:

dnf install centreon-plugin-Cloud-Aws-Elasticache-Api

Configuration​

Host​

  • Log into Centreon and add a new host through Configuration > Hosts.
  • Fill the Name, Alias & IP Address/DNS fields according to your Elasticache server settings.
  • Apply the Cloud-Aws-ElastiCache-custom template to the host.
  • Once the template is applied, fill in the corresponding macros. Some macros are mandatory.
MandatoryMacroDescription
AWSACCESSKEY
AWSASSUMEROLE
AWSCUSTOMMODE
AWSINSTANCENAME
AWSNODEID
AWSREGION
AWSSECRETKEY
EXTRAOPTIONSAny extra option you may want to add to every command line (eg. a --verbose flag)
PROXYURL

How to check in the CLI that the configuration is OK and what are the main options for?​

Once the plugin is installed, log into your Centreon poller's CLI using the centreon-engine user account (su - centreon-engine) and test the plugin by running the following command:

/usr/lib/centreon/plugins//centreon_aws_elasticache_api.pl \
    --plugin=cloud::aws::elasticache::plugin \
    --mode=cpu \
    --custommode='' \
    --aws-secret-key='' \
    --aws-access-key='' \
    --aws-role-arn='' \
    --region='' \
    --name='' \
    --node-id='' \
    --proxyurl='' \
    --statistic='average' \
    --timeframe='600' \
    --period='60' \
    --warning-cpuutilization-average='' \
    --critical-cpuutilization-average='' \
    --per-sec \
    --verbose \
    --use-new-perfdata

The expected command output is shown below:

OK: |

All available options for a given mode can be displayed by adding the --help parameter to the command:

/usr/lib/centreon/plugins//centreon_aws_elasticache_api.pl \
    --plugin=cloud::aws::elasticache::plugin \
    --mode=cpu \
    --help

All available modes can be displayed by adding the --list-mode parameter to the command:

/usr/lib/centreon/plugins//centreon_aws_elasticache_api.pl \
    --plugin=cloud::aws::elasticache::plugin \
    --list-mode

Troubleshooting​

Please find the troubleshooting documentation for Centreon Plugins typical issues.