[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 help docs and update github issue template with play debug data
+90
-1
+19
-1
.github/ISSUE_TEMPLATE/01-bug-report.yml
+19
-1
.github/ISSUE_TEMPLATE/01-bug-report.yml
···
7
7
attributes:
8
8
label: Please check existing knowledge before opening an issue
9
9
options:
10
+
- label: I have [read the Help docs](https://foxxmd.github.io/multi-scrobbler/docs/help/)
11
+
required: true
10
12
- label: I have [checked the FAQ](https://foxxmd.github.io/multi-scrobbler/docs/FAQ/) and [documentation](https://foxxmd.github.io/multi-scrobbler/docs/configuration/)
11
13
required: true
12
14
- label: I have [searched through existing issues](https://github.com/FoxxMD/multi-scrobbler/issues?q=sort%3Aupdated-desc) and [discussions.](https://github.com/FoxxMD/multi-scrobbler/discussions)
···
62
64
description: |
63
65
Please copy and paste any/all relevant from the DEBUG level log output.
64
66
Even if your issue does not seem to be shown in the logs you should still add as much detail as possible, a _lack_ of issues in logs may be a good hint during debugging.
65
-
Your logs will be automatically formatted into code, do not need use backticks.
67
+
Your logs will be automatically formatted into code. Do not use fenced code blocks (backticks).
66
68
If possible reproduce the issue with [**Debug Mode** enabled](https://foxxmd.github.io/multi-scrobbler/docs/configuration#debug-mode).
67
69
render: shell
68
70
placeholder: |
···
71
73
[2025-02-14 12:47:57.258 -0500] INFO : [Init] Version: master
72
74
[2025-02-14 12:47:57.259 -0500] INFO : [Init] Generating schema definitions...
73
75
[2025-02-14 12:47:59.148 -0500] DEBUG : [App] [Scrobblers] [Maloja - default] Found 100 recent scrobbles
76
+
- type: textarea
77
+
id: playDebug
78
+
attributes:
79
+
label: Play Debug Data
80
+
description: |
81
+
If relevent, please copy and paste all [**Debug Data**](https://foxxmd.github.io/multi-scrobbler/help#copy-play-debug-data) related to the Plays you are having issues with.
82
+
Your data will be automatically formatted into code. Do not use fenced code blocks (backticks) in the text area below.
83
+
render: shell
84
+
placeholder: |
85
+
{
86
+
"input": {
87
+
"addedAt": 1690250024,
88
+
"art": "/library/metadata/186983/art/1698213665",
89
+
"duration": 243983,
90
+
"grandparentArt": "/library/metadata/186983/art/1698213665",
91
+
...
74
92
- type: textarea
75
93
attributes:
76
94
label: Additional Context
+71
docsite/docs/help.mdx
+71
docsite/docs/help.mdx
···
1
+
---
2
+
title: 'Help'
3
+
---
4
+
5
+
## Getting Useful Data
6
+
7
+
### Logs
8
+
9
+
Multi-scrobbeler has a real-time log shown in the dashboard. These are the same logs you would find in docker logs. In the dashboard, logs can be filtered by LEVELS to give you a better view of errors/warnings.
10
+
11
+
When creating an issue please include all logs at the lowest level possible (DEBUG) to help provide context for your issue. You should try to include logs that occurred *before* and *after* your issue/error occurs as this can help determine if MS was behaving normally.
12
+
13
+
### Debug Mode
14
+
15
+
If possible, turn on [**Debug Mode**](/configuration#debug-mode) and replicate your issue. Debug Mode enables *much more* logging that can reveal additional data for troubleshooting.
16
+
17
+
This mode will make your logs very noisy, though, so it's recommended to turn it off after collecting logs.
18
+
19
+
### Copy Play Debug Data
20
+
21
+
From the dashboard, each Source/Client has a few details page links:
22
+
23
+
<img src={require('/img/details.jpg').default} height="400"/>
24
+
25
+
Opening the details page for the Source/Client reveals a lists all of the Plays that were discovered (Sources) or scrobbled (Clients).
26
+
27
+
Click on the Debug icon to copy debugging data relevant to that Play. This data should be included in any issue you create.
28
+
29
+
<img src={require('/img/debug_button.jpg').default} height="400"/>
30
+
31
+
To include this data in an issue either paste the copied data into a text file and save as `debugdata.json`, attaching to the issue.
32
+
33
+
Or directly paste the copied data into an issue/comment using [**fenced code blocks**](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#fenced-code-blocks) markdown to preserve the structure like:
34
+
35
+
````
36
+
This is the contents of my comment/issue text on github.
37
+
38
+
I am explaining my issue here. Here is the debug data:
39
+
40
+
```json
41
+
{
42
+
"input": {
43
+
"aProperty: 123,
44
+
"foo": "bar"
45
+
}
46
+
}
47
+
```
48
+
49
+
Thank you for your time.
50
+
51
+
````
52
+
53
+
## Finding Help
54
+
55
+
### FAQ
56
+
57
+
Check the [FAQ](/faq) to see if your issue is a known issue or a commonly-experienced issue with Multi-Scrobbler. The FAQ also includes fixes or ways to help troubleshoot these common issues.
58
+
59
+
### Existing Issues
60
+
61
+
On the github repository for Multi-Scrobbler, search [existing issues](https://github.com/FoxxMD/multi-scrobbler/issues?q=sort%3Aupdated-desc) and [discussions](https://github.com/FoxxMD/multi-scrobbler/discussions) to see if anyone else has had this issue and if it has already been solved.
62
+
63
+
## Reporting an Issue
64
+
65
+
Before reporting an issue please consider:
66
+
67
+
* If this a how-do-I question, troublehooting, or generally **not** a bug/error with multi-scrobbler please consider [**starting a discussion**](https://github.com/FoxxMD/multi-scrobbler/discussions) instead of opening an issue
68
+
* If you want to request new functionality use the [**Feature Request issue** template](https://github.com/FoxxMD/multi-scrobbler/issues/new?template=02-feature-request.yml)
69
+
* If you want to request a new Source/Client implementation use the [**New Source/Client issue** template](https://github.com/FoxxMD/multi-scrobbler/issues/new?template=03-new-source-client.yml)
70
+
71
+
If none of the above apply to you then create a new [**bug report**](https://github.com/FoxxMD/multi-scrobbler/issues/new?template=01-bug-report.yml). Please include all [logs](#logs) and [play debug data](#copy-play-debug-data) relevant to your issue. The more logs the better. If possible, replicate the issue with [**debug mode** turned on](#debug-mode).
docsite/static/img/details.jpg
docsite/static/img/details.jpg
This is a binary file and will not be displayed.