---
title: "Host Template: Cloud - AWS - S3"
description: ""
url: "https://docs.itrsgroup.com/docs/opsview/6.11.7/opspacks/cloud-aws-opspack/cloud-aws-s3-host-template/index.html"
---## Overview

Monitor your S3 Buckets with a variety of checks, including Bucket Size, Objects, Requests, Errors and Latency statistics.

This Host Template includes the following Service Checks:

| Service&nbsp;Check&nbsp;Name | Description | Default&nbsp;Thresholds (Metric:&nbsp;Warning,&nbsp;Critical) | UOM |
|:-----------------------------|:------------|:------------------------------------------------:|:---:|
| AWS - S3 - Bucket Size | The amount of data, in bytes, stored in a bucket. By default it uses standard storage class as dimension but users can override this by providing the Storage class in the dimensions argument. | N/A | B |
| AWS - S3 - Number Of Objects | The total number of objects stored in a bucket for all storage classes except for the GLACIER storage class. | N/A | N/A |
| AWS - S3 - All Requests | The total number of HTTP requests made to a bucket. Requires detailed monitoring to be enabled. | N/A | N/A |
| AWS - S3 - Get Requests | The number of HTTP GET requests made for objects in a bucket. Requires detailed monitoring to be enabled. | N/A | N/A |
| AWS - S3 - Put Requests | The number of HTTP PUT requests made for objects in a bucket. Requires detailed monitoring to be enabled. | N/A | N/A |
| AWS - S3 - Delete Requests | The number of HTTP DELETE requests made for objects in a bucket. Requires detailed monitoring to be enabled. | N/A | N/A |
| AWS - S3 - Head Requests | The number of HTTP HEAD requests made to a bucket. Requires detailed monitoring to be enabled. | N/A | N/A |
| AWS - S3 - Post Requests | The number of HTTP POST requests made to a bucket. Requires detailed monitoring to be enabled. | N/A | N/A |
| AWS - S3 - List Requests | The number of HTTP requests that list the contents of a bucket. Requires detailed monitoring to be enabled. | N/A | N/A |
| AWS - S3 - Bytes Downloaded | The number of bytes downloaded for requests made to a bucket, where the response includes a body. Requires detailed monitoring to be enabled. | N/A | B |
| AWS - S3 - Bytes Uploaded | The number of bytes uploaded to a bucket that contain a request body. Requires detailed monitoring to be enabled. | N/A | B |
| AWS - S3 - 4xxErrors | The number of HTTP 4xx client error status code requests made to a bucket. Requires detailed monitoring to be enabled. | N/A | N/A |
| AWS - S3 - 5xxErrors | The number of HTTP 5xx client error status code requests made to a bucket. Requires detailed monitoring to be enabled. | N/A | N/A |
| AWS - S3 - First Byte Latency | The per-request time from the complete request being received by a bucket to when the response starts to be returned. Requires detailed monitoring to be enabled. | N/A | ms |
| AWS - S3 - Total Request Latency | The elapsed per-request time from the first byte received to the last byte sent to a bucket. Requires detailed monitoring to be enabled. | N/A | ms |


**Note**


See details about [Monitoring Plugin thresholds here](https://www.monitoring-plugins.org/doc/guidelines.html#THRESHOLDFORMAT).



## Usage Instructions

Please review the overall [Cloud - AWS Opspack](https://docs.itrsgroup.com/docs/opsview/6.11.7/opspacks/cloud-aws-opspack/cloud-aws-opspack/index.html) documentation for details on prerequisites, known issues, and other necessary configurations that apply to all Host Templates in the Opspack.

### Add this Host Template

Add the **Cloud - AWS - S3** Host Template to your Opsview Monitor host.
If the resource you're monitoring has no hostname or public IP, then open the **Advanced** settings pane and change **Host Check Command** to **Always assumed to be UP**.


**Note**


For more information, refer to the documentation on [Adding Host Templates to Hosts](https://docs.itrsgroup.com/docs/opsview/6.11.7/host/index.html#host-templates).



### Add and configure Variables

The Service Checks in this Host Template use the following variables, and they will be added to your Opsview Monitor instance alongside the Host Template:

- [**AWS_S3_BUCKET_NAME**](#aws_s3_bucket_name)
- [**AWS_AUTHENTICATION**](#aws_authentication)
- [**AWS_CREDENTIALS_FILE**](#aws_credentials_file)
- [**AWS_CONFIG_FILE**](#aws_config_file)
- [**AWS_DIMENSIONS**](#aws_dimensions)
- [**AWS_CLOUDWATCH_ROLE_ARN**](#aws_cloudwatch_role_arn)


**Note**


For more information, refer to the documentation on [Adding Variables to Hosts](https://docs.itrsgroup.com/docs/opsview/6.11.7/adding-a-new-variable/index.html#adding-a-variable-to-a-host).



### Apply Changes

Apply Changes and the system will now be monitored:

![View Output](https://docscdn.itrsgroup.com/opsview/images/opspacks-cloud-aws-output-cloud-aws-s3.png)

## Additional Information

This host template requires the **AmazonS3ReadOnlyAccess** permission to be added to your IAM user.

**Note**

For more information, refer to [How do I create an AWS access key?](https://repost.aws/knowledge-center/create-access-key).


To view the service checks that require detailed monitoring, you must enable **Request Metrics** for your S3 buckets.

**Note**

For more information, refer to [How Do I Configure Request Metrics for an S3 Bucket?](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/configure-metrics.html)


## Available Variables

### Authentication variables

This Host Template supports the following authentication variables: [**AWS_AUTHENTICATION**](#aws_authentication), [**AWS_CREDENTIALS_FILE**](#aws_credentials_file) and [**AWS_CONFIG_FILE**](#aws_config_file).
If credentials are specified in more than one of these variables, the order of precedence is [**AWS_AUTHENTICATION**](#aws_authentication), [**AWS_CREDENTIALS_FILE**](#aws_credentials_file), [**AWS_CONFIG_FILE**](#aws_config_file).
We recommend using the [**AWS_AUTHENTICATION**](#aws_authentication) variable as this will encrypt your Access Key ID and Secret Access Key.

### AWS_S3_BUCKET_NAME

| Plugin&nbsp;Parameter | Position&nbsp;in Variable | Name | Description |
|:---------------------:|:-------------------------:|:-----|:------------|
| `--bucket-name` | Value | Bucket Name | Name or ID of the S3 Bucket |

### AWS_AUTHENTICATION

This variable allows users to store the AWS Access key, Secret key encrypted and Region in Opsview.

| Plugin&nbsp;Parameter | Position&nbsp;in Variable | Name | Description |
|:---------------------:|:-------------------------:|:-----|:------------|
| `--access-key` | Arg1 | Access Key ID | Access Key for your AWS account |
| `--secret-key` | Arg2 | Secret Access Key | Secret Key for your AWS account |
| `--region-name` | Arg3 | Default Region | Default Region to use |

### AWS_CREDENTIALS_FILE


**Opsview Cloud**

 For Opsview Cloud customers, please contact [ITRS Support](https://www.itrsgroup.com/about/contact) for assistance with these steps, as they require Orchestrator access. 

This argument is **optional**, to be used if you have a credentials file in a custom location. We recommend not setting it, and relying on the default location as follows: Create your `creds` file and run as opsview user `/opt/opsview/orchestrator/bin/orchestratorimportscripts etc-plugins cloud-aws /path/to/creds` followed by an Apply Changes to set it up with the correct permissions in the default location (`/opt/opsview/monitoringscripts/etc/plugins/cloud-aws/creds`) on all Opsview collectors.

**Note**

For more information on the credentials file, refer to [Configuration and Credential Files](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html).


| Plugin&nbsp;Parameter | Position&nbsp;in Variable | Name | Description |
|:---------------------:|:-------------------------:|:-----|:------------|
| N/A (Opsview UI Only) | Value | AWS Credentials File | Path to the AWS credentials file |
| `--credentials-file` | Arg1 | AWS Credentials File | Path to the AWS credentials file |

### AWS_CONFIG_FILE


**Opsview Cloud**

 For Opsview Cloud customers, please contact [ITRS Support](https://www.itrsgroup.com/about/contact) for assistance with these steps, as they require Orchestrator access. 

This argument is **optional**, to be used if you have a config file in a custom location. We recommend not setting it, and relying on the default location as follows: Create your `config` file and run as opsview user `/opt/opsview/orchestrator/bin/orchestratorimportscripts etc-plugins cloud-aws /path/to/config` followed by an Apply Changes to set it up with the correct permissions in the default location (`/opt/opsview/monitoringscripts/etc/plugins/cloud-aws/config`) on all Opsview collectors.

**Note**

For more information on the config file, refer to [Configuration and Credential Files](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html).


| Plugin&nbsp;Parameter | Position&nbsp;in Variable | Name | Description |
|:---------------------:|:-------------------------:|:-----|:------------|
| N/A (Opsview UI Only) | Value | AWS Config File | Path to the AWS config file |
| `--config-file` | Arg1 | AWS Config File | Path to the AWS config file |

### AWS_DIMENSIONS

| Plugin&nbsp;Parameter | Position&nbsp;in Variable | Name | Description |
|:---------------------:|:-------------------------:|:-----|:------------|
| `--dimensions` | Value | AWS Dimensions | Dimensions to be used in the request |

### AWS_CLOUDWATCH_ROLE_ARN

| Plugin&nbsp;Parameter | Position&nbsp;in Variable | Name | Description |
|:---------------------:|:-------------------------:|:-----|:------------|
| `--role-arn` | Arg1 | AWS Role ARN | Role Amazon Resource Name |

## Plugin help

Plugin: `check_amazon_webservice`


**Secure Args**


This plugin uses the [Secure Args](https://docs.itrsgroup.com/docs/opsview/6.11.7/configuration/secure-arguments/index.html) feature for argument passing.



For mode-specific help, run the plugin with the `-h -m <mode>` flags. This will list the required and optional Variable Arguments for that mode.
The appropriate mode for each Service Check is listed here:

| Service&nbsp;Check&nbsp;Name | Mode |
|:-----------------------------|:-----|
| AWS - S3 - Bucket Size | `S3.BucketSize` |
| AWS - S3 - Number Of Objects | `S3.Objects` |
| AWS - S3 - All Requests | `S3.AllRequests` |
| AWS - S3 - Get Requests | `S3.GetRequests` |
| AWS - S3 - Put Requests | `S3.PutRequests` |
| AWS - S3 - Delete Requests | `S3.DeleteRequests` |
| AWS - S3 - Head Requests | `S3.HeadRequests` |
| AWS - S3 - Post Requests | `S3.PostRequests` |
| AWS - S3 - List Requests | `S3.ListRequests` |
| AWS - S3 - Bytes Downloaded | `S3.BytesDownloaded` |
| AWS - S3 - Bytes Uploaded | `S3.BytesUploaded` |
| AWS - S3 - 4xxErrors | `S3.4xxErrors` |
| AWS - S3 - 5xxErrors | `S3.5xxErrors` |
| AWS - S3 - First Byte Latency | `S3.FirstByteLatency` |
| AWS - S3 - Total Request Latency | `S3.TotalRequestLatency` |


