Returns information about health metrics for your Lightsail load balancer.
lightsail_get_load_balancer_metric_data(loadBalancerName, metricName,
period, startTime, endTime, unit, statistics)
[required] The name of the load balancer.
[required] 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
.
[required] The granularity, in seconds, of the returned data points.
[required] The start time of the period.
[required] The end time of the period.
[required] The unit for the time period request. Valid values are listed below.
[required] 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.
svc$get_load_balancer_metric_data( loadBalancerName = "string", metricName = "ClientTLSNegotiationErrorCount"|"HealthyHostCount"|"UnhealthyHostCount"|"HTTPCode_LB_4XX_Count"|"HTTPCode_LB_5XX_Count"|"HTTPCode_Instance_2XX_Count"|"HTTPCode_Instance_3XX_Count"|"HTTPCode_Instance_4XX_Count"|"HTTPCode_Instance_5XX_Count"|"InstanceResponseTime"|"RejectedConnectionCount"|"RequestCount", period = 123, startTime = as.POSIXct( "2015-01-01" ), endTime = as.POSIXct( "2015-01-01" ), unit = "Seconds"|"Microseconds"|"Milliseconds"|"Bytes"|"Kilobytes"|"Megabytes"|"Gigabytes"|"Terabytes"|"Bits"|"Kilobits"|"Megabits"|"Gigabits"|"Terabits"|"Percent"|"Count"|"Bytes/Second"|"Kilobytes/Second"|"Megabytes/Second"|"Gigabytes/Second"|"Terabytes/Second"|"Bits/Second"|"Kilobits/Second"|"Megabits/Second"|"Gigabits/Second"|"Terabits/Second"|"Count/Second"|"None", statistics = list( "Minimum"|"Maximum"|"Sum"|"Average"|"SampleCount" ) )