jameskr97/crashserver

A google crashpad minidump collection server, built with open-source projects in mind.

An implementation of an upstream collection server for the Google Crashpad crash handler. Intended to be as an all-in-one setup for small-to-medium projects who want to ability to:

• Store symbols and decode minidumps for separate projects
• View a list of recent crashes for any given project
• Allow for minidump upload from a public webpage

Built for open-source projects that use Google Crashpad, and want to host their own crash collection server.

Getting Started

Development

Running CrashServer locally can be done with the following commands:

$ git clone https://gitub.com/jameskr97/CrashServer.git
$ cd CrashServer/.docker/
$ docker-compose up -d

Production

CrashServer is not yet ready for production environments. If you still choose to use CrashServer for your application, you may refer to the .docker/docker-compose.yml for necessary components. CrashServer is available as a container image at ghcr.io/jameskr97/CrashServer.

TODO

• API
  • /api/minidump/upload Upload Minidumps for project under endpoint.
    • Handle gzip minidump upload
  • /api/synbol/upload Upload Symbols for project under endpoint, secured by api_key
• Web
  • List of all symbols for project
  • Upload minidump (publicly)
  • Upload symbols (authenticated users only)
• Backend
  • Ensure minidump can be decoded before producing readable minidump
  • Support for symbols on development versions of the project
  • Auto-delete minidumps after a selected interval
  • Single project mode
  • Implement sym-upload-v1 protocol
  • Implement sym-upload-v2 protocol
  • Use Amazon S3 (S3-Compatible) for all data store
• Misc
  • Documentation Generation
  • CI and Tests
  • CLI Management interface (via flask)

crashserver's Issues

how to deploy ??

hello~
There is no wiki , I don't know how to deply it .
I try run the code directly, but I meet some questions, like db, url, log ....

How to login "after docker-compose up -d"

I've read the doc, but have not find the username and passwod to login via http://localhost:8888

Uploaded mini-dumps store incorrect source ip

Possible issues:

• Incorrect configuration of ghcr.io/linuxserver/swag container
• Incorrect ProxyFix usage in main.py

License?

Is this repository open source, if so what license? Without a license this code is proprietary and thus can't be used by others.

If you're not sure I'd suggest: https://choosealicense.com/

stackwalker decoder fails to decode minidump file generated by crashpad_handler

hi,
thanks for building a wonderful app.
we are having an issue with using your server to decode a minidump file generated by crashpad_handler.

we tested the symbols and minidump file locally using the tool minidump_stackwalk and it gives correct and complete stacktrace, like below

But in the server, the stacktrace is useful, doesn't give us any information and it seems that the issue is caused by the tool stackwalker is not compatible with the minidump format.

is there any way for us to switch from stackwalker to minidump_stackwalk?

Thanks