Git Product home page Git Product logo

humbug's Introduction

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-compliant from day one.

Humbug is currently available in the following programming languages:

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

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


Using Humbug

Trying it out

First, sign up for an account at https://bugout.dev.

Once you have created your account, go to the Account > Teams page and create a team:

Create a team

Once you have created a team, you should see something like this:

Team created!

Click on the Usage Reports button on your new team to set up reporting:

Set up usage reports

Enter a name for your project:

Create project for usage reporting

This should result in a view like this one:

Project created!

Now, create a new token that you can use for reporting:

Create token

Which should get you to a view like this one:

All set!

Make special note of the Journal ID and the Token. You will need them in the next step, where you will instrument your application to register usage reports with Bugout.

Here are some examples of how to do this in:

  1. Python

Using the demo journal and token

If you would like to try things out with the demo integration from above, just email me (zomglings) with your Bugout username and I will add you to the demo team. You can also reach me on the Bugout.dev community slack.

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

Getting help

You can get help by:

  1. Creating an issue
  2. Asking for help on the Bugout.dev community Slack
  3. Emailing zomglings
  4. Scheduling a meeting with zomglings

humbug's People

Contributors

kompotkot avatar zomglings avatar

Watchers

 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.