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 TrueSight Capacity Optimization metrics.

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

Note

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

The RDS metrics are available only when you apply Cumulative Hotfix 19 or later on Patch 1 (20.02.01) of TrueSight Capacity Optimization 20.02.

Entity relationship

The following table explains the relationship between the 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 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.

Auto Scale Group - AWS

(asg:aws)

Virtual Machine - AWS

(gm:aws)

ASG_CONTAINS_GM

The relationship is true only for the Autoscale Group with a manual scaling policy.

RDS - AWS

(rds:aws)

Not applicable

CL_CONTAINS_RDS


Business service

Virtual Machine – AWS                  

BS_CONTAINS_GM


Business service

Auto Scale Group - AWS               

BS_CONTAINS_ASG


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_NAME

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 TrueSight Capacity Optimization metrics.

Volume performance metrics

Instance and Auto Scale Group performance metrics

1 - 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

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

RDS DB instance performance metrics

TrueSight Capacity Optimization
metric 

Amazon Web Services metric

Formula

CPU_UTIL

CPUUtilization

(CPUUtilization)÷100

DB_TOTAL_FREE_SIZE1

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_LAG1

ReplicaLag

Not applicable

DB_BIN_LOG_USAGE1

BinLogDiskUsage

Not applicable

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

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*