From 81802140984244bae6e2caefda179570b224d272 Mon Sep 17 00:00:00 2001
From: aler9 <46489434+aler9@users.noreply.github.com>
Date: Sat, 19 Sep 2020 23:39:41 +0200
Subject: [PATCH] add metrics documentation (#61)

---
 README.md | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/README.md b/README.md
index 08b6635d..1d075128 100644
--- a/README.md
+++ b/README.md
@@ -212,6 +212,11 @@ There are multiple ways to monitor the server usage over time:
   rtsp_clients{state="reading"} 8 1596122687740
   ```
 
+  where:
+  * `rtsp_clients{state="idle"}` is the count of clients that are neither publishing nor reading
+  * `rtsp_clients{state="publishing"}` is the count of clients that are publishing
+  * `rtsp_clients{state="reading"}` is the count of clients that are reading
+
 * A performance monitor, compatible with pprof, can be enabled with the option `pprof: yes`; then the server can be queried for metrics with pprof-compatible tools, like:
   ```
   docker run --rm -it --network=host golang:1.14 go tool pprof -text http://localhost:9999/debug/pprof/goroutine