At a glance
- Availability: Experimental (how to enable).
- Auth: API key.
- Connection: The key from
NEW_RELIC_API_KEYis sent as theAPI-Keyheader. - Docs: https://docs.newrelic.com/docs/apis/nerdgraph/get-started/introduction-new-relic-nerdgraph/
Credentials
Set these per environment. See Connect an integration.| Variable | Required | Description |
|---|---|---|
NEW_RELIC_API_KEY | Yes | New Relic user API key (starts with NRAK-), sent as the API-Key header Docs. |
Setup
- Sign up for New Relic: Free accounts at https://newrelic.com include full API access. Note your account ID from the account picker or the URL - NRQL and issue tools need it.
- Create a user API key: Go to https://one.newrelic.com/api-keys and create a key of type ‘User’ (it starts with NRAK-). User keys are required for NerdGraph.
- Set the environment variable: Add the key to your .env as NEW_RELIC_API_KEY=NRAK-…
- Verify access: Run Search Entities with a query like “domain = ‘APM’”, or Run NRQL Query with your account ID.
- All tools are GraphQL calls to https://api.newrelic.com/graphql with the key in the ‘API-Key’ header
- EU-region accounts use api.eu.newrelic.com; these tools target the US endpoint
- NRQL and issue tools take your numeric account ID as a parameter - find it under Administration → Access management → Accounts
Tools
| Tool | Access | Description |
|---|---|---|
| Run NRQL Query | Read | Run an NRQL query against a New Relic account and return the results |
| Search Entities | Read | Search monitored entities (apps, hosts, services) with an entity search query |
| Get Entity | Read | Get an entity’s details and tags by GUID |
| List Issues | Read | List alert issues from the last day in an account (queries the NrAiIssue event type via NRQL) |
Example prompts
- Run a New Relic NRQL query for the transaction error rate in the last hour and summarize the result.
- List the open New Relic issues in my account ordered by priority.