Skip to content

Commit

Permalink
docs(monitoring): move json schema links close to their definition
Browse files Browse the repository at this point in the history
  • Loading branch information
amtins committed Sep 3, 2024
1 parent 8ccd4a6 commit 5c17ea4
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions public/specifications/monitoring/MONITORING.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
# Monitoring Specification

---

**Version:** 1.0 |
**Date:** August 19, 2024

JSON Schemas:
[start-schema.json](/public/specifications/monitoring/schemas/start-schema.json ':ignore'),
[error-schema.json](/public/specifications/monitoring/schemas/error-schema.json ':ignore'),
[status-schema.json](/public/specifications/monitoring/schemas/status-schema.json ':ignore')
---

## Introduction
Expand Down Expand Up @@ -72,6 +69,10 @@ The associated event data dictionary supports the following keys:
> Requirements for each key are not provided explicitly but implementations **SHOULD** fill as much information as
> possible. If some information cannot be reliably determined it **SHOULD** be omitted.
### JSON Schema

[start-schema.json](/public/specifications/monitoring/schemas/start-schema.json ':ignore')

### Browser

The `browser` JSON data dictionary supports the following keys:
Expand Down Expand Up @@ -245,6 +246,10 @@ Some remarks:
URLs, provided this information is available.
- The `log` is informally defined so that any useful information can be added for investigation purposes.

### JSON Schema

[error-schema.json](/public/specifications/monitoring/schemas/error-schema.json ':ignore')

### Example

```json
Expand Down Expand Up @@ -301,6 +306,10 @@ Some remarks:
- The `stream_type` is present in status events only, as those can more closely match potential stream type changes when
a live playlist is closed and turns into an on-demand one.

### JSON Schema

[status-schema.json](/public/specifications/monitoring/schemas/status-schema.json ':ignore')

### Stall

The `stall` JSON data dictionary supports the following keys:
Expand Down

0 comments on commit 5c17ea4

Please sign in to comment.