|
| 1 | +--- |
| 2 | +title: Atlas |
| 3 | +sidebar_order: 1 |
| 4 | +redirect_from: |
| 5 | + - /product/integrations/atlas/ |
| 6 | +description: "Learn more about Sentry's Atlas integration and how you can connect Atlas sessions directly to Sentry issues" |
| 7 | +--- |
| 8 | + |
| 9 | +Atlas is all-in-one customer support software built to show your customers’ experience in a simple, timeline view. Easily link Atlas sessions to Sentry issues and link Sentry issues to existing Atlas sessions. |
| 10 | + |
| 11 | +This integration is maintained and supported by the company that created it. For more details, check out our [Integration Platform documentation](/product/integrations/integration-platform/). |
| 12 | + |
| 13 | +## Install and Configure |
| 14 | + |
| 15 | +<Note> |
| 16 | + |
| 17 | +Sentry owner, manager, or admin permissions are required to install this integration. |
| 18 | + |
| 19 | +Atlas **won't** work with self-hosted Sentry. |
| 20 | + |
| 21 | +</Note> |
| 22 | + |
| 23 | +1. Navigate to **App Configuration > Sentry** in Atlas |
| 24 | + |
| 25 | + |
| 26 | + |
| 27 | +2. Follow the instructions to install the Atlas app from within Sentry |
| 28 | + |
| 29 | +## Session Linking |
| 30 | + |
| 31 | +Session linking allows you to associate Sentry issues with sessions in Atlas so that they can be viewed by your support team when they are assisting your customers. |
| 32 | + |
| 33 | +Session linking is automatically attempted if a user has been identified by Sentry. However, if there are multiple simultaneous sessions, disambiguation is needed. For this reason, the best practice is to always identify Atlas sessions from Sentry. |
| 34 | + |
| 35 | +This can be done by first getting the session id from Atlas by calling the following from the client: |
| 36 | + |
| 37 | +```javascript |
| 38 | +apiAxios.interceptors.request.use(config => { |
| 39 | + config.headers[ |
| 40 | + "X-Atlas-Session-Id" |
| 41 | + ] = window.Atlas?.recording?.getSessionId(); |
| 42 | + return config; |
| 43 | +}); |
| 44 | +``` |
| 45 | +
|
| 46 | +You can send this to the Sentry via your Client SDK: |
| 47 | +
|
| 48 | +```javascript |
| 49 | +Sentry.addGlobalEventProcessor(event => { |
| 50 | + event.tags = { |
| 51 | + ...(event.tags || {}), |
| 52 | + ["atlasSupport.sessionId"]: window.Atlas?.recording?.getSessionId(), |
| 53 | + }; |
| 54 | + return event; |
| 55 | +}); |
| 56 | +``` |
| 57 | +
|
| 58 | +or from the Server SDK: |
| 59 | +
|
| 60 | +```python |
| 61 | +sentry_sdk.set_tag("atlasSupport.sessionId", atlas_session_id) |
| 62 | +``` |
| 63 | +
|
| 64 | +Now, Sentry issues will appear in the customer’s timeline in Atlas: |
| 65 | +
|
| 66 | + |
| 67 | +
|
| 68 | +As well as within the session recording: |
| 69 | +
|
| 70 | + |
0 commit comments