Use New Relic 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.
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 apiKeystring Yes New Relic user API key for NerdGraph regionstring No New Relic data center region: us or eu accountIdnumber Yes New Relic account ID to query nrqlstring Yes NRQL query to execute timeoutnumber No Optional query timeout in seconds
Parameter Type Description resultsarray NRQL result rows. Row fields depend on the query projection. resultCountnumber Number of NRQL result rows returned
Search New Relic entities by name, GUID, domain type, tags, or reporting state.
Parameter Type Required Description apiKeystring Yes New Relic user API key for NerdGraph regionstring No New Relic data center region: us or eu querystring Yes Entity search query, for example: name like "api" or domainType = "APM-APPLICATION" cursorstring No Pagination cursor from a previous entity search
Parameter Type Description countnumber Total number of entities matching the query querystring Entity search query New Relic executed entitiesarray 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 nextCursorstring Cursor for the next page of results
Fetch a New Relic entity by GUID.
Parameter Type Required Description apiKeystring Yes New Relic user API key for NerdGraph regionstring No New Relic data center region: us or eu guidstring Yes Entity GUID
Parameter Type Description entityobject 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
Record a deployment change event in New Relic change tracking.
Parameter Type Required Description apiKeystring Yes New Relic user API key for NerdGraph regionstring No New Relic data center region: us or eu entityGuidstring Yes GUID of the entity associated with the deployment versionstring Yes Deployment version, release name, or commit SHA shortDescriptionstring No Short description of the deployment descriptionstring No Longer deployment description changelogstring No Deployment changelog text or URL commitstring No Commit SHA or identifier associated with the deployment deepLinkstring No URL to the deployment, build, or release details userstring No User or automation that performed the deployment groupIdstring No Optional group ID to correlate related changes customAttributesjson No Custom change event metadata as key-value pairs with string, number, or boolean values deploymentTypestring No Deployment type: basic, blue green, canary, rolling, or shadow timestampnumber No Event timestamp in milliseconds since Unix epoch
Parameter Type Description eventobject 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 messagesarray Messages returned by New Relic for the created change event