Before deleting a private location, ensure no monitors are assigned to it. Deleting a private location that has active monitors assigned will cause those monitors to fail.
@@ -301,3 +301,12 @@ A successful response returns `null` for errors:
```
If there are any issues deleting the private location, the `errors` array will contain objects with `description` and `type` fields explaining what went wrong.
+
+## Query private locations [#query-private-locations]
+
+Use NerdGraph to retrieve location metadata and configuration details.
+
+For more information, refer to:
+- [Query private locations](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data#query-private-locations) - Get all private locations with their configuration details.
+
+To view complete list of query examples, refer to the [Query synthetics data](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data) document.
diff --git a/src/content/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data.mdx b/src/content/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data.mdx
index f9e1ae756e79..7582230eb47d 100644
--- a/src/content/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data.mdx
+++ b/src/content/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data.mdx
@@ -11,186 +11,161 @@ freshnessValidatedDate: never
After setting up your monitoring infrastructure, you can use queries to retrieve information about your synthetic entities. Queries make requests to fetch data about monitors, private locations, credentials, and downtimes. This tutorial provides examples of how to use the NerdGraph API to query synthetic monitoring data.
+
+ **Quick Navigation**: Use the links below to jump to specific query types:
+ - [General monitor queries](#query-monitors): Query all monitors or specific types
+ - [Monitor-specific queries](#query-monitor-script): Retrieve the script from a scripted monitor, or the ordered steps from a step monitor
+ - [Supporting entity queries](#query-private-locations): Query private locations, secure credentials, and monitor downtimes
+ - [Advanced queries](#query-guid-mapping): Map legacy monitor IDs and check runtime upgrade status
+
+
To learn additional query capabilities available to your synthetic entities, check out [NerdGraph entities API tutorial](/docs/apis/nerdgraph/examples/nerdgraph-entities-api-tutorial/).
-## Query monitors [#query-monitors]
-
-This query retrieves all synthetic monitors in your account, returning essential information including the monitor's GUID, name, account ID, monitor type, and associated tags. The tags contain additional configuration details and metadata about each monitor.
-
-### Input parameters
-
-
-
-
- | Parameter |
- Data Type |
- Is it Required? |
- Description |
-
-
-
-
- | `query` |
- String |
- Yes |
- The search query to filter entities. Use `domain = 'SYNTH' AND type = 'MONITOR'` to retrieve all synthetic monitors. |
-
-
-
-
-### Sample query
-
-```graphql
-{
- actor {
- entitySearch(query: "domain = 'SYNTH' AND type = 'MONITOR'") {
- results {
- entities {
- ... on SyntheticMonitorEntityOutline {
- guid
- name
- accountId
- monitorType
- tags {
- key
- values
+## General monitor queries [#general-monitor-queries]
+
+
+
+
+ This query retrieves all synthetic monitors in your account, returning essential information including the monitor's GUID, name, account ID, monitor type, and associated tags. The tags contain additional configuration details and metadata about each monitor.
+
+ ### Input parameters
+
+
+
+
+ | Parameter |
+ Data Type |
+ Is it Required? |
+ Description |
+
+
+
+
+ | `query` |
+ String |
+ Yes |
+ The search query to filter entities. Use `domain = 'SYNTH' AND type = 'MONITOR'` to retrieve all synthetic monitors. |
+
+
+
+
+ ### Sample query
+
+ ```graphql
+ {
+ actor {
+ entitySearch(query: "domain = 'SYNTH' AND type = 'MONITOR'") {
+ results {
+ entities {
+ ... on SyntheticMonitorEntityOutline {
+ guid
+ name
+ accountId
+ monitorType
+ tags {
+ key
+ values
+ }
}
}
}
}
}
}
-}
-```
-
-## Query private locations [#query-private-locations]
-
-This query retrieves all private locations in your account, returning essential information including the location's GUID, name, account ID, and associated tags. Private locations allow you to monitor applications behind your firewall, and their configuration details are accessible through the tags.
-
-### Input parameters
-
-
-
-
- | Parameter |
- Data Type |
- Is it Required? |
- Description |
-
-
-
-
- | `query` |
- String |
- Yes |
- The search query to filter entities. Use `domain = 'SYNTH' AND type = 'PRIVATE_LOCATION'` to retrieve all private locations. |
-
-
-
-
-### Sample query
-
-```graphql
-{
- actor {
- entitySearch(query: "domain = 'SYNTH' AND type = 'PRIVATE_LOCATION'") {
- results {
- entities {
- accountId
- guid
- name
- tags {
- key
- values
- }
- }
- }
- }
- }
-}
-```
-
-## Query monitor downtimes [#query-monitor-downtimes]
-
-This query retrieves all monitor downtimes in your account, returning essential information including the downtime's GUID, name, account ID, and associated tags. Monitor downtimes are scheduled periods when synthetic monitors stop running, useful during planned maintenance or known outages. Configuration details such as schedule type, timezone, and recurrence patterns are stored in tags.
-
-### Input parameters
-
-
-
-
- | Parameter |
- Data Type |
- Is it Required? |
- Description |
-
-
-
-
- | `query` |
- String |
- Yes |
- The search query to filter entities. Use `domain = 'SYNTH' AND type = 'MONITOR_DOWNTIME'` to retrieve all monitor downtimes. |
-
-
-
-
-### Sample query
-
-```graphql
-{
- actor {
- entitySearch(query: "domain = 'SYNTH' AND type = 'MONITOR_DOWNTIME'") {
- results {
- entities {
- accountId
- guid
- name
- tags {
- key
- values
+ ```
+
+
+
+## Entity support queries [#supporting-entity-queries]
+
+
+
+
+ This query retrieves all private locations in your account, returning essential information including the location's GUID, name, account ID, and associated tags. Private locations allow you to monitor applications behind your firewall, and their configuration details are accessible through the tags.
+
+ ### Input parameters
+
+
+
+
+ | Parameter |
+ Data Type |
+ Is it Required? |
+ Description |
+
+
+
+
+ | `query` |
+ String |
+ Yes |
+ The search query to filter entities. Use `domain = 'SYNTH' AND type = 'PRIVATE_LOCATION'` to retrieve all private locations. |
+
+
+
+
+ ### Sample query
+
+ ```graphql
+ {
+ actor {
+ entitySearch(query: "domain = 'SYNTH' AND type = 'PRIVATE_LOCATION'") {
+ results {
+ entities {
+ accountId
+ guid
+ name
+ tags {
+ key
+ values
+ }
}
}
}
}
}
-}
-```
-
-## Query secure credentials [#query-secure-credentials]
-
-This query retrieves all secure credentials in your account, returning metadata information including the credential's GUID, name, account ID, tags, and last update timestamp. Secure credentials help store, protect, and centrally manage sensitive information like passwords, API keys, or encoded certificates. For security reasons, querying secure credentials returns metadata only, but not the actual credential values themselves.
-
-### Input parameters
-
-
-
-
- | Parameter |
- Data Type |
- Is it Required? |
- Description |
-
-
-
-
- | `query` |
- String |
- Yes |
- The search query to filter entities. Use `domain = 'SYNTH' AND type = 'SECURE_CRED'` to retrieve all secure credentials. |
-
-
-
-
-### Sample query
-
-```graphql
-{
- actor {
- entitySearch(query: "domain = 'SYNTH' AND type = 'SECURE_CRED'") {
- results {
- entities {
- ... on SecureCredentialEntityOutline {
+ ```
+
+
+
+
+ This query retrieves all monitor downtimes in your account, returning essential information including the downtime's GUID, name, account ID, and associated tags. Monitor downtimes are scheduled periods when synthetic monitors stop running, useful during planned maintenance or known outages. Configuration details such as schedule type, timezone, and recurrence patterns are stored in tags.
+
+ ### Input parameters
+
+
+
+
+ | Parameter |
+ Data Type |
+ Is it Required? |
+ Description |
+
+
+
+
+ | `query` |
+ String |
+ Yes |
+ The search query to filter entities. Use `domain = 'SYNTH' AND type = 'MONITOR_DOWNTIME'` to retrieve all monitor downtimes. |
+
+
+
+
+ ### Sample query
+
+ ```graphql
+ {
+ actor {
+ entitySearch(query: "domain = 'SYNTH' AND type = 'MONITOR_DOWNTIME'") {
+ results {
+ entities {
accountId
guid
name
@@ -198,250 +173,326 @@ This query retrieves all secure credentials in your account, returning metadata
key
values
}
- updatedAt
}
}
}
}
}
-}
-```
-
-## Query monitor script [#query-monitor-script]
-
-This query retrieves the script content used in a scripted API or scripted browser monitor. The script contains the JavaScript code that defines the monitor's behavior, such as API calls, browser interactions, or custom validation logic. This query only works with scripted monitor types - other monitor types (simple, ping, step, certificate check, broken links) will return an error since they don't use custom scripts.
-
-### Input parameters
-
-
-
-
- | Parameter |
- Data Type |
- Is it Required? |
- Description |
-
-
-
-
- | `id` (account) |
- Integer |
- Yes |
- The New Relic account ID that contains the monitor. |
-
-
- | `monitorGuid` |
- String |
- Yes |
- The unique entity GUID of the scripted monitor whose script you want to retrieve. |
-
-
-
-
-### Sample query
-
-```graphql
-{
- actor {
- account(id: ACCOUNT_ID) {
- synthetics {
- script(monitorGuid: "ENTITY_GUID") {
- text
+ ```
+
+
+
+
+ This query retrieves all secure credentials in your account, returning metadata information including the credential's GUID, name, account ID, tags, and last update timestamp. Secure credentials help store, protect, and centrally manage sensitive information like passwords, API keys, or encoded certificates. For security reasons, querying secure credentials returns metadata only, but not the actual credential values themselves.
+
+ ### Input parameters
+
+
+
+
+ | Parameter |
+ Data Type |
+ Is it Required? |
+ Description |
+
+
+
+
+ | `query` |
+ String |
+ Yes |
+ The search query to filter entities. Use `domain = 'SYNTH' AND type = 'SECURE_CRED'` to retrieve all secure credentials. |
+
+
+
+
+ ### Sample query
+
+ ```graphql
+ {
+ actor {
+ entitySearch(query: "domain = 'SYNTH' AND type = 'SECURE_CRED'") {
+ results {
+ entities {
+ ... on SecureCredentialEntityOutline {
+ accountId
+ guid
+ name
+ tags {
+ key
+ values
+ }
+ updatedAt
+ }
+ }
}
}
}
}
-}
-```
-
-## Query monitor steps [#query-monitor-steps]
-
-This query retrieves the steps configured for a step monitor. Step monitors provide codeless, multi-step browser-based monitoring through a sequence of predefined actions like navigation, clicks, form inputs, and assertions. Each step has an ordinal position, a type that defines the action, and values that contain the step's configuration data. This query only works with step monitors - other monitor types will return an error since they don't use step-based configurations.
-
-### Input parameters
-
-
-
-
- | Parameter |
- Data Type |
- Is it Required? |
- Description |
-
-
-
-
- | `id` (account) |
- Integer |
- Yes |
- The New Relic account ID that contains the monitor. |
-
-
- | `monitorGuid` |
- String |
- Yes |
- The unique entity GUID of the step monitor whose steps you want to retrieve. |
-
-
-
-
-### Sample query
-
-```graphql
-{
- actor {
- account(id: ACCOUNT_ID) {
- synthetics {
- steps(monitorGuid: "ENTITY_GUID") {
- ordinal
- type
- values
+ ```
+
+
+
+## Monitor-specific queries [#monitor-specific-queries]
+
+
+
+
+ This query retrieves the script content used in a scripted API or scripted browser monitor. The script contains the JavaScript code that defines the monitor's behavior, such as API calls, browser interactions, or custom validation logic. This query only works with scripted monitor types: other monitor types (simple, ping, step, certificate check, broken links) will return an error since they don't use custom scripts.
+
+ ### Input parameters
+
+
+
+
+ | Parameter |
+ Data Type |
+ Is it Required? |
+ Description |
+
+
+
+
+ | `id` (account) |
+ Integer |
+ Yes |
+ The New Relic account ID that contains the monitor. |
+
+
+ | `monitorGuid` |
+ String |
+ Yes |
+ The unique entity GUID of the scripted monitor whose script you want to retrieve. |
+
+
+
+
+ ### Sample query
+
+ ```graphql
+ {
+ actor {
+ account(id: ACCOUNT_ID) {
+ synthetics {
+ script(monitorGuid: "ENTITY_GUID") {
+ text
+ }
}
}
}
}
-}
-```
-
-## Query to map monitor ID to entity GUID [#query-guid-mapping]
-
-This query retrieves the entity GUID for a synthetic monitor using the monitor ID. This is useful when you have the legacy numeric monitor ID and need to convert it to the entity GUID format required for most NerdGraph operations. The entity GUID is the modern identifier used for updates, deletions, and other monitor management tasks, while the monitor ID is the older numeric identifier that may appear in URLs or legacy integrations.
-
-### Input parameters
-
-
-
-
- | Parameter |
- Data Type |
- Is it Required? |
- Description |
-
-
-
-
- | `query` |
- String |
- Yes |
- The search query to find the monitor. Use `domainId = 'MONITOR_ID'` where MONITOR_ID is the numeric ID of the monitor you want to find. |
-
-
-
-
-### Sample query
-
-```graphql
-{
- actor {
- entitySearch(
- query: "(domainId = 'MONITOR_ID')"
- ) {
- results {
- entities {
- ... on SyntheticMonitorEntityOutline {
- guid
- name
- monitorId
+ ```
+
+
+
+
+ This query retrieves the steps configured for a step monitor. Step monitors provide codeless, multi-step browser-based monitoring through a sequence of predefined actions like navigation, clicks, form inputs, and assertions. Each step has an ordinal position, a type that defines the action, and values that contain the step's configuration data. This query only works with step monitors: other monitor types will return an error since they don't use step-based configurations.
+
+ ### Input parameters
+
+
+
+
+ | Parameter |
+ Data Type |
+ Is it Required? |
+ Description |
+
+
+
+
+ | `id` (account) |
+ Integer |
+ Yes |
+ The New Relic account ID that contains the monitor. |
+
+
+ | `monitorGuid` |
+ String |
+ Yes |
+ The unique entity GUID of the step monitor whose steps you want to retrieve. |
+
+
+
+
+ ### Sample query
+
+ ```graphql
+ {
+ actor {
+ account(id: ACCOUNT_ID) {
+ synthetics {
+ steps(monitorGuid: "ENTITY_GUID") {
+ ordinal
+ type
+ values
}
}
}
}
}
-}
-```
-
-## Query runtime upgrade status (all monitors) [#query-runtime-upgrade-all]
-
-This query retrieves the status of all runtime upgrade tests for legacy runtime monitors in your account. These tests validate whether monitors using older runtimes (like Chrome 72 or Node.js API legacy) can successfully run on newer runtimes (Chrome 100+ or Node.js 16.10). The results populate the [runtime upgrades UI](/docs/synthetics/synthetic-monitoring/using-monitors/runtime-upgrade-ui/) and help you identify which monitors are ready for upgrade. The test result is stored in the `validationStatus` tag, and if the upgrade test failed, detailed error information is available in the `validationError` tag.
-
-### Input parameters
-
-
-
-
- | Parameter |
- Data Type |
- Is it Required? |
- Description |
-
-
-
-
- | `query` |
- String |
- Yes |
- The search query to filter entities. Use `domain = 'SYNTH' AND type = 'RUNTIME_VALIDATION'` to retrieve all runtime upgrade test results. |
-
-
-
-
-### Sample query
-
-```graphql
-{
- actor {
- entitySearch(query: "domain = 'SYNTH' AND type = 'RUNTIME_VALIDATION'") {
- results {
- entities {
- accountId
- guid
- name
- tags {
- key
- values
+ ```
+
+
+
+## Advanced queries [#advanced-queries]
+
+
+
+
+ This query retrieves the entity GUID for a synthetic monitor using the monitor ID. This is useful when you have the legacy numeric monitor ID and need to convert it to the entity GUID format required for most NerdGraph operations. The entity GUID is the modern identifier used for updates, deletions, and other monitor management tasks, while the monitor ID is the older numeric identifier that may appear in URLs or legacy integrations.
+
+ ### Input parameters
+
+
+
+
+ | Parameter |
+ Data Type |
+ Is it Required? |
+ Description |
+
+
+
+
+ | `query` |
+ String |
+ Yes |
+ The search query to find the monitor. Use `domainId = 'MONITOR_ID'` where `MONITOR_ID` is the numeric ID of the monitor you want to find. |
+
+
+
+
+ ### Sample query
+
+ ```graphql
+ {
+ actor {
+ entitySearch(
+ query: "(domainId = 'MONITOR_ID')"
+ ) {
+ results {
+ entities {
+ ... on SyntheticMonitorEntityOutline {
+ guid
+ name
+ monitorId
+ }
}
}
}
}
}
-}
-```
-
-## Query runtime upgrade status (specific monitor) [#query-runtime-upgrade-specific]
-
-This query retrieves the status of a runtime upgrade test for a specific legacy runtime monitor using the monitor ID. This is useful when you want to check the upgrade readiness of a particular monitor rather than all monitors in your account. The test validates whether the monitor can successfully run on newer runtimes and these results populate the [runtime upgrades UI](/docs/synthetics/synthetic-monitoring/using-monitors/runtime-upgrade-ui/). The test result is stored in the `validationStatus` tag, and if the upgrade test failed, detailed error information is available in the `validationError` tag.
-
-### Input parameters
-
-
-
-
- | Parameter |
- Data Type |
- Is it Required? |
- Description |
-
-
-
-
- | `query` |
- String |
- Yes |
- The search query to filter entities. Use `domain = 'SYNTH' AND type = 'RUNTIME_VALIDATION' AND domainId = 'MONITOR_ID'` where MONITOR_ID is the numeric ID of the specific monitor. |
-
-
-
-
-### Sample query
-
-```graphql
-{
- actor {
- entitySearch(
- query: "domain = 'SYNTH' AND type = 'RUNTIME_VALIDATION' AND domainId = 'MONITOR_ID'"
- ) {
- results {
- entities {
- accountId
- guid
- name
- tags {
- key
- values
+ ```
+
+
+
+
+ This query retrieves the status of all runtime upgrade tests for legacy runtime monitors in your account. These tests validate whether monitors using older runtimes (like Chrome 72 or Node.js API legacy) can successfully run on newer runtimes (Chrome 100+ or Node.js 16.10). The results populate the [runtime upgrades UI](/docs/synthetics/synthetic-monitoring/using-monitors/runtime-upgrade-ui/) and help you identify which monitors are ready for upgrade. The test result is stored in the `validationStatus` tag, and if the upgrade test failed, detailed error information is available in the `validationError` tag.
+
+ ### Input parameters
+
+
+
+
+ | Parameter |
+ Data Type |
+ Is it Required? |
+ Description |
+
+
+
+
+ | `query` |
+ String |
+ Yes |
+ The search query to filter entities. Use `domain = 'SYNTH' AND type = 'RUNTIME_VALIDATION'` to retrieve all runtime upgrade test results. |
+
+
+
+
+ ### Sample query
+
+ ```graphql
+ {
+ actor {
+ entitySearch(query: "domain = 'SYNTH' AND type = 'RUNTIME_VALIDATION'") {
+ results {
+ entities {
+ accountId
+ guid
+ name
+ tags {
+ key
+ values
+ }
+ }
+ }
+ }
+ }
+ }
+ ```
+
+
+
+
+ This query retrieves the status of a runtime upgrade test for a specific legacy runtime monitor using the monitor ID. This is useful when you want to check the upgrade readiness of a particular monitor rather than all monitors in your account. The test validates whether the monitor can successfully run on newer runtimes and these results populate the [runtime upgrades UI](/docs/synthetics/synthetic-monitoring/using-monitors/runtime-upgrade-ui/). The test result is stored in the `validationStatus` tag, and if the upgrade test failed, detailed error information is available in the `validationError` tag.
+
+ ### Input parameters
+
+
+
+
+ | Parameter |
+ Data Type |
+ Is it Required? |
+ Description |
+
+
+
+
+ | `query` |
+ String |
+ Yes |
+ The search query to filter entities. Use `domain = 'SYNTH' AND type = 'RUNTIME_VALIDATION' AND domainId = 'MONITOR_ID'` where `MONITOR_ID` is the numeric ID of the specific monitor. |
+
+
+
+
+ ### Sample query
+
+ ```graphql
+ {
+ actor {
+ entitySearch(
+ query: "domain = 'SYNTH' AND type = 'RUNTIME_VALIDATION' AND domainId = 'MONITOR_ID'"
+ ) {
+ results {
+ entities {
+ accountId
+ guid
+ name
+ tags {
+ key
+ values
+ }
}
}
}
}
}
-}
-```
+ ```
+
+
diff --git a/src/content/docs/apis/nerdgraph/examples/synthetics-api/scripted-api-monitor.mdx b/src/content/docs/apis/nerdgraph/examples/synthetics-api/scripted-api-monitor.mdx
index 39a73618a70d..ffaf46ab38cd 100644
--- a/src/content/docs/apis/nerdgraph/examples/synthetics-api/scripted-api-monitor.mdx
+++ b/src/content/docs/apis/nerdgraph/examples/synthetics-api/scripted-api-monitor.mdx
@@ -13,7 +13,7 @@ New Relic allows you use NerdGraph to create [scripted API monitors](/docs/synth
## Create a scripted API monitor [#create-scripted-api]
-You can create a scripted API monitor using the `syntheticsCreateScriptApiMonitor` mutation. This mutation allows you to set up custom API testing that executes your JavaScript code to validate API endpoints.
+You can create a scripted API monitor using the `syntheticsCreateScriptApiMonitor` mutation. This mutation allows you to set up custom API testing that executes your JavaScript code to validate API endpoints.
### Input parameters
@@ -136,7 +136,7 @@ If there are any issues creating the monitor, the `errors` array will contain ob
## Update a scripted API monitor [#update-scripted-api]
-You can update an existing scripted API monitor using the `syntheticsUpdateScriptApiMonitor` mutation. This allows you to modify the configuration of a scripted API monitor that has already been created.
+You can update an existing scripted API monitor using the `syntheticsUpdateScriptApiMonitor` mutation. This allows you to modify the configuration of a scripted API monitor that has already been created.
### Input parameters
@@ -441,6 +441,18 @@ If there are any issues moving the monitor, the `errors` array will contain obje
## Delete a scripted API monitor [#delete-monitor]
-When a scripted API monitor is no longer needed, you can permanently remove it using the `syntheticsDeleteMonitor` mutation.
+When a scripted API monitor is no longer needed, you can permanently remove it using the `syntheticsDeleteMonitor` mutation.
To delete a monitor, refer to the [Delete Synthetic monitor](/docs/apis/nerdgraph/examples/synthetics-api/ping-monitor/#delete-monitor) section.
+
+## Query scripted API monitors [#query-scripted-api-monitors]
+
+Use NerdGraph to retrieve metadata, scripts, map IDs, or check the status of your scripted API monitors.
+
+For more information, refer to:
+- [Query all monitors](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data#query-monitors): To list all synthetic monitors and their configurations.
+- [Map monitor ID to entity GUID](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data#query-guid-mapping): To migrate legacy monitor IDs to entity GUIDs.
+- [Runtime upgrade status](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data#query-runtime-upgrade-all): To check if your monitors are ready for the latest runtime upgrades.
+- [Query monitor script](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data#query-monitor-script) - Retrieve JavaScript code from scripted monitors.
+
+To view complete list of query examples, refer to the [Query synthetics data](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data) document.
diff --git a/src/content/docs/apis/nerdgraph/examples/synthetics-api/scripted-browser-monitor.mdx b/src/content/docs/apis/nerdgraph/examples/synthetics-api/scripted-browser-monitor.mdx
index fc5b12350934..cc43bc71e17c 100644
--- a/src/content/docs/apis/nerdgraph/examples/synthetics-api/scripted-browser-monitor.mdx
+++ b/src/content/docs/apis/nerdgraph/examples/synthetics-api/scripted-browser-monitor.mdx
@@ -13,7 +13,7 @@ New Relic allows you use NerdGraph to create [scripted browser monitors](/docs/s
## Create a scripted browser monitor [#create-scripted-browser]
-You can create a scripted browser monitor using the `syntheticsCreateScriptBrowserMonitor` mutation. This mutation allows you to set up custom scripted monitoring that executes your JavaScript code in a browser.
+You can create a scripted browser monitor using the `syntheticsCreateScriptBrowserMonitor` mutation. This mutation allows you to set up custom scripted monitoring that executes your JavaScript code in a browser.
### Input parameters
@@ -46,10 +46,10 @@ You can create a scripted browser monitor using the `syntheticsCreateScriptBrows
Devices that the monitor will use to execute jobs. Supported devices: `DESKTOP`, `MOBILE_LANDSCAPE`, `MOBILE_PORTRAIT`, `TABLET_LANDSCAPE`, `TABLET_PORTRAIT`. |
- | `monitor.locations.public` |
- Array |
+ `monitor.locations` |
+ Object |
Yes |
- Array of [public location](/docs/synthetics/synthetic-monitoring/using-monitors/add-edit-monitors/#setting-location) identifiers where the monitor will run checks (e.g., `["US_EAST_1", "US_WEST_1"]`). |
+ The geographic locations where the monitor will execute. `monitor.location` allows two values: private locations and public locations. You can select either private locations, public locations, or both:
• `private`: Private location GUIDs (e.g., `{ private: ["PRIVATE_LOCATION_GUID"] }`)
• `public`: Public location identifiers (e.g., `{ public: ["US_EAST_1", "US_WEST_1"] }`) |
| `monitor.name` |
@@ -157,7 +157,7 @@ If there are any issues creating the monitor, the `errors` array will contain ob
## Update a scripted browser monitor [#update-scripted-browser]
-You can update an existing scripted browser monitor using the `syntheticsUpdateScriptBrowserMonitor` mutation. This allows you to modify the configuration of a scripted browser monitor that has already been created.
+You can update an existing scripted browser monitor using the `syntheticsUpdateScriptBrowserMonitor` mutation. This allows you to modify the configuration of a scripted browser monitor that has already been created.
### Input parameters
@@ -190,10 +190,10 @@ You can update an existing scripted browser monitor using the `syntheticsUpdateS
Devices that the monitor will use to execute jobs. Supported devices: `DESKTOP`, `MOBILE_LANDSCAPE`, `MOBILE_PORTRAIT`, `TABLET_LANDSCAPE`, `TABLET_PORTRAIT`. |
- | `monitor.locations.public` |
- Array |
+ `monitor.locations` |
+ Object |
No |
- Array of [public location](/docs/synthetics/synthetic-monitoring/using-monitors/add-edit-monitors/#setting-location) identifiers where the monitor will run checks (e.g., `["US_EAST_1", "US_WEST_1"]`). |
+ The geographic locations where the monitor will execute. `monitor.location` allows two values. 1. is private locations and 2. is public locations. You can select either private locations, public locations, or both:
• `private`: Private location GUIDs (e.g., `{ private: ["PRIVATE_LOCATION_GUID"] }`)
• `public`: Public location identifiers (e.g., `{ public: ["US_EAST_1", "US_WEST_1"] }`) |
| `monitor.name` |
@@ -388,6 +388,18 @@ If there are any issues upgrading the monitor runtime, the `errors` array will c
## Delete a scripted browser monitor [#delete-monitor]
-When a scripted browser monitor is no longer needed, you can permanently remove it using the `syntheticsDeleteMonitor` mutation.
+When a scripted browser monitor is no longer needed, you can permanently remove it using the `syntheticsDeleteMonitor` mutation.
To delete a monitor, refer to the [Delete Synthetic monitor](/docs/apis/nerdgraph/examples/synthetics-api/ping-monitor/#delete-monitor) section.
+
+## Query scripted browser monitors [#query-scripted-browser-monitors]
+
+Use NerdGraph to retrieve metadata, scripts, map IDs, or check the status of your scripted browser monitors.
+
+For more information, refer to:
+- [Query all monitors](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data#query-monitors): To list all synthetic monitors and their configurations.
+- [Map monitor ID to entity GUID](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data#query-guid-mapping): To migrate legacy monitor IDs to entity GUIDs.
+- [Runtime upgrade status](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data#query-runtime-upgrade-all): To check if your monitors are ready for the latest runtime upgrades.
+- [Query monitor script](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data#query-monitor-script) - Retrieve JavaScript code from scripted monitors.
+
+To view complete list of query examples, refer to the [Query synthetics data](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data) document.
diff --git a/src/content/docs/apis/nerdgraph/examples/synthetics-api/secure-credentials.mdx b/src/content/docs/apis/nerdgraph/examples/synthetics-api/secure-credentials.mdx
index 1e811177951b..68980ef2c6cb 100644
--- a/src/content/docs/apis/nerdgraph/examples/synthetics-api/secure-credentials.mdx
+++ b/src/content/docs/apis/nerdgraph/examples/synthetics-api/secure-credentials.mdx
@@ -13,7 +13,7 @@ freshnessValidatedDate: never
## Create a secure credential [#create-secure-credential]
-You can create a secure credential using the `syntheticsCreateSecureCredential` mutation. This mutation allows you to securely store sensitive information that your synthetic monitors can access during script execution.
+You can create a secure credential using the `syntheticsCreateSecureCredential` mutation. This mutation allows you to securely store sensitive information that your synthetic monitors can access during script execution.
### Input parameters
@@ -90,7 +90,7 @@ If there are any issues creating the secure credential, the `errors` array will
## Update a secure credential [#update-secure-credential]
-You can update an existing secure credential using the `syntheticsUpdateSecureCredential` mutation. This allows you to modify the value and description while keeping the same key name.
+You can update an existing secure credential using the `syntheticsUpdateSecureCredential` mutation. This allows you to modify the value and description while keeping the same key name.
### Input parameters
@@ -171,7 +171,7 @@ If there are any issues updating the secure credential, the `errors` array will
## Delete a secure credential [#delete-secure-credential]
-You can delete a secure credential using the `syntheticsDeleteSecureCredential` mutation. Once deleted, any monitors referencing this credential will fail until updated.
+You can delete a secure credential using the `syntheticsDeleteSecureCredential` mutation. Once deleted, any monitors referencing this credential will fail until updated.
Before deleting a secure credential, make sure no active monitors are using it. Deleting a credential that's in use will cause those monitors to fail.
@@ -235,3 +235,12 @@ A successful response returns `null` for errors:
```
If there are any issues deleting the secure credential, the `errors` array will contain objects with `description` and `type` fields explaining what went wrong.
+
+## Query secure credentials [#query-secure-credentials]
+
+Use NerdGraph to retrieve credential metadata.
+
+For more information, refer to:
+- [Query secure credentials](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data#query-secure-credentials) - Get secure credential metadata (names, GUIDs, last updated).
+
+To view complete list of query examples, refer to the [Query synthetics data](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data) document.
diff --git a/src/content/docs/apis/nerdgraph/examples/synthetics-api/simple-browser-monitor.mdx b/src/content/docs/apis/nerdgraph/examples/synthetics-api/simple-browser-monitor.mdx
index fc5001a30c6e..7077bbcd1df4 100644
--- a/src/content/docs/apis/nerdgraph/examples/synthetics-api/simple-browser-monitor.mdx
+++ b/src/content/docs/apis/nerdgraph/examples/synthetics-api/simple-browser-monitor.mdx
@@ -13,7 +13,7 @@ New Relic allows you use NerdGraph to create [simple browser monitors](/docs/syn
## Create a simple browser monitor [#create-simple-browser]
-You can create a simple browser monitor using the `syntheticsCreateSimpleBrowserMonitor` mutation.
+You can create a simple browser monitor using the `syntheticsCreateSimpleBrowserMonitor` mutation.
### Input parameters
@@ -180,7 +180,7 @@ If there are any issues creating the monitor, the `errors` array will contain ob
## Update a simple browser monitor [#update-simple-browser]
-You can update an existing simple browser monitor using the `syntheticsUpdateSimpleBrowserMonitor` mutation. This allows you to modify the configuration of a simple browser monitor that has already been created.
+You can update an existing simple browser monitor using the `syntheticsUpdateSimpleBrowserMonitor` mutation. This allows you to modify the configuration of a simple browser monitor that has already been created.
### Input parameters
@@ -434,6 +434,17 @@ If there are any issues upgrading the monitor runtime, the `errors` array will c
## Delete a simple browser monitor [#delete-monitor]
-When a simple browser monitor is no longer needed, you can permanently remove it using the `syntheticsDeleteMonitor` mutation.
+When a simple browser monitor is no longer needed, you can permanently remove it using the `syntheticsDeleteMonitor` mutation.
To delete a monitor, refer to the [Delete Synthetic monitor](/docs/apis/nerdgraph/examples/synthetics-api/ping-monitor/#delete-monitor) section.
+
+## Query simple browser monitors [#query-simple-browser-monitors]
+
+Use NerdGraph to retrieve metadata, map IDs, or check the status of your simple browser monitors.
+
+For more information, refer to:
+- [Query all monitors](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data#query-monitors): To list all synthetic monitors and their configurations.
+- [Map monitor ID to entity GUID](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data#query-guid-mapping): To migrate legacy monitor IDs to entity GUIDs.
+- [Runtime upgrade status](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data#query-runtime-upgrade-all): To check if your monitors are ready for the latest runtime upgrades.
+
+To view complete list of query examples, refer to the [Query synthetics data](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data) document.
diff --git a/src/content/docs/apis/nerdgraph/examples/synthetics-api/step-monitor.mdx b/src/content/docs/apis/nerdgraph/examples/synthetics-api/step-monitor.mdx
index 762eada36302..2469088424d4 100644
--- a/src/content/docs/apis/nerdgraph/examples/synthetics-api/step-monitor.mdx
+++ b/src/content/docs/apis/nerdgraph/examples/synthetics-api/step-monitor.mdx
@@ -13,7 +13,7 @@ New Relic allows you use NerdGraph to create [step monitors](/docs/synthetics/sy
## Create a step monitor [#create-step-monitor]
-You can create a step monitor using the `syntheticsCreateStepMonitor` mutation. This mutation allows you to set up multi-step browser monitoring with a series of predefined actions.
+You can create a step monitor using the `syntheticsCreateStepMonitor` mutation. This mutation allows you to set up multi-step browser monitoring with a series of predefined actions.
### Input parameters
@@ -160,7 +160,7 @@ If there are any issues creating the monitor, the `errors` array will contain ob
## Update a step monitor [#update-step-monitor]
-You can update an existing step monitor using the `syntheticsUpdateStepMonitor` mutation. This allows you to modify the configuration of a step monitor that has already been created.
+You can update an existing step monitor using the `syntheticsUpdateStepMonitor` mutation. This allows you to modify the configuration of a step monitor that has already been created.
### Input parameters
@@ -308,6 +308,18 @@ If there are any issues updating the monitor, the `errors` array will contain ob
## Delete a step monitor [#delete-monitor]
-When a step monitor is no longer needed, you can permanently remove it using the `syntheticsDeleteMonitor` mutation.
+When a step monitor is no longer needed, you can permanently remove it using the `syntheticsDeleteMonitor` mutation.
To delete a monitor, refer to the [Delete Synthetic monitor](/docs/apis/nerdgraph/examples/synthetics-api/ping-monitor/#delete-monitor) section.
+
+## Query step monitors [#query-step-monitors]
+
+Use NerdGraph to retrieve metadata, steps configuration, map IDs, or check the status of your step monitors.
+
+For more information, refer to:
+- [Query all monitors](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data#query-monitors): To list all synthetic monitors and their configurations.
+- [Map monitor ID to entity GUID](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data#query-guid-mapping): To migrate legacy monitor IDs to entity GUIDs.
+- [Runtime upgrade status](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data#query-runtime-upgrade-all): To check if your monitors are ready for the latest runtime upgrades.
+- [Query monitor steps](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data#query-monitor-steps) - Retrieve step configurations from step monitors.
+
+To view complete list of query examples, refer to the [Query synthetics data](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data) document.
diff --git a/src/content/docs/apis/rest-api-v2/account-examples-v2/listing-users-your-account.mdx b/src/content/docs/apis/rest-api-v2/account-examples-v2/listing-users-your-account.mdx
index bd79599aca42..a75d02f0eb85 100644
--- a/src/content/docs/apis/rest-api-v2/account-examples-v2/listing-users-your-account.mdx
+++ b/src/content/docs/apis/rest-api-v2/account-examples-v2/listing-users-your-account.mdx
@@ -16,7 +16,7 @@ freshnessValidatedDate: never
For New Relic users on our [original user model](/docs/accounts/original-accounts-billing/original-product-based-pricing/overview-user-models), we store a list of the users who can access your account in a database by their [email address](/docs/accounts-partnerships/accounts/account-setup/adding-updating-users), assigned [role](/docs/accounts-partnerships/accounts/account-setup/users-roles), and their first and last name if provided. You can view this data from New Relic's [user interface](/docs/accounts-partnerships/accounts/account-setup/adding-updating-users) and from the [API Explorer (v2)](/docs/apm/apis/api-explorer-v2/parts-api-explorer).
- To obtain the same information from the [New Relic API Explorer (v2)](https://rpm.newrelic.com/api/explore), select **Users > GET List**.
+ To obtain the same information from the [New Relic API Explorer (v2)](https://api.newrelic.com/docs), select **Users > GET List**.
## Requirements [#requirements]
diff --git a/src/content/docs/apis/rest-api-v2/api-explorer-v2/introduction-new-relics-rest-api-explorer.mdx b/src/content/docs/apis/rest-api-v2/api-explorer-v2/introduction-new-relics-rest-api-explorer.mdx
index 1fd014ab063c..9101c188d2d7 100644
--- a/src/content/docs/apis/rest-api-v2/api-explorer-v2/introduction-new-relics-rest-api-explorer.mdx
+++ b/src/content/docs/apis/rest-api-v2/api-explorer-v2/introduction-new-relics-rest-api-explorer.mdx
@@ -41,7 +41,7 @@ For information on API key requirements, see [REST API keys](/docs/apis/rest-api
/>
- **[rpm.newrelic.com/api/explore](https://rpm.newrelic.com/api/explore)**: The New Relic API Explorer makes it easy to test and send requests for any API endpoint. After you select your account and your choice of functions for the type of API call (applications, browsers, users, etc.), the UI provides an interactive form to view requirements and test your parameter values.
+ **[api.newrelic.com/docs](https://api.newrelic.com/docs)**: The New Relic API Explorer makes it easy to test and send requests for any API endpoint. After you select your account and your choice of functions for the type of API call (applications, browsers, users, etc.), the UI provides an interactive form to view requirements and test your parameter values.
## Differences from API version 1 [#v1]
diff --git a/src/content/docs/apis/rest-api-v2/api-explorer-v2/retrieve-metric-timeslice-data-your-app-explorer.mdx b/src/content/docs/apis/rest-api-v2/api-explorer-v2/retrieve-metric-timeslice-data-your-app-explorer.mdx
index a763f68189c4..1bb57183a3ff 100644
--- a/src/content/docs/apis/rest-api-v2/api-explorer-v2/retrieve-metric-timeslice-data-your-app-explorer.mdx
+++ b/src/content/docs/apis/rest-api-v2/api-explorer-v2/retrieve-metric-timeslice-data-your-app-explorer.mdx
@@ -27,7 +27,7 @@ When using New Relic's REST API Explorer (v2) to get [metric timeslice data](/do
To view your [app's ID](/docs/apm/apis/requirements/identification-code):
-1. From the New Relic REST [API Explorer](https://rpm.newrelic.com/api/explore "Link opens in a new window"), select **Applications > GET List**.
+1. From the New Relic REST [API Explorer](https://api.newrelic.com/docs "Link opens in a new window"), select **Applications > GET List**.
2. If you are not signed in to New Relic, provide an [API key](/docs/apis/rest-api-v2/requirements/rest-api-key#viewing) for your app.
3. Optional: From **Applications > List**, fill in values for the `name`, `ids`, or `language` filters.
4. Select **Send Request**.
diff --git a/src/content/docs/apis/rest-api-v2/api-explorer-v2/use-api-explorer.mdx b/src/content/docs/apis/rest-api-v2/api-explorer-v2/use-api-explorer.mdx
index 2d5c5d0b618d..dd92129dddbb 100644
--- a/src/content/docs/apis/rest-api-v2/api-explorer-v2/use-api-explorer.mdx
+++ b/src/content/docs/apis/rest-api-v2/api-explorer-v2/use-api-explorer.mdx
@@ -4,7 +4,7 @@ tags:
- APIs
- REST API v2
- API Explorer v2
-metaDescription: 'Before signing in to New Relic’s REST API Explorer v2 at https://rpm.newrelic.com/api/explore, activate API access and generate an API key for your account.'
+metaDescription: 'Before signing in to New Relic’s REST API Explorer v2 at https://api.newrelic.com/docs, activate API access and generate an API key for your account.'
redirects:
- /docs/apis/using-the-api-explorer
- /docs/apis/parts-of-the-api-explorer
@@ -21,7 +21,7 @@ New Relic's REST API Explorer (v2) makes it easy to test and send requests for a
## API key requirements [#api-key]
-Before you can use the [API Explorer](https://rpm.newrelic.com/api/explore), API access must be activated and an [User API key](/docs/apis/rest-api-v2/requirements/rest-api-key) must be generated for your account.
+Before you can use the [API Explorer](https://api.newrelic.com/docs), API access must be activated and an [User API key](/docs/apis/rest-api-v2/requirements/rest-api-key) must be generated for your account.
Tips:
diff --git a/src/content/docs/apis/rest-api-v2/application-examples-v2/change-alias-your-application-v2.mdx b/src/content/docs/apis/rest-api-v2/application-examples-v2/change-alias-your-application-v2.mdx
index 16a439e7cccd..7063e6cc0f6a 100644
--- a/src/content/docs/apis/rest-api-v2/application-examples-v2/change-alias-your-application-v2.mdx
+++ b/src/content/docs/apis/rest-api-v2/application-examples-v2/change-alias-your-application-v2.mdx
@@ -24,7 +24,7 @@ By default, the alias is the same as the name used in the agent configuration fi
While the example utilizes New Relic's REST API v2, we recommend using [NerdGraph](/docs/apis/nerdgraph/examples/mobile-monitoring-config-nerdgraph) for mobile application monitoring. To explore its capabilities, check [the NerdGraph tutorials](/docs/apis/nerdgraph/get-started/introduction-new-relic-nerdgraph/#tutorials).
-To change the alias for the app name from the New Relic REST API (v2), use this command. You can also change the app alias from New Relic's [API Explorer](/docs/apis/rest-api-v2/api-explorer-v2/getting-started-new-relics-api-explorer) by selecting [**Applications > Update**](https://rpm.newrelic.com/api/explore/applications/update).
+To change the alias for the app name from the New Relic REST API (v2), use this command. You can also change the app alias from New Relic's [API Explorer](/docs/apis/rest-api-v2/api-explorer-v2/getting-started-new-relics-api-explorer) by selecting [**Applications > Update**](https://api.newrelic.com/docs/#/Applications/put_applications__id__json).
* You will need to supply the `${APP_ID}`, `${API_KEY}`, and the alias `name` you want the application to be displayed as in the New Relic UI.
* You must also provide `APP_APDEX_THRESHOLD`, `BROWSER_APDEX_THRESHOLD`, and the monitoring enabled `BOOLEAN` (`true` or `false`) even if they are not being modified.
diff --git a/src/content/docs/apis/rest-api-v2/application-examples-v2/get-average-cpu-usage-host-app.mdx b/src/content/docs/apis/rest-api-v2/application-examples-v2/get-average-cpu-usage-host-app.mdx
index 5c518d4eddde..3cc6313a37aa 100644
--- a/src/content/docs/apis/rest-api-v2/application-examples-v2/get-average-cpu-usage-host-app.mdx
+++ b/src/content/docs/apis/rest-api-v2/application-examples-v2/get-average-cpu-usage-host-app.mdx
@@ -35,7 +35,7 @@ For additional detail:
* Specify a different [time range](/docs/apis/rest-api-v2/requirements/specifying-time-range-v2).
- To get the same information from the [New Relic API Explorer (v2)](https://rpm.newrelic.com/api/explore), select [**Application Hosts > GET Metric Data**](https://rpm.newrelic.com/api/explore/application_hosts/data), and include your [API key](/docs/apis/rest-api-v2/getting-started/introduction-new-relic-rest-api-v2#api_key). Add your [application ID](/docs/apm/apis/requirements/identification-code), [host id](/docs/apis/rest-api-v2/requirements/listing-host-instance-application-server-ids#locating_host_id), and the `names[]=CPU/User Time` and `values[]=percent` metrics in the appropriate fields.
+ To get the same information from the [New Relic API Explorer (v2)](https://api.newrelic.com/docs), select [**Application Hosts > GET Metric Data**](https://api.newrelic.com/docs/#/Applications/get_applications__application_id__hosts__host_id__metrics_data_json), and include your [API key](/docs/apis/rest-api-v2/getting-started/introduction-new-relic-rest-api-v2#api_key). Add your [application ID](/docs/apm/apis/requirements/identification-code), [host id](/docs/apis/rest-api-v2/requirements/listing-host-instance-application-server-ids#locating_host_id), and the `names[]=CPU/User Time` and `values[]=percent` metrics in the appropriate fields.
## Get CPU usage for the entire app [#api-call]
@@ -56,5 +56,5 @@ For additional detail:
* Specify a different [time range](/docs/apis/rest-api-v2/requirements/specifying-time-range-v2).
- To get the same information from the [New Relic API Explorer (v2)](https://rpm.newrelic.com/api/explore), select [**Applications > GET Metric Data**](https://rpm.newrelic.com/api/explore/applications/data), and include your [API key](/docs/apis/rest-api-v2/getting-started/introduction-new-relic-rest-api-v2#api_key). Add your [application ID](/docs/apm/apis/requirements/identification-code), and the `names[]=CPU/User Time` and `values[]=percent` metrics in the appropriate fields.
+ To get the same information from the [New Relic API Explorer (v2)](https://api.newrelic.com/docs), select [**Applications > GET Metric Data**](https://api.newrelic.com/docs/#/Applications/get_applications__application_id__metrics_data_json), and include your [API key](/docs/apis/rest-api-v2/getting-started/introduction-new-relic-rest-api-v2#api_key). Add your [application ID](/docs/apm/apis/requirements/identification-code), and the `names[]=CPU/User Time` and `values[]=percent` metrics in the appropriate fields.
diff --git a/src/content/docs/apis/rest-api-v2/application-examples-v2/get-host-memory-used-application.mdx b/src/content/docs/apis/rest-api-v2/application-examples-v2/get-host-memory-used-application.mdx
index 738903a6090f..06ab58e55e7c 100644
--- a/src/content/docs/apis/rest-api-v2/application-examples-v2/get-host-memory-used-application.mdx
+++ b/src/content/docs/apis/rest-api-v2/application-examples-v2/get-host-memory-used-application.mdx
@@ -35,9 +35,9 @@ This example shows the time range for the [default time period](/docs/apis/rest-
* Remove the `summarize=true` to obtain detailed [time series data.](/docs/apis/rest-api-v2/requirements/calculating-average-metric-values-summarize)
* Specify a different [time range](/docs/apis/rest-api-v2/requirements/specifying-time-range-v2).
-To obtain the same information from the [New Relic API Explorer (v2)](https://rpm.newrelic.com/api/explore):
+To obtain the same information from the [New Relic API Explorer (v2)](https://api.newrelic.com/docs):
-1. Select [**Application Hosts > GET Metric Data**](https://rpm.newrelic.com/api/explore/application_hosts/data), and include your [API key](/docs/apis/rest-api-v2/getting-started/introduction-new-relic-rest-api-v2#api_key).
+1. Select [**Application Hosts > GET Metric Data**](https://api.newrelic.com/docs/#/Applications/get_applications__application_id__hosts__host_id__metrics_data_json), and include your [API key](/docs/apis/rest-api-v2/getting-started/introduction-new-relic-rest-api-v2#api_key).
2. Add your [application ID](/docs/apm/apis/requirements/identification-code), [host id](/docs/apis/rest-api-v2/requirements/listing-host-instance-application-server-ids#locating_host_id), and the `names[]=Memory/Physical` and `values[]=used_mb_by_host` metrics in the appropriate fields.
## Get memory usage for the entire app [#api-call]
@@ -55,7 +55,7 @@ For additional detail:
* Remove the `summarize=true` to obtain detailed [time series data.](/docs/apis/rest-api-v2/requirements/calculating-average-metric-values-summarize)
* Specify a different [time range](/docs/apis/rest-api-v2/requirements/specifying-time-range-v2).
-To obtain the same information from the [New Relic API Explorer (v2)](https://rpm.newrelic.com/api/explore):
+To obtain the same information from the [New Relic API Explorer (v2)](https://api.newrelic.com/docs):
-1. Select [**Applications > GET Metric Data**](https://rpm.newrelic.com/api/explore/applications/data), and include your [API key](/docs/apis/rest-api-v2/getting-started/introduction-new-relic-rest-api-v2#api_key).
+1. Select [**Applications > GET Metric Data**](https://api.newrelic.com/docs/#/Applications/get_applications__application_id__metrics_data_json), and include your [API key](/docs/apis/rest-api-v2/getting-started/introduction-new-relic-rest-api-v2#api_key).
2. Add your [application ID](/docs/apm/apis/requirements/identification-code) and the `names[]=Memory/Physical` and `values[]=total_used_mb` metrics in the appropriate fields.
diff --git a/src/content/docs/apis/rest-api-v2/browser-examples-v2/add-or-list-browser-apps-api-v2.mdx b/src/content/docs/apis/rest-api-v2/browser-examples-v2/add-or-list-browser-apps-api-v2.mdx
index 6f6a3b449c1b..7f81b92c171b 100644
--- a/src/content/docs/apis/rest-api-v2/browser-examples-v2/add-or-list-browser-apps-api-v2.mdx
+++ b/src/content/docs/apis/rest-api-v2/browser-examples-v2/add-or-list-browser-apps-api-v2.mdx
@@ -24,7 +24,7 @@ Here are examples of how to use the New Relic REST API (v2) to add apps to [**[rpm.newrelic.com/api/explore](https://rpm.newrelic.com/api/explore) > Browser applications > POST create**.
+To add an app to New Relic, replace `$API_KEY` with your [New Relic API key](/docs/apis/rest-api-v2/requirements/api-keys#rest-api-key), and replace `${STRING}` with the app's name in the following command. To accomplish the same task from the API Explorer, use your API key and go to **[api.newrelic.com/docs](https://api.newrelic.com/docs) > Browser applications > POST create**.
Use the following command:
@@ -120,7 +120,7 @@ The API returns an array of data where the element is a browser application and
## List all browser apps [#list-browser-apps]
-To view a list of your browser-monitored apps, replace `$API_KEY` with your [New Relic API key](/docs/apis/rest-api-v2/requirements/api-keys#rest-api-key) in the following command. To accomplish the same task from the API Explorer, use your API key and go to **[rpm.newrelic.com/api/explore](https://rpm.newrelic.com/api/explore) > Browser Applications > GET List**.
+To view a list of your browser-monitored apps, replace `$API_KEY` with your [New Relic API key](/docs/apis/rest-api-v2/requirements/api-keys#rest-api-key) in the following command. To accomplish the same task from the API Explorer, use your API key and go to **[api.newrelic.com/docs](https://api.newrelic.com/docs) > Browser Applications > GET List**.
Use the following command:
diff --git a/src/content/docs/apis/rest-api-v2/get-started/list-application-id-host-id-instance-id.mdx b/src/content/docs/apis/rest-api-v2/get-started/list-application-id-host-id-instance-id.mdx
index 5c37ddb24b18..ffc5e6f82355 100644
--- a/src/content/docs/apis/rest-api-v2/get-started/list-application-id-host-id-instance-id.mdx
+++ b/src/content/docs/apis/rest-api-v2/get-started/list-application-id-host-id-instance-id.mdx
@@ -56,9 +56,8 @@ IDs for the host and physical server are not the same. Each host ID is unique an
Use the `$HOST_ID` to retrieve summary metrics for the host as well as specific metric timeslice values. For more information about available metrics:
-1. Go to **[rpm.newrelic.com](https://rpm.newrelic.com)**.
-2. Go to the [API Explorer](https://rpm.newrelic.com/api/explore/application_hosts/list), then select your account name from the **Select an account** dropdown.
-3. Go to the API Explorer's **Application host** page at [rpm.newrelic.com/api/explore/application_hosts/names](https://rpm.newrelic.com/api/explore/application_hosts/names).
+1. Go to the [API Explorer](https://api.newrelic.com/docs), then select your account name from the **Select an account** dropdown.
+2. Go to the API Explorer's **Application host** page at [api.newrelic.com/docs](https://api.newrelic.com/docs/#/Applications/get_applications__application_id__hosts_json).
To use the API Explorer to return a list of every `$HOST_ID` for a particular application, you will need the [`$APP_ID`](/docs/apis/rest-api-v2/requirements/finding-product-id).
- 1. Go to the [API Explorer](https://rpm.newrelic.com/api/explore/application_hosts/list), then select your account name from the **Select an account** dropdown.
+ 1. Go to the [API Explorer](https://api.newrelic.com/docs/#/Applications/get_applications__application_id__hosts_json), then select your account name from the **Select an account** dropdown.
2. Enter the specific [`$APP_ID`](/docs/apis/rest-api-v2/requirements/finding-product-id) in the following command:
```sh
@@ -128,7 +127,7 @@ Use the `$HOST_ID` to retrieve summary metrics for the host as well as specific
## List instance IDs [#locating_instance_id]
-The instance ID meaning depends on the New Relic language agent being used. You can list this ID from the REST API. For Java, you can also [view the instance ID (JVM)](#UI) from APM's **Overview** page.
+The instance ID meaning depends on the New Relic language agent being used. You can list this ID from the REST API.
@@ -216,7 +215,7 @@ The instance ID meaning depends on the New Relic language agent being used. You
-You can retrieve summary metrics for the instance as well as specific metric timeslice values using the `INSTANCE_ID`. For details about available metrics, use the [REST API Explorer Application Instance](https://rpm.newrelic.com/api/explore/application_instances/names) page.
+You can retrieve summary metrics for the instance as well as specific metric timeslice values using the `INSTANCE_ID`. For details about available metrics, use the [REST API Explorer Application Instance](https://api.newrelic.com/docs/#/Applications/get_applications__application_id__instances__instance_id__metrics_json) page.
To use the API Explorer to return a list of every `$INSTANCE_ID` for a particular application, you will need the [`$APP_ID`](/docs/apis/rest-api-v2/requirements/finding-product-id).
- 1. Go to the [API Explorer](https://rpm.newrelic.com/api/explore/application_hosts/list), then select your account name from the **Select an account** dropdown.
+ 1. Go to the [API Explorer](https://api.newrelic.com/docs), then select your account name from the **Select an account** dropdown.
2. Enter the specific [`$APP_ID`](/docs/apis/rest-api-v2/requirements/finding-product-id) in the following command:
```sh
@@ -278,22 +277,6 @@ You can retrieve summary metrics for the instance as well as specific metric tim
. . .
```
-
-
- Java apps: To locate a specific JVM `$INSTANCE_ID` in New Relic:
-
- 1. Go to **[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > APM & services > Applications > (select an app) > JVMs**.
- 2. Select the name of the instance.
-
- In the URL, the number after the `_i` designator represents the Java JVM instance:
-
- ```
- https://rpm.newrelic.com/accounts/$ACCOUNT_ID/applications/$APP_ID_i$INSTANCE_ID
- ```
-
## REST API application list example [#app-list-example]
diff --git a/src/content/docs/apis/rest-api-v2/mobile-examples-v2/mobile-crash-count-crash-rate-example-v2.mdx b/src/content/docs/apis/rest-api-v2/mobile-examples-v2/mobile-crash-count-crash-rate-example-v2.mdx
index d10598c7cb81..cafafdd8bafb 100644
--- a/src/content/docs/apis/rest-api-v2/mobile-examples-v2/mobile-crash-count-crash-rate-example-v2.mdx
+++ b/src/content/docs/apis/rest-api-v2/mobile-examples-v2/mobile-crash-count-crash-rate-example-v2.mdx
@@ -19,7 +19,7 @@ While the examples utilize New Relic's REST API v2, we recommend using [NRQL fun
These examples use the default time period of the last 30 minutes. To obtain crash data for a different [time range](/docs/apis/rest-api-v2/requirements/specifying-time-range-v2), add the time period to the commands.
- You can also use the New Relic API Explorer to retrieve [mobile metric data](https://rpm.newrelic.com/api/explore/mobile_applications/metric_data).
+ You can also use the New Relic API Explorer to retrieve [mobile metric data](https://api.newrelic.com/docs/#/Mobile%20Applications/get_mobile_applications__mobile_application_id__metrics_data_json).
## Prerequisites [#prereqs]
diff --git a/src/content/docs/apm/agents/java-agent/configuration/java-agent-config-file-template.mdx b/src/content/docs/apm/agents/java-agent/configuration/java-agent-config-file-template.mdx
index 7ca2e663fb63..b814b3ea6a54 100644
--- a/src/content/docs/apm/agents/java-agent/configuration/java-agent-config-file-template.mdx
+++ b/src/content/docs/apm/agents/java-agent/configuration/java-agent-config-file-template.mdx
@@ -231,11 +231,11 @@ common: &default_settings
# When true, attributes will be sent to New Relic. The default is true.
enabled: true
- #A comma separated list of attribute keys whose values should
+ #A comma separated list of attribute keys whose values should
# be sent to New Relic.
#include:
- # A comma separated list of attribute keys whose values should
+ # A comma separated list of attribute keys whose values should
# not be sent to New Relic.
#exclude:
@@ -267,12 +267,10 @@ common: &default_settings
# Controls the addition of comments to the beginning of executed SQL
# statements to be used by the New Relic Query Performance Monitoring
- # product for entity linking. An empty String disables SQL comments
- # (default setting).
- # Allowed options are:
- # nr_service_guid - The GUID of the New Relic entity this agent is instrumenting
+ # product for entity linking. Default is false.
+ #
# A resulting comment would resemble this:
- # /*nr_service_guid=MTE3NDc2MDB8QVBNfEFQUExJQ0FUSU9OfDI4MTc5NDEIEA*/
+ # /*nr_service_guid=MTE3NDc2MDB8QVBNfAAAAAxJQEEEEE9OfDI4MTc5NDEIEA*/
sql_metadata_comments:
# For large SQL statements, executing the regular expressions that attempt to parse exec and
@@ -305,7 +303,7 @@ common: &default_settings
# Default is true.
explain_enabled: true
- # Threshold for query execution time below which query plans will
+ # Threshold for query execution time below which query plans will
# not be captured. Relevant only when `explain_enabled` is true.
# Default is 0.5 seconds.
explain_threshold: 0.5
@@ -339,7 +337,7 @@ common: &default_settings
ignore_status_codes: 404
# Transaction events are used for histograms and percentiles. Non-aggregated data is collected
- # for each web transaction and sent to the server on harvest.
+ # for each web transaction and sent to the server on harvest.
transaction_events:
# Set to false to disable transaction events.
@@ -421,7 +419,7 @@ common: &default_settings
# New Relic Real User Monitoring (RUM) gives you insight into the performance real users are
# experiencing with your website. This is accomplished by measuring the time it takes for
# your users' browsers to download and render your web pages by injecting a small amount
- # of JavaScript code into the header and footer of each page.
+ # of JavaScript code into the header and footer of each page.
browser_monitoring:
# By default the agent automatically inserts API calls in compiled JSPs to
@@ -462,7 +460,7 @@ common: &default_settings
# All instrumentation modules can be found here: https://github.com/newrelic/newrelic-java-agent/tree/main/instrumentation
class_transformer:
- # This instrumentation reports the name of the user principal returned from
+ # This instrumentation reports the name of the user principal returned from
# HttpServletRequest.getUserPrincipal() when servlets and filters are invoked.
com.newrelic.instrumentation.servlet-user:
enabled: false
@@ -554,6 +552,11 @@ common: &default_settings
# Default is 250000
queue_size: 250000
+ # If true, the JFR host name will be set to the value in the process_host.display_name config.
+ # Note that if the process_host.display_name value is empty/null, the default hostname
+ # resolution logic will be used. Default is false.
+ use_display_name: false
+
# User-configurable custom labels for this agent. Labels are name-value pairs.
# There is a maximum of 64 labels per agent. Names and values are limited to 255 characters.
# Names and values may not contain colons (:) or semicolons (;).
diff --git a/src/content/docs/apm/agents/java-agent/configuration/java-agent-configuration-config-file.mdx b/src/content/docs/apm/agents/java-agent/configuration/java-agent-configuration-config-file.mdx
index 864b715c5df7..ca78a01a53a2 100644
--- a/src/content/docs/apm/agents/java-agent/configuration/java-agent-configuration-config-file.mdx
+++ b/src/content/docs/apm/agents/java-agent/configuration/java-agent-configuration-config-file.mdx
@@ -3993,6 +3993,41 @@ Configure real-time profiling in the `jfr` section in the agent YAML. These conf
The maximum number of JFR events stored in the agent's memory queue. Increasing this value can help prevent gaps in JFR data, but it will also increase the agent's resource consumption. If the queue is too large, data may be dropped if backend pipline limits are exceeded.
Default value is set to 250000. For more information, refer to [event API ingest limits](/docs/data-apis/ingest-apis/event-api/introduction-event-api/#limits).
+
+ This applies to Java agent [version 8.17.0 or higher](/docs/release-notes/agent-release-notes/java-release-notes).
+
+
+
+
+
+
+ |
+ Type
+ |
+
+
+ Boolean
+ |
+
+
+
+ |
+ Default
+ |
+
+
+ `false`
+ |
+
+
+
+
+ The maximum number of JFR events stored in the agent's memory queue. Increasing this value can help prevent gaps in JFR data, but it will also increase the agent's resource consumption. If the queue is too large, data may be dropped if backend pipline limits are exceeded.
+ Default value is set to 250000. For more information, refer to [event API ingest limits](/docs/data-apis/ingest-apis/event-api/introduction-event-api/#limits).
+
This applies to Java agent [version 8.17.0 or higher](/docs/release-notes/agent-release-notes/java-release-notes).
@@ -6681,14 +6716,11 @@ Set the transaction tracer options in the `transaction_tracer` section. These op
- Controls the addition of comments to the beginning of executed SQL statements to be used by the New Relic Query Performance Monitoring
- product for entity linking. An empty String disables SQL comments (default setting).
- Allowed options are:
-
- * `nr_service_guid` - The GUID of the New Relic entity the agent is instrumenting
-
+ Controls the addition of comments to the beginning of executed SQL statements to be used by the New Relic Query Performance Monitoring
+ product for entity linking. Default is false.
+
A resulting comment would resemble this:
- `/*nr_service_guid=MTE3NDc2MDB8QVBNfEFQUExJQ0FUSU9OfDI4MTc5NDEIEA*/`
+ /*nr_service_guid=MTE3NDc2MDB8QVBNfAAAAAxJQEEEEE9OfDI4MTc5NDEIEA*/
If you have version 8.12.0 or higher of Java agent, you can collect AI data from certain AI libraries and frameworks. See our [AI Monitoring documentation](/docs/ai-monitoring/intro-to-ai-monitoring) for more information.
* AWS Bedrock 2.20.157 to latest
+ * MCP Java SDK 1.0.0 to latest
+ * Spring AI Chat Completions 1.0.0-RC1 to latest
+ * Spring AI Embeddings 1.0.0-M7 to latest
* Java Completable futures 8 to latest
* Java Process 8 to latest
+ * Java XML RPC 8 to latest
* JSP 2.0 to latest
* OpenEJB 3.0 to latest
* OpenJPA 1.0 to latest
diff --git a/src/content/docs/apm/agents/java-agent/troubleshooting/no-data-appears-java.mdx b/src/content/docs/apm/agents/java-agent/troubleshooting/no-data-appears-java.mdx
index 45d8b603d064..72354667fb43 100644
--- a/src/content/docs/apm/agents/java-agent/troubleshooting/no-data-appears-java.mdx
+++ b/src/content/docs/apm/agents/java-agent/troubleshooting/no-data-appears-java.mdx
@@ -51,7 +51,7 @@ After sending a request to your web application, data should appear in the APM U
7. Verify that your app is reporting to the expected name: In your New Relic log files, search for `"reporting to"`, then select the link in the message. For example:
```json
- {"message":"Reporting to: https://rpm.newrelic.com/accounts/000/applications/000000"}
+ {"message":"Reporting to: https://one.newrelic.com/redirect/entity/"}
```
If you are reporting to [multiple application names](/docs/apm/new-relic-apm/installation-configuration/using-multiple-names-app), look for multiple lines with this message.
diff --git a/src/content/docs/apm/agents/net-agent/getting-started/net-agent-approaches-lambda.mdx b/src/content/docs/apm/agents/net-agent/getting-started/net-agent-approaches-lambda.mdx
index 0f99a1e4298d..9579d2702346 100644
--- a/src/content/docs/apm/agents/net-agent/getting-started/net-agent-approaches-lambda.mdx
+++ b/src/content/docs/apm/agents/net-agent/getting-started/net-agent-approaches-lambda.mdx
@@ -157,17 +157,19 @@ In a Lambda function, the agent will switch into a "serverless mode" that will d
Since the agent automatically instruments most lambda functions, you can use the [agent NuGet package](https://www.nuget.org/packages/NewRelic.Agent#readme-body-tab) to monitor your lambda functions. You need to manually configure environment variables for your chosen deployment method (see our [installation guide](/install/dotnet/?deployment=nuget#nuget-linux)). This still requires that you set up either the [New Relic Lambda Extension or CloudWatch integration](/docs/serverless-function-monitoring/aws-lambda-monitoring/instrument-lambda-function/introduction-lambda/#how) to send your data to New Relic.
-Automatic instrumentation is available for the following AWS Lambda function types (as of agent version 10.29.0):
+The following AWS Lambda function types are automatically detected and instrumented without any additional configuration (as of agent version 10.29.0):
* `Amazon.Lambda.AspNetCoreServer.APIGatewayProxyFunction`
* `Amazon.Lambda.AspNetCoreServer.APIGatewayHttpApiV2ProxyFunction`
* `Amazon.Lambda.AspNetCoreServer.ApplicationLoadBalancerFunction`
+Other handler types (such as SQS, SNS, Kinesis, S3, DynamoDB triggers, and custom handlers) are also instrumented when you set the `NEW_RELIC_LAMBDA_HANDLER` environment variable to the fully qualified handler path (for example, `MyAssembly::MyNamespace.MyClass::MyMethod`). This includes any handler method that accepts an `ILambdaContext` parameter.
+
Limitations:
* Generic lambda Methods are not instrumented automatically. If your lambda method is a generic method, such as `Task MyMethod(TRequest, ILambdaContext)`, the .NET agent is currently not able to instrument that method.
* The [Lambda Annotations Framework](https://aws.amazon.com/blogs/developer/net-lambda-annotations-framework/) is currently not supported.
* [ApiGatewayV2](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html#http-api-develop-integrations-lambda.proxy-format) events are missing some context required for distributed tracing.
-* Outbound distributed tracing for different AWS SDK calls (such as SQS) are not supported.
+* Inbound distributed tracing from SQS requires the upstream producer to inject W3C trace headers (`traceparent`, `tracestate`) as SQS message attributes. The agent reads these automatically when present.
* If your Lambda function handler does not include an [`ILambdaContext`](https://docs.aws.amazon.com/lambda/latest/dg/csharp-context.html) parameter, the .NET agent will not be able to gather all of the expected information about your Lambda function.
* .NET Lambda functions built with the [Native AOT deployment method](https://learn.microsoft.com/en-us/dotnet/core/deploying/native-aot/?tabs=net7%2Cwindows) are not supported.
diff --git a/src/content/docs/apm/agents/net-agent/getting-started/net-agent-compatibility-requirements.mdx b/src/content/docs/apm/agents/net-agent/getting-started/net-agent-compatibility-requirements.mdx
index ef8643fd6c92..60b82893b06c 100644
--- a/src/content/docs/apm/agents/net-agent/getting-started/net-agent-compatibility-requirements.mdx
+++ b/src/content/docs/apm/agents/net-agent/getting-started/net-agent-compatibility-requirements.mdx
@@ -415,7 +415,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
The .NET agent `v9.2.0` or higher automatically instruments the [Microsoft.Azure.Cosmos](https://www.nuget.org/packages/Microsoft.Azure.Cosmos) library.
* Minimum supported version: 3.17.0
- * Latest verified compatible version: 3.59.0
+ * Latest verified compatible version: 3.61.0
* Versions 3.35.0 and higher are supported beginning with .NET agent v10.32.0
@@ -520,7 +520,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
Minimum supported version: 2.3.0
- Latest verified compatible version: 3.8.0
+ Latest verified compatible version: 3.9.0
Versions 3.0.0 and higher are supported beginning with .NET agent v10.40.0.
@@ -557,7 +557,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
**MySqlConnector**
* Minimum supported version: 1.0.1
- * Latest verified compatible version: 2.5.0
+ * Latest verified compatible version: 2.6.0
|
@@ -575,7 +575,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
Minimum supported version: 1.0.488
- Latest verified compatible version: 2.12.14
+ Latest verified compatible version: 3.0.0
|
@@ -626,7 +626,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
Use [EnyimMemcachedCore](https://www.nuget.org/packages/EnyimMemcachedCore).
* Minimum supported version: 2.0.0
- * Latest verified compatible version: 3.5.0
+ * Latest verified compatible version: 3.5.1
@@ -646,7 +646,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
Use [AWSSDK.DynamoDBv2](https://www.nuget.org/packages/AWSSDK.DynamoDBv2).
* Minimum supported version: 3.5.0
- * Latest verified compatible version: 4.0.17.8
+ * Latest verified compatible version: 4.0.21.3
* Minimum agent version required: 10.33.0
@@ -667,7 +667,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
Use [System.Data.Odbc](https://www.nuget.org/packages/System.Data.Odbc/).
* Minimum supported version: 8.0.0
- * Latest verified compatible version: 10.0.6
+ * Latest verified compatible version: 10.0.9
* Minimum agent version required: 10.35.0
@@ -774,7 +774,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
10.37.0 (`InvokeModelAsync`, `ConverseAsync`)
|
- 4.0.17.5
+ 4.0.20.6
|
@@ -880,7 +880,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
9.7.0
|
- 6.1.2
+ 6.1.3
|
@@ -895,7 +895,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
10.0.0
- 10.0.7
+ 10.0.9
|
@@ -938,7 +938,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
* Minimum supported version: 1.4.0
- * Latest verified compatible version: 2.14.0
+ * Latest verified compatible version: 2.14.2
@@ -952,7 +952,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
* Minimum supported version: 5.0
- * Latest verified compatible version: 10.1.4
+ * Latest verified compatible version: 10.2.5
@@ -1006,7 +1006,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
* Minimum supported version: 3.7.0
- * Latest verified compatible version: 4.0.2.25
+ * Latest verified compatible version: 4.0.3.4
@@ -1020,7 +1020,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
* Minimum supported version: 3.7.0
- * Latest verified compatible version: 4.0.8.11
+ * Latest verified compatible version: 4.0.9.4
@@ -1034,7 +1034,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
* Minimum supported version: 3.7.0
- * Latest verified compatible version: 4.0.3.24
+ * Latest verified compatible version: 4.0.5
@@ -1512,7 +1512,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
The .NET agent `v9.2.0` or higher automatically instruments [Microsoft.Azure.Cosmos](https://www.nuget.org/packages/Microsoft.Azure.Cosmos) library.
* Minimum supported version: 3.17.0
- * Latest verified compatible version: 3.59.0
+ * Latest verified compatible version: 3.61.0
* Versions 3.35.0 and higher are supported beginning with .NET agent v10.32.0
@@ -1639,7 +1639,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
Minimum supported version: 2.3.0
- Latest verified compatible version: 3.8.0
+ Latest verified compatible version: 3.9.0
Versions 3.0.0 and higher are supported beginning with .NET agent v10.40.0.
@@ -1676,7 +1676,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
**MySqlConnector**
* Minimum supported version: 1.0.1
- * Latest verified compatible version: 2.5.0
+ * Latest verified compatible version: 2.6.0
|
@@ -1752,7 +1752,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
* Minimum supported version: 1.0.488
- * Latest verified compatible version: 2.12.14
+ * Latest verified compatible version: 2.13.17
|
@@ -1824,7 +1824,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
Use [AWSSDK.DynamoDBv2](https://www.nuget.org/packages/AWSSDK.DynamoDBv2).
* Minimum supported version: 3.5.0
- * Latest verified compatible version: 4.0.17.8
+ * Latest verified compatible version: 4.0.18.6
* Minimum agent version required: 10.33.0
@@ -1992,7 +1992,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
10.37.0 (`InvokeModelAsync`, `ConverseAsync`)
- 4.0.17.5
+ 4.0.20.6
|
@@ -2113,7 +2113,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
9.7.0
|
- 10.0.7
+ 10.0.9
|
@@ -2233,7 +2233,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
* Minimum supported version: 3.7.0
- * Latest verified compatible version: 4.0.2.25
+ * Latest verified compatible version: 4.0.2.33
@@ -2247,7 +2247,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
* Minimum supported version: 3.7.0
- * Latest verified compatible version: 4.0.8.11
+ * Latest verified compatible version: 4.0.8.19
@@ -2261,7 +2261,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
* Minimum supported version: 3.7.0
- * Latest verified compatible version: 4.0.3.24
+ * Latest verified compatible version: 4.0.3.32
diff --git a/src/content/docs/apm/agents/nodejs-agent/extend-your-instrumentation/apollo-server-plugin-nodejs.mdx b/src/content/docs/apm/agents/nodejs-agent/extend-your-instrumentation/apollo-server-plugin-nodejs.mdx
index ac7f265491f8..a4a4b6caa85e 100644
--- a/src/content/docs/apm/agents/nodejs-agent/extend-your-instrumentation/apollo-server-plugin-nodejs.mdx
+++ b/src/content/docs/apm/agents/nodejs-agent/extend-your-instrumentation/apollo-server-plugin-nodejs.mdx
@@ -11,9 +11,15 @@ redirects:
freshnessValidatedDate: never
---
+
+ Starting with 14.0.0 of the Node.js agent, Apollo Server customers no longer need to install and use `@newrelic/apollo-server-plugin`. The instrumentation is automatically applied to every Apollo Server instance.
+
+ See our [Apollo Server Migration Guide](/docs/apm/agents/nodejs-agent/installation-configuration/update-nodejs-agent/#apollo-server-migration-guide) for more details.
+
+
The New Relic Apollo Server plugin instruments your Apollo Server applications to give visibility into your GraphQL payloads. This helps you uncover and diagnose the cause of your slow [GraphQL queries](/docs/apis/nerdgraph/get-started/introduction-new-relic-nerdgraph). The supported Apollo Server version is 2.14 or later.
-Our plugin records overall timings for queries and uses [distributed tracing](/docs/understand-dependencies/distributed-tracing/get-started/how-new-relic-distributed-tracing-works) to uncover the route problem. Use this instrumentation to see if the problem arises from resolving a piece of requested data or if it stems from work done on other services or databases.
+The plugin records overall timings for queries and uses [distributed tracing](/docs/understand-dependencies/distributed-tracing/get-started/how-new-relic-distributed-tracing-works) to uncover route problems. Use this instrumentation to see whether the problem arises from resolving a piece of requested data or from work done on other services or databases.
## Compatibility
@@ -31,6 +37,506 @@ The New Relic plugin works with the following Apollo Server modules:
Other plugins may work, depending on their underlying implementation, but they have not been verified.
-## GitHub documentation [#github]
+## Metrics
+
+Two new metrics have been introduced to understand the behavior of your GraphQL operations within and across transactions. Read more on those below or jump down to the [Visualizations](#visualizations) section to see some recommended ways to use this data.
+
+For more information on querying metrics and creating charts, see the [Resources](#resources) section.
+
+### Operation Metrics
+
+`/GraphQL/operation/ApolloServer/[operation-type]/[operation-name]/[deepest-unique-path]`
+
+Operation metrics include the operation type, operation name, and deepest path. These metrics represent the durations of individual queries or mutations. Use them to compare performance outside the context of individual transactions, which may contain multiple queries.
+
+**Operation Type:** Indicates if the operation was a query or a mutation.
+
+**Operation Name:** The operation name when provided or ``.
+
+**Deepest Unique Path:** The deepest path included in the selection set of a query where only one field was selected at each level. Since operation names may be reused, this helps further determine uniqueness of a given operation. See the description on the [transactions](#deepest-unique-path) section for more details.
+
+### Field Resolve Metrics
+
+`/GraphQL/resolve/ApolloServer/[parent-type].[field-name]`
+
+Resolve metrics capture the duration spent resolving a particular piece of requested GraphQL data. Use them to find specific resolvers that may contribute to slowing down incoming queries, to distinguish field resolvers with the same name on different types, or to identify the same resolver applied across different types.
+
+These differ slightly in naming from their segment and span counterparts. To better visualize relationships, the full path to a field is represented in segments and spans (for example, `libraries.books.title`). To understand the duration aggregated across all usages and transactions, these metrics use the field name without the full path.
+
+### Field and Argument Metrics
+
+`/GraphQL/field/ApolloServer/[parent-type].[field-name]`
+`/GraphQL/arg/ApolloServer/[parent-type].[field-name]/[arg-name]`
+
+Field metrics are only captured when `config.apollo_server.field_metrics` is `true`. Unlike field resolve metrics, this captures every time a field or resolver argument is seen. Use these metrics to determine whether a field in a GraphQL schema is still in use and safe to remove.
+
+#### All fields and args that have been requested within the last day
+
+```sql
+FROM Metric SELECT count(newrelic.timeslice.value) where appName = 'YOUR_APP_NAME' WITH METRIC_FORMAT 'GraphQL/{kind}/ApolloServer/{field}' where kind = 'arg' or kind = 'field' FACET kind, field limit max since 1 day ago
+```
+
+### Visualizations [#visualizations]
+
+The following queries use these metrics to help you understand the behavior of your Apollo GraphQL applications.
+
+#### Top 10 Operations
+
+To get a list of the top 10 slowest operations, use the following query on demand or as part of a dashboard.
+
+```sql
+FROM Metric SELECT average(newrelic.timeslice.value) * 1000 WHERE appName = 'YOUR_APP_NAME' WITH METRIC_FORMAT 'GraphQL/operation/ApolloServer/{operation}' FACET operation LIMIT 10
+```
+
+The **Bar** chart type gives a visualization similar to the transaction overview.
+
+A **Table** chart type is also useful for showing a breakdown of operations. Use the `METRIC_FORMAT` for additional sorting and visualization flexibility. The following query generates columns for operation type, operation name, deepest path, and **AVG Duration (MS)**.
+
+```sql
+FROM Metric SELECT average(newrelic.timeslice.value) * 1000 as 'AVG Duration (MS)' WHERE appName = 'YOUR_APP_NAME' WITH METRIC_FORMAT 'GraphQL/operation/ApolloServer/{type}/{name}/{deepest-path}' FACET type, name, `deepest-path` LIMIT 20
+```
+
+#### Average Operation Time
+
+To track the average duration over time for operations, use a similar query with `TIMESERIES`.
+
+```sql
+FROM Metric SELECT average(newrelic.timeslice.value) WHERE appName = 'YOUR_APP_NAME' WITH METRIC_FORMAT 'GraphQL/operation/ApolloServer/{operation}' TIMESERIES FACET operation
+```
+
+View this with the **Line** chart type, which lets you see all operations or toggle individual ones.
+
+#### Top 10 Resolvers
+
+To get a list of the top 10 slowest resolvers, use the following query on demand or as part of a dashboard.
+
+```sql
+FROM Metric
+SELECT average(newrelic.timeslice.value) * 1000 as 'Average Duration (MS)' WHERE appName = 'YOUR_APP_NAME' WITH METRIC_FORMAT 'GraphQL/resolve/ApolloServer/{type}.{field}' FACET field LIMIT 20
+```
+
+If you would like to include the parent type:
+
+```sql
+FROM Metric
+SELECT average(newrelic.timeslice.value) * 1000 as 'Average Duration (MS)' WHERE appName = 'YOUR_APP_NAME' WITH METRIC_FORMAT 'GraphQL/resolve/ApolloServer/{field}' FACET field LIMIT 20
+```
+
+The **Bar** chart type gives a visualization similar to the transaction overview. The **Table** chart type is also useful for showing a breakdown of field and **Average Duration (MS)**.
+
+#### Average Resolver Time
+
+To track the average duration over time for resolvers, use a similar query with `TIMESERIES`.
+
+```sql
+FROM Metric
+SELECT average(newrelic.timeslice.value) * 1000 as 'Average Duration (MS)' TIMESERIES WHERE appName = 'YOUR_APP_NAME' WITH METRIC_FORMAT 'GraphQL/resolve/ApolloServer/{field}' FACET field
+```
+
+View this with the **Line** chart type, which lets you see all resolvers or toggle individual ones.
+
+### Resources [#resources]
+
+* [Query APM metric timeslice data with NRQL](/docs/data-apis/understand-data/metric-data/query-apm-metric-timeslice-data-nrql/)
+
+* [Add and customize metric charts](/docs/nrql/get-started/introduction-nrql-new-relics-query-language/)
+
+## Segments and Spans
+
+Segments and spans (when distributed tracing is enabled) are captured for GraphQL operations, field resolution, and additional instrumented work that occurs as part of field resolution, such as making a query to a database.
+
+### Operation Segments/Spans
+
+`/GraphQL/operation/ApolloServer/[operation-type]/[operation-name]/[deepest-unique-path]`
+
+Operation segments and spans include the operation type, operation name, and deepest unique path. These represent the individual duration and attributes of a specific invocation within a transaction or trace.
+
+For more details on the parts, see the [transactions](#details) section.
+
+**Attributes**
+
+
+
+
+ |
+ **Name**
+ |
+
+ **Description**
+ |
+
+ **Default**
+ |
+
+
+
+
+ |
+ `graphql.operation.type`
+ |
+
+ `query` or `mutation`
+ |
+
+ Included
+ |
+
+
+ |
+ `graphql.operation.name`
+ |
+
+ Name given to the operation or `anonymous`
+ |
+
+ Included
+ |
+
+
+ |
+ `graphql.operation.query`
+ |
+
+ The original GraphQL query with arguments obfuscated
+ |
+
+ Included
+ |
+
+
+
+
+To exclude the query attribute (or any attribute), add the attribute name to the `attributes` exclude list or to the segment and span attributes exclude lists individually.
+
+For more information on including and excluding attributes, see the [attributes documentation](/docs/apm/agents/nodejs-agent/attributes/nodejs-agent-attributes/#configure-attributes).
+
+### Field Resolve Segments/Spans
+
+`/GraphQL/resolve/ApolloServer/[path]`
+
+Resolve segments and spans use the resolution path of the individual field to best differentiate within a given trace or transaction. For example, the path `libraries.books` is used instead of just `books`. These represent the individual duration and attributes of a specific field being resolved as part of the GraphQL operation.
+
+**Attributes**
+
+
+
+
+ |
+ **Name**
+ |
+
+ **Description**
+ |
+
+ **Default**
+ |
+
+
+
+
+ |
+ `graphql.field.name`
+ |
+
+ Name of the resolved field
+ |
+
+ Included
+ |
+
+
+ |
+ `graphql.field.returnType`
+ |
+
+ Return type (`Book!`, `[String]`, etc.) of the resolved field
+ |
+
+ Included
+ |
+
+
+ |
+ `graphql.field.parentType`
+ |
+
+ Type of the parent of this field (`[Book]`)
+ |
+
+ Included
+ |
+
+
+ |
+ `graphql.field.path`
+ |
+
+ Full resolve path of the field (`libraries.books`)
+ |
+
+ Included
+ |
+
+
+ |
+ `graphql.field.args`
+ |
+
+ Arg passed to the GraphQL query or mutation for this resolver captured as key/value pairs
+ |
+
+ Excluded
+ |
+
+
+
+
+To capture args attributes, add `graphql.field.args.*` to the `attributes` include list or to the segment and span attributes include lists individually.
+
+For more information on including and excluding attributes, see the [attributes documentation](/docs/apm/agents/nodejs-agent/attributes/nodejs-agent-attributes/#configure-attributes).
+
+## Transactions
+
+```graphql
+query {
+ libraries {
+ books {
+ title
+ author {
+ name
+ }
+ }
+ }
+}
+```
+
+`post /query//libraries.books`
+
+Transactions are captured as web transactions, associated with the underlying framework (Express, Koa, etc.), and named based on the GraphQL operations executed.
+
+The agent uses several details to group unique query representations in a transaction name: HTTP method, operation type, operation name, and the deepest path resolved (the first, if multiple).
+
+The raw representation of a transaction looks like the following: `/WebTransaction/{framework-name}/POST//{operation-type}/{operation-name}/{deepest-unique-path}`
+
+For an Express usage of Apollo Server, that may look like: `/WebTransaction/Expressjs/POST//query//libraries.books`
+
+The transaction on New Relic One will ultimately display similar to: `post /query//libraries.books`.
+
+### Details [#details]
+
+#### HTTP method
+
+The HTTP method for the web request. Requests can arrive via GET or POST, surfacing them similarly to other web transactions.
+
+#### Operation Type
+
+Indicates if the operation was a query or a mutation.
+
+#### Operation Name
+
+The operation name when provided or ``.
+
+`query { libraries }` would use the operation name `` because a name was not provided.
+
+A named query such as `query GetLibraries { libraries }` would use the operation name `GetLibraries`.
+
+#### Deepest Unique Path [#deepest-unique-path]
+
+The deepest path included in the selection set of a query where only one field was selected at each level. Since operation names may be reused, this helps further determine uniqueness of a given operation.
+
+The agent uses the deepest unique path (instead of the deepest path) to avoid making an arbitrary naming decision that might imply or hide details about what causes slowness in an application.
+
+For the query:
+
+```graphql
+query {
+ libraries {
+ branch
+ booksInStock {
+ isbn,
+ title,
+ author
+ }
+ magazinesInStock {
+ issue,
+ title
+ }
+ }
+}
+```
+
+The deepest unique path resolves to `libraries` because multiple fields are selected beyond that point. Any resolver executed beyond that point may contribute to the performance characteristics of the transaction.
+
+If the query selects only one field per resolver, the full path is used because each selection set is unique.
+
+The query:
+
+```graphql
+query {
+ libraries {
+ booksInStock {
+ title
+ }
+ }
+}
+```
+
+Results in the deepest unique path: `libraries.booksInStock.title`.
+
+`id` and `__typename` fields are automatically excluded from the naming decision.
+
+For example, a federated subgraph query:
+
+```graphql
+query {
+ libraries {
+ branch
+ __typename
+ id
+ }
+}
+```
+
+Results in the deepest unique path: `libraries.branch`.
+
+### Union Types and Inline Fragments
+
+For union types that use inline fragments, the transaction name uses `< ... >` brackets to indicate the underlying selected field when only one result type is specified in the query.
+
+For the following schema:
+
+```graphql
+union SearchResult = Book | Author
+
+type Book {
+ title: String!
+}
+
+type Author {
+ name: String!
+}
+
+type Query {
+ search(contains: String): [SearchResult!]
+}
+```
+
+And the following query:
+
+```graphql
+query example {
+ search(contains: "author") {
+ __typename
+ ... on Author {
+ name
+ }
+ }
+}
+```
+
+Results in the following transaction name:
+
+`post /query/example/search.name`
+
+However, if the query returns both Book and Author:
+
+```graphql
+query example {
+ search(contains: "author") {
+ __typename
+ ... on Author {
+ name
+ }
+ ... on Book {
+ title
+ }
+ }
+}
+```
+
+The resulting transaction name is:
+
+`post /query/example/search`
+
+### Naming on Error
+
+Errors parsing or validating a GraphQL request can impact transaction naming.
+
+#### Validation Errors
+
+If a request parsed but failed validation, the agent names the transaction based on what was attempted. For example, this occurs when a field in the incoming GraphQL query does not exist.
+
+In this situation, the agent uses the parsed document to indicate each intended piece, including calculating the deepest intended path.
+
+Here is an example of querying for a field that does not exist (`doesnotexist`) and what that looks like in NR One.
+
+```graphql
+query GetBooksByLibrary {
+ libraries {
+ books {
+ doesnotexist {
+ name
+ }
+ }
+ }
+}
+```
+
+`post /query/GetBooksByLibrary/libraries.books.doesnotexist.name`
+
+#### Parsing Errors
+
+If a requested operation can't be parsed, the agent names the transaction using a wildcard (`*`) in place of the usual operation pieces. In this situation, the query is invalid and there are no identifiable pieces to go on.
+
+Here is an example missing a closing `}` that cannot parse and what that looks like in NR One.
+
+```graphql
+query GetBooksByLibrary {
+ libraries {
+ books {
+ title
+ author {
+ name
+ }
+ }
+ }
+// missing closing }
+```
+
+`post /*`
+
+In these situations, the `query` attribute on the operation span associated with the error is the best way to identify the particular offender.
+
+#### Batch Queries
+
+Apollo Server supports batch queries. In these situations, there are multiple operations in play that affect naming.
+
+To best identify transaction groupings, the agent aggregates operation names after an additional `/batch` indicator. These names can be quite long.
+
+Here is an example of a batch query and what that looks like in NR One.
+
+```
+[
+ {
+ query: query GetBookForLibrary {
+ library(branch: "downtown") {
+ books {
+ title
+ author {
+ name
+ }
+ }
+ }
+ }
+ },
+ {
+ query: mutation {
+ addThing(name: "added thing!")
+ }
+ }
+]
+```
+
+`post /batch/query/GetBookForLibrary/library.books/mutation//addThing`
-For detailed information about installation, configuration, transaction details, metrics, segments, errors, testing, troubleshooting, and more, see New Relic's [Apollo Server plugin documentation on GitHub](https://github.com/newrelic/newrelic-node-apollo-server-plugin/blob/main/README.md).
+Here you see `batch/` followed by `query/GetBookForLibrary/library.books` and `mutation//addThing`.
diff --git a/src/content/docs/apm/agents/nodejs-agent/extend-your-instrumentation/nextjs-instrumentation.mdx b/src/content/docs/apm/agents/nodejs-agent/extend-your-instrumentation/nextjs-instrumentation.mdx
new file mode 100644
index 000000000000..196ff998ea13
--- /dev/null
+++ b/src/content/docs/apm/agents/nodejs-agent/extend-your-instrumentation/nextjs-instrumentation.mdx
@@ -0,0 +1,173 @@
+---
+title: Next.js instrumentation with the hybrid agent
+tags:
+ - Agents
+ - Nodejs agent
+ - Extend your instrumentation
+metaDescription: The New Relic Node.js agent can intercept native Next.js OpenTelemetry spans and produce necessary telemetry within New Relic.
+freshnessValidatedDate: never
+---
+
+The recommended way to monitor a Next.js application is to rely on the native OpenTelemetry spans emitted by Next.js together with the Node.js agent's hybrid agent feature, rather than the agent's built-in Next.js instrumentation. This page explains how to enable the hybrid agent, points to example applications, and covers common questions about injecting the browser agent and deploying to cloud providers.
+
+
+ Native Next.js OpenTelemetry support requires Node.js agent version [14.1.0](https://github.com/newrelic/node-newrelic/releases/tag/v14.1.0) or later. The hybrid agent only instruments the Node.js runtime; the Next.js edge runtime is not supported, which is why the `register()` example below exits early unless `NEXT_RUNTIME` is `nodejs`.
+
+
+The Node.js agent has had Next.js instrumentation since 2022 through [@newrelic/next](https://github.com/newrelic/newrelic-node-nextjs/releases/tag/v0.1.0), and that instrumentation was bundled into the agent in [12.0.0](https://github.com/newrelic/node-newrelic/releases/tag/v12.0.0). However, it was limited and didn't work when deploying to cloud providers like [Vercel](https://vercel.com/frameworks/nextjs), [AWS Amplify](https://aws.amazon.com/amplify/), [Netlify](https://www.netlify.com/with/nextjs/), or [Azure Static Web Apps](https://azure.microsoft.com/en-us/products/app-service/static). With the introduction of the [hybrid agent](/docs/apm/agents/manage-apm-agents/opentelemetry-api-support), the Node.js agent can intercept OpenTelemetry spans and synthesize the telemetry that drives the New Relic experience. Native Next.js OpenTelemetry instrumentation was added in [14.1.0](https://github.com/newrelic/node-newrelic/releases/tag/v14.1.0).
+
+## Enable the hybrid agent [#enable]
+
+To enable the hybrid agent and disable the agent instrumentations that conflict with Next.js, set the following configuration in `newrelic.js`:
+
+```js
+'use strict'
+
+exports.config = {
+ app_name: ['Your application name'],
+ license_key: 'your-license-key',
+ opentelemetry: {
+ enabled: true
+ },
+ instrumentation: {
+ http: {
+ enabled: false
+ },
+ next: {
+ enabled: false
+ },
+ undici: {
+ enabled: false
+ }
+ }
+}
+```
+
+
+ If you make native `fetch` calls, you must disable `undici` instrumentation as shown above. Next.js wraps `fetch` and creates its own client spans, so leaving `undici` enabled produces duplicate client spans in your traces.
+
+
+If you prefer to use environment variables:
+
+```ini
+NEW_RELIC_LICENSE_KEY=
+NEW_RELIC_APP_NAME=
+NEW_RELIC_OPENTELEMETRY_ENABLED=true
+NEW_RELIC_INSTRUMENTATION_NEXT_ENABLED=false
+NEW_RELIC_INSTRUMENTATION_HTTP_ENABLED=false
+NEW_RELIC_INSTRUMENTATION_UNDICI_ENABLED=false
+```
+
+You must also add an `instrumentation.js` file (or `instrumentation.ts` for TypeScript) to load the agent before the rest of your application:
+
+```js
+async function loadNewRelicAgent() {
+ const { default: newrelic } = await import('newrelic')
+ const agent = newrelic?.agent
+ if (!agent || agent.collector?.isConnected?.()) {
+ return
+ }
+
+ await new Promise((resolve) => {
+ const done = () => {
+ clearTimeout(timer)
+ agent.removeListener('started', done)
+ agent.removeListener('errored', done)
+ resolve()
+ }
+ const timer = setTimeout(done, 8000)
+ agent.once('started', done)
+ agent.once('errored', done)
+ })
+}
+
+export async function register() {
+ // The agent only instruments the Node.js runtime, not the edge runtime.
+ if (process.env.NEXT_RUNTIME !== 'nodejs') {
+ return
+ }
+
+ await loadNewRelicAgent()
+}
+```
+
+Check out the Next.js App Router [example application](https://github.com/newrelic/newrelic-node-examples/tree/9fa74c516926014fa33758cbd6e3737334ed4f98/nextjs/nextjs-app-router) for a more complete example of this setup.
+
+## Next.js instrumentation in Vercel [#vercel]
+
+Deploying to Vercel splits static and dynamic pages into different environments. Instead of relying on `.env` and `newrelic.js` to load agent configuration, define the following [environment variables](https://vercel.com/docs/environment-variables) in the Vercel console under **Environment Variables**:
+
+```ini
+NEW_RELIC_LICENSE_KEY=
+NEW_RELIC_APP_NAME=
+NEW_RELIC_OPENTELEMETRY_ENABLED=true
+NEW_RELIC_INSTRUMENTATION_NEXT_ENABLED=false
+NEW_RELIC_INSTRUMENTATION_HTTP_ENABLED=false
+NEW_RELIC_INSTRUMENTATION_UNDICI_ENABLED=false
+```
+
+You still need the `instrumentation.js` file described above; only the source of the configuration changes on Vercel.
+
+Check out the Next.js App Router [example application](https://github.com/newrelic/newrelic-node-examples/tree/9fa74c516926014fa33758cbd6e3737334ed4f98/nextjs/nextjs-app-router) for a more complete example of this setup.
+
+## Inject the browser agent [#browser-agent]
+
+Since Next.js is a full-stack framework, most customers want observability on both the client and the server. The following example shows how to inject the New Relic browser agent into every page.
+
+Edit the root layout file within `app/` and add the following:
+
+```js
+import Script from 'next/script';
+
+async function loadNewRelicAgent() {
+ const { default: newrelic } = await import('newrelic')
+ const agent = newrelic?.agent
+ if (!agent || agent.collector?.isConnected?.()) {
+ return newrelic
+ }
+
+ await new Promise((resolve) => {
+ const done = () => {
+ clearTimeout(timer)
+ agent.removeListener('started', done)
+ agent.removeListener('errored', done)
+ resolve()
+ }
+ const timer = setTimeout(done, 8000)
+ agent.once('started', done)
+ agent.once('errored', done)
+ })
+
+ return newrelic
+}
+
+export default async function RootLayout({
+ children,
+}){
+ // Wait for the agent to connect before requesting the browser timing header.
+ const newrelic = await loadNewRelicAgent()
+ const browserTimingHeader = newrelic.getBrowserTimingHeader({
+ hasToRemoveScriptWrapper: true,
+ allowTransactionlessInjection: true,
+ })
+
+ return (
+
+ {children}
+ 
-The knowledge connector securely integrates with your content and knowledge bases, such as Confluence, to enhance New Relic AI's responses with your specific organizational knowledge. The process follows these steps:
+New Relic AI Knowledge securely integrates with your content and knowledge bases, such as Confluence, to enhance New Relic AI's responses with your specific organizational knowledge. The process follows these steps:
-- **Index:** Once your knowledge bases are connected to the New Relic AI platform, the knowledge connector performs an initial indexing of your documents. You can configure this process to run on a recurring basis, ensuring that New Relic AI always has access to the most up-to-date information as your documents evolve.
+- **Index:** Once your knowledge bases are connected to the New Relic AI platform, New Relic AI Knowledge performs an initial indexing of your documents. You can configure this process to run on a recurring basis, ensuring that New Relic AI always has access to the most up-to-date information as your documents evolve.
- **Retrieval:** When you ask a question in New Relic AI, the system searches the indexed content for the most relevant information. This step ensures that the context is pulled directly from your trusted, internal documentation.
@@ -74,27 +75,27 @@ If a query doesn't require your organizational knowledge, New Relic AI will gene
## Prerequisites
-Before you begin using the New Relic AI knowledge connector, ensure that:
+Before you begin using New Relic AI Knowledge, ensure that:
- Only documents suitable for organization-wide access are indexed.
- Sensitive information is redacted.
- All the documents to be indexed comply with your organization's internal data security and privacy policies.
- New Relic AI is enabled for your account.
-- Appropriate user permissions are configured for indexing (you'll need the Organization Manager role, which allows you to perform actions—such as set up and manage the knowledge connectors—that may have future billing implications).
+- Appropriate user permissions are configured for indexing (you'll need the Organization Manager role, which allows you to perform actions—such as set up and manage New Relic AI Knowledge—that may have future billing implications).
You have two options to assign the Organization Manager role:
-- **Apply to an existing user group:** Add the Organization Manager role to an existing group of users who will be responsible for managing the knowledge connectors.
+- **Apply to an existing user group:** Add the Organization Manager role to an existing group of users who will be responsible for managing New Relic AI Knowledge.
- **Create a dedicated group:** For more granular control, create a new user group specifically for this purpose and assign the Organization Manager role to that group.
This flexibility allows your organization to control who has the ability to manage indexed content.
## Configure data source and indexing frequency [#configure]
-You can connect your knowledge sources using either pre-built connectors or the [knowledge connector API](/docs/apis/nerdgraph/examples/nerdgraph-rag) for more custom integrations.
+You can connect your knowledge sources using either pre-built connectors or the [Knowledge API](/docs/apis/nerdgraph/examples/nerdgraph-rag) for more custom integrations.
### Best practices for optimizing your knowledge source content
-To maximize the effectiveness of New Relic AI's ability to surface relevant information, provide accurate answers, and accelerate alert event resolution, it's crucial to structure your internal documentation with the AI in mind. While these guidelines focus on alert event retro documents for quick and efficient alert event management, the principles apply broadly to other knowledge types. The knowledge connector performs best when your source documents are clear, consistent, and rich in specific details relevant to their intended use.
+To maximize the effectiveness of New Relic AI's ability to surface relevant information, provide accurate answers, and accelerate alert event resolution, it's crucial to structure your internal documentation with the AI in mind. While these guidelines focus on alert event retro documents for quick and efficient alert event management, the principles apply broadly to other knowledge types. New Relic AI Knowledge performs best when your source documents are clear, consistent, and rich in specific details relevant to their intended use.
-Follow these best practices when creating and maintaining your retro documents and other knowledge base articles to ensure New Relic AI can optimally leverage the indexed information:
+Follow these best practices when creating and maintaining your retro documents and other knowledge articles to ensure New Relic AI can optimally leverage the indexed information:
- **Descriptive title:** Ensure each document has a clear and descriptive title. This helps New Relic AI fetch the closest matching content based on alert titles and user queries. For example, "Memory Leak in Service X during v2.3 Deployment" is more effective than "System Slowdown."
@@ -124,7 +125,7 @@ Follow these best practices when creating and maintaining your retro documents a
- **Owning team:** Clearly identify the team responsible for the service or component where the alert event originated or the team owning the resolution.
-- **Regularly update and review:** Ensure your knowledge connector is configured to run on a recurring basis, and make it a practice to regularly review and update your source documents. This ensures New Relic AI always has access to the most up-to-date and accurate information.
+- **Regularly update and review:** Ensure New Relic AI Knowledge is configured to run on a recurring basis, and make it a practice to regularly review and update your source documents. This ensures New Relic AI always has access to the most up-to-date and accurate information.
To start indexing Confluence content, you need:
@@ -137,7 +138,7 @@ To start indexing Confluence content, you need:
- `read:content-details:confluence`
- Relevant query parameter using Confluence Query Language (CQL) to filter the list of returned content to be indexed
-To start indexing your content and benefit from the knowledge connector with New Relic AI, follow these mentioned steps:
+To start indexing your content and benefit from New Relic AI Knowledge, follow these mentioned steps:
+
+With 
+
+ 
+ ```graphql
+ {
+ actor {
+ organization {
+ authorizationManagement {
+ authenticationDomains(id: "YOUR_AUTHENTICATION_DOMAIN_ID") {
+ authenticationDomains {
+ groups {
+ groups {
+ displayName
+ id
+ roles {
+ roles {
+ roleId
+ name
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ ```
+