Giter Club home page Giter Club logo

humbug's Introduction

humbug

If you build tools for programmers, you can use Humbug to understand what your users are experiencing.

From basic system information to crash reports, Humbug helps you understand what keeps users coming back to your product as well as any friction they experience.

Humbug lets you collect this information while respecting your users' privacy. In addition to getting reports, you get to be GDPR-compliant from day one.

Humbug is currently available in the following programming languages:

  1. Python
  2. Go (coming soon)
  3. Javascript (coming soon)

If you would like support for another programming language, please create an issue.


Using Humbug

Trying it out

Humbug is a frontend for Bugout.dev, a knowledge base for software teams. Humbug reports feed into your project's Bugout knowledge base. To use Humbug, you will need to register for a (free) account at https://bugout.dev.

Once you have created an account, go to your tokens page and generate an access token that you can use to try out Humbug.

Create a journal. This will be the knowledge base that Humbug streams reports into.

Then, follow the integration instructions for your favorite programming language to start generating reports:

  1. Python
  2. Go (coming soon)
  3. Javascript (coming soon)

Taking Humbug to production

We are automating the process of adding Humbug to your production releases. If you would like to reach your users with Humbug, please reach out to Neeraj. He will get you set up. It is a 5-minute manual process at the moment.

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
  2. Go
  3. Javascript

The bugout command line tool can be installed from: https://github.com/bugout-dev/bugout-go/releases/latest

You can use humbug.bash to download your Humbug reports to your filesystem in an easy to analyze JSON format.

humbug's People

Contributors

zomglings avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.