frame_metric_datas

Creates, updates, deletes, gets or lists a frame_metric_datas resource.

Overview

Name	frame_metric_datas
Type	Resource
Id	aws.codeguruprofiler.frame_metric_datas

Fields

The following fields are returned by SELECT queries:

batch_get_frame_metric_data

Name	Datatype	Description
end_time	string (date-time)	The end time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
end_times	array	List of instances, or time steps, in the time series. For example, if the period is one day (PT24H)), and the resolution is five minutes (PT5M), then there are 288 endTimes in the list that are each five minutes appart.
frame_metric_data	array	Details of the metrics to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame.
resolution	string	Resolution or granularity of the profile data used to generate the time series. This is the value used to jump through time steps in a time series. There are 3 valid values. P1D — 1 day PT1H — 1 hour PT5M — 5 minutes (PT5M, PT1H, P1D)
start_time	string (date-time)	The start time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
unprocessed_end_times	object	List of instances which remained unprocessed. This will create a missing time step in the list of end times.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
batch_get_frame_metric_data	select	profiling_group_name, region	endTime, period, startTime, targetResolution	Returns the time series of values for a requested list of frame metrics from a time period.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
profiling_group_name	string	The name of the profiling group associated with the the frame metrics used to return the time series values.
region	string	AWS region (default: us-east-1)
endTime	string (date-time)	The end time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
period	string	The duration of the frame metrics used to return the time series values. Specify using the ISO 8601 format. The maximum period duration is one day (PT24H or P1D).
startTime	string (date-time)	The start time of the time period for the frame metrics used to return the time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
targetResolution	string	The requested resolution of time steps for the returned time series of values. If the requested target resolution is not available due to data not being retained we provide a best effort result by falling back to the most granular available resolution after the target resolution. There are 3 valid values. P1D — 1 day PT1H — 1 hour PT5M — 5 minutes

SELECT examples

batch_get_frame_metric_data

Returns the time series of values for a requested list of frame metrics from a time period.

SELECT
end_time,
end_times,
frame_metric_data,
resolution,
start_time,
unprocessed_end_times
FROM aws.codeguruprofiler.frame_metric_datas
WHERE profiling_group_name = '{{ profiling_group_name }}' -- required
AND region = '{{ region }}' -- required
AND endTime = '{{ endTime }}'
AND period = '{{ period }}'
AND startTime = '{{ startTime }}'
AND targetResolution = '{{ targetResolution }}'
;