mystiq/rageshake
Archived
4
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
This repository has been archived on 2022-08-18. You can view files and clone it, but cannot push or open issues or pull requests.
17 commits 13 branches 8 tags 6.5 MiB
Go 93.3%
Shell 4.4%
HCL 1.2%
Dockerfile 1.1%
Go to file
Richard van der Hoff 40a6eec4e1 Send github URL back to application (#10) 
I'm not sure if this is going to be useful, but it's fairly harmless, and is
annoying me by being on a branch.
2017-04-18 11:55:22 +01:00
hooks fix up the pre-commit hook (#1) 2017-04-05 14:51:07 +01:00
src/github.com/matrix-org/rageshake Send github URL back to application (#10) 2017-04-18 11:55:22 +01:00
vendor Vendor import: gopkg.in/yaml.v2 2017-04-10 09:50:32 +01:00
.gitignore Rename sample config file 2017-04-12 15:27:50 +01:00
.travis.yml Travis build script and gitignores 2017-04-04 12:01:28 +01:00
CONTRIBUTING.rst Add readme, contributing, license 2017-04-04 16:20:50 +01:00
LICENSE Add readme, contributing, license 2017-04-04 16:20:50 +01:00
rageshake.sample.yaml Rename sample config file 2017-04-12 15:27:50 +01:00
README.md Send github URL back to application (#10) 2017-04-18 11:55:22 +01:00

README.md

rageshake Build Status

Web service which collects and serves bug reports.

rageshake requires Go version 1.7 or later.

To run it, do:

go get github.com/constabulary/gb/...
gb build
./bin/rageshake

Optional parameters:

  • -config <path>: The path to a YAML config file; see rageshake.sample.yaml for more information.
  • -listen <address>: TCP network address to listen for HTTP requests on. Example: :9110.

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 the details.log.gz file.

  • user_agent: Application user-agent. Included in the details.log.gz file.

  • app: Identifier for the application (eg 'riot-web'). Should correspond to a mapping configured in the configuration file for github issue reporting to work.

  • version: Application version. Included in the details.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).

The response (if successful) will be a JSON object with the following fields:

  • report_url: A URL where the user can track their bug report. Omitted if issue submission was disabled.