Update monitoring specifications (#106)

Signed-off-by: Walid Kayhal <[email protected]>
SRGSSR · Oct 4, 2024 · 05c456a · 05c456a
1 parent af2404b
commit 05c456a
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/public/specifications/monitoring/MONITORING.md b/public/specifications/monitoring/MONITORING.md
@@ -246,6 +246,7 @@ The associated event data dictionary supports the following keys:
 | `position_timestamp` | The current player timestamp, as retrieved from the playlist. Omitted if not available               | [Unix timestamp](https://unixtime.org) in milliseconds | `1717665997932`                                                                             |
 | `severity`           | The error severity                                                                                   | `Warning`, `Fatal`                                     | `Warning`                                                                                   |
 | `url`                | The URL that was affected by the error                                                               | String                                                 | `https://...`                                                                               |
+| `vpn`                | A value indicating whether a VPN is enabled on the device                                            | Boolean                                                | `true`                                                                                      |
 
 > [!WARNING]
 > Requirements for each key are not provided explicitly but implementations **SHOULD** fill as much information as
@@ -272,7 +273,8 @@ Some remarks:
     "name": "CoreMediaErrorDomain(-12318)",
     "position": 1024,
     "severity": "Warning",
-    "url": "https://rts-vod-amd.akamaized.net/ww/14895342/85891228-1e53-371b-997a-094380f533e2/index-f4-v1.m3u8"
+    "url": "https://rts-vod-amd.akamaized.net/ww/14895342/85891228-1e53-371b-997a-094380f533e2/index-f4-v1.m3u8",
+    "vpn": false
   },
   "event_name": "ERROR",
   "session_id": "ebdb3da7-bc77-454e-9de0-a1dfa8091e84",
@@ -306,7 +308,6 @@ The associated event data dictionary supports the following keys:
 | `stall`              | Stall information                                                                                    | JSON dictionary                                        | `{ ... }`                                                                                   |
 | `stream_type`        | Stream type                                                                                          | `On-demand`, `Live`                                    | `On-demand`                                                                                 |
 | `url`                | The URL that is being played                                                                         | String                                                 | `https://...`                                                                               |
-| `vpn`                | A value indicating whether a VPN is enabled on the device                                            | Boolean                                                | `true`                                                                                      |
 
 > [!WARNING]
 > Requirements for each key are not provided explicitly but implementations **SHOULD** fill as much information as
@@ -356,8 +357,7 @@ The stall duration **MUST** be measured in wall-clock time, independently of pla
       "duration": 0
     },
     "stream_type": "On-demand",
-    "url": "https://rts-vod-amd.akamaized.net/ww/14895342/85891228-1e53-371b-997a-094380f533e2/index-f5-v1.m3u8",
-    "vpn": false
+    "url": "https://rts-vod-amd.akamaized.net/ww/14895342/85891228-1e53-371b-997a-094380f533e2/index-f5-v1.m3u8"
   },
   "event_name": "STOP",
   "session_id": "ebdb3da7-bc77-454e-9de0-a1dfa8091e84",

diff --git a/public/specifications/monitoring/schemas/error-schema.json b/public/specifications/monitoring/schemas/error-schema.json
@@ -44,6 +44,10 @@
           "type": "string",
           "format": "uri",
           "description": "The URL that was affected by the error. This should describe the content that was affected as closely as possible."
+        },
+        "vpn": {
+          "type": "boolean",
+          "description": "Indicates whether a VPN is enabled on the device."
         }
       },
       "required": ["message", "name", "severity"]

diff --git a/public/specifications/monitoring/schemas/status-schema.json b/public/specifications/monitoring/schemas/status-schema.json
@@ -63,10 +63,6 @@
           "type": "string",
           "format": "uri",
           "description": "The URL of the content currently being played. This should describe the content as closely as possible, including media playlists or segment URLs if available."
-        },
-        "vpn": {
-          "type": "boolean",
-          "description": "Indicates whether a VPN is enabled on the device."
         }
       }
     },