Skip to content

Testing and debugging edits #7921

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Sep 9, 2025
Merged

Testing and debugging edits #7921

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e85e54e
initial edits to testing and debugging
rchinn1 Sep 9, 2025
69fe19f
preview [netlify-build]
rchinn1 Sep 9, 2025
9c45503
more edits
rchinn1 Sep 9, 2025
52f66a5
quick fix
rchinn1 Sep 9, 2025
f05d85f
Apply suggestions from code review
rchinn1 Sep 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 20 additions & 28 deletions src/getting-started/06-testing-debugging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,25 @@ For monitoring purposes, you'll also see alerts in the [Workspace Health](/docs/

{% include components/reference-button.html href="https://university.segment.com/series/segment-101/debugging-and-troubleshooting?reg=1&referrer=docs" icon="media/academy.svg" title="Segment University: Debugging and Troubleshooting" description="Want more? Check out our course on debugging and troubleshooting. (Must be logged in to access.)" %}


## The Source Debugger

<!-- Source: https://segment.com/docs/connections/sources/debugger/ -->

The Source Debugger is a real-time tool that helps you confirm that API calls made from your website, mobile app, or servers arrive to your Segment Source, so you can troubleshoot your Segment set up even quicker. With the Debugger, you can check that you're sending calls in the expected format, without having to wait for any data processing.
The Source Debugger is a real-time tool that confirms whether API calls made from your website, mobile app, or servers reach a Segment source, so you can troubleshoot your Segment set up even quicker. With the Debugger, you can check that you're sending calls in the expected format, without having to wait for any data processing.

![Debugger view](/docs/connections/sources/images/debugger_view.png)

The Debugger is separate from your workspace's data pipeline and is not an exhaustive view of all the events ever sent to your Segment workspace. The Debugger only shows a sample of the events that the Source receives in real time, with a cap of 500 events. The Debugger is a great way to test specific parts of your implementation to validate that events are being fired successfully and arriving to your Source.
The Debugger is separate from your workspace's data pipeline and is not an exhaustive view of all the events ever sent to your Segment workspace. The Debugger only shows a sample of the events that the source receives in real time, with a cap of 500 events. The Debugger is a great way to test specific parts of your implementation to validate that events are being fired successfully and arriving to your source.

To see a more complete view of all your events, we recommend that you set up either a [warehouse](/docs/connections/storage/warehouses/) or an [S3 destination](/docs/connections/storage/catalog/amazon-s3/).

The Debugger shows a live stream of sampled events arriving into the Source, but you can also pause the stream from displaying new events by toggling "Live" to "Pause". Events continue to arrive to your Source while you Pause the stream.
The Debugger shows a live stream of sampled events arriving into the source, but you can also pause the stream from displaying new events by toggling **Live** to **Pause**. Events continue to arrive to your source while you pause the stream.

You can search in the Debugger to find a specific payload using any information you know is available in the event's raw payload. You can also use advanced search options to limit the results to a specific event.

![Debugger search options](/docs/connections/sources/images/debugger_search.png)

Two views are available when viewing a payload:
When you open an event, two payload views are available:

* The **Pretty view** is a recreation of the API call you made that was sent to Segment.
* The **Raw view** is the complete JSON object Segment received from the calls you sent. These calls include all the details about what is being tracked: timestamps, properties, traits, ids, and [contextual information Segment automatically collects](/docs/connections/spec/common/#context-fields-automatically-collected) the moment the data is sent.
Expand All @@ -48,12 +47,12 @@ Here is an example of what the Event Delivery tool looks like:
![Event Delivery tool example](/docs/connections/images/edelivery_jXaoBuF6.png)


Event Delivery is most useful when: 
Event Delivery is most useful: 

- **When data seems to be missing in your destination.**
For example, you have Google Analytics set up as a destination and your recent data looks incomplete
For example, you have Google Analytics set up as a destination and your recent data looks incomplete.
- **When setting up a destination for the first time.** 
For example, you are connecting Google Analytics to your Node Source. Once you've entered your credentials and turned the destination on, you can use this feature to see whether events are successfully making it to GA in near realtime. 
For example, you are connecting Google Analytics to your Node source. Once you've entered your credentials and turned the destination on, you can use this feature to see whether events are successfully making it to GA in near realtime. 

You can access the Event Delivery tool from the destination **Settings** tab in any supported destination.

Expand All @@ -67,19 +66,19 @@ You can access the Event Delivery tool from the destination **Settings** tab in

The UI shows three parts that report on Segment's ability to deliver your source data: Key Metrics, Error Details, and Delivery Trends.

**Before you begin,** select a time period from the drop down menu at the right. The Event Delivery display updates to show only information about your selected time period.
Before you begin, select a time period from the drop-down menu. The Event Delivery display updates to show only data for that period.

![Select a time period from the dropdown menu](/docs/connections/images/edelivery_Qs4r85sc.png)

#### Key metrics

This panel displays quantitative information about the destination's data flow:

- **Delivered:** The number of messages Segment successfully delivered to the destination in the selected time period.
- **Delivered**: The number of messages Segment successfully delivered to the destination in the selected time period.

- **Not Delivered:** The number of messages Segment was unable to deliver. If this number is greater than zero, the reasons for these failures appear in the errors table below. 
- **Not Delivered**: The number of messages Segment was unable to deliver. If this number is greater than zero, the reasons for failure will appear in the [Error details table](#error-details). 

- **P95 Latency:** The time it takes for Segment to deliver the slowest 5% of your data (known as P95 latency). The latency reported is end-to-end: from the event being received through the Segment API, to the event being delivered to partner API. This helps tell you if there is a delay in your data pipeline, and how severe it is.
- **P95 Latency**: The time it takes for Segment to deliver the slowest 5% of your data (known as P95 latency). The latency reported is end-to-end: from the event being received through the Segment API, to the event being delivered to partner API. This helps tell you if there is a delay in your data pipeline, and how severe it is.

#### Error details

Expand All @@ -94,29 +93,22 @@ The Error Details view gives you as much information as possible to help you res

This view includes: 

- **Description**
The event delivery UI provides a human-friendly summary of the error, based on the payload Segment received back from the partner.
- **Actions**
These are actions you can take, based on what Segment knows about the issue. 
- **More Info**
Links to any documentation that might be helpful to you. 
- **Sample payloads**
To help you debug, Segment provides sample payloads from every step of the data's journey:
- **You Sent** - the data you sent to Segment's API.

- **Request to Destination** - the request Segment made to the Partner API. This payload will likely be different from what you sent it because Segment is mapping your event to the partner's spec to ensure the message is successfully delivered. 
- **Description**: The event delivery UI provides a human-friendly summary of the error, based on the payload Segment received back from the partner.
- **Actions**: These are actions you can take, based on what Segment knows about the issue. 
- **More Info**: Links to any documentation that might be helpful to you. 
- **Sample payloads**: To help you debug, Segment provides sample payloads from every step of the data's journey.
- **You Sent**: The data you sent to Segment's API.
- **Request to Destination**: The request Segment made to the Partner API. This payload will likely be different from what you sent it because Segment is mapping your event to the partner's spec to ensure the message is successfully delivered. 
- **Response from Destination**: The response Segment received from the Partner API. This will have the raw partner error. If you need to troubleshoot an issue with a Partner's Success team, this is usually something they'll want to see. 

- **Response from Destination** - the response Segment received from the Partner API. This will have the raw partner error. If you need to troubleshoot an issue with a Partner's Success team, this is usually something they'll want to see. 

View Segment's list of [Integration Error Codes](/docs/connections/integration_error_codes/) for more information about what might cause an error.
View Segment's list of [Integration Error Codes](/docs/connections/integration_error_codes/) for more details.

### Trends

When debugging, it's helpful to see when issues start, stop and how they trend over time. 
When debugging, it's helpful to see when issues start, stop, and how they trend over time. 

The Event Delivery view shows a graph with the following information:
- **Delivered**: The number of events that were successfully delivered in the time period you selected. 

- **Not delivered**: The number of events that were not successfully delivered in the time period you selected. 

The Latency view shows the end-to-end P95 latency during the time period you selected.
Expand Down