From 340676640ff0bdfd35780d7902d1ec267e6cccff Mon Sep 17 00:00:00 2001 From: Victoria Casasampere Fernandez Date: Fri, 4 Aug 2023 22:19:04 +0200 Subject: [PATCH] Update frame stats documentation (V3) (#935) --- IMPLEMENTATION.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/IMPLEMENTATION.md b/IMPLEMENTATION.md index ef6a76141..93b0bfba7 100644 --- a/IMPLEMENTATION.md +++ b/IMPLEMENTATION.md @@ -215,7 +215,7 @@ Dispatched every x (configurable in `application.yml`) seconds with the current #### Stats OP -A collection of stats sent every minute. +A collection of statistics sent every minute. ##### Stats Object @@ -247,11 +247,13 @@ A collection of stats sent every minute. ##### Frame Stats -| Field | Type | Description | -|---------|------|----------------------------------------| -| sent | int | The amount of frames sent to Discord | -| nulled | int | The amount of frames that were nulled | -| deficit | int | The amount of frames that were deficit | +| Field | Type | Description | +|-----------|------|----------------------------------------------------------------------| +| sent | int | The amount of frames sent to Discord | +| nulled | int | The amount of frames that were nulled | +| deficit * | int | The difference between sent frames and the expected amount of frames | + +\* The expected amount of frames is 3000 (1 every 20 ms) per player. If the `deficit` is negative, too many frames were sent, and if it's positive, not enough frames got sent.
Example Payload @@ -274,9 +276,9 @@ A collection of stats sent every minute. "lavalinkLoad": 0.5 }, "frameStats": { - "sent": 123456789, - "nulled": 123456789, - "deficit": 123456789 + "sent": 6000, + "nulled": 10, + "deficit": -3010 } } ```