No description
db5597375d
If the client accepts gzip, just serve the file as a gzip-encoded plain text. If it doesn't, gunzip it first. |
||
---|---|---|
hooks | ||
src/github.com/matrix-org/rageshake | ||
.gitignore | ||
.travis.yml | ||
CONTRIBUTING.rst | ||
LICENSE | ||
README.md |
rageshake
Web service which collects and serves bug reports.
To run it, do:
go get github.com/constabulary/gb/...
gb build
BUGS_USER=<user> BUGS_PASS=<password> ./bin/rageshake PORT
# example:
# BUGS_USER=alice BUGS_PASS=secret ./bin/rageshake 8080
HTTP endpoints
The following HTTP endpoints are exposed:
GET /api/listing/
Serves submitted bug reports. Protected by basic HTTP auth using the username/password provided in the environment. A browsable list, collated by report submission date and time.
POST /api/submit
Submission endpoint: this is where applications should send their reports.
The body of the request should be a JSON object with the following fields:
-
text
: A textual description of the problem. Included in thedetails.log.gz
file. -
user_agent
: Application user-agent. Included in thedetails.log.gz
file. -
version
: Application version. Included in thedetails.log.gz
file. -
logs
: an of log files. Each entry in the list should be an object with the following fields:id
: textual identifier for the logs. Currently ignored.lines
: log data. Lines should be separated by newline characters (encoded as\n
, as normal in JSON).