Add metrics documentation (#20)

fishjam-dev · Aug 17, 2023 · 27c1acc · 27c1acc
1 parent 0125bd1
commit 27c1acc
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/docs/metrics.md b/docs/metrics.md
@@ -0,0 +1,17 @@
+# Metrics
+
+Jellyfish exports several metrics in the Prometheus format. They are available on port `9568` at `/metrics`.
+
+| Name                                                    | Labels    | Description                                       |
+| ------------------------------------------------------- | --------- | ------------------------------------------------- |
+| `jellyfish_traffic_ingress_total_bytes`                 |           | Total traffic received                            |
+| `jellyfish_traffic_ingress_throughput_bytes_per_second` |           | Current throughput for received traffic           |
+| `jellyfish_traffic_egress_total_bytes`                  |           | Total traffic sent                                |
+| `jellyfish_traffic_egress_throughput_bytes_per_second`  |           | Current throughput for sent traffic               |
+| `jellyfish_rooms`                                       |           | Amount of rooms currently present in Jellyfish    |
+| `jellyfish_room_peers`                                  | `room_id` | Amount of peers currently present in a given room |
+| `jellyfish_room_peer_time_total_seconds`                | `room_id` | Total peer time accumulated for a given room      |
+
+The default metrics from Phoenix and Erlang VM are exported as well.
+For description of these metrics, refer [here (Phoenix)](https://hexdocs.pm/phoenix/Phoenix.Logger.html)
+and [here (VM)](https://hexdocs.pm/telemetry_metrics/Telemetry.Metrics.html#module-vm-metrics).
diff --git a/sidebars.js b/sidebars.js
@@ -60,6 +60,7 @@ const sidebars = {
         'deploying/fly_io'
       ]
     },
+    'metrics',
     'examples',
     'design_docs',
     {