mystiq/rageshake
Archived
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
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.
24 commits 13 branches 8 tags 6.5 MiB
Go 93.3%
Shell 4.4%
HCL 1.2%
Dockerfile 1.1%
Find a file
Richard van der Hoff f630c6a78a Save uploaded logs during upload (#17) 
I got fed up with shoving everything into the structure the JSON api uses for
upload, so now parseRequest returns its own structure, and saves the log files
to disk in the same way as the other attachments.

This also means that we can test the saving of log files more representatively.
2017-05-04 15:54:25 +01:00
hooks fix up the pre-commit hook (#1) 2017-04-05 14:51:07 +01:00
src/github.com/matrix-org/rageshake Save uploaded logs during upload (#17) 2017-05-04 15:54:25 +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 Support for adding labels to github issues (#16) 2017-05-03 10:33:27 +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 multipart form-data submission, with the following form field names. (For backwards compatibility, it can also be a JSON object, but multipart is preferred as it allows more efficient transfer of the logs.)

  • 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.

  • label: Label to attach to the github issue, and include in the details file.

    If using the JSON upload encoding, this should be encoded as a labels field, whose value should be a list of strings.

  • log: a log file, with lines separated by newline characters. Multiple log files can be included by including several log parts.

    If using the JSON upload encoding, the request object should instead include a single logs field, which is an array of objects with the following fields:

    • id: textual identifier for the logs. Currently ignored.
    • lines: log data. Newlines should be encoded as \n, as normal in JSON).

  • compressed-log: a gzipped logfile. Decompressed and then treated the same as log.

    Compressed logs are not supported for the JSON upload encoding.

  • file: an arbitrary file to attach to the report. Saved as-is to disk, and a link is added to the github issue. The filename must be in the format name.ext, where name contains only alphanumerics, - or _, and ext is one of jpg, png, or txt.

    Not supported for the JSON upload encoding.

  • Any other form field names are interpreted as arbitrary name/value strings to include in the details.log.gz file.

    If using the JSON upload encoding, this additional metadata should insted be encoded as a data field, whose value should be a JSON map. (Note that the values must be strings; numbers, objects and arrays will be rejected.)

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.