GitHub Apps

GitHub Apps

Overview

Connect Datadog with GitHub Apps to enable permissions for your repositories and see code snippets in your errors. You can also display links to GitHub PRs and issues in Datadog’s notebooks and incident timelines.

Setup

Installation

Install the integration tile with the Datadog GitHub Apps integration tile.

Configuration

If you are an admin in your GitHub organization, you can configure GitHub Apps.

  1. In the GitHub Apps integration tile, navigate to the Configuration tab.
  2. Click Link GitHub Account to create a new GitHub App.
  3. In Configure, either select Organization and enter a name for your organization, or select Personal Account.
  4. In Edit Permissions, enable Datadog read permissions for issues, pull requests, and contents. You must select at least one permission.
  5. Click Create App in GitHub, then you are prompted to enter a GitHub App name in GitHub.
  6. Enter a name in the GitHub App name field and click Create GitHub App.
  7. In the Configuration tab, click Install GitHub App and Install & Authorize.

Your GitHub App displays in the integration tile. To enable inline code snippets in stack traces, see Setting Up Source Code Integration.

Notebooks

In Notebooks, GitHub issues and pull requests automatically generate a preview hoverbox with additional details including commit history, author, and date.

  1. Navigate to Notebooks > New Notebook.
  2. Add a Text cell and mention an issue or pull request on GitHub in the Edit field, for example: https://github.com/project/repository/pull/#.
  3. Click Done, then the GitHub icon appears next to your linked issue or pull request.
  4. Click Connect to Preview and Authorize.
  5. Hover over the linked issue or pull request to see the description preview.

Data Collected

Metrics

The GitHub Apps integration does not include any metrics.

Events

The GitHub Apps integration does not include any events.

Service Checks

The GitHub Apps integration does not include any service checks.

Troubleshooting

Need help? Contact Datadog support.

Further Reading

Additional helpful documentation, links, and articles: