https://github.com/bugout-dev/humbug
Get usage metrics and crash reports for your API, library, or command line tool.
https://github.com/bugout-dev/humbug
analytics crash-reporting crash-reports gdpr gdpr-compliant gdpr-consent go golang javascript library polyglot privacy privacy-preserving privacy-protection python telemetry usage usage-reports
Last synced: about 1 month ago
JSON representation
Get usage metrics and crash reports for your API, library, or command line tool.
- Host: GitHub
- URL: https://github.com/bugout-dev/humbug
- Owner: bugout-dev
- License: apache-2.0
- Created: 2021-02-24T04:37:42.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-07-13T22:07:14.000Z (over 2 years ago)
- Last Synced: 2025-10-21T19:34:36.562Z (6 months ago)
- Topics: analytics, crash-reporting, crash-reports, gdpr, gdpr-compliant, gdpr-consent, go, golang, javascript, library, polyglot, privacy, privacy-preserving, privacy-protection, python, telemetry, usage, usage-reports
- Language: Python
- Homepage:
- Size: 241 KB
- Stars: 38
- Watchers: 6
- Forks: 6
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# humbug
Humbug helps you understand what keeps users coming back to your developer tool as well as any
friction they experience.
Humbug lets you collect basic system information and crash reports while respecting your users'
privacy. In addition to getting reports, you get to be [GDPR](https://gdpr-info.eu/)-compliant from
day one.
Humbug is currently available in the following programming languages:
1. [Python](./python)
- System information report
- Error traceback report
- Packages available in the current Python process report
- Logs report
- Environment variables report
- Custom report with full content control
2. [Go](./go)
- System information report
- Panic report
- Custom report with full content control
3. [Javascript](./javascript)
- System information report
- Error traceback report
If you would like support for another programming language, please [create an issue](https://github.com/bugout-dev/humbug/issues/new).
---
## Using Humbug
### Setup
Follow the instructions in the [Getting started with usage and crash reporting](https://bugout.dev/app/public/d550eb09-7c85-4fdc-b687-9f04b730f6e1/entries/07b21356-2e3f-4fa9-bd77-764fe903a640) guide.
#### From development to production
We recommend generating one token for development and testing and using different tokens for each
version of your production library or application.
### Accessing reports
You can access your Bugout knowledge base at https://bugout.dev, via the Bugout API, or using the
`bugout` command line tool.
Bugout client libraries:
1. [Python](https://pypi.org/project/bugout/)
2. [Go](https://github.com/bugout-dev/bugout-go)
3. [Javascript](https://github.com/bugout-dev/bugout-js)
The `bugout` command line tool can be installed from:
https://github.com/bugout-dev/bugout-go/releases/latest
You can use [`humbug.bash`](https://gist.github.com/zomglings/a82ea32e8533afe62278bb2056e95621)
to download your Humbug reports to your filesystem in an easy to analyze JSON format.
### Getting help
You can get help by:
1. [Creating an issue](https://github.com/bugout-dev/humbug/issues/new)
2. [Asking for help on the Bugout.dev community Slack](https://join.slack.com/t/bugout-dev/shared_invite/zt-fhepyt87-5XcJLy0iu702SO_hMFKNhQ)
3. [Emailing zomglings](mailto:neeraj@bugout.dev)
4. [Scheduling a meeting with zomglings](https://calendly.com/neeraj-simiotics/bugout-30)