From e287a3e48d256a816eb3e2076a564c895107c309 Mon Sep 17 00:00:00 2001 From: svc-docs-eng-opensource-bot Date: Fri, 24 Jan 2025 12:03:52 +0000 Subject: [PATCH] chore: Update Attribute Dictionary JSON --- src/data/attribute-dictionary.json | 298 ++++++++++++++++++++++------- 1 file changed, 229 insertions(+), 69 deletions(-) diff --git a/src/data/attribute-dictionary.json b/src/data/attribute-dictionary.json index bf64fb9a265..2e1fc6dab3d 100644 --- a/src/data/attribute-dictionary.json +++ b/src/data/attribute-dictionary.json @@ -187,7 +187,8 @@ "BrowserInteraction", "BrowserTiming", "JavaScriptError", - "PageView" + "PageView", + "UserAction" ], "name": "deviceType", "units": null @@ -222,6 +223,20 @@ "name": "groupedRequestUrl", "units": null }, + { + "definition": "

Indicates whether the event is associated with a session replay. If you already have custom dashboards, adding hasReplay = true to queries would allow you to search for a particular session of interest and watch the replay.

\n", + "events": [ + "AjaxRequest", + "BrowserInteraction", + "BrowserTiming", + "JavaScriptError", + "PageView", + "PageViewTiming", + "UserAction" + ], + "name": "hasReplay", + "units": null + }, { "definition": "

The fully qualified domain name (FQDN) of the request URL.

\n", "events": [ @@ -301,14 +316,6 @@ "label": "enum" } }, - { - "definition": "

Likelihood this event will be saved.

\n", - "events": [ - "AjaxRequest" - ], - "name": "priority", - "units": null - }, { "definition": "

The specific administrative division within a country where the PageView event occurred. In the United States, regions correspond to state codes, such as WA or NY. Outside the United States, a country's regions correspond to numerical codes.

\n

In the United States, regions correspond to state codes ; for example, WA or NY. Outside the United States, a country's regions correspond to numerical codes .

\n", "events": [ @@ -376,6 +383,7 @@ "BrowserTiming", "JavaScriptError", "PageAction", + "PageView", "PageViewTiming", "UserAction" ], @@ -399,7 +407,6 @@ "definition": "

The duration, in seconds, from the start of the request (timestamp) to the end of the last callback. This is not just an additive function; the callback time can overlap with the wait time. This attribute is only seen in AjaxRequest data that is tied to BrowserInteraction.

\n", "events": [ "AjaxRequest", - "BrowserInteraction", "BrowserTiming" ], "name": "timeToLastCallbackEnd", @@ -1361,7 +1368,8 @@ "BrowserInteraction", "BrowserTiming", "JavaScriptError", - "PageView" + "PageView", + "UserAction" ], "name": "deviceType", "units": null @@ -1417,6 +1425,20 @@ "name": "firstPaint", "units": null }, + { + "definition": "

Indicates whether the event is associated with a session replay. If you already have custom dashboards, adding hasReplay = true to queries would allow you to search for a particular session of interest and watch the replay.

\n", + "events": [ + "AjaxRequest", + "BrowserInteraction", + "BrowserTiming", + "JavaScriptError", + "PageView", + "PageViewTiming", + "UserAction" + ], + "name": "hasReplay", + "units": null + }, { "definition": "

The total duration, in seconds, spent on JavaScript execution. This attribute is only seen in AjaxRequest data that is tied to BrowserInteraction. This attribute doesn't exist for initial page load events.

\n", "events": [ @@ -1498,6 +1520,17 @@ "name": "previousURL", "units": null }, + { + "definition": "

The total time the request waits for a service to initiate (in seconds).

\n", + "events": [ + "BrowserInteraction", + "PageView" + ], + "name": "queueDuration", + "units": { + "label": "seconds (s)" + } + }, { "definition": "

The specific administrative division within a country where the PageView event occurred. In the United States, regions correspond to state codes, such as WA or NY. Outside the United States, a country's regions correspond to numerical codes.

\n

In the United States, regions correspond to state codes ; for example, WA or NY. Outside the United States, a country's regions correspond to numerical codes .

\n", "events": [ @@ -1537,6 +1570,7 @@ "BrowserTiming", "JavaScriptError", "PageAction", + "PageView", "PageViewTiming", "UserAction" ], @@ -1548,7 +1582,8 @@ { "definition": "

The grouped version of the URL in the browser at the end of the interaction.

\n", "events": [ - "BrowserInteraction" + "BrowserInteraction", + "PageViewTiming" ], "name": "targetGroupedUrl", "units": null @@ -1669,18 +1704,6 @@ "label": "seconds (s)" } }, - { - "definition": "

The duration, in seconds, from the start of the request (timestamp) to the end of the last callback. This is not just an additive function; the callback time can overlap with the wait time. This attribute is only seen in AjaxRequest data that is tied to BrowserInteraction.

\n", - "events": [ - "AjaxRequest", - "BrowserInteraction", - "BrowserTiming" - ], - "name": "timeToLastCallbackEnd", - "units": { - "label": "seconds (s)" - } - }, { "definition": "

The time, in seconds, from the start of the interaction to the loadEventEnd, as defined by the Navigation Timing API. This attribute exists for initial page load events, not route changes.

\n

For more information about the Navigation Timing API, see Instrumentation for Browser monitoring.

\n", "events": [ @@ -1848,6 +1871,17 @@ ], "name": "userAgentVersion", "units": null + }, + { + "definition": "

The total server-side response time for the top-level resource of the PageView or BrowserInteraction event (in seconds) as measured by the APM agent.

\n

This does not include network time to transmit the request or receive the response, or server-side request queueing time. The webAppDuration is measured by the APM agent and must be injected into the browser monitoring script before the request is fully finished. Its end point is slightly before the end point used to calculate the duration attribute on Transactions, so webAppDuration will be slightly less than the duration attribute on Transactions in practice.

\n", + "events": [ + "BrowserInteraction", + "PageView" + ], + "name": "webAppDuration", + "units": { + "label": "seconds (s)" + } } ], "dataSources": [ @@ -2054,7 +2088,8 @@ "BrowserInteraction", "BrowserTiming", "JavaScriptError", - "PageView" + "PageView", + "UserAction" ], "name": "deviceType", "units": null @@ -2080,6 +2115,20 @@ "name": "groupedPageURL", "units": null }, + { + "definition": "

Indicates whether the event is associated with a session replay. If you already have custom dashboards, adding hasReplay = true to queries would allow you to search for a particular session of interest and watch the replay.

\n", + "events": [ + "AjaxRequest", + "BrowserInteraction", + "BrowserTiming", + "JavaScriptError", + "PageView", + "PageViewTiming", + "UserAction" + ], + "name": "hasReplay", + "units": null + }, { "definition": "

The total duration, in seconds, spent on JavaScript execution. This attribute is only seen in AjaxRequest data that is tied to BrowserInteraction. This attribute doesn't exist for initial page load events.

\n", "events": [ @@ -2159,6 +2208,7 @@ "BrowserTiming", "JavaScriptError", "PageAction", + "PageView", "PageViewTiming", "UserAction" ], @@ -2182,7 +2232,6 @@ "definition": "

The duration, in seconds, from the start of the request (timestamp) to the end of the last callback. This is not just an additive function; the callback time can overlap with the wait time. This attribute is only seen in AjaxRequest data that is tied to BrowserInteraction.

\n", "events": [ "AjaxRequest", - "BrowserInteraction", "BrowserTiming" ], "name": "timeToLastCallbackEnd", @@ -3437,7 +3486,8 @@ "BrowserInteraction", "BrowserTiming", "JavaScriptError", - "PageView" + "PageView", + "UserAction" ], "name": "deviceType", "units": null @@ -3454,13 +3504,11 @@ "units": null }, { - "definition": "

The unique identifier of the monitor referenced in New Relic One.

\n", + "definition": "

An optional attribute set using the Browser agent API that can be used to inform how errors should be grouped in Errors Inbox. For more info, see our docs.

\n", "events": [ - "JavaScriptError", - "SyntheticCheck", - "SyntheticRequest" + "JavaScriptError" ], - "name": "entityGuid", + "name": "error.group.name", "units": null }, { @@ -3487,6 +3535,28 @@ "name": "firstErrorInSession", "units": null }, + { + "definition": "

The timestamp of when the first JS error occurs on the page.

\n", + "events": [ + "JavaScriptError" + ], + "name": "firstOccurrenceTimestamp", + "units": null + }, + { + "definition": "

Indicates whether the event is associated with a session replay. If you already have custom dashboards, adding hasReplay = true to queries would allow you to search for a particular session of interest and watch the replay.

\n", + "events": [ + "AjaxRequest", + "BrowserInteraction", + "BrowserTiming", + "JavaScriptError", + "PageView", + "PageViewTiming", + "UserAction" + ], + "name": "hasReplay", + "units": null + }, { "definition": "

The synthetic monitoring account from which you are running the monitor.

\n", "events": [ @@ -3604,6 +3674,7 @@ "BrowserTiming", "JavaScriptError", "PageAction", + "PageView", "PageViewTiming", "UserAction" ], @@ -7277,7 +7348,6 @@ "definition": "

The last interaction before a crash or harvest event, if one is present.

\n", "events": [ "Mobile", - "MobileApplicationExit", "MobileCrash", "MobileHandledException", "MobileRequest", @@ -7683,20 +7753,6 @@ "name": "importance", "units": null }, - { - "definition": "

The last interaction before a crash or harvest event, if one is present.

\n", - "events": [ - "Mobile", - "MobileApplicationExit", - "MobileCrash", - "MobileHandledException", - "MobileRequest", - "MobileRequestError", - "MobileSession" - ], - "name": "lastInteraction", - "units": null - }, { "definition": "

The total amount of memory, in MB, used by the application. Updated every 60 seconds.

\n", "events": [ @@ -8328,7 +8384,6 @@ "definition": "

The last interaction before a crash or harvest event, if one is present.

\n", "events": [ "Mobile", - "MobileApplicationExit", "MobileCrash", "MobileHandledException", "MobileRequest", @@ -9049,7 +9104,6 @@ "definition": "

The last interaction before a crash or harvest event, if one is present.

\n", "events": [ "Mobile", - "MobileApplicationExit", "MobileCrash", "MobileHandledException", "MobileRequest", @@ -9624,7 +9678,6 @@ "definition": "

The last interaction before a crash or harvest event, if one is present.

\n", "events": [ "Mobile", - "MobileApplicationExit", "MobileCrash", "MobileHandledException", "MobileRequest", @@ -10273,7 +10326,6 @@ "definition": "

The last interaction before a crash or harvest event, if one is present.

\n", "events": [ "Mobile", - "MobileApplicationExit", "MobileCrash", "MobileHandledException", "MobileRequest", @@ -10905,7 +10957,6 @@ "definition": "

The last interaction before a crash or harvest event, if one is present.

\n", "events": [ "Mobile", - "MobileApplicationExit", "MobileCrash", "MobileHandledException", "MobileRequest", @@ -14182,9 +14233,10 @@ "units": null }, { - "definition": "

The URL on which the PageAction is occurring. This URL may be different from the Page URL.

\n", + "definition": "

The URL value at the time of observing the event. This URL may differ from the Page URL if soft navigations have occurred.

\n", "events": [ - "PageAction" + "PageAction", + "UserAction" ], "name": "currentUrl", "units": null @@ -14270,6 +14322,7 @@ "BrowserTiming", "JavaScriptError", "PageAction", + "PageView", "PageViewTiming", "UserAction" ], @@ -14540,7 +14593,8 @@ "BrowserInteraction", "BrowserTiming", "JavaScriptError", - "PageView" + "PageView", + "UserAction" ], "name": "deviceType", "units": null @@ -14604,6 +14658,20 @@ "name": "firstPaint", "units": null }, + { + "definition": "

Indicates whether the event is associated with a session replay. If you already have custom dashboards, adding hasReplay = true to queries would allow you to search for a particular session of interest and watch the replay.

\n", + "events": [ + "AjaxRequest", + "BrowserInteraction", + "BrowserTiming", + "JavaScriptError", + "PageView", + "PageViewTiming", + "UserAction" + ], + "name": "hasReplay", + "units": null + }, { "definition": "

The name of the invoked web transaction. For example: Controller/customers/show.

\n", "events": [ @@ -14634,6 +14702,14 @@ "label": "seconds (s)" } }, + { + "definition": "

An ID that is generated per hard page load. This ID remains the same across soft navigations but changes on page refreshes and hard navigations.

\n", + "events": [ + "PageView" + ], + "name": "pageTraceId", + "units": null + }, { "definition": "

The URL of the page that was loaded for the PageView, for example: http://www.newrelic.com. This URL does not include query parameters.

\n", "events": [ @@ -14652,6 +14728,7 @@ { "definition": "

The total time the request waits for a service to initiate (in seconds).

\n", "events": [ + "BrowserInteraction", "PageView" ], "name": "queueDuration", @@ -14700,6 +14777,23 @@ "name": "session", "units": null }, + { + "definition": "

Allows for linking together end user actions from session traces and querying across browser events. Not all browser events will have this. For example, PageView events complete before the first session trace harvest. Also, initial page loads from BrowserInteraction won't always include this.

\n", + "events": [ + "AjaxRequest", + "BrowserInteraction", + "BrowserTiming", + "JavaScriptError", + "PageAction", + "PageView", + "PageViewTiming", + "UserAction" + ], + "name": "sessionTraceId", + "units": { + "label": "ID" + } + }, { "definition": "

The time (date, hour, minute, second) at which the interaction occurred.

\n", "events": [ @@ -14761,8 +14855,9 @@ "units": null }, { - "definition": "

The total server-side response time for the top-level resource of the PageView (in seconds) as measured by the APM agent.

\n

This does not include network time to transmit the request or receive the response, or server-side request queueing time. The webAppDuration is measured by the APM agent and must be injected into the browser monitoring script before the request is fully finished. Its end point is slightly before the end point used to calculate the duration attribute on Transactions, so webAppDuration will be slightly less than the duration attribute on Transactions in practice.

\n", + "definition": "

The total server-side response time for the top-level resource of the PageView or BrowserInteraction event (in seconds) as measured by the APM agent.

\n

This does not include network time to transmit the request or receive the response, or server-side request queueing time. The webAppDuration is measured by the APM agent and must be injected into the browser monitoring script before the request is fully finished. Its end point is slightly before the end point used to calculate the duration attribute on Transactions, so webAppDuration will be slightly less than the duration attribute on Transactions in practice.

\n", "events": [ + "BrowserInteraction", "PageView" ], "name": "webAppDuration", @@ -15045,16 +15140,6 @@ "label": "seconds (s)" } }, - { - "definition": "

The first input delay measures the duration from the first interaction to the moment the web application responds. The duration is rounded down to the nearest millisecond. This attribute only occurs when the value of the timingName attribute is firstInteraction.

\n

The firstInputDelay goes one step beyond firstInteraction. It measures how long the user has to wait until their action is registered and they receive the expected response from the browser.

\n

For more information, see the PageViewTiming documentation.

\n", - "events": [ - "PageViewTiming" - ], - "name": "firstInputDelay", - "units": { - "label": "milliseconds (ms)" - } - }, { "definition": "

First interaction is a timing that captures when customers begin to engage with a website, such as clicking a button or typing in a box. The first interaction timing is rounded down to the nearest second. This attribute only occurs when the value of the timingName attribute is firstInteraction.

\n

Events are handled at the document level with addEventListener(). Clicking an empty page will cause an interaction to fire. Valid event type values include:

\n\n

Note that this attribute represents the time of the event; to know which event triggered it, use interactionType.

\n

For more information, see the PageViewTiming documentation.

\n", "events": [ @@ -15075,6 +15160,20 @@ "label": "seconds (s)" } }, + { + "definition": "

Indicates whether the event is associated with a session replay. If you already have custom dashboards, adding hasReplay = true to queries would allow you to search for a particular session of interest and watch the replay.

\n", + "events": [ + "AjaxRequest", + "BrowserInteraction", + "BrowserTiming", + "JavaScriptError", + "PageView", + "PageViewTiming", + "UserAction" + ], + "name": "hasReplay", + "units": null + }, { "definition": "

The time from when the user interacted with the page until when the browser was first able to start processing event listeners for that interaction. This time captures the delay before event processing can begin due to the main thread being busy with other work. This attribute only occurs when the value of the timingName attribute is interactionToNextPaint.

\n

Introduced in browser agent version 1.267 as part of web-vitals v4 library. Please see the web-vitals documentation for current browser support.

\n", "events": [ @@ -15161,6 +15260,14 @@ "name": "loadState", "units": null }, + { + "definition": "

A unique ID used by the Google Core Web Vitals library to track changes for a particular metric instance. For more information, see this link.

\n", + "events": [ + "PageViewTiming" + ], + "name": "metricId", + "units": null + }, { "definition": "

This is the estimated effective bandwidth in megabits per second at the time the PageViewTiming event was captured. This value will only be reported with the largestContentfulPaint and firstInteraction events on compatible browsers.

\n

The value is captured from the NetworkInformation API. For a full browser compatibility table and description see the MDN web docs.

\n", "events": [ @@ -15259,6 +15366,14 @@ "name": "regionCode", "units": null }, + { + "definition": "

Per web-vitals v4, this is the delta between time to first byte (TTFB) and when the browser starts loading the largest contentful paint (LCP) resource (if there is one, otherwise 0). For more information, please see Optimize LCP.

\n

This attribute only occurs when the value of the timingName attribute is largestContentfulPaint.

\n

Please see the web-vitals documentation for current browser support.

\n", + "events": [ + "PageViewTiming" + ], + "name": "resourceLoadDelay", + "units": null + }, { "definition": "

Per web-vitals v4, this is the total time it takes to load the LCP resource itself (if there is one, otherwise 0). For more information, please see Optimize LCP.

\n

This attribute only occurs when the value of the timingName attribute is largestContentfulPaint.

\n

Please see the web-vitals documentation for current browser support.

\n", "events": [ @@ -15303,6 +15418,7 @@ "BrowserTiming", "JavaScriptError", "PageAction", + "PageView", "PageViewTiming", "UserAction" ], @@ -15311,6 +15427,15 @@ "label": "ID" } }, + { + "definition": "

The grouped version of the URL in the browser at the end of the interaction.

\n", + "events": [ + "BrowserInteraction", + "PageViewTiming" + ], + "name": "targetGroupedUrl", + "units": null + }, { "definition": "

Per web-vitals v4, this is the time from when the user initiates loading the page until when the browser receives the first byte of the response (for example, time to first byte (TTFB)).

\n

This attribute only occurs when the value of the timingName attribute is firstContentfulPaint or largestContentfulPaint.

\n

Please see the web-vitals documentation for current browser support.

\n", "events": [ @@ -17145,7 +17270,6 @@ { "definition": "

The unique identifier of the monitor referenced in New Relic One.

\n", "events": [ - "JavaScriptError", "SyntheticCheck", "SyntheticRequest" ], @@ -17571,7 +17695,6 @@ { "definition": "

The unique identifier of the monitor referenced in New Relic One.

\n", "events": [ - "JavaScriptError", "SyntheticCheck", "SyntheticRequest" ], @@ -20627,6 +20750,42 @@ "name": "countryCode", "units": null }, + { + "definition": "

The URL value at the time of observing the event. This URL may differ from the Page URL if soft navigations have occurred.

\n", + "events": [ + "PageAction", + "UserAction" + ], + "name": "currentUrl", + "units": null + }, + { + "definition": "

The type of device that loaded the page: mobile, tablet, or desktop.

\n", + "events": [ + "AjaxRequest", + "BrowserInteraction", + "BrowserTiming", + "JavaScriptError", + "PageView", + "UserAction" + ], + "name": "deviceType", + "units": null + }, + { + "definition": "

Indicates whether the event is associated with a session replay. If you already have custom dashboards, adding hasReplay = true to queries would allow you to search for a particular session of interest and watch the replay.

\n", + "events": [ + "AjaxRequest", + "BrowserInteraction", + "BrowserTiming", + "JavaScriptError", + "PageView", + "PageViewTiming", + "UserAction" + ], + "name": "hasReplay", + "units": null + }, { "definition": "

The name of the invoked web transaction. For example: Controller/customers/show.

\n", "events": [ @@ -20699,6 +20858,7 @@ "BrowserTiming", "JavaScriptError", "PageAction", + "PageView", "PageViewTiming", "UserAction" ], @@ -21100,4 +21260,4 @@ "definition": "

The workload status is derived from the alerting status of entities in your workload. This allows you to set up an alert condition to notify you whenever the workload goes into a DISRUPTED or DEGRADED status.

\n", "name": "WorkloadStatus" } -] +] \ No newline at end of file