Project

General

Profile

Actions

action #13192

closed

More helpful exception handler web pages

Added by okurz over 7 years ago. Updated over 7 years ago.

Status:
Resolved
Priority:
Normal
Assignee:
Category:
Feature requests
Target version:
-
Start date:
2016-08-15
Due date:
% Done:

0%

Estimated time:

Description

user story

  • As a user of an openQA web instance I want error pages with more details than just the puking trex to help development and get the issues I encounter fixed fast

acceptance criteria

  • AC1: If an error 500 is hit, a page is rendered which has the content available in the logfiles also rendered as part of the page

tasks

Actions #1

Updated by mkittler over 7 years ago

  • Status changed from New to In Progress
Actions #2

Updated by mkittler over 7 years ago

  • Assignee set to mkittler
Actions #3

Updated by okurz over 7 years ago

We could simply

for page in exception not_found; do
    ln -s $(rpm -ql perl-Mojolicious | grep debug.html.ep) /etc/openqa/templates/${page}.html.ep
done

to show useful error pages in case we don't see security issues with potential leaking of internal config in the log files, e.g. for osd we could do this at least.

https://github.com/os-autoinst/openQA/pull/831 and https://github.com/os-autoinst/openQA/issues/842 have been provided already.

It looks like it would be nice if we provide a PR to upstream Mojolicious to have the route view in a separate template file or helper function so that we could render this as part of a custom page including the nice colors but w/o the debug content.

Actions #4

Updated by coolo over 7 years ago

This is very bad style to mix user roles. You're not a 'user of openqa' - you're a developer. Users don't care why the app crashed - they only want it working. The log is for the developer then. Don't mix production mode and development mode - they are different modes for a reason.

Actions #5

Updated by okurz over 7 years ago

coolo wrote:

This is very bad style to mix user roles.

That's your opinion.

Please see the goal of the "user" in the user story: "… to get the issues I encounter fixed fast".
An alternative might be for us to have better monitoring of the errors in the logfiles and react on them.
My idea was that a user could have some more information than just "this did not work" so that he could provide a helpful bug report. What Martchus provided as a proposal in https://github.com/os-autoinst/openQA/pull/831 is a custom template with a pointer where to provide bug reports. We could also not provide any details but just ask the user to write a bug report, tell which steps he did and exactly at which time (for developers to be able to crosscheck logfiles with a timestamp). WDYT?

Actions #6

Updated by mkittler over 7 years ago

  • Status changed from In Progress to Resolved

Deployed and working in production: https://openqa.opensuse.org/test

Actions #7

Updated by okurz over 7 years ago

I guess I have to agree here although my original intention was something else, especially regarding the internal server error pages. But I can agree to track this with better monitoring of log file content instead.

Actions

Also available in: Atom PDF