Entities, lookup information, and metrics for AWS API Extractor

This topic covers the following information:

Related topics

Entity list

With the extractor, you can obtain the following AWS entities:

Parent entity	Child entity	Relationship type	Description
Cloud - AWS (cl:aws)	Virtual Machine - AWS (gm:aws)	CL_CONTAINS_GM
Cloud - AWS (cl:aws)	Auto Scale Group - AWS (asg:aws)	CL_CONTAINS_ASG
Virtual Machine - AWS (gm:aws)	Storage Volume - AWS (volume:aws)	GM_USES_VOLUME
Cloud - AWS (cl:aws)	Storage Volume - AWS (volume:aws)	CL_CONTAINS_VOLUME	The ETL will import volumes when one of these conditions are true: Volume is stand alone Volume isn't flagged to be destroyed when the instance will be deleted Volume is related to an instances not involved in Auto scaling Groups Volume is related to an instances part of a static Auto scaling Group
Auto Scale Group - AWS (asg:aws)	Virtual Machine - AWS (gm:aws)	ASG_CONTAINS_GM	Only for Autoscale Group with a manual scaling policy (not dynamic)
Business service	Virtual Machine – AWS	BS_CONTAINS_GM
Business service	Auto Scale Group - AWS	BS_CONTAINS_ASG

TrueSight Capacity 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

TrueSight Capacity Optimization metric	Amazon Web Services metric	Formula
CPU_UTIL	CPUUtilization	Average[CPUUtilization]/100
NET_IN_BYTE_RATE	NetworkIn	Sum[NetworkIn]/duration
NET_OUT_BYTE_RATE	NetworkOut	Sum[NetworkOut]/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]

The metrics in the following table will be available only when the monitoring scripts for Amazon EC2 instances are executed.

To enable metrics for the EC2 Linux based instances, see Enabling metrics on Linux instances .
To enable metrics for the EC2 Windows based instances, see Enabling metrics on Windows instances .

The mapping to TrueSight Capacity Optimization metrics will work only if the unit of measure for the value is not modified.

TrueSight Capacity Optimization metric	Amazon Web Services metric	Unit of measure	Formula	System
MEM_REAL_UTIL	MemoryUtilization	Percentage	(MemoryUtilization)/100	Windows / Linux
MEM_REAL_USED	MemoryUsed	Megabyte	MemoryUsed * 1024 * 1024	Windows / Linux
SWAP_SPACE_UTIL	SwapUtilization	Percentage	(SwapUtilization)/100	Linux
SWAP_SPACE_USED	SwapUsed	Megabyte	SwapUsed * 1024 * 1024	Linux
BYFS_USED_SPACE_PCT	DiskSpaceUtilization	Percentage	(DiskSpaceUtilization)/100	Linux
BYFS_USED	DiskSpaceUsed	Gigabyte	DiskSpaceUsed * 1024 * 1024 * 1024	Linux
BYFS_FREE	DiskSpaceAvailable	Gigabyte	DiskSpaceAvailable * 1024 * 1024 * 1024	Linux
BYFS_SIZE	DiskSpaceUsed, DiskSpaceAvailable	Gigabyte	(DiskSpaceUsed + DiskSpaceAvailable) * 1024 * 1024 * 1024	Linux
TOTAL_FS_USED	NA		Sum of all BYFS_USED	Linux
TOTAL_FS_FREE	NA		Sum of all BYFS_FREE	Linux
TOTAL_FS_SIZE	NA		Sum of all (BYFS_SIZE)	Linux
TOTAL_FS_UTIL	NA		(TOTAL_FS_USED/ TOTAL_FS_SIZE)	Linux