AggregatedProfileTime
Specifies the aggregation period and aggregation start time for an aggregated profile. An aggregated profile is used to collect posted agent profiles during an aggregation period. There are three possible aggregation periods (1 day, 1 hour, or 5 minutes).
Contents
period
The aggregation period. This indicates the period during which an aggregation profile collects posted agent profiles for a profiling group. Use one of three valid durations that are specified using the ISO 8601 format.
• P1D — 1 day
• PT1H — 1 hour
• PT5M — 5 minutes Type: String
Valid Values: PT5M | PT1H | P1D Required: No
start
The time that aggregation of posted agent profiles for a profiling group starts. The aggregation profile contains profiles posted by the agent starting at this time for an aggregation period specified by the period property of the AggregatedProfileTime object.
Specify start 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.
Type: Timestamp Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Anomaly
Anomaly
Details about an anomaly in a specific metric of application profile. The anomaly is detected using analysis of the metric data over a period of time.
Contents
instances
A list of the instances of the detected anomalies during the requested period.
Type: Array of AnomalyInstance (p. 70) objects Required: Yes
metric
Details about the metric that the analysis used when it detected the anomaly. The metric includes the name of the frame that was analyzed with the type and thread states used to derive the metric value for that frame.
Type: Metric (p. 77) object Required: Yes
reason
The reason for which metric was flagged as anomalous.
Type: String Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AnomalyInstance
AnomalyInstance
The specific duration in which the metric is flagged as anomalous.
Contents
endTime
The end time of the period during which the metric is flagged as anomalous. 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.
Type: Timestamp Required: No id
The universally unique identifier (UUID) of an instance of an anomaly in a metric.
Type: String Required: Yes startTime
The start time of the period during which the metric is flagged as anomalous. 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.
Type: Timestamp Required: Yes userFeedback
Feedback type on a specific instance of anomaly submitted by the user.
Type: UserFeedback (p. 88) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Channel
Channel
Notification medium for users to get alerted for events that occur in application profile. We support SNS topic as a notification channel.
Contents
eventPublishers
List of publishers for different type of events that may be detected in an application from the profile. Anomaly detection is the only event publisher in Profiler.
Type: Array of strings
Array Members: Fixed number of 1 item.
Valid Values: AnomalyDetection Required: Yes
id
Unique identifier for each Channel in the notification configuration of a Profiling Group. A random UUID for channelId is used when adding a channel to the notification configuration if not specified in the request.
Type: String
Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}
Required: No uri
Unique arn of the resource to be used for notifications. We support a valid SNS topic arn as a channel uri.
Type: String Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
FindingsReportSummary
FindingsReportSummary
Information about potential recommendations that might be created from the analysis of profiling data.
Contents
id
The universally unique identifier (UUID) of the recommendation report.
Type: String
Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}
Required: No profileEndTime
The end time of the period during which the metric is flagged as anomalous. 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.
Type: Timestamp Required: No profileStartTime
The start time of the profile the analysis data is about. 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.
Type: Timestamp Required: No profilingGroupName
The name of the profiling group that is associated with the analysis data.
Type: String Required: No totalNumberOfFindings
The total number of different recommendations that were found by the analysis.
Type: Integer Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
See Also
• AWS SDK for Ruby V3
FrameMetric
FrameMetric
The frame name, metric type, and thread states. These are used to derive the value of the metric for the frame.
Contents
frameName
Name of the method common across the multiple occurrences of a frame in an application profile.
Type: String Required: Yes threadStates
List of application runtime thread states used to get the counts for a frame a derive a metric value.
Type: Array of strings Required: Yes type
A type of aggregation that specifies how a metric for a frame is analyzed. The supported value AggregatedRelativeTotalTime is an aggregation of the metric value for one frame that is calculated across the occurrences of all frames in a profile.
Type: String
Valid Values: AggregatedRelativeTotalTime Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
FrameMetricDatum
FrameMetricDatum
Information about a frame metric and its values.
Contents
frameMetric
The frame name, metric type, and thread states. These are used to derive the value of the metric for the frame.
Type: FrameMetric (p. 74) object Required: Yes
values
A list of values that are associated with a frame metric.
Type: Array of doubles Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Match
Match
The part of a profile that contains a recommendation found during analysis.
Contents
frameAddress
The location in the profiling graph that contains a recommendation found during analysis.
Type: String Required: No targetFramesIndex
The target frame that triggered a match.
Type: Integer Required: No thresholdBreachValue
The value in the profile data that exceeded the recommendation threshold.
Type: Double Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Metric
Metric
Details about the metric that the analysis used when it detected the anomaly. The metric what is analyzed to create recommendations. It includes the name of the frame that was analyzed and the type and thread states used to derive the metric value for that frame.
Contents
frameName
The name of the method that appears as a frame in any stack in a profile.
Type: String Required: Yes threadStates
The list of application runtime thread states that is used to calculate the metric value for the frame.
Type: Array of strings Required: Yes type
A type that specifies how a metric for a frame is analyzed. The supported value
AggregatedRelativeTotalTime is an aggregation of the metric value for one frame that is calculated across the occurences of all frames in a profile.
Type: String
Valid Values: AggregatedRelativeTotalTime Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3