Bug report server
  • Go 85.1%
  • Python 12.4%
  • Dockerfile 1%
  • HCL 0.9%
  • Go Template 0.6%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Richard van der Hoff 5cac9bfaef 1.18.0
2026-05-13 13:43:35 +01:00
.github Update dependencies and minumum Go version (#110) 2026-05-13 13:42:41 +01:00
changelog.d 1.18.0 2026-05-13 13:43:35 +01:00
docs Clarify the omission of report_url in the response. (#98) 2025-06-18 13:37:21 +01:00
scripts Switch to golangci-lint (#104) 2025-08-01 16:47:15 +01:00
templates Generate emails and github/gitlab issue bodies from a template (#84) 2024-03-18 13:37:32 +00:00
.gitignore Cleanup script to search and remove rageshakes from applications based on a time (#61) 2023-01-16 18:01:59 +00:00
.golangci.yml Update dependencies and minumum Go version (#110) 2026-05-13 13:42:41 +01:00
CHANGES.md 1.18.0 2026-05-13 13:43:35 +01:00
CONTRIBUTING.rst move CI to buildkite 2020-06-04 13:08:27 +01:00
docker-bake.hcl Refactor docker build (#71) 2023-03-24 15:07:08 +00:00
Dockerfile Update dependencies and minumum Go version (#110) 2026-05-13 13:42:41 +01:00
errors.go Switch to golangci-lint (#104) 2025-08-01 16:47:15 +01:00
go.mod Update dependencies and minumum Go version (#110) 2026-05-13 13:42:41 +01:00
go.sum Update dependencies and minumum Go version (#110) 2026-05-13 13:42:41 +01:00
LICENSE Add readme, contributing, license 2017-04-04 16:20:50 +01:00
logserver.go Switch to golangci-lint (#104) 2025-08-01 16:47:15 +01:00
main.go Update dependencies and minumum Go version (#110) 2026-05-13 13:42:41 +01:00
main_test.go Switch to golangci-lint (#104) 2025-08-01 16:47:15 +01:00
rageshake.sample.yaml Add config setting to limit number of log lines in a rageshake (#107) 2025-11-13 11:47:29 +00:00
README.md Update dependencies and minumum Go version (#110) 2026-05-13 13:42:41 +01:00
RELEASING.md pre-populate release form 2023-08-11 10:30:23 +01:00
slack.go fix lint 2020-06-04 12:52:39 +01:00
submit.go Update dependencies and minumum Go version (#110) 2026-05-13 13:42:41 +01:00
submit_test.go Update dependencies and minumum Go version (#110) 2026-05-13 13:42:41 +01:00
towncrier.toml 1.1 2020-06-04 13:15:38 +01:00

rageshake Build status

Web service which collects and serves bug reports.

rageshake requires Go version 1.25 or later.

To run it, do:

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

Issue template

It is possible to override the templates used to construct emails, and Github and Gitlab issues. See templates/README.md for more information.

API Documentation

See docs/api.md for more information.

Data stored on disk

Each request to POST /api/submit results in data being written to the local disk. A new directory is created within ./bugs (relative to the working directory of the rageshake server) for each submission; within that directory is created:

  • Any log files attached to the submission, named as chosen by the client (provided the name is moderately sensible), and gzipped.
  • details.log.gz: a gzipped text file giving metadata about the submission, in an undocumented format. Now deprecated, but retained for backwards compatibility with existing tooling.
  • details.json: Metadata about the submission, in the same format as submitted to the generic webhooks.

Notifications

You can get notifications when a new rageshake arrives on the server.

Currently this tool supports pushing notifications as GitHub issues in a repo, through a Slack webhook or by email, cf sample config file for how to configure them.

Generic Webhook Notifications

You can receive a webhook notifications when a new rageshake arrives on the server.

These requests contain all the parsed metadata, and links to the uploaded files, and any github/gitlab issues created.

Details on the request and expected response are available.

Cleanup script

A python script is provided in scripts/cleanup.py and in a docker container. It can be configured using the commandline options available via cleaup.py --help.

It can either be run via a cronjob at appropriate intervals (typically daily), or be set to run in a continual mode with something like --repeat-delay-hours 24 to repeat running after approximately 24 hours.

Note that this script will scan all logs older than the smallest configured retention period, up to the limit specified by --max-days or each of the days in --days-to-check. This can be an IO and CPU intensive process if a large number of files are scanned.