What the Canvas Agent can do
Read repositories, code, commits, branches, releases, pull requests, issues, checks, and commit statuses.The GitHub connector is read-only.
The Canvas Agent cannot change anything in your repositories.
Access this connector grants
The Honeycomb GitHub App requests read access to repository contents, metadata, issues, pull requests, checks, and commit statuses.Before you install
- The GitHub connector works with GitHub.com only. GitHub Enterprise Server and GitHub Enterprise Cloud with data residency (GHE.com) are not supported.
- The person who installs the App must also be an owner of your Honeycomb Team. Honeycomb links an installation only to the GitHub user who installed it.
- 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. If the session is not active, Honeycomb can fail to link the installation.
Installing the Honeycomb GitHub App
To complete this task, you must be a Team Owner.
- Navigate to Canvas > Connectors.
- Find GitHub in the connector list and select Install app.
- On GitHub, choose the organization and repositories.
- Install and authorize the Honeycomb GitHub App.
A Honeycomb Team can link to one GitHub App installation at a time, so you cannot connect one Honeycomb Team to more than one GitHub organization.
If an installation is already linked to a different Honeycomb Team, you cannot link it to your Team.
To install the App on a GitHub organization, you must have permission to install GitHub Apps on that organization.
If you do not have this permission, GitHub sends an install request to the organization owners.
The organization owner who approves the request must then finish the link in Honeycomb, and that owner must also be an owner of your Honeycomb Team.
Turning GitHub on or off
After a Honeycomb Team owner installs the GitHub App, you can choose whether the Canvas Agent uses GitHub in your investigations.- In a Canvas chat, select the plus (
+) button. - Choose Connectors.
- Use the toggle beside GitHub.
Troubleshooting the GitHub connector
If the GitHub row on the Connectors page shows a warning, use this table to fix it:
If you are not an owner of your Honeycomb Team and GitHub is not installed, the GitHub row has no Install app button.
Ask a Honeycomb Team owner to install the App.
Removing the Honeycomb GitHub App
To complete this task, you must be a Team Owner.
- Navigate to Account > Team Settings > Integrations.
- In the Honeycomb + GitHub section, select Remove.