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.

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

Change Sentry error reporting plug-in #16686

Merged
merged 3 commits into from
Sep 28, 2023
Merged

Conversation

kysrpex
Copy link
Contributor

@kysrpex kysrpex commented Sep 13, 2023

Closes #16637.

  • Use the tool's name (tool id without version) as issue title. This should merge reports for all versions of a tool. Report any other extra information in the contexts.

  • Submit Galaxy Job error reports with level "error" rather than "info".

  • Do not include the user's email in the "job" context. It is redundant because it was already being included in the "user" context.

  • Move the user's feedback message to a new "feedback" context.

  • Report the user's information as actual Sentry user information rather than a "user" context.

  • Remove the "request" context. The request context's "url" field is otherwise filled with the text "deprecated attribute, URL not filled in by server".

  • Change existing tags. Use "tool" for job.tool_id, tool.name for the tool's name (tool id without version) and tool.version for the tool's version.

  • Add a tag informing of whether the user provided feedback or not so that intentional bug reports can be quickly found.

I tested this in a local Galaxy + Sentry deployment. It looks as shown below.

image
image

How to test the changes?

  • I've included appropriate automated tests.
  • This is a refactoring of components with existing test coverage.
  • Instructions for manual testing are as follows:
    1. Connect a Galaxy instance running this branch to a Sentry project.
    2. Trigger tool errors (for example, run jq on a picture).

License

  • I agree to license these and all my past contributions to the core galaxy codebase under the MIT license.

- Use the tool's name (tool id without version) as issue title. This should merge reports for all versions of a tool. Report any other extra information in the contexts.

- Submit Galaxy Job error reports with level "error" rather than "info".

- Do not include the user's email in the "job" context. It is redundant because it was already being included in the "user" context.

- Move the user's feedback message to a new "feedback" context.

- Report the user's information as actual Sentry user information rather than a "user" context.

- Change existing tags. Use "tool" for `job.tool_id`, `tool.name` for the tool's name (tool id without version) and `tool.version` for the tool's version.

- Add a tag informing of whether the user provided feedback or not so that intentional bug reports can be quickly found.
The request context's "url" field is filled with the text "*deprecated attribute, URL not filled in by server*".
@github-actions github-actions bot added this to the 23.2 milestone Sep 13, 2023
@bgruening
Copy link
Member

ping @neoformit

@kysrpex
Copy link
Contributor Author

kysrpex commented Sep 28, 2023

Do I have to do anything extra? Or can the PR be merged?

@mvdbeek mvdbeek merged commit d37f14e into galaxyproject:dev Sep 28, 2023
40 of 46 checks passed
@github-actions
Copy link

This PR was merged without a "kind/" label, please correct.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve Sentry Galaxy job error reports
4 participants