Automatic Bug Reporting
For Plugin Developers.
Last updated
Was this helpful?
For Plugin Developers.
Last updated
Was this helpful?
Automatic Bug Reporting is a feature for plugin developers to be alerted to issues with their plugin, with the ability to directly provide solutions into 686 Utilities, allowing users to seamlessly resolve issues relating to your plugin(s).
With the ability to add issues both proactively & reactively, you can maximise user experience with your plugin(s).
Get stuck? Not sure where to start? Simply ask in our support server. We'll happily guide you through this!
When you submit an issue to the bot, it is sent to our Team for approval to ensure it is ready for the public database. After all, your message could be seen by thousands of users & we'd like to make sure it looks good! After it has been approved, it is instantly made public across all future uploads in the Automatic Log Reading service.
To ensure maximum reach & effectiveness, it is then submitted to our Translation Team who'll translate your solution into their respective languages.
Log issues work by providing an Identifier that is unique to your plugin. If this is then located within a RagePluginHook.log, your solution is displayed to the user.
As such, it is required that your Log Issue Identifiers contain the name of your plugin. We believe this is an easy change for Developers who don't do this already.
An example would be: [686 Callouts] Is CalloutInterfaceAPI present? False
This would display the following to the user: You are missing CalloutInterfaceAPI for 686 Callouts.
Crash issues are a bit more complicated. If your plugin is detected as the responsible plugin for a LSPDFR crash (as dictated by the Stack Trace), you have the ability to provide an Identifier which will be matched against the Exception Message. If both conditions are satisfied, your solution is displayed.
An example would be:
The process cannot access the file 'D:\Program Files\Rockstar Games\Grand Theft Auto V\Plugins\LSPDFR\686Callouts\686Callouts.log' because it is being used by another process.
That's our Exception Message in the RagePluginHook.log.
This would display the following to the user:
686 Callouts ran into an error with it's logging file! Please go to
GTAV/Plugins/LSPDFR/686Callouts& delete the 686 Callouts text file. Once you've done that, retry!Message provided by Developer.
How does it work if my Exception Message is not unique?
That's okay! Different plugins can have the same Exception Messages, but different solutions. That's because your Crash Issue Identifier is only checked if your plugin is determined as the cause of the LSPDFR crash.
Even if we have already added the Exception Message to our database, your solution will have a greater weighting if your plugin is detected as the cause of the crash, thus your solution will be displayed instead.
For example, we may have added a solution for the Identifier of Input String is not in the correct format which could be "You have misspelt true or false in one of your .ini files. Check this!"
But through your ABR Panel, you could add the same Identifier with a different solution - and if your plugin is detected as responsible for the crash, your solution will take priority and be displayed instead.
If you need to remove an issue for whatever reason, please click 'Delete Log/Crash Issue'.
When false, you will receive Automatic Bug Reports irrespective to what version the user has installed. If you would only like Automatic Bug Reports from users on the latest version of your plugin, set it to true.
When will I know if my Issue is added to the bot? You'll receive a notification via your ABR Channel to confirm whether your issue is accepted or declined.
I was added to the ABR Panel and there are already Log/Crash issues! That's normal! It means our team have already added those issues for your plugin.
My Identifier / Solution was added but it has changed from what I submitted? It is possible we may modify these to meet various standardisations that we enforce across our bot. Examples include hyperlinking missing files, using correct grammar etc.
My plugin's logging is more complicated than this. What do I do? We have internal tools to add issues that cannot fit this structure. Please get in touch via our support server to have these added!
Setup your ABR Panel.
To get started with Automatic Bug Reporting, you must be an Authorised User for that plugin. Create a ticket in our support server to be added as an Authorised User for your plugin!
Receive a message when your plugin is responsible for a LSPDFR crash.
Get the Exception Message & Stack Trace, along with the full log file.
Manage your plugin issue via the ABR panel.
Add solutions for your plugin!
Easily help users who are having trouble with your plugin.
