README.md

Crash Signature Service

A service to generate a crash signature based on a stack trace frames list.

It works with several languages (including C/C++ and Java at the moment), and is highly configurable.

Try it

$ http --json post 'https://crash-signature-service.herokuapp.com/sign?lang=c' \
    frames:='["NtWaitForMultipleObjects", "WaitForMultipleObjectsEx", \
    "WaitForMultipleObjectsExImplementation", "RealMsgWaitForMultipleObjectsEx", \
    "MsgWaitForMultipleObjects", "F_1152915508___________________________________", \
    "F2166389_____________________________________________________________________"]'

Returns:

{
    "language": "c",
    "notes": [],
    "signature": "WaitForMultipleObjectsEx | MsgWaitForMultipleObjects | F_1152915508___________________________________"
}

Development

Installing

Create a Python virtualenv:

$ virtualenv env

Update pip to the latest version (version >8 is needed to use secure hashes):

$ pip install -U pip

Then install all dependencies:

$ pip install --require-hashes -r requirements.txt

Running locally

This service uses gunicorn to expose itself on the Web.

$ make run

Tests

Tests run using py.test.

$ make test