Skip to main content
Connect to GitHub to let the Canvas Agent use your code during an investigation.
The GitHub connection is established for the whole Honeycomb Team through the Honeycomb GitHub App, but individual users can still toggle it on or off.

​
What the Canvas Agent can do

Read repositories, code, commits, branches, releases, pull requests, and issues.
The GitHub connector is read-only. The Canvas Agent cannot change anything in your repositories.
All GitHub tools are read-only tools, so the Canvas Agent runs them without asking, when your investigation needs them. To change this, visit Managing tool permissions.

​
Access this connector grants

The Canvas Agent can access any repository where the Honeycomb GitHub App has been installed. During setup in GitHub, you can specify whether to install the App for all or specific repositories. The Honeycomb GitHub App requests read access to repository contents, issues, pull requests, checks, and commit statuses.

​
Before you install

  • If your GitHub organization uses SAML single sign-on, the person who installs the App must have an active SSO session when they authorize the Honeycomb GitHub App. Otherwise, Honeycomb can fail to link the installation.
  • The GitHub connector works with GitHub.com only. GitHub Enterprise Server and GitHub Enterprise Cloud with data residency (GHE.com) are not supported.

​
Installing the Honeycomb GitHub App

To complete this task, you must be a Team Owner.
  1. Navigate to Canvas > Connectors.
  2. Find GitHub in the connector list and select Install app.
  3. On GitHub, choose the organization and repositories.
  4. Install and authorize the Honeycomb GitHub App.
Honeycomb returns you to the Connectors page. The GitHub row shows a Connected badge and a note such as Canvas can read selected repositories in acme.
A Honeycomb Team can connect to one GitHub App installation at a time. Connecting a single Honeycomb Team to multiple GitHub organizations is not supported.
To install the App on a GitHub organization, you must have permission to install GitHub Apps on that organization. If you do not, GitHub sends an install request to the organization owners.
You can also install the App from Account > Team Settings > Integrations. Select Install GitHub App in the Honeycomb + GitHub section.

​
Turning GitHub on or off

After the GitHub App is installed, you can choose whether to allow the Canvas Agent to use GitHub in your investigations.
  1. In a Canvas chat, select the plus (+) button.
  2. Choose Connectors.
  3. Use the toggle beside GitHub.

​
Removing the Honeycomb GitHub App

To complete this task, you must be a Team Owner.
  1. Navigate to Account > Team Settings > Integrations.
  2. In the Honeycomb + GitHub section, select Remove.
Removing the App uninstalls it from GitHub and removes the link for the whole Honeycomb Team. The Canvas Agent will no longer be able to read GitHub for anyone on the Team. To use GitHub again, reinstall the App. To learn more, visit Canvas Connectors.