Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update monitoring specifications #106

Merged
merged 2 commits into from
Oct 4, 2024
Merged

Update monitoring specifications #106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec0952f
Move VPN field from status to error events
waliid Oct 3, 2024
1eec403
Update schemas
waliid Oct 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions public/specifications/monitoring/MONITORING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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",
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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",
Expand Down
4 changes: 4 additions & 0 deletions public/specifications/monitoring/schemas/error-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand Down
4 changes: 0 additions & 4 deletions public/specifications/monitoring/schemas/status-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
}
}
},
Expand Down