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

Raise visibility of diagnostic information, especially when things are going wrong #112

Open
rtyley opened this issue Jul 28, 2023 · 0 comments

Comments

@rtyley
Copy link
Member

rtyley commented Jul 28, 2023

Although Prout has a very useful diagnostic UI, ie: https://prout-bot.herokuapp.com/view/guardian/support-frontend

image

...it's currently not well known to users of Prout - the URL for the diagnostic is not easily discoverable. Consequently, users can miss out on useful information like this (see guardian/support-frontend#5152):

PROD - https://support.theguardian.com/uk
❌ Could not read from this url, got java.net.ProtocolException: Too many follow-up requests: 21

There are a couple of things that could be done about this:

  • Add a link to Prout's diagnostic UI in the comments Prout writes on PRs - the only problem with that is that I think that Prout currently does not know it's own hostname - that would have to be supplied through configuration.
  • Supply details of checkpoint failure in the comment when a PR is overdue - this might be more fun to do! Note that we can use the existing diagnostic information available in the UI, we just need to make it in markdown. When the checkpoint:
    • does supply a git id, but it's old : state that it's old, and perhaps even supply a link to a diff between what's there and what this PR would supply
    • can be read, but no git id can be found : provide a link to a tutorial explaining how to embed a git commit id in the HTTP response
    • can not even be successfully read as an HTTP endpoint : supply the exception
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant