Skip to content

AWS EBS(Elastic Block Store)

Collect AWS EBS (Elastic Block Store) Metrics

Configuration

Install Func

We recommend enabling hosted Func under Integration - Extensions in Guance. All prerequisites are installed automatically; continue with the script installation.

If deploying Func manually, refer to Manual Deployment of Func

Install Script

Note: Please prepare the required Amazon AK in advance (for simplicity, you can grant global read-only permissions ReadOnlyAccess)

Activate Scripts in Hosted Func

  1. Log in to the Guance console
  2. Click the 【Integration】 menu and select 【Cloud Account Management】
  3. Click 【Add Cloud Account】, select 【AWS】, and fill in the required information on the interface. If you have already configured the cloud account information before, ignore this step
  4. Click 【Test】, and if the test is successful, click 【Save】. If the test fails, please check if the relevant configuration information is correct and test again
  5. Click 【Cloud Account Management】, and you can see the added cloud account in the list. Click the corresponding cloud account to enter the details page
  6. Click 【Integration】 on the cloud account details page, find AWS EBS(Elastic Block Store) in the Not Installed list and click 【Install】 to open the installation form.

Manual Activation Script

  1. Log in to the Func console, click 【Script Market】, open the Guance script market and search for integration_aws_ebs.

  2. Click 【Install】, then enter the corresponding parameters: AWS AK ID, AK Secret, and account name.

  3. Click 【Deploy Startup Script】 to create the Startup script set and configure the corresponding startup scripts automatically.

  4. After enabling the script, open 【Management / Automatic Trigger Configuration】 to view its automatic trigger configuration. Click 【Execute】 to run it immediately without waiting for the scheduled time. After a short wait, review the task records and logs.

Verification

  1. Under 【Management / Automatic Trigger Configuration】, confirm that the task has an automatic trigger configuration. Review its task records and logs for errors.
  2. In Guance, check 【Infrastructure - Resource Catalog】 for asset information.
  3. In Guance, check 【Metrics】 for the corresponding monitoring data.

Metrics

Configure Amazon CloudWatch to collect more metrics Amazon CloudWatch Metrics Details

AWS Elastic Block Store metrics are under the aws_AWS/EBS Measurement, with the description column including the description of each metric, unit, and statistical data.

Metric Description Unit
VolumeAvgReadLatency The average time taken to complete read operations in one minute ms
VolumeAvgWriteLatency The average time taken to complete write operations in one minute ms
VolumeIOPSExceededCheck Reports whether the application has consistently attempted to drive IOPS performance exceeding the volume's provisioned IOPS performance in the last minute. This metric can be 0 (not exceeded) or 1 (exceeded) -
VolumeThroughputExceededCheck Reports whether the application has consistently attempted to increase throughput exceeding the volume's provisioned throughput performance in the last minute. This metric can be 0 (not exceeded) or 1 (exceeded) -
VolumeReadBytes Number of bytes read Bytes
VolumeWriteBytes Number of bytes written Bytes
VolumeReadOps The total number of read operations in the specified time. Read operations are counted when completed. To calculate the average read operations per second (read IOPS) for this time period, divide the total read operations by the number of seconds Count
VolumeWriteOps The total number of write operations in the specified time. Write operations are counted when completed. To calculate the average write operations per second (write IOPS) for this time period, divide the total write operations by the number of seconds Count
VolumeTotalReadTime The total number of seconds spent on all read operations in the specified time period s
VolumeIdleTime The total number of seconds in the specified time period when no read or write operations were committed s
VolumeQueueLength The number of read and write operation requests waiting to be completed in the specified time period Count
VolumeStalledIOCheck Reports whether the volume passed or failed the stalled IO check in the last minute. This metric can be 0 (passed) or 1 (failed) -
VolumeThroughputPercentage The percentage of I/O operations per second (IOPS) transferred out of the total IOPS provisioned for the Amazon EBS volume %
VolumeConsumedReadWriteOps The total number of seconds spent on all write operations in the specified time period Count
BurstBalance Provides information about the percentage of I/O credits remaining in the burst bucket (for gp2) or throughput credits (for st1 and sc1) %

Object

The collected AWS EBS (Elastic Block Store) object data structure can be seen in 「Infrastructure - Resource Catalog」

{
  "measurement": "aws_ebs",
  "tags": {
    "RegionId"                    : "vol-03c65a3b0dc5e7d91",
    "VolumeId"                    : "fs-03babd100fxxxxxxx",
    "VolumeName"                  : "Intergation",
    "VolumeType"                  : "gp3",
    "AvailabilityZone"            : "generalPurpose"
  },
  "fields": {
    "Size"                    : "80",
    "Iops"                    : "3000",
    "SseType"                 : "xxxxxx",
    "SnapshotId"              : "snap-0b8b6fee9ef5426d7",
    "State"                   : "in-use",
    "CreateTime"              : "2025/07/31 11:45:25",
    "Attachments"             : "[{json data}]",
    "Tags"                    : "[{json data}]"
  }
}

Note: The fields in tags and fields may change with subsequent updates

Feedback

Is this page helpful?