Amazon SQS
Connector dependencies​
The following monitoring connectors will be installed when you install the Amazon SQS connector through the Configuration > Monitoring Connector Manager menu:
Pack assets​
Templates​
The Monitoring Connector Amazon SQS brings a host template:
- Cloud-Aws-Sqs-custom
The connector brings the following service templates (sorted by the host template they are attached to):
- Cloud-Aws-Sqs-custom
| Service Alias | Service Template | Service Description |
|---|---|---|
| Sqs-Queues | Cloud-Aws-Sqs-Queues-Api-custom | Check Amazon SQS queues |
The services listed above are created automatically when the Cloud-Aws-Sqs-custom host template is used.
Discovery rules​
Host discovery​
| Rule name | Description |
|---|---|
| Amazon Web Service SQS | Discover AWS SQS queues |
More information about discovering hosts automatically is available on the dedicated page.
Collected metrics & status​
Here is the list of services for this connector, detailing all metrics and statuses linked to each service.
- Sqs-Queues
| Name | Unit |
|---|---|
| sqs.queue.messages.oldest.seconds | s |
| sqs.queue.messages.delayed.count | count |
| sqs.queue.messages.notvisible.count | count |
| sqs.queue.messages.visible.count | count |
| sqs.queue.messages.empty.count | count |
| sqs.queue.messages.deleted.count | count |
| sqs.queue.messages.received.count | count |
| sqs.queue.messages.sent.count | count |
Prerequisites​
AWS Configuration​
Configure a service account (access/secret key combo) for which the following privileges have to be granted:
- cloudwatch:getMetricStatistics
- cloudwatch:listMetrics
- sqs:ListQueues
Plugin dependencies​
To interact with the 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 the AWS Cloudwatch APIs.
- perl-Paws-installation
- aws-cli-installation
yum install perl-Paws
curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
unzip awscliv2.zip
sudo ./aws/install
Installing the monitoring connector​
Pack​
- If the platform uses an online license, you can skip the package installation instruction below as it is not required to have the connector 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:
- Alma / RHEL / Oracle Linux 8
- Alma / RHEL / Oracle Linux 9
- Debian 11 & 12
- CentOS 7
dnf install centreon-pack-cloud-aws-sqs
dnf install centreon-pack-cloud-aws-sqs
apt install centreon-pack-cloud-aws-sqs
yum install centreon-pack-cloud-aws-sqs
- Whatever the license type (online or offline), install the Amazon SQS connector 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:
- Alma / RHEL / Oracle Linux 8
- Alma / RHEL / Oracle Linux 9
- Debian 11 & 12
- CentOS 7
dnf install centreon-plugin-Cloud-Aws-Sqs-Api
dnf install centreon-plugin-Cloud-Aws-Sqs-Api
apt install centreon-plugin-cloud-aws-sqs-api
yum install centreon-plugin-Cloud-Aws-Sqs-Api
Using the monitoring connector​
Using a host template provided by the connector​
- Log into Centreon and add a new host through Configuration > Hosts.
- Fill in the Name, Alias & IP Address/DNS fields according to your resource's settings.
- Apply the Cloud-Aws-Sqs-custom template to the host. A list of macros appears. Macros allow you to define how the connector will connect to the resource, and to customize the connector's behavior.
- Fill in the macros you want. Some macros are mandatory.
| Macro | Description | Default value | Mandatory |
|---|---|---|---|
| AWSACCESSKEY | Set AWS access key | X | |
| AWSASSUMEROLE | Set Amazon Resource Name of the role to be assumed | ||
| AWSCUSTOMMODE | When a plugin offers several ways (CLI, library, etc.) to get information the desired one must be defined with this option | awscli | |
| AWSREGION | Set the region name | X | |
| AWSSECRETKEY | Set AWS secret key | X | |
| PROXYURL | Proxy URL if any | ||
| QUEUENAME | Set the SQS queue name (required) (can be multiple, one instance per --queue-name option). Example: --queue-name="myqueue1" --queue-name="myqueue2" | .* | X |
| EXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed here. |
- Deploy the configuration. The host appears in the list of hosts, and on the Resources Status page. The command that is sent by the connector is displayed in the details panel of the host: it shows the values of the macros.
Using a service template provided by the connector​
- If you have used a host template and checked Create Services linked to the Template too, the services linked to the template have been created automatically, using the corresponding service templates. Otherwise, create manually the services you want and apply a service template to them.
- Fill in the macros you want (e.g. to change the thresholds for the alerts). Some macros are mandatory (see the table below).
- Sqs-Queues
| Macro | Description | Default value | Mandatory |
|---|---|---|---|
| TIMEFRAME | Set timeframe in seconds | 900 | |
| PERIOD | Set period in seconds | 60 | |
| FILTERMETRIC | Filter metrics (can be: 'ApproximateAgeOfOldestMessage', 'ApproximateNumberOfMessagesDelayed', 'ApproximateNumberOfMessagesNotVisible', 'ApproximateNumberOfMessagesVisible', 'NumberOfEmptyReceives', 'NumberOfMessagesDeleted', 'NumberOfMessagesReceived', 'NumberOfMessagesSent'). (can be a regexp) | ||
| WARNINGMESSAGESDELAYED | Threshold | ||
| CRITICALMESSAGESDELAYED | Threshold | ||
| WARNINGMESSAGESDELETED | Threshold | ||
| CRITICALMESSAGESDELETED | Threshold | ||
| WARNINGMESSAGESEMPTYRECEIVES | Threshold | ||
| CRITICALMESSAGESEMPTYRECEIVES | Threshold | ||
| WARNINGMESSAGESNOTVISIBLE | Threshold | ||
| CRITICALMESSAGESNOTVISIBLE | Threshold | ||
| WARNINGMESSAGESOLDESTAGE | Threshold | ||
| CRITICALMESSAGESOLDESTAGE | Threshold | ||
| WARNINGMESSAGESRECEIVED | Threshold | ||
| CRITICALMESSAGESRECEIVED | Threshold | ||
| WARNINGMESSAGESSENT | Threshold | ||
| CRITICALMESSAGESSENT | Threshold | ||
| WARNINGMESSAGESVISIBLE | Threshold | ||
| CRITICALMESSAGESVISIBLE | Threshold | ||
| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed here. |
- Deploy the configuration. The service appears in the list of services, and on the Resources Status page. The command that is sent by the connector is displayed in the details panel of the service: it shows the values of the macros.
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). Test that the connector
is able to monitor an AWS Instance using a command like this one (replace the sample values by yours):
/usr/lib/centreon/plugins/centreon_aws_sqs_api.pl \
--plugin=cloud::aws::sqs::plugin \
--mode=queues \
--custommode='awscli' \
--aws-secret-key='XXXX' \
--aws-access-key='XXXX' \
--aws-role-arn='' \
--region='us-east-1' \
--proxyurl='' \
--queue-name='.*' \
--filter-metric='' \
--timeframe='900' \
--period='60' \
--warning-messages-notvisible='' \
--critical-messages-notvisible='' \
--warning-messages-oldest-age='' \
--critical-messages-oldest-age='' \
--warning-messages-visible='' \
--critical-messages-visible='' \
--warning-messages-delayed='' \
--critical-messages-delayed='' \
--warning-messages-deleted='' \
--critical-messages-deleted='' \
--warning-messages-sent='' \
--critical-messages-sent='' \
--warning-messages-empty-receives='' \
--critical-messages-empty-receives='' \
--warning-messages-received='' \
--critical-messages-received=''
The expected command output is shown below:
OK: 'my_sqs_queue_1' Statistic 'Average' number of messages sent: 45, number of
messages received: 32 | 'my_sqs_queue_1~average#sqs.queue.messages.sent.count'=45;;1:;; 'my_sqs_queue_1~average#sqs.queue.messages.received.count'=32;;1:;;
SQS Queue'my_sqs_queue_1'
Statistic 'Average' number of messages sent: 45, number of messages received: 32
Troubleshooting​
Please find the troubleshooting documentation for Centreon Plugins typical issues.
Available modes​
In most cases, a mode corresponds to a service template. The mode appears in the execution command for the connector. In the Centreon interface, you don't need to specify a mode explicitly: its use is implied when you apply a service template. However, you will need to specify the correct mode for the template if you want to test the execution command for the connector in your terminal.
All available modes can be displayed by adding the --list-mode parameter to
the command:
/usr/lib/centreon/plugins/centreon_aws_sqs_api.pl \
--plugin=cloud::aws::sqs::plugin \
--list-mode
The plugin brings the following modes:
| Mode | Linked service template |
|---|---|
| discovery [code] | Used for host discovery |
| list-queues [code] | Not used in this Monitoring Connector |
| queues [code] | Cloud-Aws-Sqs-Queues-Api-custom |
Available options​
Generic options​
All generic options are listed here:
| Option | Description |
|---|---|
| --mode | Define the mode in which you want the plugin to be executed (see --list-mode). |
| --dyn-mode | Specify a mode with the module's path (advanced). |
| --list-mode | List all available modes. |
| --mode-version | Check minimal version of mode. If not, unknown error. |
| --version | Return the version of the plugin. |
| --custommode | When a plugin offers several ways (CLI, library, etc.) to get information the desired one must be defined with this option. |
| --list-custommode | List all available custom modes. |
| --multiple | Multiple custom mode objects. This may be required by some specific modes (advanced). |
| --pass-manager | Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass. |
| --verbose | Display extended status information (long output). |
| --debug | Display debug messages. |
| --filter-perfdata | Filter perfdata that match the regexp. Example: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data. |
| --filter-perfdata-adv | Filter perfdata based on a "if" condition using the following variables: label, value, unit, warning, critical, min, max. Variables must be written either %{variable} or %(variable). Example: adding --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' will remove all metrics whose value equals 0 and that don't have a maximum value. |
| --explode-perfdata-max | Create a new metric for each metric that comes with a maximum limit. The new metric will be named identically with a '_max' suffix). Example: it will split 'used_prct'=26.93%;0:80;0:90;0;100 into 'used_prct'=26.93%;0:80;0:90;0;100 'used_prct_max'=100%;;;; |
| --change-perfdata --extend-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[newuom],[min],[max]] Common examples: =over 4 Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic_in,,percent()' =back |
| --change-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[newuom],[min],[max]] Common examples: =over 4 Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic_in,,percent()' =back |
| --extend-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[newuom],[min],[max]] Common examples: =over 4 Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic_in,,percent()' =back |
| --extend-perfdata-group | Add new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Syntax: --extend-perfdata-group=regex,namesofnewmetrics,calculation[,[newuom],[min],[max]] regex: regular expression namesofnewmetrics: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). calculation: how the values of the new metrics should be calculated newuom (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: =over 4 Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets_wrong,sum(packets_(discard|error)_(in|out))' Sum traffic by interface: --extend-perfdata-group='traffic_in_(.*),traffic_$1,sum(traffic_(in|out)_$1)' =back |
| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' |
| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' |
| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' |
| --change-exit | Replace an exit code with one of your choice. Example: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state. |
| --range-perfdata | Rewrite the ranges displayed in the perfdata. Accepted values: 0: nothing is changed. 1: if the lower value of the range is equal to 0, it is removed. 2: remove the thresholds from the perfdata. |
| --filter-uom | Mask the units when they don't match the given regular expression. |
| --opt-exit | Replace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown. |
| --output-ignore-perfdata | Remove all the metrics from the service. The service will still have a status and an output. |
| --output-ignore-label | Remove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...' |
| --output-xml | Return the output in XML format (to send to an XML API). |
| --output-json | Return the output in JSON format (to send to a JSON API). |
| --output-openmetrics | Return the output in OpenMetrics format (to send to a tool expecting this format). |
| --output-file | Write output in file (can be combined with json, xml and openmetrics options). E.g.: --output-file=/tmp/output.txt will write the output in /tmp/output.txt. |
| --disco-format | Applies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML). |
| --disco-show | Applies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery. |
| --float-precision | Define the float precision for thresholds (default: 8). |
| --source-encoding | Define the character encoding of the response sent by the monitored resource Default: 'UTF-8'. =head1 DESCRIPTION B\<output>. =cut |
| --aws-secret-key | Set AWS secret key. |
| --aws-access-key | Set AWS access key. |
| --aws-session-token | Set AWS session token. |
| --aws-role-arn | Set Amazon Resource Name of the role to be assumed. |
| --region | Set the region name (required). |
| --period | Set period in seconds. |
| --timeframe | Set timeframe in seconds. |
| --statistic | Set CloudWatch statistics (can be: 'minimum', 'maximum', 'average', 'sum'). |
| --zeroed | Set metrics value to 0 if none. Useful when CloudWatch does not return value when not defined. |
| --proxyurl | Proxy URL if any |
| --aws-profile | Set AWS profile. |
| --endpoint-url | Override AWS service endpoint URL if necessary. |
| --timeout | Set timeout in seconds (default: 50). |
| --sudo | Use 'sudo' to execute the command. |
| --command | Command to get information (default: 'aws'). Can be changed if you have output in a file. |
| --command-path | Command path (default: none). |
| --command-options | Command options (default: none). Only use for testing purpose, when you want to set ALL parameters of a command by yourself. |
| --skip-ssl-check | Avoid certificate issuer verification. Useful when AWS resources are hosted by a third party. Note that it strips all stderr from the command result. Debug will only display CLI instead of everything. |
Modes options​
All available options for each service template are listed below:
- Sqs-Queues
| Option | Description |
|---|---|
| --queue-name | Set the SQS queue name (required) (can be multiple, one instance per --queue-name option). Example: --queue-name="myqueue1" --queue-name="myqueue2". |
| --filter-metric | Filter metrics (can be: 'ApproximateAgeOfOldestMessage', 'ApproximateNumberOfMessagesDelayed', 'ApproximateNumberOfMessagesNotVisible', 'ApproximateNumberOfMessagesVisible', 'NumberOfEmptyReceives', 'NumberOfMessagesDeleted', 'NumberOfMessagesReceived', 'NumberOfMessagesSent'). (can be a regexp). |
| --warning- --critical- | Warning thresholds (can be 'messages-oldest-age', 'messages-delayed', 'messages-notvisible', 'messages-visible', 'messages-empty-receives', 'messages-deleted', 'messages-received', 'messages-sent'). |
All available options for a given mode can be displayed by adding the
--help parameter to the command:
/usr/lib/centreon/plugins/centreon_aws_sqs_api.pl \
--plugin=cloud::aws::sqs::plugin \
--mode=queues \
--help