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

(CHORE): managing session replay modify capabilities #19593

Open
wants to merge 13 commits into
base: develop
Choose a base branch
from

Conversation

adutta-newrelic
Copy link
Contributor

@adutta-newrelic adutta-newrelic commented Dec 20, 2024

  • NR-352200
  • Changed the left alignment for Sessions Replay into sub categories.
  • Added a new content managing session replay modify capabilities
  • Do not merge as the review is still pending from Vinay and swagatika

Copy link

Hi @adutta-newrelic 👋

Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days.

We will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 10 to 20 minutes).

Copy link

netlify bot commented Dec 20, 2024

Deploy Preview for docs-website-netlify ready!

Name Link
🔨 Latest commit 00502d9
🔍 Latest deploy log https://app.netlify.com/sites/docs-website-netlify/deploys/676ac82734ebbf0008bd61b1
😎 Deploy Preview https://deploy-preview-19593--docs-website-netlify.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

@adutta-newrelic adutta-newrelic requested review from vpayyapilly and removed request for WriteMayur December 22, 2024 15:28
@adutta-newrelic adutta-newrelic marked this pull request as ready for review December 23, 2024 03:45
Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

The most accurate way to project your cost per replay is to enable the feature for a short test period and measure your actual consumption. Alternatively, you can use an average of 5.3 MB per replay as a rough approximation, though keep in mind that your actual cost may vary significantly. A simple formula to project your approximate costs is: `sessions` x `sampling_rate` x `gb_per_replay` x `cost_per_gb`. Here's an example:

```
1 million (sessions) x 5% (sampling_rate) x 0.0053 (gb_per_replay) x $0.35 (cost_per_gb) = $92.75 for 50,000 replays
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this formatted as code with the copy functionality?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have updated this information

* **Performance optimization techniques**: Payload size can also increase if the DOM is large. However, session replay uses a number of techniques to reduce payload size, such as:
* GZIP compression
* Duplication reduction
* Strategic payload harvesting: It only sends a large (compressed) payload when the full DOM is captured, which typically only happens when the replay feature is first imported. After that, it will only send small payloads that relate to the user's actions. The browser agent will harvest on whatever happens first of the following:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...whatever happens first among the following

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have rewritten the whole sentence

If needed, you can programmatically `force` a session replay to start or stop recording using API methods. Here are some use cases:

* Allow users to opt in for interaction recording. For example, if you have a pop-up asking "Allow this session to be recorded for performance analysis?" and a user consents:
1. Call `newrelic.recordReplay()` to initiate recording.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

,

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated


* Allow users to opt in for interaction recording. For example, if you have a pop-up asking "Allow this session to be recorded for performance analysis?" and a user consents:
1. Call `newrelic.recordReplay()` to initiate recording.
2. Once the session is complete or consent is withdrawn, use `newrelic.pauseReplay()` to stop capturing data.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After instead of once
,

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

* Start recording only for sessions on specific URLs such as a product checkout flow.
* Stop recording for sensitive pages such as `/billing` or `/health-records`.

See the API documentation for instructions:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Global comment...use "refer" instead of "see"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

src="/images/browser_screenshot-full_text-masking-example.webp"
/>

If this setting is appropriate, move onto the next step.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

on to

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated


* On the <DNT>**Application settings**</DNT> page, add your own CSS selectors or check the masking boxes. Note that using mask selectors will **not** mask user input, so if you need to hide user input, we recommend using block selectors.

<img
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this image necessary?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me check this with the PM and get back to you.

```
````

These options use an asterisk (\*) to mask all text in that element, hiding the actual text but revealing the number of characters entered. However, asterisks are not valid numbers, so masking number type-specific fields such as telephone or credit card numbers will result in a blank field in a replay.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this formatted as code?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated, the believe, the writer who had written the document earlier was unable to add the code and that is why it was formatted as a code

freshnessValidatedDate: 2024-12-19
---

Fully utilize session replay in New Relic, start by enabling this feature in your browser application settings. This step is essential for capturing user interactions on your web app, providing insights into user journeys, and troubleshooting issues effectively. Follow the steps below to enable session replay and ensure your browser agent is configured correctly.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To fully?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apologies, I did not see this, i have removed the word


4. On the <DNT>**Application settings**</DNT> page, make sure <DNT>**Pro**</DNT> or <DNT>**Pro + SPA**</DNT> browser agent is selected. Session replay is not available for the Lite browser agent.

5. Toggle ON <DNT>**Session tracking**</DNT> and <DNT>**Session replay**</DNT> settings.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ON should follow the setting names

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated


5. Toggle ON <DNT>**Session tracking**</DNT> and <DNT>**Session replay**</DNT> settings.

## Configure sampling rates [#configure-sampling-rates]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section title starts with a verb but doesnt have any actions within. Revisit.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

freshnessValidatedDate: 2024-12-19
---

Manage session replay & modify capabilities provides instructions on utilizing the new user management access functionality, enabling Admins to control who can modify Session replay settings by customizing user roles and access.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was be written for better clarity

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

</Step>

<Step>
Expand the **Account acess** section and in the **Add account roles to this group** select the following:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Qualify Add account roles to this group

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

</Step>

<Step>
Select the <DNT>**Modify**</DNT> checkbox for <DNT>**Session replays**</DNT>.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean "In the Session replays section, select...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I have updated the sentence

freshnessValidatedDate: 2024-12-19
---

This is the first step in diagnosing your New Relic Session replays problem yourself, use this guide to resolve issues quickly.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the second half of this sentence adds no value. consider removing.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

* Ensure you have permission to view replays.
* Make sure you're using the Pro or Pro+SPA version of the browser agent. Session replay does not work with the Lite browser agent.
* Make sure your browser agent meets these requirements:
* Agent version v1.260.0 or greater. We recommend [upgrading to the latest agent version](/docs/release-notes/new-relic-browser-release-notes/browser-agent-release-notes) as we continue making improvements.
Copy link
Contributor

@vpayyapilly vpayyapilly Dec 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not "greater", "later"
as we are continuously making improvements

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

* In [Errors inbox](/docs/errors-inbox/errors-inbox/), filter your views so that you always see a replay. By default, browser event data is stored 8 days, but actual data retention depends on your account.
* If you're using the copy/paste deployment method, make sure you [updated your agent code](#update-snippet).
* If you’re using the APM deployment method, you may need to wait a while for session replay to be automatically enabled. If you’re still not seeing data, try restarting the agent.
* If you're [dropping](https://docs.newrelic.com/docs/data-apis/manage-data/drop-data-using-nerdgraph/) PageView event data, Session Replays may not display in the UI.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

appear in the UI

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

* If you’re using the APM deployment method, you may need to wait a while for session replay to be automatically enabled. If you’re still not seeing data, try restarting the agent.
* If you're [dropping](https://docs.newrelic.com/docs/data-apis/manage-data/drop-data-using-nerdgraph/) PageView event data, Session Replays may not display in the UI.

## Replays not displaying correctly [#replays-not-displaying]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

appearing

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

</Step>

<Step>
Click on the <DNT>**Triage**</DNT> and <DNT>**Group errors**</DNT> pages to see replays attached to errors.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

,
No "click on" only "click"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

Copy link
Contributor

@vpayyapilly vpayyapilly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix and resubmit

vpayyapilly
vpayyapilly previously approved these changes Dec 23, 2024
Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

@adutta-newrelic adutta-newrelic added content requests related to docs site content from_internal Identifies issues/PRs from Relics (except writers) from_tw Identifies issues/PRs from Tech Docs writers documentation and removed content requests related to docs site content labels Dec 24, 2024
Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

1 similar comment
Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation from_internal Identifies issues/PRs from Relics (except writers) from_tw Identifies issues/PRs from Tech Docs writers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants