-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(browser): Experimental features section #19238
base: develop
Are you sure you want to change the base?
Changes from 4 commits
ce07cfd
b8171ce
8a28b23
7b0cf3b
a9bb2e5
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
--- | ||
title: 'Automatically track native marks and measures' | ||
tags: | ||
- Browser | ||
- Browser monitoring | ||
- Experimental features | ||
metaDescription: "Observes and reports on the performance of your webpages by automatically tracking native marks and measures." | ||
freshnessValidatedDate: never | ||
--- | ||
|
||
<Callout variant="important"> | ||
This is an experimental browser feature. These features are subject to change and should be used with caution. They are only available when using the browser agent installed via copy/paste or NPM. | ||
Check warning on line 12 in src/content/docs/browser/new-relic-browser/browser-pro-features/marks-and-measures.mdx GitHub Actions / vale-linter
Check failure on line 12 in src/content/docs/browser/new-relic-browser/browser-pro-features/marks-and-measures.mdx GitHub Actions / vale-linter
|
||
</Callout> | ||
|
||
|
||
[Marks](https://developer.mozilla.org/en-US/docs/Web/API/Performance/mark) and [measures](https://developer.mozilla.org/en-US/docs/Web/API/Performance/measure) are standard methods to observe and report on the performance of your webpages. They are generic events native to the browser and can be used to measure the duration of any task. The New Relic browser agent can automatically track marks and measures as store them as `BrowserPerformance` events. | ||
Check failure on line 16 in src/content/docs/browser/new-relic-browser/browser-pro-features/marks-and-measures.mdx GitHub Actions / vale-linter
Check warning on line 16 in src/content/docs/browser/new-relic-browser/browser-pro-features/marks-and-measures.mdx GitHub Actions / vale-linter
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Suggestions: Marks and measures are standard methods to observe and report your webpages' performance. These generic events are native to browser and can measure any task's duration. The New Relic browser agent automatically tracks these marks and measures and then store them as |
||
|
||
## Enable marks and measures monitoring [#enable-feature] | ||
|
||
To enable this feature, you'll be making the following changes to your browser agent: | ||
|
||
1. Make sure you're using browser agent 1.272.0 or later. | ||
2. Locate the agent code in your webpage HTML or JS application. | ||
3. In the `init` configuration object, and add the `performance` feature configuration. | ||
|
||
Here's an example to enable both marks and measures detection: | ||
```js | ||
<script type="text/javascript"> ;window.NREUM||(NREUM={});init={ …, performance: {capture_marks: true, capture_measures: true} }: | ||
``` | ||
4. Deploy your app. | ||
|
||
## Find your data in New Relic [#find-data] | ||
|
||
Once enabled, the agent stores marks and measures data under the `BrowserPerformance` event type in New Relic. To find this data, try the following queries and then create custom dashboards to track performance. | ||
|
||
Query 1: This NRQL query retrieves all `BrowserPerformance` events for the specified `appName` ("My Application") where the `entryName` is either `mark` or `measure`. | ||
Check warning on line 36 in src/content/docs/browser/new-relic-browser/browser-pro-features/marks-and-measures.mdx GitHub Actions / vale-linter
|
||
|
||
```nrql | ||
FROM BrowserPerformance SELECT * WHERE appName = 'My Application' AND entryName = 'mark' OR entryName = 'measure' | ||
``` | ||
|
||
Query 2: This NRQL query calculates the average `entryDuration` for mark and measure events within the specified `appName`. The `FACET entryName` clause groups the results by the `entryName` field, providing separate average durations for mark and measure events. This can be useful for comparing the average performance of marks versus measures. | ||
|
||
```nrql | ||
FROM BrowserPerformance SELECT average(entryDuration) WHERE appName = 'My Application' AND entryName = 'mark' OR entryName = 'measure' FACET entryName | ||
``` | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
title: 'Experimental features in browser monitoring' | ||
metaDescription: "Opt-in to use experimental features in New Relic browser monitoring before they're generally available." | ||
freshnessValidatedDate: never | ||
--- | ||
|
||
New Relic Browser offers a range of features to enhance your application monitoring capabilities. To ensure stability and reliability, some features are released in an experimental state. These features are subject to change, may not be fully supported, and should be used with caution. | ||
Check warning on line 7 in src/content/docs/browser/new-relic-browser/configuration/experimental-features.mdx GitHub Actions / vale-linter
Check warning on line 7 in src/content/docs/browser/new-relic-browser/configuration/experimental-features.mdx GitHub Actions / vale-linter
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Suggestion: New Relic browser agent offers a range of features to enhance your application monitoring capabilities. Some features are released in experimental state to ensure stability and reliability. These features may change or may lack support. You must use them with caution. |
||
|
||
## Current experimental features | ||
|
||
The following experimental features are available: | ||
* Browser agent v1.272.0: [Automatically track native marks and measures as `BrowserPerformance` events](/docs/browser/new-relic-browser/browser-pro-features/marks-and-measures) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion: This is an experimental browser feature and may change. You must use it with caution. It's available only with the browser agent installed via copy/paste or NPM.