mackerel-plugin-aws-s3-requests

mackerel-plugin-aws-s3-requests

AWS S3 requests metrics plugin for mackerel.io agent.

Requirement

You need a metrics configuration FilterID for the target S3 bucket to get CloudWatch metrics. If you haven't created any configurations yet, you can create by AWS CLI or AWS API. (ref: https://docs.aws.amazon.com/AmazonS3/latest/dev/metrics-configurations.html)

Synopsis

mackerel-plugin-aws-s3-requests -bucket-name=<bucket-name> -filter-id=<filter-id> -region=<aws-region> -access-key-id=<id> -secret-access-key=<key> [-metric-key-prefix=<prefix>] [-metric-label-prefix=<prefix>]

• filter-id is the id for the metrics configuration, described in "Requirement" section.
• you can set some parameters by environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION.
  • If both of those environment variables and command line parameters are passed, command line parameters are used.
• You may omit region parameter if you're running this plugin on an EC2 instance running in same region with the target bucket.

Example of mackerel-agent.conf

[plugin.metrics.aws-s3-requests]
command = "mackerel-plugin-aws-s3-requests -bucket-name=MyBucket -filter-id=SomeFilterId -region=ap-northeast-1"

List of Metrics

You can customize graph labels and metric names by command line parameters -metric-label-prefix and -metric-key-prefix.