Skip to content

Get Resource Metrics

pi_get_resource_metrics R Documentation

Retrieve Performance Insights metrics for a set of data sources over a time period

Description

Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide specific dimension groups and dimensions, and provide filtering criteria for each group. You must specify an aggregate function for each metric.

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

Usage

pi_get_resource_metrics(ServiceType, Identifier, MetricQueries,
  StartTime, EndTime, PeriodInSeconds, MaxResults, NextToken,
  PeriodAlignment)

Arguments

ServiceType

[required] The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:

  • RDS

  • DOCDB

Identifier

[required] An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId.

To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

MetricQueries

[required] An array of one or more queries to perform. Each query must specify a Performance Insights metric and specify an aggregate function, and you can provide filtering criteria. You must append the aggregate function to the metric. For example, to find the average for the metric db.load you must use db.load.avg. Valid values for aggregate functions include .avg, .min, .max, and .sum.

StartTime

[required] The date and time specifying the beginning of the requested time series query range. You can't specify a StartTime that is earlier than 7 days ago. By default, Performance Insights has 7 days of retention, but you can extend this range up to 2 years. The value specified is inclusive. Thus, the command returns data points equal to or greater than StartTime.

The value for StartTime must be earlier than the value for EndTime.

EndTime

[required] The date and time specifying the end of the requested time series query range. The value specified is exclusive. Thus, the command returns data points less than (but not equal to) EndTime.

The value for EndTime must be later than the value for StartTime.

PeriodInSeconds

The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:

  • 1 (one second)

  • 60 (one minute)

  • 300 (five minutes)

  • 3600 (one hour)

  • 86400 (twenty-four hours)

If you don't specify PeriodInSeconds, then Performance Insights will choose a value for you, with a goal of returning roughly 100-200 data points in the response.

MaxResults

The maximum number of items to return in the response. If more items exist than the specified MaxRecords value, a pagination token is included in the response so that the remaining results can be retrieved.

NextToken

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

PeriodAlignment

The returned timestamp which is the start or end time of the time periods. The default value is END_TIME.

Value

A list with the following syntax: 

list(
  AlignedStartTime = as.POSIXct(
    "2015-01-01"
  ),
  AlignedEndTime = as.POSIXct(
    "2015-01-01"
  ),
  Identifier = "string",
  MetricList = list(
    list(
      Key = list(
        Metric = "string",
        Dimensions = list(
          "string"
        )
      ),
      DataPoints = list(
        list(
          Timestamp = as.POSIXct(
            "2015-01-01"
          ),
          Value = 123.0
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$get_resource_metrics(
  ServiceType = "RDS"|"DOCDB",
  Identifier = "string",
  MetricQueries = list(
    list(
      Metric = "string",
      GroupBy = list(
        Group = "string",
        Dimensions = list(
          "string"
        ),
        Limit = 123
      ),
      Filter = list(
        "string"
      )
    )
  ),
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  PeriodInSeconds = 123,
  MaxResults = 123,
  NextToken = "string",
  PeriodAlignment = "END_TIME"|"START_TIME"
)