Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.
Sign upfeat: add instructions #3
Conversation
| ``` | ||
| npm install --save sentry-fullstory | ||
| ``` | ||
| This assumes you are using npm as your package manager. |
This comment has been minimized.
This comment has been minimized.
manuzope
Dec 2, 2019
I've noticed that it's also common to put the yarn instructions. So, how about this:
To install and save in your package.json dependencies, run:
// with npm
npm install --save sentry-fullstory
// with yarn
yarn add sentry-fullstory
| ``` | ||
|
|
||
|
|
||
| You can get the value of `__SENTRY_ORG_SLUG__` from the URL of your sentry organization. Example: `https://sentry.io/organizations/fullstory/` where `fullstory` would be the value of `__SENTRY_ORG_SLUG__`. |
This comment has been minimized.
This comment has been minimized.
manuzope
Dec 2, 2019
Maybe use the word "replace" so that people know to replace __SENTRY_ORG_SLUG__ in the sample code? So something like "Repalce __SENTRY_ORG_SLUG__ with the org for your slug. You can get..."
This comment has been minimized.
This comment has been minimized.
patrick-fs
Dec 2, 2019
Collaborator
The FullStory module needs initialization as well. You could call FullStory.init() as such:
import SentryFullStory, { FullStory } from '@sentry/sentry-fullstory'
FullStory.init({ orgId = '__FULLSTORY_ORG_ID__' });
Replace __FULLSTORY_ORG_ID__ with the value of _fs_org in the FullStory recording snippet on your FullStory settings page
|
I had one nitpick. Otherwise, LGTM! |
| @@ -1,2 +1,43 @@ | |||
| # sentry-fullstory | |||
| The Sentry-FullStory integration creates a link from the Sentry Error to the FullStory replay. It also creates a link from the FullStory event to the Sentry error. | |||
This comment has been minimized.
This comment has been minimized.
patrick-fs
Dec 3, 2019
Collaborator
Nit: Sentry Error - I'm guessing Error should be lowercase. If it's intended to be uppercase, then Sentry error should updated with consistent casing.
scefali commentedDec 2, 2019
This PR adds instructions on how to install the integration