Entities, lookup information, and metrics for AWS API ETL

This topic provides information about the entity relationship, lookup details, and mapping between the AWS metrics and the BMC Helix Continuous Optimization metrics.

You can also collect additional metrics by using this ETL. For more information, see Collecting-EC2-instance-metrics-by-using-the-CloudWatch-agent and Collecting-data-for-additional-performance-and-instance-type-configuration-metrics topics.

Important

If there are no metrics available for an entity in the AWS infrastructure, the ETL does not collect any value (including the default value as zero) for that entity.

Entity list

The AWS API ETL collects the following types of entities:

Cloud
Auto Scale Group
Virtual Machine
EBS Volume
RDS (Amazon Aurora, MySQL, MariaDB, PostgreSQL, Oracle, and Microsoft SQL Server)
Business Service

Entity relationship

The following table explains the relationship between the AWS entities.

Parent entity	Child entity	Description	Display status
Cloud - AWS (cl:aws)	Virtual Machine - AWS (gm:aws)		Visible
Cloud - AWS (cl:aws)	Auto Scale Group - AWS (asg:aws)		Visible
Virtual Machine - AWS (gm:aws)	Storage Volume - AWS (volume:aws)		Visible
Cloud - AWS (cl:aws)	Storage Volume - AWS (volume:aws)	The ETL will import volumes when one of these conditions is true: Volume is stand alone. Volume is not flagged to be destroyed after an instance deletion. Volume is related to instances that do not belong to the Auto scaling groups. Volume is related to instances that belong to the static Auto scaling group.	Visible
Auto Scale Group - AWS (asg:aws)	Virtual Machine - AWS (gm:aws)	The relationship is true only for the Autoscale Group with a manual scaling policy.	Visible
RDS - AWS (rds:aws)	Not applicable		Visible
Business service	Virtual Machine – AWS		Visible
Business service	Auto Scale Group - AWS		Visible

Lookup information

The following table explains the lookup fields for AWS entities that you can use to quickly find the required entity.

Entity type	Lookup fields
	Strong	Weak
Storage Volume - AWS	AWS_ID	Not applicable
Virtual Machine - AWS	AWS_ID	Not applicable
Cloud - AWS	AWS_NAME	Not applicable
Auto Scale Group - AWS	AWS_ARN	Not applicable
RDS - AWS	AWS_NAME	Not applicable
Business Service (svc)	APPLICATION_NAME	Not applicable

Metric mapping

The following table explains the mapping between the AWS metrics and the BMC Helix Continuous Optimization metrics.

Volume configuration metrics

BMC Helix Continuous Optimization metric	Description	Amazon Web Services metric	Formula
AVAILABILITY_ZONE	Availability Zone	AvailabilityZone
LOCATION_SITE	Location site
REGION_ID	Region ID	Region.Id
REGION_NAME	Region Name	Region.Name
ST_VOLUME_IOPS_LIMIT	Storage Volume IOPS limit	Iops
ST_VOLUME_SIZE	Storage Volume Size	Size	Size10241024*1024
ST_VOLUME_SNAPSHOT_NUM	Storage Volume Number Of Snapshots	SnapshotSet	Count(SnapshotSet)
ST_VOLUME_STATE	Storage Volume State	Status
ST_VOLUME_THROUGHPUT_LIMIT	Storage Volume Throughput limit	Throughput
ST_VOLUME_TYPE	Storage Volume Type	volumeType

Volume performance metrics

BMC Helix Continuous Optimization metric	Amazon Web Services metric	Formula
ST_VOLUME_TRANSFER_READ_BYTE_RATE	VolumeReadBytes	Sum[VolumeReadBytes]÷duration
ST_VOLUME_TRANSFER_WRITE_BYTE_RATE	VolumeWriteBytes	Sum[VolumeWriteBytes]÷duration
ST_VOLUME_TRANSFER_BYTE_RATE	Derived	(Sum[VolumeReadBytes]+Sum[VolumeWriteBytes])÷duration
ST_VOLUME_IO_READ_RATE	VolumeReadOps	Sum[VolumeReadOps]÷duration
ST_VOLUME_IO_WRITE_RATE	VolumeWriteOps	Sum[VolumeWriteOps]÷duration
ST_VOLUME_IO_RATE	Derived	(Sum[VolumeReadOps]+Sum[VolumeWriteOps])÷duration
ST_VOLUME_READ_TIME	VolumeTotalReadTime	Average(VolumeTotalReadTime)
ST_VOLUME_WRITE_TIME	VolumeTotalWriteTime	Average(VolumeTotalWriteTime)
ST_VOLUME_QUEUE_LENGTH	VolumeQueueLength	Average[VolumeQueueLength]
ST_VOLUME_IDLE_PCT	VolumeIdleTime	Sum[VolumeIdleTime]÷duration
ST_VOLUME_IOPS_LIMIT	IOPS	Not applicable
ST_VOLUME_THROUGHPUT_LIMIT	Throughput	Not applicable

Auto Scale configuration metrics

BMC Helix Continuous Optimization metric	Description	Amazon Web Services metric	Formula
AVAILABILITY_ZONE	Availability Zone	AvailabilityZones	join(AvailabilityZones.members)
INSTANCE_NUM	Instance Number	Max -> MaxSize Min -> MinSize Desired -> DesiredCapacity
LOCATION_SITE	Location site
REGION_ID	Region ID	Region.Id
REGION_NAME	Region Name	Region.Name
REQUESTED_INSTANCE_TYPE	Requested Instance Type	LaunchConfiguration.InstanceType

Instance configuration metrics

BMC Helix Continuous Optimization metric	Description	Amazon Web Services metric	Formula
AVAILABILITY_ZONE	Availability Zone	AvailabilityZone
CPU_NUM	Number of CPU cores	InstanceTypeInfo.VCpuInfo.DefaultVCpus
DISK_SIZE	Disk Size	InstanceTypeInfo.InstanceStorageInfo.TotalSizeInGB	InstanceTypeInfo.InstanceStorageInfo.TotalSizeInGB10241024*1024
INSTANCE_TENANCY	Instance Tenancy	Placement.Tenancy.Name
LOCATION_SITE	Location site
MEMBER_OF_ASG	Identify if instance is part of an Auto Scaling Group
REGION_ID	Region ID	Region.Id
REGION_NAME	Region Name	Region.Name
REQUESTED_INSTANCE_TYPE	Requested Instance Type	InstanceType
TOTAL_REAL_MEM	Real memory	InstanceTypeInfo.MemoryInfo.SizeInMiB	InstanceTypeInfo.MemoryInfo.SizeInMiB10241024
VM_LAST_STATUS	Guest Machine last known power status. Set to poweredOn if the guest machine is running, otherwise poweredOff.	State.Code

Instance and Auto Scale Group performance metrics

BMC Helix Continuous Optimization metric	Amazon Web Services metric	Formula
CPU_NUM	Not applicable	Not applicable
CPU_UTIL	CPUUtilization	Average[CPUUtilization]÷100
NET_IN_BYTE_RATE	NetworkIn	Sum[NetworkIn]÷duration
NET_OUT_BYTE_RATE	NetworkOut	Sum[NetworkOut]÷duration
NET_BIT_RATE	Derived	((NetworkOut+NetworkIn) * 8)÷duration
NET_BYTE_RATE¹	Derived	(Sum[NetworkOut]+Sum[NetworkIn])÷duration
DISK_READ_RATE	DiskReadBytes	Sum[DiskReadBytes]÷duration
DISK_WRITE_RATE	DiskWriteBytes	Sum[DiskWriteBytes]÷duration
DISK_TRANSFER_RATE	Derived	(Sum[DiskReadBytes]+Sum[DiskWriteBytes])÷duration
DISK_IO_READ_RATE	DiskReadOps	Sum[DiskReadOps]÷duration
DISK_IO_WRITE_RATE	DiskWriteOps	Sum[DiskWriteOps]/duration
DISK_IO_RATE	Derived	(Sum[DiskReadOps] +Sum[DiskWriteOps])/duration
GM_ON_NUM (Only for Autoscale)	GroupInServiceInstances	Maximum[GroupInServiceInstances]
TOTAL_REAL_MEM	Not applicable	Not applicable

¹ - Indicates metrics that are set at level 4. These metrics are imported only when the collection level of the ETL is set to ‘Extended’. For information about changing the collection level, see Amazon-Web-Services-AWS-API-Extractor.

RDS DB instance configuration metrics

BMC Helix Continuous Optimization metric	Amazon Web Services metric
AVAILABILITY_ZONE	Region and Availability Zone
DB_PRODUCT_NAME	DB instance ID
DB_NAME	DB name
DB_PRODUCT_VERSION	Engine version
DB_PRODUCT_TYPE	Engine
LOCATION_SITE	Region name
REGION_ID	Region ID
REGION_NAME	Region name

RDS DB instance performance metrics

BMC Helix Continuous Optimization metric	Amazon Web Services metric	Formula
CPU_UTIL	CPUUtilization	(CPUUtilization)÷100
DB_TOTAL_FREE_SIZE¹	FreeStorageSpace	Not applicable
DB_SESSIONS	DatabaseConnections	Not applicable
DB_READ_LATENCY	ReadLatency	Not applicable
DB_WRITE_LATENCY	WriteLatency	Not applicable
DISK_IO_READ_RATE	ReadIOPS	Not applicable
DISK_READ_RATE	ReadThroughput	Not applicable
DISK_IO_WRITE_RATE	WriteIOPS	Not applicable
DISK_WRITE_RATE	WriteThroughput	Not applicable
MEM_FREE	FreeableMemory	Not applicable
SWAP_SPACE_USED	SwapUsage	Not applicable
BYDISK_QUEUE_SIZE	DiskQueueDepth	Not applicable
DB_REPLICA_LAG¹	ReplicaLag	Not applicable
DB_BIN_LOG_USAGE¹	BinLogDiskUsage	Not applicable

1 - Indicates that the metrics are not supported in Amazon Aurora.