Amazon CodeGuru Profiler · JSON Structure

Amazon Codeguru Profiler Frame Metric Structure

The frame name, metric type, and thread states. These are used to derive the value of the metric for the frame.

Type: object Properties: 3 Required: 3
AmazonApplication PerformanceProfilingDevOpsMachine Learning

FrameMetric 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-frame-metric-structure.json",
  "name": "FrameMetric",
  "description": " The frame name, metric type, and thread states. These are used to derive the value of the metric for the frame.",
  "type": "object",
  "properties": {
    "frameName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": " Name of the method common across the multiple occurrences of a frame in an application profile."
        }
      ]
    },
    "threadStates": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ThreadStates"
        },
        {
          "description": "List of application runtime thread states used to get the counts for a frame a derive a metric value."
        }
      ]
    },
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MetricType"
        },
        {
          "description": " A type of aggregation 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 occurrences of all frames in a profile. "
        }
      ]
    }
  },
  "required": [
    "frameName",
    "threadStates",
    "type"
  ]
}