Skip to content

Commit c3ea8da

Browse files
authored
Merge pull request #5498 from segmentio/DOC-535
segment inspector
2 parents 05c6dfa + b02c866 commit c3ea8da

File tree

1 file changed

+32
-0
lines changed
  • src/connections/sources/catalog/libraries/website/javascript

1 file changed

+32
-0
lines changed

src/connections/sources/catalog/libraries/website/javascript/index.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -919,6 +919,38 @@ Bundle the destinations you want loaded from [npm](https://www.npmjs.com/package
919919
}),
920920
```
921921

922+
## Segment Inspector
923+
The Segment Inspector is a Chrome web extension that enables you to debug your Segment integration on web applications instrumented with Analytics.js 2.0. Analytics.js sends data to the extension so that you can see how events change before they're sent to your destinations and so that you can verify that the event details are correct. The Segment Inspector also lets you analyze and confirm that API calls made from your website arrive to your Analytics.js 2.0 source.
924+
925+
> info ""
926+
> For the Segment inspector to work, you must enable the Analytics.js 2.0 source.
927+
928+
To add the Segment Inspector as a Chrome extension:
929+
1. Go to the [Chrome web store](https://chrome.google.com/webstore/category/extensions){:target="_blank”}.
930+
2. Search for **Segment Inspector**.
931+
3. Click **Add to Chrome**.
932+
4. Click **Add Extension** in the pop-up window.
933+
934+
Once installed, use the Inspect Elements developer tool in Chrome to use the Segment Inspector. To access the Inspector, go to the top menu bar of Chrome and navigate to **View > Developer > Developer Tools** and go to the **Segment** tab. On the Segment tab, you can:
935+
- Filter the different calls by type
936+
- Search based off of the content in the calls
937+
- Identify users
938+
939+
### Components of the Segment Inspector
940+
The Segment Inspector is composed of these three components:
941+
1. The **Diagnostics** tab
942+
- This tab shows the library versions and the list of active integrations that are running.
943+
- When you select an integration, you can see the options that passed while the integration loads. If you made any local overrides within the integration or on the page itself, they appear highlighted in the code.
944+
2. The **Events** tab
945+
- This tab enables you to select an event and see the specific details of the event. You can view the time the event occurred, the status of the event (whether it sent or failed), what plugins were added, and how the context object changed. Any changes made to the payload appear highlighted.
946+
- Select the double-checked icon to see the payload at the delivery stage.
947+
- Select the *fx* icon to see the payloads after plugins ran.
948+
- Select the single-checked icon to see the payload as it was when the event triggered.
949+
3. The **Identity** tab
950+
- This tab enables you to see the information of a user if you're using the `identify` feature. You can associate the data to an individual and measure their activity across multiple sessions and devices. This tab only shows the user's traits that are on the client.
951+
- If you're not using the `identify` feature, the user remains anonymous.
952+
953+
922954
## Open source libraries
923955

924956
Analytics.js 2.0 includes the following open source components:

0 commit comments

Comments
 (0)