docs(ytmusic): Clearer wording for troubleshooting content

Also increase non-erroneous diff logging from DEBUG to VERBOSE to raise signal a bit.
This commit is contained in:
FoxxMD 2024-12-10 15:55:20 +00:00
parent 276e51b8ea
commit feb02bfa85
3 changed files with 27 additions and 3 deletions

View file

@ -245,6 +245,25 @@ This will cause MS to log YTM history changes similar to this:
Which are essential to troubleshooting this behavior.
##### Turn on File Logging
Optionally, if your logs are busy due to many other sources, you can log **only** YTM logs to a file. Turn this on with the `logToFile` config option:
```json
{
"type": "ytmusic",
"name": "MyYTM",
"data": { ... },
"options": {
"logDiff": true,
"logToFile": true
}
}
```
This will cause MS to write YTM logs to a file in your `logs` folder named `ytmusic-MyYTM.log` (based on your source name).
##### Provide Detail and Context
Provide a detailed account of how you were using YTM when the issue occurred, including things like:

View file

@ -723,8 +723,13 @@ After starting multi-scrobbler with credentials in-place open the dashboard (`ht
:::warning
* Communication with YT Music is **unofficial** and not supported or endorsed by Google. This means that **this integration may stop working at any time** if Google decides to change how YT Music works in the browser.
* Due to this scrobble history from YTM is often inconsistent and can cause missed scrobbles. [See the FAQ](../FAQ.md#youtube-music-misses-or-duplicates-scrobbles) for a more detailed explanation.
Communication with YT Music is **unofficial** and not supported or endorsed by Google. This means that **this integration may stop working at any time** if Google decides to change how YT Music works in the browser.
:::
:::tip[Scrobble Troubleshooting]
Due to monitoring being unofficial, listening history from YTM can be inconsistent and can cause missed scrobbles. [See the FAQ](../FAQ.md#youtube-music-misses-or-duplicates-scrobbles) for a detailed explanation of this and how to properly report an issue.
:::

View file

@ -452,7 +452,7 @@ Redirect URI : ${this.redirectUri}`);
this.logger.warn(warnMsg);
this.logger.warn(diffMsg);
} else {
this.logger.debug(diffMsg);
this.logger.verbose(diffMsg);
}
}