Connecting repositories to services

Set the environment variable NEW_RELIC_METADATA_REPOSITORY_URL. New Relic APM agents create the repository entity and associate it with your application entity automatically.

This requires the SSH or HTTPS remote URL format. We recommend that this be set as part of your build pipeline.

Go to the APM summary page via one.newrelic.com > All capabilities > APM & Services > (select an app), then look click on the ellipses menu to the right of the service name. Click on the Repositories tab to connect a repository.

Click Connect repository to find an existing repository or add a new one.

Use New Relic's NerdGraph APIs to create a repository and associate it with your application entities.

Step 1: Create a repository entity

To create a repository entity, use the referenceEntityCreateOrUpdateRepository API and make sure to save the GUID that's produced. The API takes the following parameters:

• accountId - the integer account ID for the account you want to add the repository to

• url - example https://github.com/newrelic/beta-docs-site.git

• name - example: newrelic/beta-docs-site

  mutation {
    referenceEntityCreateOrUpdateRepository(
      repositories: [
        { accountId: [YOUR_ACCOUNT_ID], name: "[REPO_NAME]", url: "[REPO_URL]" }
      ]
    ) {
      created
      failures {
        guid
        message
        type
      }
    }
  }

  Copy

  To find the entity you create, you can use a query like the following. Note that the URL you provided to referenceEntityCreateOrUpdateRepository gets saved as an entity tag.

  {
    actor {
      entitySearch(query: "name = 'a name' OR tags.url = 'a url'") {
        count
        query
        results {
          entities {
            guid
            name
            tags {
              key
              values
            }
          }
        }
      }
    }
  }

  Copy

  Step 2: Associate the repository entity to your application entity

  First, find the GUID for the application you want to associate your repository to.

  Parameters:

• sourceEntityGuid - the entity GUID of the application

• targetEntityGuid - the entity GUID of your repository

• type - always BUILT_FROM

  mutation {
    entityRelationshipUserDefinedCreateOrReplace(
      sourceEntityGuid: ""
      targetEntityGuid: ""
      type: BUILT_FROM
    ) {
      errors {
        message
        type
      }
    }
  }

  Copy

  To see all entities related to your repository you can do a query like this:

  {
    actor {
      entity(guid: "[YOUR_REPOSITORY_GUID]]") {
        relatedEntities(
          filter: { direction: BOTH, relationshipTypes: { include: BUILT_FROM } }
        ) {
          results {
            target {
              entity {
                name
                guid
                type
              }
            }
            type
          }
        }
        name
        type
        tags {
          values
          key
        }
      }
    }
  }

  Copy

  Step 3: Cleanup (if needed)

  Delete a repository with the following query:

  mutation DeleteRepository {
    entityDelete(guids: "[ENTITY_GUID_HERE]]") {
      deletedEntities
      failures {
        message
        guid
      }
    }
  }

  Copy