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.
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | New Relic user API key for NerdGraph |
region | string | Non | New Relic data center region: us or eu |
accountId | number | Oui | New Relic account ID to query |
nrql | string | Oui | NRQL query to execute |
timeout | number | Non | Optional query timeout in seconds |
| Paramètre | 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.
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | New Relic user API key for NerdGraph |
region | string | Non | New Relic data center region: us or eu |
query | string | Oui | Entity search query, for example: name like "api" or domainType = "APM-APPLICATION" |
cursor | string | Non | Pagination cursor from a previous entity search |
| Paramètre | 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 |
nextCursor | string | Cursor for the next page of results |
Fetch a New Relic entity by GUID.
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | New Relic user API key for NerdGraph |
region | string | Non | New Relic data center region: us or eu |
guid | string | Oui | Entity GUID |
| Paramètre | Type | Description |
|---|
entity | object | New Relic entity details |
↳ guid | string | Entity GUID |
↳ name | string | Entity name |
↳ entityType | string | Entity type |
Record a deployment change event in New Relic change tracking.
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | New Relic user API key for NerdGraph |
region | string | Non | New Relic data center region: us or eu |
entityGuid | string | Oui | GUID of the entity associated with the deployment |
version | string | Oui | Deployment version, release name, or commit SHA |
shortDescription | string | Non | Short description of the deployment |
description | string | Non | Longer deployment description |
changelog | string | Non | Deployment changelog text or URL |
commit | string | Non | Commit SHA or identifier associated with the deployment |
deepLink | string | Non | URL to the deployment, build, or release details |
user | string | Non | User or automation that performed the deployment |
groupId | string | Non | Optional group ID to correlate related changes |
customAttributes | json | Non | Custom change event metadata as key-value pairs with string, number, or boolean values |
deploymentType | string | Non | Deployment type: basic, blue green, canary, rolling, or shadow |
timestamp | number | Non | Event timestamp in milliseconds since Unix epoch |
| Paramètre | 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 |
