f AWS S3 Monitoring | Part of the AWS Monitoring Suite

You are here

AWS S3 Monitoring

Requires Opsview Cloud or Opsview Monitor 6.4

This Host Template is part of the Aws Monitoring Opspack

check_circle
Opsview Supported

AWS S3 Monitoring

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 Checks

Service Check Name Description Default Thresholds (Warning, 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

S3 Monitoring Usage Instructions

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

For more information, refer to How do I create an AWS access key.

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

For more information, refer to How Do I Configure Request Metrics for an S3 Bucket?

Step 1: 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.

For more information, refer to Opsview Knowledge Center - Adding Host Templates to Hosts.

Step 2: Add and configure variables required for this Host Template

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

Authentication variables

This Host Template supports the following authentication variables AWS_AUTHENTICATION, AWS_CREDENTIALS_FILE and AWS_CONFIG_FILE. If credentials are specified in more than one of these variables, the order of precedence is AWS_AUTHENTICATION, AWS_CREDENTIALS_FILE, AWS_CONFIG_FILE. We recommend using the AWS_AUTHENTICATION variable as this will encrypt your AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.

AWS_S3_BUCKET_NAME
Parameter Position 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.

Parameter Position 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

For more information on the credentials file, refer to Configuration and Credential Files

Parameter Position in Variable Name Description
--credentials-file Arg1 AWS Credentials File Path to the AWS credentials file
AWS_CONFIG_FILE

For more information on the config file, refer to Configuration and Credential Files

Parameter Position in Variable Name Description
--config-file Arg1 AWS Config File Path to the AWS config file
AWS_DIMENSIONS
Parameter Position in Variable Name Description
--dimensions Value AWS Dimensions Dimensions to be used in the request

For more information, refer to Opsview Knowledge Center - Adding Variables to Hosts.

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

Service Check 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

Step 3: Apply changes and the system will now be monitored

Opsview AWS S3 Opsack Service Checks