Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
Synopsis
- data GetInstanceMetricData = GetInstanceMetricData' {}
- newGetInstanceMetricData :: Text -> InstanceMetricName -> Natural -> UTCTime -> UTCTime -> MetricUnit -> GetInstanceMetricData
- getInstanceMetricData_instanceName :: Lens' GetInstanceMetricData Text
- getInstanceMetricData_metricName :: Lens' GetInstanceMetricData InstanceMetricName
- getInstanceMetricData_period :: Lens' GetInstanceMetricData Natural
- getInstanceMetricData_startTime :: Lens' GetInstanceMetricData UTCTime
- getInstanceMetricData_endTime :: Lens' GetInstanceMetricData UTCTime
- getInstanceMetricData_unit :: Lens' GetInstanceMetricData MetricUnit
- getInstanceMetricData_statistics :: Lens' GetInstanceMetricData [MetricStatistic]
- data GetInstanceMetricDataResponse = GetInstanceMetricDataResponse' {}
- newGetInstanceMetricDataResponse :: Int -> GetInstanceMetricDataResponse
- getInstanceMetricDataResponse_metricName :: Lens' GetInstanceMetricDataResponse (Maybe InstanceMetricName)
- getInstanceMetricDataResponse_metricData :: Lens' GetInstanceMetricDataResponse (Maybe [MetricDatapoint])
- getInstanceMetricDataResponse_httpStatus :: Lens' GetInstanceMetricDataResponse Int
Creating a Request
data GetInstanceMetricData Source #
See: newGetInstanceMetricData
smart constructor.
GetInstanceMetricData' | |
|
Instances
newGetInstanceMetricData Source #
:: Text | |
-> InstanceMetricName | |
-> Natural | |
-> UTCTime | |
-> UTCTime | |
-> MetricUnit | |
-> GetInstanceMetricData |
Create a value of GetInstanceMetricData
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:instanceName:GetInstanceMetricData'
, getInstanceMetricData_instanceName
- The name of the instance for which you want to get metrics data.
$sel:metricName:GetInstanceMetricData'
, getInstanceMetricData_metricName
- The metric for which you want to return information.
Valid instance metric names are listed below, along with the most useful
statistics
to include in your request, and the published unit
value.
BurstCapacityPercentage
- The percentage of CPU performance available for your instance to burst above its baseline. Your instance continuously accrues and consumes burst capacity. Burst capacity stops accruing when your instance'sBurstCapacityPercentage
reaches 100%. For more information, see Viewing instance burst capacity in Amazon Lightsail.Statistics
: The most useful statistics areMaximum
andAverage
.Unit
: The published unit isPercent
.BurstCapacityTime
- The available amount of time for your instance to burst at 100% CPU utilization. Your instance continuously accrues and consumes burst capacity. Burst capacity time stops accruing when your instance'sBurstCapacityPercentage
metric reaches 100%.Burst capacity time is consumed at the full rate only when your instance operates at 100% CPU utilization. For example, if your instance operates at 50% CPU utilization in the burstable zone for a 5-minute period, then it consumes CPU burst capacity minutes at a 50% rate in that period. Your instance consumed 2 minutes and 30 seconds of CPU burst capacity minutes in the 5-minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail.
Statistics
: The most useful statistics areMaximum
andAverage
.Unit
: The published unit isSeconds
.CPUUtilization
- The percentage of allocated compute units that are currently in use on the instance. This metric identifies the processing power to run the applications on the instance. Tools in your operating system can show a lower percentage than Lightsail when the instance is not allocated a full processor core.Statistics
: The most useful statistics areMaximum
andAverage
.Unit
: The published unit isPercent
.NetworkIn
- The number of bytes received on all network interfaces by the instance. This metric identifies the volume of incoming network traffic to the instance. The number reported is the number of bytes received during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.Statistics
: The most useful statistic isSum
.Unit
: The published unit isBytes
.NetworkOut
- The number of bytes sent out on all network interfaces by the instance. This metric identifies the volume of outgoing network traffic from the instance. The number reported is the number of bytes sent during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.Statistics
: The most useful statistic isSum
.Unit
: The published unit isBytes
.StatusCheckFailed
- Reports whether the instance passed or failed both the instance status check and the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.Statistics
: The most useful statistic isSum
.Unit
: The published unit isCount
.StatusCheckFailed_Instance
- Reports whether the instance passed or failed the instance status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.Statistics
: The most useful statistic isSum
.Unit
: The published unit isCount
.StatusCheckFailed_System
- Reports whether the instance passed or failed the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.Statistics
: The most useful statistic isSum
.Unit
: The published unit isCount
.
$sel:period:GetInstanceMetricData'
, getInstanceMetricData_period
- The granularity, in seconds, of the returned data points.
The StatusCheckFailed
, StatusCheckFailed_Instance
, and
StatusCheckFailed_System
instance metric data is available in 1-minute
(60 seconds) granularity. All other instance metric data is available in
5-minute (300 seconds) granularity.
$sel:startTime:GetInstanceMetricData'
, getInstanceMetricData_startTime
- The start time of the time period.
$sel:endTime:GetInstanceMetricData'
, getInstanceMetricData_endTime
- The end time of the time period.
$sel:unit:GetInstanceMetricData'
, getInstanceMetricData_unit
- The unit for the metric data request. Valid units depend on the metric
data being requested. For the valid units to specify with each available
metric, see the metricName
parameter.
$sel:statistics:GetInstanceMetricData'
, getInstanceMetricData_statistics
- The statistic for the metric.
The following statistics are available:
Minimum
- The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.Maximum
- The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.Sum
- All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.Average
- The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.SampleCount
- The count, or number, of data points used for the statistical calculation.
Request Lenses
getInstanceMetricData_instanceName :: Lens' GetInstanceMetricData Text Source #
The name of the instance for which you want to get metrics data.
getInstanceMetricData_metricName :: Lens' GetInstanceMetricData InstanceMetricName Source #
The metric for which you want to return information.
Valid instance metric names are listed below, along with the most useful
statistics
to include in your request, and the published unit
value.
BurstCapacityPercentage
- The percentage of CPU performance available for your instance to burst above its baseline. Your instance continuously accrues and consumes burst capacity. Burst capacity stops accruing when your instance'sBurstCapacityPercentage
reaches 100%. For more information, see Viewing instance burst capacity in Amazon Lightsail.Statistics
: The most useful statistics areMaximum
andAverage
.Unit
: The published unit isPercent
.BurstCapacityTime
- The available amount of time for your instance to burst at 100% CPU utilization. Your instance continuously accrues and consumes burst capacity. Burst capacity time stops accruing when your instance'sBurstCapacityPercentage
metric reaches 100%.Burst capacity time is consumed at the full rate only when your instance operates at 100% CPU utilization. For example, if your instance operates at 50% CPU utilization in the burstable zone for a 5-minute period, then it consumes CPU burst capacity minutes at a 50% rate in that period. Your instance consumed 2 minutes and 30 seconds of CPU burst capacity minutes in the 5-minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail.
Statistics
: The most useful statistics areMaximum
andAverage
.Unit
: The published unit isSeconds
.CPUUtilization
- The percentage of allocated compute units that are currently in use on the instance. This metric identifies the processing power to run the applications on the instance. Tools in your operating system can show a lower percentage than Lightsail when the instance is not allocated a full processor core.Statistics
: The most useful statistics areMaximum
andAverage
.Unit
: The published unit isPercent
.NetworkIn
- The number of bytes received on all network interfaces by the instance. This metric identifies the volume of incoming network traffic to the instance. The number reported is the number of bytes received during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.Statistics
: The most useful statistic isSum
.Unit
: The published unit isBytes
.NetworkOut
- The number of bytes sent out on all network interfaces by the instance. This metric identifies the volume of outgoing network traffic from the instance. The number reported is the number of bytes sent during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.Statistics
: The most useful statistic isSum
.Unit
: The published unit isBytes
.StatusCheckFailed
- Reports whether the instance passed or failed both the instance status check and the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.Statistics
: The most useful statistic isSum
.Unit
: The published unit isCount
.StatusCheckFailed_Instance
- Reports whether the instance passed or failed the instance status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.Statistics
: The most useful statistic isSum
.Unit
: The published unit isCount
.StatusCheckFailed_System
- Reports whether the instance passed or failed the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.Statistics
: The most useful statistic isSum
.Unit
: The published unit isCount
.
getInstanceMetricData_period :: Lens' GetInstanceMetricData Natural Source #
The granularity, in seconds, of the returned data points.
The StatusCheckFailed
, StatusCheckFailed_Instance
, and
StatusCheckFailed_System
instance metric data is available in 1-minute
(60 seconds) granularity. All other instance metric data is available in
5-minute (300 seconds) granularity.
getInstanceMetricData_startTime :: Lens' GetInstanceMetricData UTCTime Source #
The start time of the time period.
getInstanceMetricData_endTime :: Lens' GetInstanceMetricData UTCTime Source #
The end time of the time period.
getInstanceMetricData_unit :: Lens' GetInstanceMetricData MetricUnit Source #
The unit for the metric data request. Valid units depend on the metric
data being requested. For the valid units to specify with each available
metric, see the metricName
parameter.
getInstanceMetricData_statistics :: Lens' GetInstanceMetricData [MetricStatistic] Source #
The statistic for the metric.
The following statistics are available:
Minimum
- The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.Maximum
- The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.Sum
- All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.Average
- The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.SampleCount
- The count, or number, of data points used for the statistical calculation.
Destructuring the Response
data GetInstanceMetricDataResponse Source #
See: newGetInstanceMetricDataResponse
smart constructor.
GetInstanceMetricDataResponse' | |
|
Instances
newGetInstanceMetricDataResponse Source #
Create a value of GetInstanceMetricDataResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:metricName:GetInstanceMetricData'
, getInstanceMetricDataResponse_metricName
- The name of the metric returned.
$sel:metricData:GetInstanceMetricDataResponse'
, getInstanceMetricDataResponse_metricData
- An array of objects that describe the metric data returned.
$sel:httpStatus:GetInstanceMetricDataResponse'
, getInstanceMetricDataResponse_httpStatus
- The response's http status code.
Response Lenses
getInstanceMetricDataResponse_metricName :: Lens' GetInstanceMetricDataResponse (Maybe InstanceMetricName) Source #
The name of the metric returned.
getInstanceMetricDataResponse_metricData :: Lens' GetInstanceMetricDataResponse (Maybe [MetricDatapoint]) Source #
An array of objects that describe the metric data returned.
getInstanceMetricDataResponse_httpStatus :: Lens' GetInstanceMetricDataResponse Int Source #
The response's http status code.