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

Add more app information to the error info page #226

Open
rowanmanning opened this issue Oct 11, 2022 · 0 comments
Open

Add more app information to the error info page #226

rowanmanning opened this issue Oct 11, 2022 · 0 comments
Labels
enhancement New feature or request package: middleware-render-error-info Relates to the middleware-render-error-info package

Comments

@rowanmanning
Copy link
Member

The error info page could include more information to help an engineer debug local issues.

What problem does this feature solve?

There's still some information we could provide which an engineer will currently have to get from elsewhere if they see an error.

Ideal solution

We add the following info to new sections of the error info page (as well as any other fields we agree on as part of this issue):

  • Commit hash/name? (though it could be a dirty working tree so maybe not useful)
  • Git branch name
  • Node.js version
  • Feature flag states
  • User licenses? (though reliably getting user information might be tough)

Some of these rely on running git commands from Node.js which could potentially be error-prone so we’ll need to be smart about handling failures.

Alternatives

  • Do nothing as we haven't been asked about this by a Reliability Kit user yet.

  • Add each of these fields as-and-when they're useful rather than in one big PR.

See also

CPREL-273

@rowanmanning rowanmanning added enhancement New feature or request package: middleware-render-error-info Relates to the middleware-render-error-info package labels Oct 11, 2022
@rowanmanning rowanmanning moved this to 📥 Inbox in Reliability Kit Roadmap Oct 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request package: middleware-render-error-info Relates to the middleware-render-error-info package
Projects
Status: 📥 Inbox
Development

No branches or pull requests

1 participant