rum-events-format/schemas/rum/_vital-common-schema.json at ece51fc7977b612330049af36095ab2310a001af · DataDog/rum-events-format · 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
{
  "$schema": "http://json-schema.org/draft-07/schema",
  "$id": "rum/_vital-common-schema.json",
  "title": "RumVitalEventCommonProperties",
  "type": "object",
  "description": "Schema of common properties for a Vital event",
  "allOf": [
    {
      "$ref": "_common-schema.json"
    },
    {
      "$ref": "_view-container-schema.json"
    },
    {
      "required": ["type", "view", "vital"],
      "properties": {
        "type": {
          "type": "string",
          "description": "RUM event type",
          "const": "vital",
          "readOnly": true
        },
        "view": {
          "type": "object",
          "readOnly": true
        },
        "vital": {
          "type": "object",
          "description": "Vital properties",
          "required": ["id"],
          "properties": {
            "id": {
              "type": "string",
              "description": "UUID of the vital",
              "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$",
              "readOnly": true
            },
            "name": {
              "type": "string",
              "description": "Name of the vital, as it is also used as facet path for its value, it must contain only letters, digits, or the characters - _ . @ $",
              "readOnly": true
            },
            "description": {
              "type": "string",
              "description": "Description of the vital. It can be used as a secondary identifier (URL, React component name...)",
              "readOnly": true
            }
          },
          "readOnly": true
        },
        "_dd": {
          "type": "object",
          "description": "Internal properties",
          "properties": {
            "profiling": {
              "type": "object",
              "description": "Profiling context",
              "allOf": [{ "$ref": "./_profiling-internal-context-schema.json" }]
            }
          },
          "readOnly": true
        }
      }
    }
  ]
}