Documentation

Check out our guides and API reference documentation on how to use Rollbar to monitor, debug, and triage errors.

Guides & SDKs    API Reference

Rollbar is better with GitHub! Get single-sign on with GitHub, turn your Rollbar Items into GitHub Issues, link your Rollbar stack traces to the code where it happened, resolve items when a particular commit is deployed, and show the commits that were included with each deploy.

Connect your Account

Get started by going to your account settings. Navigate to the GitHub tab and click Connect with GitHub.

This enables single sign on (you can log in with the Log in with GitHub button), and enables the GitHub integration settings for all your projects.

Set up Linking

πŸ“˜

For general information about Rollbar's Git integration, check out the Source Control guide.

Each line in your stack trace can be linked to your code in GitHub if it's hosted in a single repository. This has to be done once per project.

Link to GitHub

  1. Go to Settings β†’ Source Control β†’ GitHub
  2. Click Connect to GitHub
  3. Select a repository from the list of available repositories, enter the branch (default is 'master') and a project root within the repository (usually this can be left blank - click here for more details), then save the settings.
  4. Ensure you are sending the server.root key with your items. More details

Issue Tracking

πŸ“˜

For general information about Rollbar's issue tracking features, check out the Issue Tracking guide.

After connecting with GitHub you can integrate GitHub issues to automatically create issues when Rollbar items arrive, or to add a 'Create GitHub Issue' button to the item page. You should do this for each project you want integrated with GitHub issues.

To do this, navigate to your project notification settings (Settings in Rollbar top nav then Notifications on the side nav). Click GitHub Issues link and continue to set up the GitHub Issues integration.

Resolving Items

With the GitHub integration, you can resolve Rollbar items using git commit messages. See docs at Resolving Items via Commits.

Code Context

Rollbar can show additional lines of context for each entry in a traceback, saving you the trouble of jumping to your source code to figure out where exactly an exception occurred. View more detailed documentation.

Git Blame

Within each frame, Rollbar will attempt to retrieve git blame information. You will be able to see the the User Avatar of the person who last touched the code. After hovering over the avatar, you are able to view the associated Commit or Pull Request, and navigate to their respective locations in GitHub.

Troubleshooting

If you encounter authorization problems related to your organization, make sure that you have granted Rollbar access to the org by going to: https://github.com/settings/applications

Updated 10 months ago


GitHub


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.