AWS S3

AWS S3

Amazon S3 (Simple Storage Service) is a cloud computing web service offered by Amazon Web Services (AWS). Amazon S3 provides object storage through web services interface.

Available solutions




This template is for Zabbix version: 6.4
Also available for: 6.2

Source: https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/cloud/AWS/aws_s3_http?at=release/6.4

AWS S3 bucket by HTTP

Overview

The template to monitor AWS S3 bucket by HTTP via Zabbix that works without any external scripts. Most of the metrics are collected in one go, thanks to Zabbix bulk data collection. NOTE This template uses the GetMetricData CloudWatch API calls to list and retrieve metrics. For more information, please refer to the CloudWatch pricing page.

Additional information about metrics and used API methods:

Requirements

Zabbix version: 6.4 and higher.

Tested versions

This template has been tested on:

  • AWS S3 bucket by HTTP

Configuration

Zabbix should be configured according to the instructions in the Templates out of the box section.

Setup

The template gets AWS S3 metrics and uses the script item to make HTTP requests to the CloudWatch API.

Before using the template, you need to create an IAM policy for the Zabbix role in your AWS account with the necessary permissions.

Add the following required permissions to your Zabbix IAM policy in order to collect Amazon S3 metrics.

{
    "Version":"2012-10-17",
    "Statement":[
        {
          "Action":[
              "cloudwatch:DescribeAlarms",
              "cloudwatch:GetMetricData"
          ],
          "Effect":"Allow",
          "Resource":"*"
        }
    ]
  }

If you are using role-based authorization, set the appropriate permissions:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": "iam:PassRole",
            "Resource": "arn:aws:iam::<<--account-id-->>:role/<<--role_name-->>"
        },
        {
            "Sid": "VisualEditor1",
            "Effect": "Allow",
            "Action": [
                "cloudwatch:DescribeAlarms",
                "cloudwatch:GetMetricData"
                "ec2:AssociateIamInstanceProfile",
                "ec2:ReplaceIamInstanceProfileAssociation"
            ],
            "Resource": "*"
        }
    ]
}

To gather Request metrics, enable Requests metrics on your Amazon S3 buckets from the AWS console.

You can also define a filter for the Request metrics using a shared prefix, object tag, or access point.

Set the macros "{$AWS.AUTH_TYPE}", "{$AWS.S3.BUCKET.NAME}"

If you are using access key-based authorization, set the following macros "{$AWS.ACCESS.KEY.ID}", "{$AWS.SECRET.ACCESS.KEY}"

For more information about manage access keys, see official documentation

Also, see the Macros section for a list of macros used for LLD filters.

Additional information about metrics and used API methods:

Macros used

Name Description Default
{$AWS.PROXY}

Sets HTTP proxy value. If this macro is empty then no proxy is used.
{$AWS.ACCESS.KEY.ID}

Access key ID.
{$AWS.SECRET.ACCESS.KEY}

Secret access key.
{$AWS.AUTH_TYPE}

Authorization method. Possible values: role_base, access_key.

 access_key
{$AWS.S3.BUCKET.NAME}

S3 bucket name.
{$AWS.S3.LLD.FILTER.ALARM_NAME.MATCHES}

Filter of discoverable alarms by name.

 .*
{$AWS.S3.LLD.FILTER.ALARM_NAME.NOT_MATCHES}

Filter to exclude discovered alarms by name.

 CHANGE_IF_NEEDED
{$AWS.S3.LLD.FILTER.ID.NAME.MATCHES}

Filter of discoverable request metrics by filter ID name.

 .*
{$AWS.S3.LLD.FILTER.ID.NAME.NOT_MATCHES}

Filter to exclude discovered request metrics by filter ID name.

 CHANGE_IF_NEEDED
{$AWS.S3.UPDATE.INTERVAL}

Interval in seconds for getting request metrics. Used in the metric configuration and in the JavaScript API query. Must be between 1 and 86400 seconds.

 1800

Items

Name Description Type Key and additional info
AWS S3: Get metrics data

Get bucket metrics.

Full metrics list related to S3: https://docs.aws.amazon.com/AmazonS3/latest/userguide/metrics-dimensions.html

 Script aws.s3.get_metrics

Preprocessing

  • Check for not supported value

    ⛔️Custom on fail: Discard value
AWS S3: Get alarms data

Get alarms data.

DescribeAlarms API method: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html

 Script aws.s3.get_alarms

Preprocessing

  • Check for not supported value

    ⛔️Custom on fail: Discard value
AWS S3: Get metrics check

Data collection check.

 Dependent item aws.s3.metrics.check

Preprocessing

  • JSON Path: $.error

    ⛔️Custom on fail: Set value to

  • Discard unchanged with heartbeat: 3h
AWS S3: Get alarms check

Data collection check.

 Dependent item aws.s3.alarms.check

Preprocessing

  • JSON Path: $.error

    ⛔️Custom on fail: Set value to

  • Discard unchanged with heartbeat: 3h
AWS S3: Bucket Size

This is a daily metric for the bucket.

The amount of data in bytes stored in a bucket in the STANDARD storage class, INTELLIGENT_TIERING storage class, Standard-Infrequent Access (STANDARD_IA) storage class, OneZone-Infrequent Access (ONEZONE_IA), Reduced Redundancy Storage (RRS) class, S3 Glacier Instant Retrieval storage class, Deep Archive Storage (S3 Glacier Deep Archive) class, or S3 Glacier Flexible Retrieval (GLACIER) storage class.

This value is calculated by summing the size of all objects and metadata in the bucket (both current and noncurrent objects), including the size of all parts for all incomplete multipart uploads to the bucket.

 Dependent item aws.s3.bucket_size_bytes

Preprocessing

  • JSON Path: The text is too long. Please see the template.

    ⛔️Custom on fail: Discard value
AWS S3: Number of objects

This is a daily metric for the bucket.

The total number of objects stored in a bucket for all storage classes.

This value is calculated by counting all objects in the bucket (both current and noncurrent objects) and the total number of parts for all incomplete multipart uploads to the bucket.

 Dependent item aws.s3.number_of_objects

Preprocessing

  • JSON Path: The text is too long. Please see the template.

    ⛔️Custom on fail: Discard value

Triggers

Name Description Expression Severity Dependencies and additional info
AWS S3: Failed to get metrics data length(last(/AWS S3 bucket by HTTP/aws.s3.metrics.check))>0 Warning
AWS S3: Failed to get alarms data length(last(/AWS S3 bucket by HTTP/aws.s3.alarms.check))>0 Warning

LLD rule Bucket Alarms discovery

Name Description Type Key and additional info
Bucket Alarms discovery

Discovery of bucket alarms.

 Dependent item aws.s3.alarms.discovery

Preprocessing

  • JavaScript: The text is too long. Please see the template.

  • Discard unchanged with heartbeat: 3h

Item prototypes for Bucket Alarms discovery

Name Description Type Key and additional info
AWS S3 Alarms: [{#ALARM_NAME}]: State reason

An explanation for the alarm state, in text format.

Alarm description:

{#ALARM_DESCRIPTION}

 Dependent item aws.s3.alarm.state_reason["{#ALARM_NAME}"]

Preprocessing

  • JSON Path: $.[?(@.AlarmName == "{#ALARM_NAME}")].StateReason.first()

    ⛔️Custom on fail: Discard value

  • Discard unchanged with heartbeat: 3h
AWS S3 Alarms: [{#ALARM_NAME}]: State

The state value for the alarm. Possible values: 0 (OK), 1 (INSUFFICIENT_DATA), 2 (ALARM).

Alarm description:

{#ALARM_DESCRIPTION}

 Dependent item aws.s3.alarm.state["{#ALARM_NAME}"]

Preprocessing

  • JSON Path: $.[?(@.AlarmName == "{#ALARM_NAME}")].StateValue.first()

    ⛔️Custom on fail: Set value to: 3

  • JavaScript: The text is too long. Please see the template.

Trigger prototypes for Bucket Alarms discovery

Name Description Expression Severity Dependencies and additional info
AWS S3 Alarms: [{#ALARM_NAME}] has 'Alarm' state

Alarm "{#ALARM_NAME}" has 'Alarm' state.
Reason: {ITEM.LASTVALUE2}

 last(/AWS S3 bucket by HTTP/aws.s3.alarm.state["{#ALARM_NAME}"])=2 and length(last(/AWS S3 bucket by HTTP/aws.s3.alarm.state_reason["{#ALARM_NAME}"]))>0 Average
AWS S3 Alarms: [{#ALARM_NAME}] has 'Insufficient data' state last(/AWS S3 bucket by HTTP/aws.s3.alarm.state["{#ALARM_NAME}"])=1 Info

LLD rule Request Metrics discovery

Name Description Type Key and additional info
Request Metrics discovery

Discovery of request metrics.

 Dependent item aws.s3.configuration.discovery

Preprocessing

  • JSON Path: $.filter_id

  • Discard unchanged with heartbeat: 3h

Item prototypes for Request Metrics discovery

Name Description Type Key and additional info
AWS S3: Filter [{#AWS.S3.FILTER.ID.NAME}]: Get request metrics

Get bucket request metrics filter: '{#AWS.S3.FILTER.ID.NAME}'.

Full metrics list related to S3: https://docs.aws.amazon.com/AmazonS3/latest/userguide/metrics-dimensions.html

 Script aws.s3.get_metrics["{#AWS.S3.FILTER.ID.NAME}"]

Preprocessing

  • Check for not supported value

    ⛔️Custom on fail: Discard value
AWS S3: Filter [{#AWS.S3.FILTER.ID.NAME}]: Requests: All

The total number of HTTP requests made to an Amazon S3 bucket, regardless of type.

If you're using a metrics configuration with a filter, then this metric only returns the HTTP requests that meet the filter's requirements.

 Dependent item aws.s3.all_requests["{#AWS.S3.FILTER.ID.NAME}"]

Preprocessing

  • JSON Path: $.[?(@.Label == "AllRequests")].Values.first().first()

    ⛔️Custom on fail: Discard value
AWS S3: Filter [{#AWS.S3.FILTER.ID.NAME}]: Requests: Get

The number of HTTP GET requests made for objects in an Amazon S3 bucket. This doesn't include list operations.

Paginated list-oriented requests, like List Multipart Uploads, List Parts, Get Bucket Object versions, and others, are not included in this metric.

 Dependent item aws.s3.get_requests["{#AWS.S3.FILTER.ID.NAME}"]

Preprocessing

  • JSON Path: $.[?(@.Label == "GetRequests")].Values.first().first()

    ⛔️Custom on fail: Discard value
AWS S3: Filter [{#AWS.S3.FILTER.ID.NAME}]: Requests: Put

The number of HTTP PUT requests made for objects in an Amazon S3 bucket.

 Dependent item aws.s3.put_requests["{#AWS.S3.FILTER.ID.NAME}"]

Preprocessing

  • JSON Path: $.[?(@.Label == "PutRequests")].Values.first().first()

    ⛔️Custom on fail: Discard value
AWS S3: Filter [{#AWS.S3.FILTER.ID.NAME}]: Requests: Delete

The number of HTTP DELETE requests made for objects in an Amazon S3 bucket.

This also includes Delete Multiple Objects requests. This metric shows the number of requests, not the number of objects deleted.

 Dependent item aws.s3.delete_requests["{#AWS.S3.FILTER.ID.NAME}"]

Preprocessing

  • JSON Path: $.[?(@.Label == "DeleteRequests")].Values.first().first()

    ⛔️Custom on fail: Discard value
AWS S3: Filter [{#AWS.S3.FILTER.ID.NAME}]: Requests: Head

The number of HTTP HEAD requests made to an Amazon S3 bucket.

 Dependent item aws.s3.head_requests["{#AWS.S3.FILTER.ID.NAME}"]

Preprocessing

  • JSON Path: $.[?(@.Label == "HeadRequests")].Values.first().first()

    ⛔️Custom on fail: Discard value
AWS S3: Filter [{#AWS.S3.FILTER.ID.NAME}]: Requests: Post

The number of HTTP POST requests made to an Amazon S3 bucket.

Delete Multiple Objects and SELECT Object Content requests are not included in this metric.

 Dependent item aws.s3.post_requests["{#AWS.S3.FILTER.ID.NAME}"]

Preprocessing

  • JSON Path: $.[?(@.Label == "PostRequests")].Values.first().first()

    ⛔️Custom on fail: Discard value
AWS S3: Filter [{#AWS.S3.FILTER.ID.NAME}]: Requests: Select

The number of Amazon S3 SELECT Object Content requests made for objects in an Amazon S3 bucket.

 Dependent item aws.s3.select_requests["{#AWS.S3.FILTER.ID.NAME}"]

Preprocessing

  • JSON Path: $.[?(@.Label == "SelectRequests")].Values.first().first()

    ⛔️Custom on fail: Discard value
AWS S3: Filter [{#AWS.S3.FILTER.ID.NAME}]: Requests: Select, bytes scanned

The number of bytes of data scanned with Amazon S3 SELECT Object Content requests in an Amazon S3 bucket.

Statistic: Average (bytes per request).

 Dependent item aws.s3.select_bytes_scanned["{#AWS.S3.FILTER.ID.NAME}"]

Preprocessing

  • JSON Path: The text is too long. Please see the template.

    ⛔️Custom on fail: Discard value
AWS S3: Filter [{#AWS.S3.FILTER.ID.NAME}]: Requests: Select, bytes returned

The number of bytes of data returned with Amazon S3 SELECT Object Content requests in an Amazon S3 bucket.

Statistic: Average (bytes per request).

 Dependent item aws.s3.select_bytes_returned["{#AWS.S3.FILTER.ID.NAME}"]

Preprocessing

  • JSON Path: The text is too long. Please see the template.

    ⛔️Custom on fail: Discard value
AWS S3: Filter [{#AWS.S3.FILTER.ID.NAME}]: Requests: List

The number of HTTP requests that list the contents of a bucket.

 Dependent item aws.s3.list_requests["{#AWS.S3.FILTER.ID.NAME}"]

Preprocessing

  • JSON Path: $.[?(@.Label == "ListRequests")].Values.first().first()

    ⛔️Custom on fail: Discard value
AWS S3: Filter [{#AWS.S3.FILTER.ID.NAME}]: Requests: Bytes downloaded

The number of bytes downloaded for requests made to an Amazon S3 bucket, where the response includes a body.

Statistic: Average (bytes per request).

 Dependent item aws.s3.bytes_downloaded["{#AWS.S3.FILTER.ID.NAME}"]

Preprocessing

  • JSON Path: $.[?(@.Label == "BytesDownloaded")].Values.first().first()

    ⛔️Custom on fail: Discard value
AWS S3: Filter [{#AWS.S3.FILTER.ID.NAME}]: Requests: Bytes uploaded

The number of bytes uploaded that contain a request body, made to an Amazon S3 bucket.

Statistic: Average (bytes per request).

 Dependent item aws.s3.bytes_uploaded["{#AWS.S3.FILTER.ID.NAME}"]

Preprocessing

  • JSON Path: $.[?(@.Label == "BytesUploaded")].Values.first().first()

    ⛔️Custom on fail: Discard value
AWS S3: Filter [{#AWS.S3.FILTER.ID.NAME}]: Requests: Errors, 4xx

The number of HTTP 4xx client error status code requests made to an Amazon S3 bucket with a value of either 0 or 1.

The average statistic shows the error rate, and the sum statistic shows the count of that type of error, during each period.

Statistic: Average (reports per request).

 Dependent item aws.s3.4xx_errors["{#AWS.S3.FILTER.ID.NAME}"]

Preprocessing

  • JSON Path: $.[?(@.Label == "4xxErrors")].Values.first().first()

    ⛔️Custom on fail: Discard value
AWS S3: Filter [{#AWS.S3.FILTER.ID.NAME}]: Requests: Errors, 5xx

The number of HTTP 5xx server error status code requests made to an Amazon S3 bucket with a value of either 0 or 1.

The average statistic shows the error rate, and the sum statistic shows the count of that type of error, during each period.

Statistic: Average (reports per request).

 Dependent item aws.s3.5xx_errors["{#AWS.S3.FILTER.ID.NAME}"]

Preprocessing

  • JSON Path: $.[?(@.Label == "5xxErrors")].Values.first().first()

    ⛔️Custom on fail: Discard value
AWS S3: Filter [{#AWS.S3.FILTER.ID.NAME}]: First byte latency, avg

The per-request time from the complete request being received by an Amazon S3 bucket to when the response starts to be returned.

Statistic: Average.

 Dependent item aws.s3.first_byte_latency.avg["{#AWS.S3.FILTER.ID.NAME}"]

Preprocessing

  • JSON Path: $.[?(@.Label == "FirstByteLatency")].Values.first().first()

    ⛔️Custom on fail: Discard value
AWS S3: Filter [{#AWS.S3.FILTER.ID.NAME}]: First byte latency, p90

The per-request time from the complete request being received by an Amazon S3 bucket to when the response starts to be returned.

Statistic: 90th percentile.

 Dependent item aws.s3.first_byte_latency.p90["{#AWS.S3.FILTER.ID.NAME}"]

Preprocessing

  • JSON Path: $.[?(@.Label == "FirstByteLatency")].Values.first().first()

    ⛔️Custom on fail: Discard value
AWS S3: Filter [{#AWS.S3.FILTER.ID.NAME}]: Total request latency, avg

The elapsed per-request time from the first byte received to the last byte sent to an Amazon S3 bucket.

This includes the time taken to receive the request body and send the response body, which is not included in FirstByteLatency.

Statistic: Average.

 Dependent item aws.s3.total_request_latency.avg["{#AWS.S3.FILTER.ID.NAME}"]

Preprocessing

  • JSON Path: The text is too long. Please see the template.

    ⛔️Custom on fail: Discard value
AWS S3: Filter [{#AWS.S3.FILTER.ID.NAME}]: Total request latency, p90

The elapsed per-request time from the first byte received to the last byte sent to an Amazon S3 bucket.

This includes the time taken to receive the request body and send the response body, which is not included in FirstByteLatency.

Statistic: 90th percentile.

 Dependent item aws.s3.total_request_latency.p90["{#AWS.S3.FILTER.ID.NAME}"]

Preprocessing

  • JSON Path: The text is too long. Please see the template.

    ⛔️Custom on fail: Discard value
AWS S3: Filter [{#AWS.S3.FILTER.ID.NAME}]: Replication: Latency

The maximum number of seconds by which the replication destination region is behind the source Region for a given replication rule.

 Dependent item aws.s3.replication_latency["{#AWS.S3.FILTER.ID.NAME}"]

Preprocessing

  • JSON Path: The text is too long. Please see the template.

    ⛔️Custom on fail: Discard value
AWS S3: Filter [{#AWS.S3.FILTER.ID.NAME}]: Replication: Bytes pending

The total number of bytes of objects pending replication for a given replication rule.

 Dependent item aws.s3.bytes_pending_replication["{#AWS.S3.FILTER.ID.NAME}"]

Preprocessing

  • JSON Path: The text is too long. Please see the template.

    ⛔️Custom on fail: Discard value
AWS S3: Filter [{#AWS.S3.FILTER.ID.NAME}]: Replication: Operations pending

The number of operations pending replication for a given replication rule.

 Dependent item aws.s3.operations_pending_replication["{#AWS.S3.FILTER.ID.NAME}"]

Preprocessing

  • JSON Path: The text is too long. Please see the template.

    ⛔️Custom on fail: Discard value

Feedback

Please report any issues with the template at https://support.zabbix.com

You can also provide feedback, discuss the template, or ask for help at ZABBIX forums

Articles and documentation

+ Propose new article

Media

Didn't find integration you need?

Request custom integration

Zabbix integration team will develop custom integration based on your requirements and Zabbix best practices.

Request

Propose your integration

Have you already developed high quality integration and want to submit to Zabbix integration repository?

Propose