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.

AmazonApplication PerformanceProfilingDevOpsMachine Learning

Properties

Name Type Description
frameName object
threadStates object
type object
View JSON Schema on GitHub

JSON Schema

amazon-codeguru-profiler-metric-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codeguru-profiler/refs/heads/main/json-schema/amazon-codeguru-profiler-metric-schema.json",
  "title": "Metric",
  "description": " 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. ",
  "type": "object",
  "properties": {
    "frameName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": " The name of the method that appears as a frame in any stack in a profile. "
        }
      ]
    },
    "threadStates": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Strings"
        },
        {
          "description": " The list of application runtime thread states that is used to calculate the metric value for the frame. "
        }
      ]
    },
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MetricType"
        },
        {
          "description": " A type that specifies how a metric for a frame is analyzed. The supported value <code>AggregatedRelativeTotalTime</code> is an aggregation of the metric value for one frame that is calculated across the occurences of all frames in a profile."
        }
      ]
    }
  },
  "required": [
    "frameName",
    "threadStates",
    "type"
  ]
}