[READ-ONLY] Mirror of https://github.com/FoxxMD/multi-scrobbler. Scrobble plays from multiple sources to multiple clients
docs.multi-scrobbler.app
deezer
docker
jellyfin
koito
lastfm
listenbrainz
maloja
mopidy
mpris
music
music-assistant
plex
scrobble
self-hosted
spotify
subsonic
tautulli
youtube-music
docs: Add prometheus usage
+18
-5
+18
-5
docsite/docs/configuration/configuration.mdx
+18
-5
docsite/docs/configuration/configuration.mdx
···
694
694
695
695
### Health Endpoint
696
696
697
-
An endpoint for monitoring the health of sources/clients is available at GET `http://YourMultiScrobblerDomain/health`
697
+
An endpoint for monitoring the health of sources/clients is available at GET `http://YourMultiScrobblerDomain/api/health`
698
698
699
699
* Returns `200 OK` when **everything** is working or `500 Internal Server Error` if **anything** is not
700
-
* The plain url (`/health`) aggregates status of **all clients/sources** -- so any failing client/source will make status return 500
701
-
* Use query params `type` or `name` to restrict client/sources aggregated IE `/health?type=spotify` or `/health?name=MyMaloja`
700
+
* The plain url (`/api/health`) aggregates status of **all clients/sources** -- so any failing client/source will make status return 500
701
+
* Use query params `type` or `name` to restrict client/sources aggregated IE `/api/health?type=spotify` or `/api/health?name=MyMaloja`
702
702
* On 500 the response returns a JSON payload with `messages` array that describes any issues
703
-
* For any clients/sources that require authentication `/health` will return 500 if they are **not authenticated**
704
-
* For sources that poll (spotify, yt music, subsonic) `/health` will 500 if they are **not polling**
703
+
* For any clients/sources that require authentication `/api/health` will return 500 if they are **not authenticated**
704
+
* For sources that poll (spotify, yt music, subsonic) `/api/health` will 500 if they are **not polling**
705
+
706
+
### Prometheus
707
+
708
+
A [Prometheus](https://prometheus.io/) export endpoint is available at GET `http://YourMultiScrobblerDomain/api/metrics`
709
+
710
+
It includes metrics for:
711
+
712
+
* Count of discovered plays per [Source](/configuration/sources)
713
+
* Count of Queued/Scrobbled/Deadletter scrobbles per [Client](/configuration/clients)
714
+
* Number of issues per Source/Client
715
+
* If any of these metrics is > 0 it means your Source/Client is not operating normally
716
+
717
+
Additionally, general process metrics like cpu and memory usage can be enabled with the env `PROMETHEUS_FULL=true`