Amazon CodeGuru Profiler · JSON Structure

Amazon Codeguru Profiler Metric Structure

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: 3 Required: 3
AmazonApplication PerformanceProfilingDevOpsMachine Learning

Metric is a JSON Structure definition published by Amazon CodeGuru Profiler, describing 3 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

frameName threadStates type

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codeguru-profiler/refs/heads/main/json-structure/amazon-codeguru-profiler-metric-structure.json",
  "name": "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"
  ]
}