Skip to content
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fixing merge conflicts
  • Loading branch information
cbehera-newrelic committed Oct 28, 2025
commit 88febe54f77476c0326e3df0a51dd7d4fe8a1b4f
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,23 @@ freshnessValidatedDate: never
This feature is currently provided as part of a preview program pursuant to our [pre-release policies](/docs/licenses/license-information/referenced-policies/new-relic-pre-release-policy).
</Callout>

The New Relic GitHub Enterprise integration imports repositories and teams from your on-premise GitHub Enterprise (GHE) account to enhance the visibility of your [Service Architecture Intelligence capability](/docs/service-architecture-intelligence/getting-started) in the New Relic platform.
Are you looking to gain deeper insights into your service architecture by leveraging data from your on-premise GitHub Enterprise account? The New Relic GitHub Enterprise integration imports repositories, teams, and user data directly into the New Relic platform using a secure collector service deployed within your private network.

This integration streamlines the onboarding process for users and teams, simplifies role management, and clarifies entity ownership mapping, reducing the setup configuration, time, and effort. Due to the restricted nature of GHE environments, integration is achieved via a local collector service deployed within your private network. This integration aims to enhance the management and visibility of [Catalogs](/docs/service-architecture-intelligence/catalogs/catalogs) and [Scorecards](/docs/service-architecture-intelligence/scorecards/getting-started) within New Relic. For more information, refer [Service Architecture Intelligence capability](/docs/service-architecture-intelligence/getting-started).
This integration streamlines the onboarding process for users and teams while simplifying role management. It also clarifies entity ownership mapping, reducing setup time and effort. Due to the restricted nature of GHE environments, integration is achieved via a local collector service deployed within your private network. This integration aims to enhance the management and visibility of [Catalogs](/docs/service-architecture-intelligence/catalogs/catalogs) and [Scorecards](/docs/service-architecture-intelligence/scorecards/getting-started) within New Relic. For more information, refer to the [Service Architecture Intelligence capability](/docs/service-architecture-intelligence/getting-started).

**Prerequisites**

* Login to your GitHub Enterprise account you plan to integrate with New Relic.
* GitHub Enterprise account that you want to integrate with New Relic.
* Docker environment to run the collector service within your GHE network.

**To set up the GitHub Enterprise integration:**

1. **Create and configure a GitHub app**: In your GHE instance, navigate to **Settings → Developer Settings → GitHub Apps → New GitHub App**.

1. **Configure Permissions**: Set the specific permissions required for the app to perform real-time and initial data syncs. A separate document outlining the required permissions will be provided.
2. **Set Up Webhooks**: Configure the Webhook URL (which we will provide) and create a custom Event Secret for secure communication.
3. **Install the App**: Install the created GitHub App on the relevant GHE organizations that you want to integrate with New Relic.
4. **Generate Keys**: Upon creation, the app will generate a unique App ID and a Private Key file (.pem format). Save these securely as they will be needed for the collector service configuration.
a. **Configure Permissions**: Set the specific permissions required for the app to perform real-time and initial data syncs. A separate document outlining the required permissions will be provided.
b. **Set Up Webhooks**: Configure the Webhook URL (which we will provide) and create a custom Event Secret for secure communication.
c. **Install the App**: Install the created GitHub App on the relevant GHE organizations that you want to integrate with New Relic.
d. **Generate Keys**: Upon creation, the app will generate a unique App ID and a Private Key file (.pem format). Save these securely as they will be needed for the collector service configuration.

2. **Prepare environment variables**: Before deploying the collector service, gather the following information:

Expand Down
Loading