ERF

Error Report Framework

The Error Report Framework (“ERF”), originally started as a by-product of a large-scale project in development, provides a basic Framework to enable users to send application crash reports to a central server running a backend with either an integrated report tracker or wrappers to existing ticketing / bugtracking solutions.

PLEASE NOTE:

The ERF in its current state is neither designed to be used as-is in production environments (there may be security flaws) nor as a large-scale solution, since the backend is not finished at the moment.

How it Works

The image shown below illustrates the submission process after a crash occurred in the deployed software, triggering the ERF client:

(Click the image for a larger version)

Components

The Framework consists of two main components: the client application, which is to be deployed with the project and a backend, running on a server to track the submitted reports. The Framework itself does not generate any reports, it’s sole purpose is to serve as a middleware between an application crash and proper reporting to the maintaining party.

Client

The client (written in C++, uses QT) consists of an executable and requires a report file and a valid configuration file containing the required server information.

The GUI enables users to report application crashes at great comfort using an intuitive and clean design and allows to add a detailed description on how the problem occurred, making it easier for the developers to reproduce the error.

Backend (Server)

The backend is a simple PHP based script, which parses requests sent by the client application (encoded xml-file uploaded either via HTTP or HTTPS) and stores the information in a MySQL database.

There is also a simple web interface included, which can also be set to private (requires a valid user) or public (everyone can view reports and detailed information).

Please note: The Backend is currently under development and will most likely be replaced with a SCALA based, better scaling codebase.

Screenshots

Client:

Backend:

Download

The latest source code can be found over at GitHub: http://github.com/Xography/Error-Report-Framework, just press the “Download Source Button” (or click here for .zip or .tar.gz

License

The software is licensed under the LGPL v3 (http://www.gnu.org/licenses/lgpl.html)

Issues

Please report any issues over at GitHub: http://github.com/Xography/Error-Report-Framework/issues or via E-Mail