github.com/mackerelio/mackerel-agent-plugins@v0.89.3/mackerel-plugin-aws-ec2-ebs/README.md (about)

     1  mackerel-plugin-aws-ec2-ebs
     2  =================================
     3  
     4  AWS EC2 EBS custom metrics plugin for mackerel.io agent.
     5  
     6  ## Synopsis
     7  
     8  ```shell
     9  mackerel-plugin-aws-ec2-ebs [-instance-id=<id>] [-region=<aws-region>] [-access-key-id=<id>] [-secret-access-key=<key>] [-tempfile=<tempfile>]
    10  ```
    11  * collect data from all volumes which attached to the instance
    12  * if you run on an ec2-instance, you probably don't have to specify `-instance-id` & `-region`
    13  * if you run on an ec2-instance and the instance is associated with an appropriate IAM Role, you probably don't have to specify `-access-key-id` & `-secret-access-key`
    14  * you can set keys by environment variables: `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` (see https://github.com/aws/aws-sdk-go#configuring-credentials)
    15  
    16  ## AWS IAM Policy
    17  the credential provided manually or fetched automatically with IAM Role, should have the policy that allows actions below.
    18  
    19  * `cloudwatch:GetMetricStatistics`
    20  * `ec2:DescribeInstanceTypes`
    21  * `ec2:DescribeInstances`
    22  * `ec2:DescribeVolumes`
    23  
    24  ## Example of mackerel-agent.conf
    25  
    26  ```
    27  [plugin.metrics.aws-ec2_ebs]
    28  command = ["/path/to/mackerel-plugin-aws-ec2-ebs"]
    29  ```