New Relic

Query observability data and record deployments in New Relic

New Relic is an observability platform for monitoring application performance, infrastructure, logs, traces, and business-impacting changes across your systems. It centralizes telemetry in NRDB and exposes that data through NerdGraph, New Relic's GraphQL API.

With New Relic, you can:

  • Query telemetry with NRQL: Run NRQL against account data to inspect service health, usage, errors, latency, and custom events.
  • Find monitored entities: Search services, applications, hosts, and other monitored resources by name, type, tags, alert state, or reporting status.
  • Fetch entity details: Resolve an entity GUID into basic entity metadata for downstream workflow steps.
  • Record deployment changes: Create deployment change tracking events with version, changelog, commit, build links, group IDs, and user context.

Sim's New Relic integration lets agents pull production observability signals into workflows and annotate releases or operational changes directly from automation. Use it to summarize live service health, route incident workflows from entity searches, or mark deployments so New Relic charts can correlate performance changes with release activity.

Usage Instructions

Integrate New Relic into workflows. Run NRQL queries, search monitored entities, fetch entity details, and record deployment change events.

Tools

new_relic_nrql_query

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

Input

ParameterTypeRequiredDescription
apiKeystringYesNew Relic user API key for NerdGraph
regionstringNoNew Relic data center region: us or eu
accountIdnumberYesNew Relic account ID to query
nrqlstringYesNRQL query to execute
timeoutnumberNoOptional query timeout in seconds

Output

ParameterTypeDescription
resultsarrayNRQL result rows. Row fields depend on the query projection.
resultCountnumberNumber of NRQL result rows returned

new_relic_search_entities

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

Input

ParameterTypeRequiredDescription
apiKeystringYesNew Relic user API key for NerdGraph
regionstringNoNew Relic data center region: us or eu
querystringYesEntity search query, for example: name like "api" or domainType = "APM-APPLICATION"
cursorstringNoPagination cursor from a previous entity search

Output

ParameterTypeDescription
countnumberTotal number of entities matching the query
querystringEntity search query New Relic executed
entitiesarrayMatching New Relic entities
guidstringEntity GUID
namestringEntity name
entityTypestringEntity type
nextCursorstringCursor for the next page of results

new_relic_get_entity

Fetch a New Relic entity by GUID.

Input

ParameterTypeRequiredDescription
apiKeystringYesNew Relic user API key for NerdGraph
regionstringNoNew Relic data center region: us or eu
guidstringYesEntity GUID

Output

ParameterTypeDescription
entityobjectNew Relic entity details
guidstringEntity GUID
namestringEntity name
entityTypestringEntity type

new_relic_create_deployment_event

Record a deployment change event in New Relic change tracking.

Input

ParameterTypeRequiredDescription
apiKeystringYesNew Relic user API key for NerdGraph
regionstringNoNew Relic data center region: us or eu
entityGuidstringYesGUID of the entity associated with the deployment
versionstringYesDeployment version, release name, or commit SHA
shortDescriptionstringNoShort description of the deployment
descriptionstringNoLonger deployment description
changelogstringNoDeployment changelog text or URL
commitstringNoCommit SHA or identifier associated with the deployment
deepLinkstringNoURL to the deployment, build, or release details
userstringNoUser or automation that performed the deployment
groupIdstringNoOptional group ID to correlate related changes
customAttributesjsonNoCustom change event metadata as key-value pairs with string, number, or boolean values
deploymentTypestringNoDeployment type: basic, blue green, canary, rolling, or shadow
timestampnumberNoEvent timestamp in milliseconds since Unix epoch

Output

ParameterTypeDescription
eventobjectCreated New Relic change tracking event
changeTrackingIdstringNew Relic change tracking ID
customAttributesjsonCustom attributes on the change tracking event
categorystringChange category
categoryAndTypestringCombined category and type
typestringChange type
shortDescriptionstringShort change description
descriptionstringChange description
timestampnumberChange timestamp in milliseconds
userstringUser associated with the change
groupIdstringChange group ID
entityobjectEntity associated with the change
guidstringEntity GUID
namestringEntity name
messagesarrayMessages returned by New Relic for the created change event

On this page