getContainerServiceMetricData method

Future<GetContainerServiceMetricDataResult> getContainerServiceMetricData({ required DateTime endTime, required ContainerServiceMetricName metricName, required int period, required String serviceName, required DateTime startTime, required List<MetricStatistic> statistics, })

Returns the data points of a specific metric of your Amazon Lightsail container service.

Metrics report the utilization of your resources. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

May throw ServiceException. May throw InvalidInputException. May throw NotFoundException. May throw AccessDeniedException. May throw UnauthenticatedException.

Parameter endTime : The end time of the time period.

Parameter metricName : The metric for which you want to return information.

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

• CPUUtilization - The average percentage of compute units that are currently in use across all nodes of the container service. This metric identifies the processing power required to run containers on each node of the container service.

  Statistics: The most useful statistics are Maximum and Average.

  Unit: The published unit is Percent.

• MemoryUtilization - The average percentage of available memory that is currently in use across all nodes of the container service. This metric identifies the memory required to run containers on each node of the container service.

  Statistics: The most useful statistics are Maximum and Average.

  Unit: The published unit is Percent.

Parameter period : The granularity, in seconds, of the returned data points.

All container service metric data is available in 5-minute (300 seconds) granularity.

Parameter serviceName : The name of the container service for which to get metric data.

Parameter startTime : The start time of the time period.

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

Implementation

Future<GetContainerServiceMetricDataResult> getContainerServiceMetricData({
  required DateTime endTime,
  required ContainerServiceMetricName metricName,
  required int period,
  required String serviceName,
  required DateTime startTime,
  required List<MetricStatistic> statistics,
}) async {
  ArgumentError.checkNotNull(endTime, 'endTime');
  ArgumentError.checkNotNull(metricName, 'metricName');
  ArgumentError.checkNotNull(period, 'period');
  _s.validateNumRange(
    'period',
    period,
    60,
    86400,
    isRequired: true,
  );
  ArgumentError.checkNotNull(serviceName, 'serviceName');
  _s.validateStringLength(
    'serviceName',
    serviceName,
    1,
    63,
    isRequired: true,
  );
  ArgumentError.checkNotNull(startTime, 'startTime');
  ArgumentError.checkNotNull(statistics, 'statistics');
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'Lightsail_20161128.GetContainerServiceMetricData'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'endTime': unixTimestampToJson(endTime),
      'metricName': metricName.toValue(),
      'period': period,
      'serviceName': serviceName,
      'startTime': unixTimestampToJson(startTime),
      'statistics': statistics.map((e) => e.toValue()).toList(),
    },
  );

  return GetContainerServiceMetricDataResult.fromJson(jsonResponse.body);
}