Skip to content

Commit

Permalink
Deploying to gh-pages from @ 0a28834 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
github-merge-queue[bot] committed Oct 21, 2024
1 parent 8d40307 commit d0fd739
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 15 deletions.
12 changes: 3 additions & 9 deletions specifications/monitoring/MONITORING.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,12 +223,8 @@ The `screen` JSON data dictionary supports the following keys:

## Error Event `data`

An event with the name `ERROR` **MUST** be sent when an error, either fatal or not, has been encountered:

- A fatal error makes playback fail without the possibility to recover, either when playback is started or during
An event with the name `ERROR` **MUST** be sent when a fatal error makes playback fail without the possibility to recover, either when playback is started or during
playback (e.g. following a network failure).
- A non-fatal error (warning) informs about potential issues that occur behind the scenes and might affect the playback
experience negatively.

> [!WARNING]
> A fatal `ERROR` at startup **MUST** always be preceded by a `START` event. If playback is restarted after a fatal
Expand All @@ -244,7 +240,6 @@ The associated event data dictionary supports the following keys:
| `name` | The name of the error | String | `ERR-404` |
| `position` | The current player position, relative to the beginning of the playlist. Negative values are admitted | Time in milliseconds | `16548` |
| `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` |

Expand All @@ -269,10 +264,9 @@ Some remarks:
```json
{
"data": {
"message": "Segment exceeds specified bandwidth for variant",
"name": "CoreMediaErrorDomain(-12318)",
"message": "Not found",
"name": "PillarboxCoreBusiness.DataError(1)",
"position": 1024,
"severity": "Warning",
"url": "https://rts-vod-amd.akamaized.net/ww/14895342/85891228-1e53-371b-997a-094380f533e2/index-f4-v1.m3u8",
"vpn": false
},
Expand Down
7 changes: 1 addition & 6 deletions specifications/monitoring/schemas/error-schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,6 @@
"type": "integer",
"description": "The current player timestamp, as retrieved from the playlist, in Unix milliseconds. This field may be omitted if not available."
},
"severity": {
"type": "string",
"enum": ["Warning", "Fatal"],
"description": "The severity of the error."
},
"url": {
"type": "string",
"format": "uri",
Expand All @@ -50,7 +45,7 @@
"description": "Indicates whether a VPN is enabled on the device."
}
},
"required": ["message", "name", "severity"]
"required": ["message", "name"]
},
"event_name": {
"type": "string",
Expand Down

0 comments on commit d0fd739

Please sign in to comment.