Skip to content

AWS Elastic Block Store

Collect AWS Elastic Block Store Metrics

Configuration

Install Func

It is recommended to activate the TrueWatch Integration - Extensions - DataFlux Func (Automata): All prerequisites are automatically installed. Please proceed with the script installation.

If you are deploying Func manually, refer to Manual Deployment of Func

Install Script

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

Activate Script for DataFlux Func (Automata)

  1. Log in to the TrueWatch console
  2. Click on the 【Integration】 menu, select 【Cloud Account Management】
  3. Click on 【Add Cloud Account】, select 【AWS】, and fill in the required information on the interface. If you have already configured the cloud account information before, you can skip this step
  4. Click on 【Test】, and after the test is successful, click on 【Save】. If the test fails, please check the relevant configuration information and retest
  5. Click on 【Cloud Account Management】 list, you can see the added cloud account. Click on the corresponding cloud account to enter the details page
  6. Click on the 【Integration】 button on the cloud account details page, find AWS Elastic Block Store under the Not Installed list, and click on the 【Install】 button. The installation interface will pop up for installation.

Manual Activation Script

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

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

  3. Click on 【Deploy Startup Script】, the system will automatically create a Startup script set and configure the corresponding startup scripts.

  4. After activation, you can see the corresponding automatic trigger configuration in 「Manage / Automatic Trigger Configuration」. Click on 【Execute】 to execute it immediately without waiting for the scheduled time. After a while, you can check the execution task records and corresponding logs.

Verification

  1. Confirm in 「Manage / Automatic Trigger Configuration」 whether the corresponding task has the corresponding automatic trigger configuration, and you can also check the corresponding task records and logs to see if there are any exceptions
  2. In TrueWatch, check if there is asset information in 「Infrastructure - Resource Catalog」
  3. In TrueWatch, check if there is corresponding monitoring data in 「Metrics」

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) %

Objects

The collected AWS 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