Tools
New Relic
Query observability data and record deployments in New Relic
Integrate New Relic into workflows. Run NRQL queries, search monitored entities, fetch entity details, and record deployment change events.
Run a NRQL query against a New Relic account using NerdGraph.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | New Relic user API key for NerdGraph |
region | string | No | New Relic data center region: us or eu |
accountId | number | Yes | New Relic account ID to query |
nrql | string | Yes | NRQL query to execute |
timeout | number | No | Optional query timeout in seconds |
| Parameter | Type | Description |
|---|
results | array | NRQL result rows. Row fields depend on the query projection. |
resultCount | number | Number of NRQL result rows returned |
Search New Relic entities by name, GUID, domain type, tags, or reporting state.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | New Relic user API key for NerdGraph |
region | string | No | New Relic data center region: us or eu |
query | string | Yes | Entity search query, for example: name like "api" or domainType = "APM-APPLICATION" |
cursor | string | No | Pagination cursor from a previous entity search |
| Parameter | Type | Description |
|---|
count | number | Total number of entities matching the query |
query | string | Entity search query New Relic executed |
entities | array | Matching New Relic entities |
nextCursor | string | Cursor for the next page of results |
Fetch a New Relic entity by GUID.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | New Relic user API key for NerdGraph |
region | string | No | New Relic data center region: us or eu |
guid | string | Yes | Entity GUID |
| Parameter | Type | Description |
|---|
entity | object | New Relic entity details |
Record a deployment change event in New Relic change tracking.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | New Relic user API key for NerdGraph |
region | string | No | New Relic data center region: us or eu |
entityGuid | string | Yes | GUID of the entity associated with the deployment |
version | string | Yes | Deployment version, release name, or commit SHA |
shortDescription | string | No | Short description of the deployment |
description | string | No | Longer deployment description |
changelog | string | No | Deployment changelog text or URL |
commit | string | No | Commit SHA or identifier associated with the deployment |
deepLink | string | No | URL to the deployment, build, or release details |
user | string | No | User or automation that performed the deployment |
groupId | string | No | Optional group ID to correlate related changes |
customAttributes | json | No | Custom change event metadata as key-value pairs with string, number, or boolean values |
deploymentType | string | No | Deployment type: basic, blue green, canary, rolling, or shadow |
timestamp | number | No | Event timestamp in milliseconds since Unix epoch |
| Parameter | Type | Description |
|---|
event | object | Created New Relic change tracking event |
messages | array | Messages returned by New Relic for the created change event |
- Category:
tools
- Type:
new_relic
