You are here

Integrations

AWS - S3 CloudWatch

Download version    6.0    5.x

Included in Opsview Monitor 5.x
Included in Opsview Monitor 6.0
check_circle
Opsview Supported

AWS - S3 CloudWatch Opspack

Amazon Simple Storage Service is storage for the Internet. It is designed to make web-scale computing easier for developers. Amazon S3 has a simple web services interface that you can use to store and retrieve any amount of data, at any time, from anywhere on the web. It gives any developer access to the same highly scalable, reliable, fast, inexpensive data storage infrastructure that Amazon uses to run its own global network of web sites. The service aims to maximize benefits of scale and to pass those benefits on to developers.

What Can You Monitor

Opsview Monitor's AWS S3 Opspack provides all of the latest metrics to track your S3 buckets. Service checks included in the Opspack allow for tracking of GET and PUT requests across each bucket. S3 Request metrics can help you easily identify operational issues.

Service Checks

Service Check Description
AWS/S3.BucketSizeBytes The amount of data in bytes stored in a bucket in the standard storage class
AWS/S3.NumberOfObjects The total number of objects stored in a bucket for all storage classes except for the GLACIER storage class
AWS/S3.AllRequests The total number of HTTP requests made to a bucket
AWS/S3.GetRequests The number of HTTP GET requests made for objects in a bucket
AWS/S3.PutRequests The number of HTTP PUT requests made for objects in a bucket
AWS/S3.DeleteRequests The number of HTTP DELETE requests made for objects in a bucket
AWS/S3.HeadRequests The number of HTTP HEAD requests made to a bucket
AWS/S3.PostRequests The number of HTTP POST requests made to a bucket
AWS/S3.ListRequests The number of HTTP requests that list the contents of a bucket
AWS/S3.BytesDownloaded The number bytes downloaded for requests made to a bucket, where the response includes a body
AWS/S3.BytesUploaded The number bytes uploaded to a bucket that contain a request body
AWS/S3.4xxErrors The number of HTTP 4xx client error status code requests made to a bucket
AWS/S3.5xxErrors The number of HTTP 5xx client error status code requests made to a bucket
AWS/S3.FirstByteLatency The per-request time from the complete request being received by a bucket to when the response starts to be returned
AWS/S3.TotalRequestLatency The elapsed per-request time from the first byte received to the last byte sent to a bucket

AWS - S3 CloudWatch Opspack

Amazon Simple Storage Service is storage for the Internet. It is designed to make web-scale computing easier for developers. Amazon S3 has a simple web services interface that you can use to store and retrieve any amount of data, at any time, from anywhere on the web. It gives any developer access to the same highly scalable, reliable, fast, inexpensive data storage infrastructure that Amazon uses to run its own global network of web sites. The service aims to maximize benefits of scale and to pass those benefits on to developers.

What Can You Monitor

Opsview Monitor's AWS S3 Opspack provides all of the latest metrics to track your S3 buckets. Service checks included in the Opspack allow for tracking of GET and PUT requests across each bucket. S3 Request metrics can help you easily identify operational issues.

Note: This Opspack knows when it was last run, so when testing the results in the troubleshoot section, you will need to wait a couple minutes each time you recheck the results. The time frame that is searched for is based around the last time the Opspack ran, so running it too quickly will result in no data being found and the service check going into an unknown

Service Checks

Service Check Description
AWS/S3.BucketSizeBytes The amount of data in bytes stored in a bucket in the standard storage class
AWS/S3.NumberOfObjects The total number of objects stored in a bucket for all storage classes except for the GLACIER storage class
AWS/S3.AllRequests The total number of HTTP requests made to a bucket
AWS/S3.GetRequests The number of HTTP GET requests made for objects in a bucket
AWS/S3.PutRequests The number of HTTP PUT requests made for objects in a bucket
AWS/S3.DeleteRequests The number of HTTP DELETE requests made for objects in a bucket
AWS/S3.HeadRequests The number of HTTP HEAD requests made to a bucket
AWS/S3.PostRequests The number of HTTP POST requests made to a bucket
AWS/S3.ListRequests The number of HTTP requests that list the contents of a bucket
AWS/S3.BytesDownloaded The number bytes downloaded for requests made to a bucket, where the response includes a body
AWS/S3.BytesUploaded The number bytes uploaded to a bucket that contain a request body
AWS/S3.4xxErrors The number of HTTP 4xx client error status code requests made to a bucket
AWS/S3.5xxErrors The number of HTTP 5xx client error status code requests made to a bucket
AWS/S3.FirstByteLatency The per-request time from the complete request being received by a bucket to when the response starts to be returned
AWS/S3.TotalRequestLatency The elapsed per-request time from the first byte received to the last byte sent to a bucket

Notes

This Opspack knows when it was last run, so when testing the results in the troubleshoot section, you will need to wait a couple minutes each time you recheck the results. The time frame that is searched for is based around the last time the Opspack ran, so running it too quickly will result in no data being found and the service check going into an unknown.

Prerequisites

There are two ways of adding your authentication credentials to the host. We recommend adding the access key and secret key directly using the variable 'AWS_CLOUDWATCH_AUTHENTICATION'. You can also add the access key and secret key to a file (default /usr/local/nagios/etc/aws_credentials.cfg) in the following format:

[default]
aws_access_key_id = "Your Access Key Id"
aws_secret_access_key = "Your Secret Key Id"

Setup and Configuration

Step 1: Add the host template and the 'Cloud - AWS - S3 CloudWatch' Opspack to the host running the S3 software.

Add host template

Step 2: Add and configure the host Variables tab. Add in 'AWS_CLOUDWATCH_AUTHENTICATION' with either the file location or the access key and secret key depending on your preferred way of supplying the access credential. Add the region you hosted in, then add and configure the AWS_S3_BUCKET_NAME' by adding the name of the bucket.

Add variable

Step 3: Reload and view the S3 statistics

View output

Prerequisites

To be able to monitor AWS CloudWatch services you need to add your AWS credentials to your Opsview Monitor server.

We recommend adding your AWS Access Key ID and AWS Secret Key ID to the default location:

/opt/opsview/monitoringscripts/etc/plugins/cloud-aws/aws_credentials.cfg

This credentials file should be in the following format:

[default]
aws_access_key_id = "Your Access Key Id"
aws_secret_access_key = "Your Secret Key Id"

If you are not using the default path, you will then need to assign your path to the variable: AWS_CLOUDWATCH_AUTHENTICATION.

Setup and Configuration

To configure and utilize this Opspack, you need to add the 'Cloud - AWS - S3 CloudWatch' Opspack to your Opsview Monitor system

Step 1: Add the host template

Add host template

Step 2: Add and configure the variables for the host

  • AWS_CLOUDWATCH_AUTHENTICATION - Contains either the file location created earlier (recommended method) or add the Access Key and Secret Key directly to this variable's values.

  • Override the Region value if you are not using the default

Add credentials variable

  • AWS_S3_BUCKET_NAME - Bucket Name from S3 you want to monitor

Add S3 Bucket variable

Step 3: Reload and view the S3 statistics

View output

v1.0-opsview-5

ODI-309 - AWS Cloudwatch Opspacks

Initial release for AWS Cloudwatch Opspacks

v2.0-opsview-6

ODI-1154 Release Opspacks for Opsview Monitor 6.0

Initial release of Opspack to work with Opsview Monitor 6.0