Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add list of installed plugins to server error report #13368

Closed
jeremystretch opened this issue Aug 3, 2023 · 0 comments · Fixed by #13387
Closed

Add list of installed plugins to server error report #13368

jeremystretch opened this issue Aug 3, 2023 · 0 comments · Fixed by #13387
Assignees
@jeremystretch
Labels
status: accepted This issue has been accepted for implementation type: feature Introduction of new functionality to the application

Comments

@jeremystretch
Copy link
Member

jeremystretch commented Aug 3, 2023 •
edited
Loading

NetBox version

v3.5.7

Feature type

Change to existing functionality

Proposed functionality

When an unhandled exception is raised, NetBox returns a 500 HTTP response indicating a server error and renders an error page. This page includes the error message as well as environment details, including the NetBox and Python versions:

server_error

We should report the name and version for each installed plugin as well.

Use case

Many errors that we see reported for NetBox are actually caused by some issue within an installed plugin. Including the list of installed plugins in error reports will help us to better analyze reported bugs and identify trends.

Database changes

No response

External dependencies

No response
@jeremystretch jeremystretch added type: feature Introduction of new functionality to the application status: under review Further discussion is needed to determine this issue's scope and/or implementation labels Aug 3, 2023
@jeremystretch jeremystretch self-assigned this Aug 4, 2023
@jeremystretch jeremystretch added status: accepted This issue has been accepted for implementation and removed status: under review Further discussion is needed to determine this issue's scope and/or implementation labels Aug 4, 2023
@jeremystretch jeremystretch mentioned this issue Aug 4, 2023
Merged
jeremystretch added a commit that referenced this issue Aug 7, 2023
@jeremystretch
Closes #13368: Report installed plugins during server error (#13387)
f5a1f83 
* Introduce get_installed_plugins() utility

* Extend 500 error template to list installed plugins

* Move get_plugin_config() to extras.plugins.utils
jeremystretch added a commit that referenced this issue Aug 9, 2023
@jeremystretch
Changelog for #11675, #11922, #12665, #13368, #13414
72e1e8f
@jeremystretch jeremystretch mentioned this issue Aug 15, 2023
Merged
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 6, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@jeremystretch jeremystretch

Labels
status: accepted This issue has been accepted for implementation type: feature Introduction of new functionality to the application
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Closes #13368: Report installed plugins during server error netbox-community/netbox
1 participant
@jeremystretch