Class: Aws::ComputeOptimizer::Types::UtilizationMetric

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-computeoptimizer/types.rb

Overview

Describes a utilization metric of a resource, such as an Amazon EC2 instance.

Compare the utilization metric data of your resource against its projected utilization metric data to determine the performance difference between your current resource and the recommended option.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#name ⇒ String

The name of the utilization metric.

The following utilization metrics are available:

  • ‘Cpu` - The percentage of allocated EC2 compute units that are currently in use on the instance. This metric identifies the processing power required to run an application on the instance.

    Depending on the instance type, tools in your operating system can show a lower percentage than CloudWatch when the instance is not allocated a full processor core.

    Units: Percent

  • ‘Memory` - The percentage of memory that is currently in use on the instance. This metric identifies the amount of memory required to run an application on the instance.

    Units: Percent

    <note markdown=“1”> The ‘Memory` metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see [Enabling Memory Utilization with the CloudWatch Agent].

    </note>

  • ‘GPU` - The percentage of allocated GPUs that currently run on the instance.

  • ‘GPU_MEMORY` - The percentage of total GPU memory that currently runs on the instance.

    <note markdown=“1”> The ‘GPU` and `GPU_MEMORY` metrics are only returned for resources with the unified CloudWatch Agent installed on them. For more information, see [Enabling NVIDIA GPU utilization with the CloudWatch Agent].

    </note>

  • ‘EBS_READ_OPS_PER_SECOND` - The completed read operations from all EBS volumes attached to the instance in a specified period of time.

    Unit: Count

  • ‘EBS_WRITE_OPS_PER_SECOND` - The completed write operations to all EBS volumes attached to the instance in a specified period of time.

    Unit: Count

  • ‘EBS_READ_BYTES_PER_SECOND` - The bytes read from all EBS volumes attached to the instance in a specified period of time.

    Unit: Bytes

  • ‘EBS_WRITE_BYTES_PER_SECOND` - The bytes written to all EBS volumes attached to the instance in a specified period of time.

    Unit: Bytes

  • ‘DISK_READ_OPS_PER_SECOND` - The completed read operations from all instance store volumes available to the instance in a specified period of time.

    If there are no instance store volumes, either the value is ‘0` or the metric is not reported.

  • ‘DISK_WRITE_OPS_PER_SECOND` - The completed write operations from all instance store volumes available to the instance in a specified period of time.

    If there are no instance store volumes, either the value is ‘0` or the metric is not reported.

  • ‘DISK_READ_BYTES_PER_SECOND` - The bytes read from all instance store volumes available to the instance. This metric is used to determine the volume of the data the application reads from the disk of the instance. This can be used to determine the speed of the application.

    If there are no instance store volumes, either the value is ‘0` or the metric is not reported.

  • ‘DISK_WRITE_BYTES_PER_SECOND` - The bytes written to all instance store volumes available to the instance. This metric is used to determine the volume of the data the application writes onto the disk of the instance. This can be used to determine the speed of the application.

    If there are no instance store volumes, either the value is ‘0` or the metric is not reported.

  • ‘NETWORK_IN_BYTES_PER_SECOND` - The number of bytes received by the instance on all network interfaces. This metric identifies the volume of incoming network traffic to a single instance.

  • ‘NETWORK_OUT_BYTES_PER_SECOND` - The number of bytes sent out by the instance on all network interfaces. This metric identifies the volume of outgoing network traffic from a single instance.

  • ‘NETWORK_PACKETS_IN_PER_SECOND` - The number of packets received by the instance on all network interfaces. This metric identifies the volume of incoming traffic in terms of the number of packets on a single instance.

  • ‘NETWORK_PACKETS_OUT_PER_SECOND` - The number of packets sent out by the instance on all network interfaces. This metric identifies the volume of outgoing traffic in terms of the number of packets on a single instance.

[1]: docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent [2]: docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#nvidia-cw-agent

Returns:

  • (String) 


7381
7382
7383
7384
7385
7386
7387
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 7381

class UtilizationMetric < Struct.new(
  :name,
  :statistic,
  :value)
  SENSITIVE = []
  include Aws::Structure
end

#statistic ⇒ String

The statistic of the utilization metric.

The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the ‘Maximum` statistic, which is the highest value observed during the specified period.

The Compute Optimizer console displays graphs for some utilization metrics using the ‘Average` statistic, which is the value of `Sum` / `SampleCount` during the specified period. For more information, see

Viewing resource recommendations][1

in the *Compute Optimizer User

Guide*. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the [Amazon CloudWatch User Guide].

[1]: docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html [2]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html

Returns:

  • (String) 


7381
7382
7383
7384
7385
7386
7387
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 7381

class UtilizationMetric < Struct.new(
  :name,
  :statistic,
  :value)
  SENSITIVE = []
  include Aws::Structure
end

#value ⇒ Float

The value of the utilization metric.

Returns:

  • (Float) 


7381
7382
7383
7384
7385
7386
7387
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 7381

class UtilizationMetric < Struct.new(
  :name,
  :statistic,
  :value)
  SENSITIVE = []
  include Aws::Structure
end