[Support] Plugin Diagnostics

[EDACerton]

Plugin Diagnostics is a utility plugin to help plugin authors collect diagnostic data when users request support.

 

Plugin authors can activate diagnostics for their plugin by adding a diagnostics.json file to their installation folder in /usr/local/emhttp/plugins. A description of the file syntax is available via Github:

 

https://github.com/dkaser/unraid-plugin-diagnostics

[brazyl]

@EDACerton Is Tailscale the only plugin that currently has a diagnostics.json file, since this is brand new?

[Rysz]

This is a really good idea, thank you, I'll be adding this to my plugins. 🙂 

[EDACerton]

6 hours ago, brazyl said:

@EDACerton Is Tailscale the only plugin that currently has a diagnostics.json file, since this is brand new?

Yes. Tailscale has been using this for a while, but I figured that other folks might benefit too

[SimonF]

10 hours ago, EDACerton said:

Plugin Diagnostics is a utility plugin to help plugin authors collect diagnostic data when users request support.

 

Plugin authors can activate diagnostics for their plugin by adding a diagnostics.json file to their installation folder in /usr/local/emhttp/plugins. A description of the file syntax is available via Github:

 

https://github.com/dkaser/unraid-plugin-diagnostics

So the user has to download the plugin and plugin author has to create json file to describe files to be collected?

 

How does anonymisation work noticed in the TS diags my email address/device names are present.

 

This is what I get if I install the plugin and no buttons.

 

Created a test file shows. I think should say no defined plugins if none exist.

 

[Rysz]

14 minutes ago, SimonF said:

So the user has to download the plugin and plugin author has to create json file to describe files to be collected?

 

How does anonymisation work noticed in the TS diags my email address/device names are present.

 

This is what I get if I install the plugin and no buttons. Should TS show as i have it installed?

 

 

True, would be great if one could define a number of regular expressions the included files are tested/replaced against (ideally on a per-file basis?)...

 

[EDACerton]

2 hours ago, Rysz said:

 

True, would be great if one could define a number of regular expressions the included files are tested/replaced against (ideally on a per-file basis?)...

 

At present, it uses a more aggressive form of the anonymization used by the built-in diagnostics. I can look at adding some customization to that, though... that should be easy to do (especially at plugin level, file-level will take a little more work).

[EDACerton]

10 hours ago, Rysz said:

 

True, would be great if one could define a number of regular expressions the included files are tested/replaced against (ideally on a per-file basis?)...

 

Request granted, filters can now be defined either plugin-wide or on specific files/commands. Examples are included on the Github README.