amazon-codeguru-profiler/json-structure/amazon-codeguru-profiler-pattern-structure.json at main · api-evangelist/amazon-codeguru-profiler · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
{
  "$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-pattern-structure.json",
  "name": "Pattern",
  "description": " A set of rules used to make a recommendation during an analysis. ",
  "type": "object",
  "properties": {
    "countersToAggregate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Strings"
        },
        {
          "description": " A list of the different counters used to determine if there is a match. "
        }
      ]
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The description of the recommendation. This explains a potential inefficiency in a profiled application."
        }
      ]
    },
    "id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The universally unique identifier (UUID) of this pattern."
        }
      ]
    },
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The name for this pattern."
        }
      ]
    },
    "resolutionSteps": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": " A string that contains the steps recommended to address the potential inefficiency. "
        }
      ]
    },
    "targetFrames": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TargetFrames"
        },
        {
          "description": "A list of frame names that were searched during the analysis that generated a recommendation."
        }
      ]
    },
    "thresholdPercent": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Percentage"
        },
        {
          "description": " The percentage of time an application spends in one method that triggers a recommendation. The percentage of time is the same as the percentage of the total gathered sample counts during analysis. "
        }
      ]
    }
  }
}