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.

Sign up for GitHub

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

chore: Update Ruby browser agent doc #17446

Merged
merged 4 commits into from
May 29, 2024
Merged

chore: Update Ruby browser agent doc #17446

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
16a070d
chore: Update Ruby browser agent doc
kaylareopelle May 24, 2024
675738e
Merge branch 'develop' into update-ruby-browser-doc
kaylareopelle May 24, 2024
8dfefa5
Apply suggestions from code review
kaylareopelle May 24, 2024
b5b2355
style(Ruby agent): Added some TW edits
May 27, 2024
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
70 changes: 51 additions & 19 deletions src/content/docs/apm/agents/ruby-agent/features/new-relic-browser-ruby-agent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,36 +13,34 @@ redirects:
freshnessValidatedDate: never
---

With the Ruby agent, you can add [browser monitoring agent](/docs/browser/new-relic-browser/getting-started/introduction-new-relic-browser) instrumentation to your webpages either automatically or manually. To enable <InlinePopover type="browser" /> in the UI, follow the procedures to [install the browser agent](/docs/browser/new-relic-browser/installation/install-new-relic-browser-agent). Then follow the procedures in this section to set up the Ruby agent.
With the Ruby agent, you can inject the [browser monitoring agent](/docs/browser/new-relic-browser/getting-started/introduction-new-relic-browser) into your webpages either automatically or manually. By default, if the Ruby agent detects Javascript, it automatically installs <InlinePopover type="browser" />.

## Requirements
If you prefer to add browser monitoring manually or want to learn about options to install the browser agent, [consult the browser agent installation guide](/docs/browser/new-relic-browser/installation/install-new-relic-browser-agent).

Automatic browser instrumentation is supported for most recent versions of Rails:
## Requirements

* New Relic Ruby agent ([version 3.0.1 or higher](/docs/release-notes/agent-release-notes/ruby-release-notes))
* For automatic instrumentation: Rails 2.3 or higher
* For manual instrumentation: Rails 2.0 to 2.2
Automatic browser instrumentation is available [for all supported versions of the Ruby agent.](https://docs.newrelic.com/docs/apm/agents/ruby-agent/getting-started/ruby-agent-eol-policy/) You must set your content security policy to `'unsafe-inline'` or give the agent [a CSP nonce](#csp-nonce-support).
rhetoric101 marked this conversation as resolved.
Show resolved Hide resolved

## Use auto-instrumentation [#auto_instrumentation]

Automatic instrumentation works with Rack, and requires Rails 2.3 or higher.

Configure the agent to automatically instrument pages with end user monitoring scripts, by adding or editing the following flag in `newrelic.yml`.
New Relic's default configuration enables browser monitoring auto-instrumentation:

```yaml
browser_monitoring:
auto_instrument: true
```

This is the simplest way to monitor end users. The Ruby agent examines each page from your application and automatically injects the browser JavaScript in the header. Auto-instrumentation works for environments that support Rack. For performance reasons the agent scans only the first 50k of your application's response for the header instrumentation point. In cases where a `X-UA-Compatible` meta tag is present and the `<head>` tag is longer than 50k, auto-instrumentation will fail gracefully.
This is the simplest way to monitor end users. The Ruby agent examines each page of your application when it loads and automatically injects the browser JavaScript in the header. Auto-instrumentation works for environments using Rack. For performance reasons, the agent only scans the first 50k lines of your application's response for the header instrumentation point. In cases where a `X-UA-Compatible` meta tag is present and the `<head>` tag is longer than 50k, auto-instrumentation will fail gracefully.

Auto-instrumentation looks for an `X-UA-Compatible` meta tag and inserts the JavaScript directly after it. If the auto-instrumentation can't find an `X-UA-Compatible` meta tag, it will insert after the opening head tag. Failing that, it will insert after the opening body tag. If any of these tags are wrapped in conditionals or comments, the automatic instrumentation will likely fail.

Auto-instrumentation will look for an `X-UA-Compatible` meta tag and insert the JavaScript directly after it. If the auto-instrumentation cannot find an `X-UA-Compatible` meta tag, it will insert after the opening head tag, and failing that it will insert after the opening body tag. If any of these tags are wrapped in conditionals or comments, the automatic instrumentation will likely fail.
Auto-instrumentation will not occur on pages with an attachment 'Content-Type' or when it detects streaming requests.

If auto-instrumentation fails to correctly instrument your application’s pages, then you must [manually instrument](#manual_instrumentation) via agent API.
If auto-instrumentation fails to correctly instrument your application's pages, then you must [manually instrument](#manual_instrumentation) via agent API.

## Manually instrument via agent API [#manual_instrumentation]

If you are using Rails 2.1 to 2.2 or cannot use auto-instrumentation, you can still set up end user monitoring manually by including appropriate scripts in your pages. Use the New Relic Ruby agent's API to generate the script to be inserted into your pages.
You can set up end user monitoring manually by including appropriate scripts in your pages. Use the New Relic Ruby agent's API to generate the script. The API injects this script into your pages.

For example, to modify your application's template to call the agent, use:

Expand All @@ -55,24 +53,58 @@ For example, to modify your application's template to call the agent, use:

## CSP Nonce support

CSP Nonce usage in our browser instrumentation is supported in version 7.1.0+ of the Ruby agent. To use a nonce with the browser instrumentation, you must disable browser monitoring auto instrumentation and use the manual instrumentation via the agent API.
The browser agent can be instrumented automatically if the content security policy is set to 'unsafe-inline'. If you want to use a [CSP Nonce](https://content-security-policy.com/nonce/), you may need to add some manual configuration.

### Rails CSP Nonce

[Rails versions 5.2+ include a feature to set a CSP nonce using an API.](https://guides.rubyonrails.org/security.html#adding-a-nonce) On Ruby agent versions 9.10.0+, the Rails CSP nonce will be automatically detected and applied to the browser agent injection script.

You can disable this feature by updating your `newrelic.yml` to the following:

```yaml
browser_monitoring:
content_security_policy_nonce: false
```

Or set the environment variable, `NEW_RELIC_BROWSER_MONITORING_CONTENT_SECURITY_POLICY=false`.

### API call

You can pass a CSP nonce to the `NewRelic::Agent.browser_timing_header` API in Ruby agent versions 7.1.0+.

When passing a nonce to this method, you must disable browser monitoring auto-instrumentation and use manual instrumentation via the agent API.

Update your `newrelic.yml` to:

```yaml
browser_monitoring:
auto_instrument: false
```

Or set the environment variable, `NEW_RELIC_BROWSER_MONITORING_AUTO_INSTRUMENT=false`.

You may now pass a nonce as an argument into the API method to allow the agent to insert the nonce into the browser instrumentation. For example, `NewRelic::Agent.browser_timing_header(nonce)`.

## Troubleshooting

If you do not see any browser data being reported, view the HTML source and confirm two blocks of script similar to this in your HTML head:
If browser data ins't reported, view the HTML source and confirm two blocks of script similar to this are in your HTML head:
kaylareopelle marked this conversation as resolved.
Show resolved Hide resolved

```html
<script type="text/javascript">window.NREUM||(NREUM={});...</script>
```

If these are not present, check the auto-instrumentation settings or the placement of manual instrumentation in your template files.

In versions of the Ruby agent prior to 3.7.0, `<%=::NewRelic::Agent.browser_timing_footer rescue "" %>` also needed to be called as close to the bottom of the document as possible. With 3.7.0, all the required script is included by `browser_timing_header`. `browser_timing_footer` returns an empty string for compatibility.
If these aren't present, check:
* The auto-instrumentation settings
* The placement of manual instrumentation in your template files
* The way you're applying a nonce

## Disable auto-instrumentation [#disable_instrumentation]

The default value of [`auto-instrument`](/docs/agents/ruby-agent/configuration/ruby-agent-configuration#browser_monitoring) is `true` (even when unspecified). To disable auto-instrumentation, set this flag to `false`.

To disable auto-instrumentation only for certain controllers or controller actions, use [`newrelic_ignore_enduser`](/docs/agents/ruby-agent/installation-configuration/ignoring-specific-transactions#page-load-timing-rum). Server-side instrumentation will be unaffected by this call.
```yaml
browser_monitoring:
auto_instrument: false
```

To disable auto-instrumentation only for certain controllers or controller actions, use [`newrelic_ignore_enduser`](/docs/agents/ruby-agent/installation-configuration/ignoring-specific-transactions#page-load-timing-rum). Server-side instrumentation isn't affected by this call.
Loading