Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Returns information about health metrics for your Lightsail load balancer.
- getLoadBalancerMetricData :: Text -> LoadBalancerMetricName -> Natural -> UTCTime -> UTCTime -> MetricUnit -> GetLoadBalancerMetricData
- data GetLoadBalancerMetricData
- glbmdLoadBalancerName :: Lens' GetLoadBalancerMetricData Text
- glbmdMetricName :: Lens' GetLoadBalancerMetricData LoadBalancerMetricName
- glbmdPeriod :: Lens' GetLoadBalancerMetricData Natural
- glbmdStartTime :: Lens' GetLoadBalancerMetricData UTCTime
- glbmdEndTime :: Lens' GetLoadBalancerMetricData UTCTime
- glbmdUnit :: Lens' GetLoadBalancerMetricData MetricUnit
- glbmdStatistics :: Lens' GetLoadBalancerMetricData [MetricStatistic]
- getLoadBalancerMetricDataResponse :: Int -> GetLoadBalancerMetricDataResponse
- data GetLoadBalancerMetricDataResponse
- glbmdrsMetricName :: Lens' GetLoadBalancerMetricDataResponse (Maybe LoadBalancerMetricName)
- glbmdrsMetricData :: Lens' GetLoadBalancerMetricDataResponse [MetricDatapoint]
- glbmdrsResponseStatus :: Lens' GetLoadBalancerMetricDataResponse Int
Creating a Request
getLoadBalancerMetricData Source #
:: Text | |
-> LoadBalancerMetricName | |
-> Natural | |
-> UTCTime | |
-> UTCTime | |
-> MetricUnit | |
-> GetLoadBalancerMetricData |
Creates a value of GetLoadBalancerMetricData
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
glbmdLoadBalancerName
- The name of the load balancer.glbmdMetricName
- The metric about which you want to return information. Valid values are listed below, along with the most usefulstatistics
to include in your request. *ClientTLSNegotiationErrorCount
- The number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols.Statistics
: The most useful statistic isSum
. *HealthyHostCount
- The number of target instances that are considered healthy.Statistics
: The most useful statistic areAverage
,Minimum
, andMaximum
. *UnhealthyHostCount
- The number of target instances that are considered unhealthy.Statistics
: The most useful statistic areAverage
,Minimum
, andMaximum
. *HTTPCode_LB_4XX_Count
- The number of HTTP 4XX client error codes that originate from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not been received by the target instance. This count does not include any response codes generated by the target instances.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
. *HTTPCode_LB_5XX_Count
- The number of HTTP 5XX server error codes that originate from the load balancer. This count does not include any response codes generated by the target instances.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
. Note thatMinimum
,Maximum
, andAverage
all return1
. *HTTPCode_Instance_2XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
. *HTTPCode_Instance_3XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
. *HTTPCode_Instance_4XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
. *HTTPCode_Instance_5XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
. *InstanceResponseTime
- The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.Statistics
: The most useful statistic isAverage
. *RejectedConnectionCount
- The number of connections that were rejected because the load balancer had reached its maximum number of connections.Statistics
: The most useful statistic isSum
. *RequestCount
- The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.glbmdPeriod
- The time period duration for your health data request.glbmdStartTime
- The start time of the period.glbmdEndTime
- The end time of the period.glbmdUnit
- The unit for the time period request. Valid values are listed below.glbmdStatistics
- An array of statistics that you want to request metrics for. Valid values are listed below. *SampleCount
- The count (number) of data points used for the statistical calculation. *Average
- The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum. This comparison helps you to know when to increase or decrease your resources as needed. *Sum
- All values submitted for the matching metric added together. This statistic can be useful for determining the total volume of a metric. *Minimum
- The lowest value observed during the specified period. You can use this value to determine low volumes of activity for your application. *Maximum
- The highest value observed during the specified period. You can use this value to determine high volumes of activity for your application.
data GetLoadBalancerMetricData Source #
See: getLoadBalancerMetricData
smart constructor.
Request Lenses
glbmdLoadBalancerName :: Lens' GetLoadBalancerMetricData Text Source #
The name of the load balancer.
glbmdMetricName :: Lens' GetLoadBalancerMetricData LoadBalancerMetricName Source #
The metric about which you want to return information. Valid values are listed below, along with the most useful statistics
to include in your request. * ClientTLSNegotiationErrorCount
- The number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols. Statistics
: The most useful statistic is Sum
. * HealthyHostCount
- The number of target instances that are considered healthy. Statistics
: The most useful statistic are Average
, Minimum
, and Maximum
. * UnhealthyHostCount
- The number of target instances that are considered unhealthy. Statistics
: The most useful statistic are Average
, Minimum
, and Maximum
. * HTTPCode_LB_4XX_Count
- The number of HTTP 4XX client error codes that originate from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not been received by the target instance. This count does not include any response codes generated by the target instances. Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
. * HTTPCode_LB_5XX_Count
- The number of HTTP 5XX server error codes that originate from the load balancer. This count does not include any response codes generated by the target instances. Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
. Note that Minimum
, Maximum
, and Average
all return 1
. * HTTPCode_Instance_2XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
. * HTTPCode_Instance_3XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
. * HTTPCode_Instance_4XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
. * HTTPCode_Instance_5XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
. * InstanceResponseTime
- The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received. Statistics
: The most useful statistic is Average
. * RejectedConnectionCount
- The number of connections that were rejected because the load balancer had reached its maximum number of connections. Statistics
: The most useful statistic is Sum
. * RequestCount
- The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer. Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
.
glbmdPeriod :: Lens' GetLoadBalancerMetricData Natural Source #
The time period duration for your health data request.
glbmdStartTime :: Lens' GetLoadBalancerMetricData UTCTime Source #
The start time of the period.
glbmdEndTime :: Lens' GetLoadBalancerMetricData UTCTime Source #
The end time of the period.
glbmdUnit :: Lens' GetLoadBalancerMetricData MetricUnit Source #
The unit for the time period request. Valid values are listed below.
glbmdStatistics :: Lens' GetLoadBalancerMetricData [MetricStatistic] Source #
An array of statistics that you want to request metrics for. Valid values are listed below. * SampleCount
- The count (number) of data points used for the statistical calculation. * Average
- The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum. This comparison helps you to know when to increase or decrease your resources as needed. * Sum
- All values submitted for the matching metric added together. This statistic can be useful for determining the total volume of a metric. * Minimum
- The lowest value observed during the specified period. You can use this value to determine low volumes of activity for your application. * Maximum
- The highest value observed during the specified period. You can use this value to determine high volumes of activity for your application.
Destructuring the Response
getLoadBalancerMetricDataResponse Source #
Creates a value of GetLoadBalancerMetricDataResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
glbmdrsMetricName
- The metric about which you are receiving information. Valid values are listed below, along with the most usefulstatistics
to include in your request. *ClientTLSNegotiationErrorCount
- The number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols.Statistics
: The most useful statistic isSum
. *HealthyHostCount
- The number of target instances that are considered healthy.Statistics
: The most useful statistic areAverage
,Minimum
, andMaximum
. *UnhealthyHostCount
- The number of target instances that are considered unhealthy.Statistics
: The most useful statistic areAverage
,Minimum
, andMaximum
. *HTTPCode_LB_4XX_Count
- The number of HTTP 4XX client error codes that originate from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not been received by the target instance. This count does not include any response codes generated by the target instances.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
. *HTTPCode_LB_5XX_Count
- The number of HTTP 5XX server error codes that originate from the load balancer. This count does not include any response codes generated by the target instances.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
. Note thatMinimum
,Maximum
, andAverage
all return1
. *HTTPCode_Instance_2XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
. *HTTPCode_Instance_3XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
. *HTTPCode_Instance_4XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
. *HTTPCode_Instance_5XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
. *InstanceResponseTime
- The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.Statistics
: The most useful statistic isAverage
. *RejectedConnectionCount
- The number of connections that were rejected because the load balancer had reached its maximum number of connections.Statistics
: The most useful statistic isSum
. *RequestCount
- The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.glbmdrsMetricData
- An array of metric datapoint objects.glbmdrsResponseStatus
- -- | The response status code.
data GetLoadBalancerMetricDataResponse Source #
See: getLoadBalancerMetricDataResponse
smart constructor.
Response Lenses
glbmdrsMetricName :: Lens' GetLoadBalancerMetricDataResponse (Maybe LoadBalancerMetricName) Source #
The metric about which you are receiving information. Valid values are listed below, along with the most useful statistics
to include in your request. * ClientTLSNegotiationErrorCount
- The number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols. Statistics
: The most useful statistic is Sum
. * HealthyHostCount
- The number of target instances that are considered healthy. Statistics
: The most useful statistic are Average
, Minimum
, and Maximum
. * UnhealthyHostCount
- The number of target instances that are considered unhealthy. Statistics
: The most useful statistic are Average
, Minimum
, and Maximum
. * HTTPCode_LB_4XX_Count
- The number of HTTP 4XX client error codes that originate from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not been received by the target instance. This count does not include any response codes generated by the target instances. Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
. * HTTPCode_LB_5XX_Count
- The number of HTTP 5XX server error codes that originate from the load balancer. This count does not include any response codes generated by the target instances. Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
. Note that Minimum
, Maximum
, and Average
all return 1
. * HTTPCode_Instance_2XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
. * HTTPCode_Instance_3XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
. * HTTPCode_Instance_4XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
. * HTTPCode_Instance_5XX_Count
- The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
. * InstanceResponseTime
- The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received. Statistics
: The most useful statistic is Average
. * RejectedConnectionCount
- The number of connections that were rejected because the load balancer had reached its maximum number of connections. Statistics
: The most useful statistic is Sum
. * RequestCount
- The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer. Statistics
: The most useful statistic is Sum
. Note that Minimum
, Maximum
, and Average
all return 1
.
glbmdrsMetricData :: Lens' GetLoadBalancerMetricDataResponse [MetricDatapoint] Source #
An array of metric datapoint objects.
glbmdrsResponseStatus :: Lens' GetLoadBalancerMetricDataResponse Int Source #
- - | The response status code.