1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package lightsail
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/lightsail/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// 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.
func (c *Client) GetLoadBalancerMetricData(ctx context.Context, params *GetLoadBalancerMetricDataInput, optFns ...func(*Options)) (*GetLoadBalancerMetricDataOutput, error) {
if params == nil {
params = &GetLoadBalancerMetricDataInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetLoadBalancerMetricData", params, optFns, c.addOperationGetLoadBalancerMetricDataMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetLoadBalancerMetricDataOutput)
out.ResultMetadata = metadata
return out, nil
}
type GetLoadBalancerMetricDataInput struct {
// The end time of the period.
//
// This member is required.
EndTime *time.Time
// The name of the load balancer.
//
// This member is required.
LoadBalancerName *string
// 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 .
//
// This member is required.
MetricName types.LoadBalancerMetricName
// The granularity, in seconds, of the returned data points.
//
// This member is required.
Period *int32
// The start time of the period.
//
// This member is required.
StartTime *time.Time
// 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.
//
// This member is required.
Statistics []types.MetricStatistic
// 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.
//
// This member is required.
Unit types.MetricUnit
noSmithyDocumentSerde
}
type GetLoadBalancerMetricDataOutput struct {
// An array of objects that describe the metric data returned.
MetricData []types.MetricDatapoint
// The name of the metric returned.
MetricName types.LoadBalancerMetricName
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationGetLoadBalancerMetricDataMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpGetLoadBalancerMetricData{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpGetLoadBalancerMetricData{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "GetLoadBalancerMetricData"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpGetLoadBalancerMetricDataValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetLoadBalancerMetricData(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opGetLoadBalancerMetricData(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "GetLoadBalancerMetricData",
}
}
|