# New Relic (/integrations/new_relic)





{/* MANUAL-CONTENT-START:intro */}

Use [New Relic](https://newrelic.com/) through NerdGraph to query telemetry with NRQL, search monitored entities by name, type, tags, alert state, or reporting status, and retrieve basic metadata by entity GUID.

Record deployment changes with a version, changelog, commit, build links, group IDs, and user context to relate releases to telemetry. Configure the account and credentials required by the action.

{/* MANUAL-CONTENT-END */}

## Use the block [#usage-instructions]

Run NRQL queries, search monitored entities, fetch entity details, and record deployment change events.

## Actions [#actions]

### New Relic NRQL Query [#new-relic-nrql-query]

Run a NRQL query against a New Relic account using NerdGraph.

#### Input [#input]

| 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 |

#### Output [#output]

| Parameter | Type | Description |
| - | - | - |
| `results` | array | NRQL result rows. Row fields depend on the query projection. |
| `resultCount` | number | Number of NRQL result rows returned |

### New Relic Search Entities [#new-relic-search-entities]

Search New Relic entities by name, GUID, domain type, tags, or reporting state.

#### Input [#input-1]

| 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 |

#### Output [#output-1]

| 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 |
| ↳ `guid` | string | Entity GUID |
| ↳ `name` | string | Entity name |
| ↳ `entityType` | string | Entity type |
| ↳ `domain` | string | Entity domain, e.g. APM, INFRA |
| ↳ `reporting` | boolean | Whether the entity is currently reporting data |
| ↳ `alertSeverity` | string | Current alert severity for the entity |
| ↳ `tags` | array | Entity tags |
| ↳ `key` | string | Tag key |
| ↳ `values` | array | Tag values |
| `nextCursor` | string | Cursor for the next page of results |

### New Relic Get Entity [#new-relic-get-entity]

Fetch a New Relic entity by GUID.

#### Input [#input-2]

| 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 |

#### Output [#output-2]

| Parameter | Type | Description |
| - | - | - |
| `entity` | object | New Relic entity details |
| ↳ `guid` | string | Entity GUID |
| ↳ `name` | string | Entity name |
| ↳ `entityType` | string | Entity type |
| ↳ `domain` | string | Entity domain, e.g. APM, INFRA |
| ↳ `reporting` | boolean | Whether the entity is currently reporting data |
| ↳ `alertSeverity` | string | Current alert severity for the entity |
| ↳ `tags` | array | Entity tags |
| ↳ `key` | string | Tag key |
| ↳ `values` | array | Tag values |

### New Relic Create Deployment Event [#new-relic-create-deployment-event]

Record a deployment change event in New Relic change tracking.

<ReferenceDetails>
  #### Input [#input-3]

  | 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 |

  #### Output [#output-3]

  | Parameter | Type | Description |
  | - | - | - |
  | `event` | object | Created New Relic change tracking event |
  | ↳ `changeTrackingId` | string | New Relic change tracking ID |
  | ↳ `customAttributes` | json | Custom attributes on the change tracking event |
  | ↳ `category` | string | Change category |
  | ↳ `categoryAndType` | string | Combined category and type |
  | ↳ `type` | string | Change type |
  | ↳ `shortDescription` | string | Short change description |
  | ↳ `description` | string | Change description |
  | ↳ `timestamp` | number | Change timestamp in milliseconds |
  | ↳ `user` | string | User associated with the change |
  | ↳ `groupId` | string | Change group ID |
  | ↳ `entity` | object | Entity associated with the change |
  | ↳ `guid` | string | Entity GUID |
  | ↳ `name` | string | Entity name |
  | `messages` | array | Messages returned by New Relic for the created change event |
</ReferenceDetails>