Collecting additional AWS data for custom metrics and instance types

This topic describes steps and examples to collect additional metrics with the Amazon Web Services - AWS API Extractor.

Collecting data for additional instance type configuration metrics

An out-of-the-box JSON file contains the mapping for configuration metrics collected by the Amazon Web Services - AWS API Extractor. This file is stored on the ETL Engine server. This ETL provides a feature that allows you to configure the collection of data for additional instance type configuration metrics or modify the existing collection configuration.

Follow the procedure given below to upload a JSON file for collecting additional instance type configuration metrics:

  1. Download the attached file and update it.
  2. Update the file for existing and additional metrics.
  3. Use the version parameter to add the current date (yyyymmdd format) to the JSON file.

    Info

    This parameter is used to determine the most recently updated file, which is then used by the AWS API Extractor.

  4. Save the JSON file to your local machine. For example, aws-metric-conf.json.
  5. Upload the file to a folder on the ETL engine server.
  6. Click Advanced and navigate to the Amazon Web Services Connection tab.
  7. Type the file path in Instance type definition JSON file path.
  8. Click Save.

Tip

  • If you need to collect additional metrics (in addition to the existing configuration), navigate to the path specified in Step 7 and download the latest JSON file. You must update this file, and upload the consolidated version to the same location. Update the version parameter with the current date.
  • Use the JSON format code block below to specify additional instance type configuration metrics for which you want to collect additional configuration information.


Collecting configuration information
{
	"version": "20150130",
	"instanceTypeConfiguration" :{
		"m3.medium" :{
			"CPU_NUM"		: "1",
			"TOTAL_REAL_MEM": "4026531840",
			"CPU_MHZ"		: "2500",
			"CPU_MODEL"		: "Intel Xeon E5-2670 v2",
			"DISK_SIZE" 	: "4000000000"
		},   
		"AWS_INSTANCE_TYPE_NAME" :{                  
			"CO_METRIC_NAME_1" : "VALUE",
			"CO_METRIC_NAME_2" :{
				"CO_METRIC_SUBRESOURCE_2" : "VALUE"
			}
		}
	}
}

Collecting data for additional CloudWatch metrics

An out-of-the-box JSON file contains the mapping for CloudWatch metrics collected by the Amazon Web Services - AWS API Extractor. This file is stored on the ETL Engine server. This ETL provides a feature that allows you to configure the collection of data for additional CloudWatch metrics.

To collect data for additional CouldWatch metrics, you must create a performance JSON file. Follow the procedure given below to create and upload a JSON file for collecting additional CloudWatch metrics:

  1. Create and save a JSON file using the sample code provided below. For example, aws-metric-perf.json.
  2. Upload the file to a folder on the ETL engine server.
  3. Click Advanced and navigate to the Amazon Web Services Connection tab.
  4. Type the file path in Additional CloudWatch metrics JSON file path.
  5. Click Save.

Tip

Use the JSON code below to specify additional Amazon CouldWatch metrics for which you want to collect performance information.

Collecting performance information
{
    "systemTypeMap" :
	//Amazon Web Services to  TrueSight Capacity Optimization
	// entity type mapping
	{ 
		"gm:aws"		: "EC2 Instance",
        "asg:aws"		: "Auto Scaling group",
         "volume:aws"	: "EBS Volume"
	},
	"typeConfiguration": [
	{
		"entypenm" : "gm:aws|asg:aws",
		//Metrics for "Instance" or "Autoscale group"
		"mapping"  : [
		//Mapping definition
			{
				"targetMetric"	: "NET_IN_BYTE_RATE",
				// TrueSight Capacity Optimization metric
				"formula"    	: "(NetworkIn)/period",
				//Formula to compute the above metric using the CloudWatch metric
				"sourceMeters"	:	[{
				//Method used for collecting the value from CloudWatch
					"awsMetric"    : "NetworkIn",
					//Amazon Web Services CloudWatch metric
					"statistic"    : "Sum"
					//This can be Average, Sum, SampleCount, Minimum, or Maximum
									}]
			},
			
			{
			//Additional metric mappings
			}
	}
	{
		"entypenm" : "volume:aws",
		//Metrics for "EBS Volume"
		"mapping"  : [
			{
				"targetMetric"	: "ST_VOLUME_TRANSFER_READ_BYTE_RATE",
				"formula"    	:"(VolumeReadBytes)/duration",
				"sourceMeters"	:	[{
					"awsMetric"    : "VolumeReadBytes",
					"statistic"    : "Sum",
									}]
			},
			{
                "targetMetric"	:"BYFS_USED_SPACE_PCT",
                "formula"		:"(DiskSpaceUtilization)/100",
                "sourceMeters"	:[{
                "awsMetric"		:"DiskSpaceUtilization",
				"statistic"		:"Average",
				"dimesionForSubObject"	:"Filesystem",
				"namespace"		: "System/Linux"
                }]
			},
			{
			//Additional metric mappings
			}
	}

						]
}
Was this page helpful? Yes No Submitting... Thank you

Comments