openreplay / openreplay/documentation
Documentation has missing Information about linking sentry errors in openReplay sessions
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 16
- Forks
- 23
- Avg merge
- 39m
- Merged PRs (30d)
- 3
Description
I have noticed, that the documentation is missing one line in the examples of linking Sentry issues in the openReplay Session, to show the directly in the OpenReplay video:
const tracker = new OpenReplay({
projectKey: window.OPENREPLAY_PROJECT_KEY,
onStart: ({ sessionToken, sessionID }) => {
// This is to link from OpenReplay -> Sentry
Sentry.setTag("openReplaySessionToken", sessionToken);
// This is to link from Sentry -> OpenReplay (requires tracker v3.6.0+)
Sentry.setTag(
"openReplaySessionURL",
tracker.getSessionURL();
);
},
});
Both your examples will create a link from Sentry to OpenReplay.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the Sentry integration documentation at the linked page and review section 4, “Attach openreplaySessionURL.” Compare both examples with the requested session URL tag and verify that the finished documentation explains linking from Sentry to the OpenReplay session video as well as the reverse direction.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100