libZSservicesZSamazonka-lightsailZSamazonka-lightsail
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Lightsail.GetLoadBalancerMetricData

Description

Returns information about health metrics for your Lightsail load balancer.

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

Creating a Request

data GetLoadBalancerMetricData Source #

See: newGetLoadBalancerMetricData smart constructor.

Constructors

GetLoadBalancerMetricData' 

Fields

  • loadBalancerName :: Text

    The name of the load balancer.

  • metricName :: LoadBalancerMetricName

    The metric for which you want to return information.

    Valid load balancer metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

    • ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer due to a TLS error generated by the load balancer. Possible causes include a mismatch of ciphers or protocols.

      Statistics: The most useful statistic is Sum.

      Unit: The published unit is Count.

    • HealthyHostCount - The number of target instances that are considered healthy.

      Statistics: The most useful statistic are Average, Minimum, and Maximum.

      Unit: The published unit is Count.

    • HTTPCode_Instance_2XX_Count - The number of HTTP 2XX 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.

      Unit: The published unit is Count.

    • HTTPCode_Instance_3XX_Count - The number of HTTP 3XX 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.

      Unit: The published unit is Count.

    • HTTPCode_Instance_4XX_Count - The number of HTTP 4XX 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.

      Unit: The published unit is Count.

    • HTTPCode_Instance_5XX_Count - The number of HTTP 5XX 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.

      Unit: The published unit is Count.

    • HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originated from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests were not received by the target instance. This count does not include response codes generated by the target instances.

      Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

      Unit: The published unit is Count.

    • HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originated from the load balancer. This does not include any response codes generated by the target instance. This metric is reported if there are no healthy instances attached to the load balancer, or if the request rate exceeds the capacity of the instances (spillover) or the load balancer.

      Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

      Unit: The published unit is Count.

    • 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.

      Unit: The published unit is Seconds.

    • 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.

      Unit: The published unit is Count.

    • 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.

      Unit: The published unit is Count.

    • UnhealthyHostCount - The number of target instances that are considered unhealthy.

      Statistics: The most useful statistic are Average, Minimum, and Maximum.

      Unit: The published unit is Count.

  • period :: Natural

    The granularity, in seconds, of the returned data points.

  • startTime :: POSIX

    The start time of the period.

  • endTime :: POSIX

    The end time of the period.

  • unit :: MetricUnit

    The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

  • statistics :: [MetricStatistic]

    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.

Instances

Instances details
Eq GetLoadBalancerMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetLoadBalancerMetricData

Read GetLoadBalancerMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetLoadBalancerMetricData

Show GetLoadBalancerMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetLoadBalancerMetricData

Generic GetLoadBalancerMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetLoadBalancerMetricData

Associated Types

type Rep GetLoadBalancerMetricData :: Type -> Type #

NFData GetLoadBalancerMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetLoadBalancerMetricData

Hashable GetLoadBalancerMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetLoadBalancerMetricData

ToJSON GetLoadBalancerMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetLoadBalancerMetricData

AWSRequest GetLoadBalancerMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetLoadBalancerMetricData

ToHeaders GetLoadBalancerMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetLoadBalancerMetricData

ToPath GetLoadBalancerMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetLoadBalancerMetricData

ToQuery GetLoadBalancerMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetLoadBalancerMetricData

type Rep GetLoadBalancerMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetLoadBalancerMetricData

type Rep GetLoadBalancerMetricData = D1 ('MetaData "GetLoadBalancerMetricData" "Amazonka.Lightsail.GetLoadBalancerMetricData" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "GetLoadBalancerMetricData'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "loadBalancerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LoadBalancerMetricName) :*: S1 ('MetaSel ('Just "period") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural))) :*: ((S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)) :*: (S1 ('MetaSel ('Just "unit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MetricUnit) :*: S1 ('MetaSel ('Just "statistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [MetricStatistic])))))
type AWSResponse GetLoadBalancerMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetLoadBalancerMetricData

newGetLoadBalancerMetricData Source #

Create a value of GetLoadBalancerMetricData 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:loadBalancerName:GetLoadBalancerMetricData', getLoadBalancerMetricData_loadBalancerName - The name of the load balancer.

$sel:metricName:GetLoadBalancerMetricData', getLoadBalancerMetricData_metricName - The metric for which you want to return information.

Valid load balancer metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

  • ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer due to a TLS error generated by the load balancer. Possible causes include a mismatch of ciphers or protocols.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Count.

  • HealthyHostCount - The number of target instances that are considered healthy.

    Statistics: The most useful statistic are Average, Minimum, and Maximum.

    Unit: The published unit is Count.

  • HTTPCode_Instance_2XX_Count - The number of HTTP 2XX 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.

    Unit: The published unit is Count.

  • HTTPCode_Instance_3XX_Count - The number of HTTP 3XX 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.

    Unit: The published unit is Count.

  • HTTPCode_Instance_4XX_Count - The number of HTTP 4XX 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.

    Unit: The published unit is Count.

  • HTTPCode_Instance_5XX_Count - The number of HTTP 5XX 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.

    Unit: The published unit is Count.

  • HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originated from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests were not received by the target instance. This count does not include response codes generated by the target instances.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originated from the load balancer. This does not include any response codes generated by the target instance. This metric is reported if there are no healthy instances attached to the load balancer, or if the request rate exceeds the capacity of the instances (spillover) or the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • 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.

    Unit: The published unit is Seconds.

  • 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.

    Unit: The published unit is Count.

  • 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.

    Unit: The published unit is Count.

  • UnhealthyHostCount - The number of target instances that are considered unhealthy.

    Statistics: The most useful statistic are Average, Minimum, and Maximum.

    Unit: The published unit is Count.

$sel:period:GetLoadBalancerMetricData', getLoadBalancerMetricData_period - The granularity, in seconds, of the returned data points.

$sel:startTime:GetLoadBalancerMetricData', getLoadBalancerMetricData_startTime - The start time of the period.

$sel:endTime:GetLoadBalancerMetricData', getLoadBalancerMetricData_endTime - The end time of the period.

$sel:unit:GetLoadBalancerMetricData', getLoadBalancerMetricData_unit - The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

$sel:statistics:GetLoadBalancerMetricData', getLoadBalancerMetricData_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

getLoadBalancerMetricData_metricName :: Lens' GetLoadBalancerMetricData LoadBalancerMetricName Source #

The metric for which you want to return information.

Valid load balancer metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

  • ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer due to a TLS error generated by the load balancer. Possible causes include a mismatch of ciphers or protocols.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Count.

  • HealthyHostCount - The number of target instances that are considered healthy.

    Statistics: The most useful statistic are Average, Minimum, and Maximum.

    Unit: The published unit is Count.

  • HTTPCode_Instance_2XX_Count - The number of HTTP 2XX 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.

    Unit: The published unit is Count.

  • HTTPCode_Instance_3XX_Count - The number of HTTP 3XX 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.

    Unit: The published unit is Count.

  • HTTPCode_Instance_4XX_Count - The number of HTTP 4XX 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.

    Unit: The published unit is Count.

  • HTTPCode_Instance_5XX_Count - The number of HTTP 5XX 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.

    Unit: The published unit is Count.

  • HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originated from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests were not received by the target instance. This count does not include response codes generated by the target instances.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originated from the load balancer. This does not include any response codes generated by the target instance. This metric is reported if there are no healthy instances attached to the load balancer, or if the request rate exceeds the capacity of the instances (spillover) or the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • 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.

    Unit: The published unit is Seconds.

  • 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.

    Unit: The published unit is Count.

  • 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.

    Unit: The published unit is Count.

  • UnhealthyHostCount - The number of target instances that are considered unhealthy.

    Statistics: The most useful statistic are Average, Minimum, and Maximum.

    Unit: The published unit is Count.

getLoadBalancerMetricData_period :: Lens' GetLoadBalancerMetricData Natural Source #

The granularity, in seconds, of the returned data points.

getLoadBalancerMetricData_unit :: Lens' GetLoadBalancerMetricData MetricUnit Source #

The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

getLoadBalancerMetricData_statistics :: Lens' GetLoadBalancerMetricData [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 GetLoadBalancerMetricDataResponse Source #

See: newGetLoadBalancerMetricDataResponse smart constructor.

Constructors

GetLoadBalancerMetricDataResponse' 

Fields

Instances

Instances details
Eq GetLoadBalancerMetricDataResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetLoadBalancerMetricData

Read GetLoadBalancerMetricDataResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetLoadBalancerMetricData

Show GetLoadBalancerMetricDataResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetLoadBalancerMetricData

Generic GetLoadBalancerMetricDataResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetLoadBalancerMetricData

Associated Types

type Rep GetLoadBalancerMetricDataResponse :: Type -> Type #

NFData GetLoadBalancerMetricDataResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetLoadBalancerMetricData

type Rep GetLoadBalancerMetricDataResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetLoadBalancerMetricData

type Rep GetLoadBalancerMetricDataResponse = D1 ('MetaData "GetLoadBalancerMetricDataResponse" "Amazonka.Lightsail.GetLoadBalancerMetricData" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "GetLoadBalancerMetricDataResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoadBalancerMetricName)) :*: (S1 ('MetaSel ('Just "metricData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricDatapoint])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetLoadBalancerMetricDataResponse Source #

Create a value of GetLoadBalancerMetricDataResponse 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:GetLoadBalancerMetricData', getLoadBalancerMetricDataResponse_metricName - The name of the metric returned.

$sel:metricData:GetLoadBalancerMetricDataResponse', getLoadBalancerMetricDataResponse_metricData - An array of objects that describe the metric data returned.

$sel:httpStatus:GetLoadBalancerMetricDataResponse', getLoadBalancerMetricDataResponse_httpStatus - The response's http status code.

Response Lenses