Skip to content
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

Browser logs documentation update #19873

Merged
merged 35 commits into from
Feb 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
833a52c
Overview updates
adutta-newrelic Feb 3, 2025
bd1da13
updates
adutta-newrelic Feb 3, 2025
310ecf2
Merge branch 'develop' into NR-356329-browser-logs
adutta-newrelic Feb 3, 2025
8476527
Merge branch 'develop' into NR-356329-browser-logs
adutta-newrelic Feb 4, 2025
ad455eb
Merge branch 'develop' into NR-356329-browser-logs
adutta-newrelic Feb 6, 2025
d8ad38a
Merge branch 'develop' into NR-356329-browser-logs
adutta-newrelic Feb 7, 2025
5b0539f
Merge branch 'develop' into NR-356329-browser-logs
adutta-newrelic Feb 10, 2025
cfe7975
Merge branch 'develop' into NR-356329-browser-logs
adutta-newrelic Feb 10, 2025
eee8e0f
Merge branch 'develop' into NR-356329-browser-logs
adutta-newrelic Feb 12, 2025
f11e0a5
Update get-started.mdx
adutta-newrelic Feb 13, 2025
4bd682f
Update src/content/docs/browser/browser-monitoring/browser-pro-featur…
adutta-newrelic Feb 13, 2025
263e0f7
Merge branch 'develop' into NR-356329-browser-logs
adutta-newrelic Feb 17, 2025
23889fe
Update src/content/docs/browser/browser-monitoring/browser-pro-featur…
adutta-newrelic Feb 17, 2025
1bacb5e
Update src/content/docs/browser/browser-monitoring/browser-pro-featur…
adutta-newrelic Feb 17, 2025
0cc7f50
Update src/content/docs/browser/browser-monitoring/browser-pro-featur…
adutta-newrelic Feb 17, 2025
22867a0
Update src/content/docs/browser/browser-monitoring/browser-pro-featur…
adutta-newrelic Feb 17, 2025
2f22421
Update src/content/docs/browser/browser-monitoring/browser-pro-featur…
adutta-newrelic Feb 17, 2025
478ad1e
Update src/content/docs/browser/browser-monitoring/browser-pro-featur…
adutta-newrelic Feb 17, 2025
af0f065
updates
adutta-newrelic Feb 17, 2025
60fa4dc
Merge branch 'develop' into NR-356329-browser-logs
adutta-newrelic Feb 17, 2025
148b3bc
updates to the error inbox page
adutta-newrelic Feb 17, 2025
1bbc8f7
Merge branch 'develop' into NR-356329-browser-logs
adutta-newrelic Feb 17, 2025
6b5869c
updates
adutta-newrelic Feb 17, 2025
d1c6d0f
Merge branch 'develop' into NR-356329-browser-logs
adutta-newrelic Feb 18, 2025
fd8e747
Update src/content/docs/browser/browser-monitoring/browser-pro-featur…
adutta-newrelic Feb 18, 2025
51a39fa
Merge branch 'develop' into NR-356329-browser-logs
adutta-newrelic Feb 19, 2025
17fe14d
Merge branch 'develop' into NR-356329-browser-logs
adutta-newrelic Feb 20, 2025
d168bcf
Merge branch 'develop' into NR-356329-browser-logs
adutta-newrelic Feb 21, 2025
1a9ac9b
updated the image
adutta-newrelic Feb 21, 2025
b0cdb24
updates
adutta-newrelic Feb 21, 2025
7d469a9
Merge branch 'develop' into NR-356329-browser-logs
adutta-newrelic Feb 22, 2025
215a42f
Update logs-of-a-browser-app.mdx
adutta-newrelic Feb 24, 2025
7a2eb30
Merge branch 'develop' into NR-356329-browser-logs
adutta-newrelic Feb 24, 2025
70f0b5f
Merge branch 'develop' into NR-356329-browser-logs
adutta-newrelic Feb 24, 2025
cb874e8
updated the redirect
adutta-newrelic Feb 24, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
---
title: Getting started
tags:
translate:
metaDescription: 'Learn how to enable and manage Browser Logs in New Relic, including steps for automatic log collection and how to disable the feature.'
redirects:
freshnessValidatedDate: never
---

Enhance your application's observability and debugging capabilities by following these simple setup instructions.

### Prerequisites

* A **Pro** or **Pro + SPA** browser agent

<Callout variant="important">
Automatic log detection is not available for the Lite browser agent.
</Callout>

## Enable automatic log collection (For Existing Browser Apps) [#enable-automatic-log]

To enable automatic log collection for an existing browser app:

<Steps>

<Step>
Go to **[one.newrelic.com](https://one.newrelic.com) > All Capabilities > Browser**.
</Step>

<Step>
Select your browser app.
</Step>

<Step>
In the left-hand menu, click **Application settings**.
</Step>

<Step>
Ensure the **Pro** or **Pro + SPA** browser agent is selected.
</Step>

<Step>
Toggle **Browser Logs** to **ON**.
</Step>

<Step>
Toggle the required verbosity level to **ON**, you can choose from:

* **Error**
* **Warn**
* **Info**
* **Debug**
* **Trace**
</Step>

<Step>
Edit the sampling rate to specify the percentage of user sessions for which to collect logs. You can enter a value between 0 and 100.

<Callout variant="important">
* Logs sampling is coordinated with other sampling decisions to maximize data collection for the same session. For example, if you set the logs sampling rate to 5% and your Session Replay (SR) sampling rate to 10%, then:
* Roughly 5% of your sessions will have both Logs and SR collected.
* Roughly 5% of your sessions will have only SR data collected.
* The remaining sessions will have neither.
* For any new browser apps you create, automatic log collection is enabled by default with a warn verbosity level and a sampling rate of 10%.
</Callout>
</Step>
</Steps>

<img
title="Session replay"
alt="screenshot of the session replay page in browser"
src="/images/browser-logs-overview.webp"
/>

## Disable browser logs [#disable-browser-logs]

To disable browser logs for an existing browser app:

<Steps>

<Step>
Go to **[one.newrelic.com](https://one.newrelic.com) > All Capabilities > Browser**.
</Step>

<Step>
Select your browser app.
</Step>

<Step>
In the left-hand menu, click **Application settings**.
</Step>

<Step>
Toggle **Browser Logs** to **OFF**.
</Step>
</Steps>
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
title: Overview
tags:
translate:
metaDescription: 'Discover how our Browser Logs feature captures real-time browser console logs to enhance observability, simplify debugging, and improve user experience.'
redirects:
- /docs/browser/browser-monitoring/browser-pro-features/auto-logging
freshnessValidatedDate: never
---

The <DNT>**Browser logs**</DNT> feature offers insights into your front-end application by automatically capturing browser console logs in real-time. With this feature, you can:

* **Maximize observability**: Understand how your application behaves in the user's environments.
* **Simplify debugging**: Identify and fix issues by correlating user actions with browser logs.
* **Enhance UX**: Resolve errors and ensure a smooth interaction for the end users.

## Key features of browser logs

<table>
<thead>
<tr>
<th style={{width: "200px"}}>
Feature
</th>

<th>
Description
</th>
</tr>
</thead>

<tbody>
<tr>
<td>
[**Automatic Log Collection**](/docs/browser/browser-monitoring/browser-pro-features/auto-logging)
</td>
<td>
Automatically captures all log messages from the browser console, including Error, Warn, Info, and Debug logs, providing a complete view of front-end activity.
</td>
</tr>

<tr>
<td>
[**Customizable Settings**](/docs/browser/browser-monitoring/browser-pro-features/browser-logs/get-started)
</td>
<td>
* **Toggle On/Off auto-logging**: Enable or disable log collection.
* **Configure Sample Rate**: Define the percentage of user sessions for log collection.
* **Set Log Verbosity Levels**: Select the minimum log level to capture, automatically including all preceding levels.
</td>
</tr>

<tr>
<td>
[**Logs in Session Replay**](/docs/browser/browser-monitoring/browser-pro-features/browser-logs/view-browser-logs/logs-in-session-replay)
</td>
<td>
View browser logs in context with Session Replay, bridging application functionality and user experience. [Learn more about Session Replay](#session-replay-section).
</td>
</tr>

<tr>
<td>
[**Logs in Errors Inbox**](/docs/browser/browser-monitoring/browser-pro-features/browser-logs/view-browser-logs/logs-in-error-inbox)
</td>
<td>
View browser logs alongside JavaScript errors during troubleshooting, aiding in debugging and better root cause analysis. [Learn more about Errors Inbox](#errors-inbox-section)
</td>
</tr>
</tbody>
</table>

Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Logs in Errors inbox
tags:
translate:
metaDescription: 'Learn how to view browser logs in context with Session Replay to gain valuable insights into user interactions and application functionality.'
redirects:
freshnessValidatedDate: never
---

View browser logs alongside JavaScript errors during troubleshooting. This contextual information facilitates faster debugging and more effective root cause analysis, enabling you to resolve issues efficiently.

<img
title="Session replay"
alt="screenshot of the session replay page in browser"
src="/images/logs-in-error-inbox-2.webp"
/>
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Logs in Session Replay
tags:
translate:
metaDescription: 'Learn how to view browser logs in context with Session Replay to gain valuable insights into user interactions and application functionality.'
redirects:
freshnessValidatedDate: never
---

When you use the Session Replay feature, you can view browser logs in context with Session Replay. This integration provides a comprehensive view of application functionality and user experience, offering valuable insights into user interactions.

<img
title="Session Replay logs"
alt="Screenshot of browser logs page"
src="/images/logs-in-session-replay.webp"
/>
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: Logs for browser app
tags:
translate:
metaDescription: 'Learn how to view and analyze logs for your browser app using New Relic.'
redirects:
freshnessValidatedDate: never
---

To view the logs of a browser app's performance:

<Steps>
<Step>
Go to <DNT>[one.newrelic.com](https://one.newrelic.com) > **All Capabilities** > **Browser**</DNT>.
</Step>

<Step>
Select a browser app.
</Step>

<Step>
In the left-hand menu, navigate to **Logs**.
</Step>
</Steps>

<img
title="Browser logs"
alt="Screenshot of browser logs page"
src="/images/browser-logs.webp"
/>

## What's next?

* You can also view browser logs in context with Session Replay (if you are using the Session Replay feature) or alongside JavaScript errors in Errors Inbox. Refer [Logs in Session Replay](#session-replay-section) and [Logs in Error Inbox](#js-errors-section) for more details.

* For more information on the Logs UI, see [Use logs UI](/docs/logs/ui-data/use-logs-ui) for more details.
14 changes: 14 additions & 0 deletions src/nav/browser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,20 @@ pages:
path: /docs/browser/new-relic-browser/browser-pro-features/geography-webpage-metrics-location
- title: Browsers page
path: /docs/browser/new-relic-browser/browser-pro-features/browsers-problem-patterns-type-or-platform
- title: Browser logs
pages:
- title: Overview
path: /docs/browser/browser-monitoring/browser-pro-features/browser-logs/overview
- title: Get started
path: /docs/browser/browser-monitoring/browser-pro-features/browser-logs/get-started
- title: View browser logs
pages:
- title: Logs for browser app
path: /docs/browser/browser-monitoring/browser-pro-features/browser-logs/view-browser-logs/logs-of-a-browser-app
- title: Logs in Session replay
path: /docs/browser/browser-monitoring/browser-pro-features/browser-logs/view-browser-logs/logs-in-session-replay
- title: Logs in Error inbox
path: /docs/browser/browser-monitoring/browser-pro-features/browser-logs/view-browser-logs/logs-in-error-inbox
- title: Browser apps index
path: /docs/browser/new-relic-browser/getting-started/browser-apps-index
- title: Browser data in distributed tracing
Expand Down
Binary file added static/images/browser-logs-overview.webp
Binary file not shown.
Binary file added static/images/browser-logs.webp
Binary file not shown.
Binary file added static/images/logs-in-session-replay.webp
Binary file not shown.
Loading