Skip to content

Commit 2c846b0

Browse files
authored
Merge pull request #7921 from segmentio/testing-and-debugging
Testing and debugging edits
2 parents abef42d + f05d85f commit 2c846b0

File tree

1 file changed

+20
-28
lines changed

1 file changed

+20
-28
lines changed

src/getting-started/06-testing-debugging.md

Lines changed: 20 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,25 @@ For monitoring purposes, you'll also see alerts in the [Workspace Health](/docs/
1010

1111
{% 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.)" %}
1212

13-
1413
## The Source Debugger
1514

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

18-
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.
17+
The Source Debugger is a real-time tool that confirms that 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.
1918

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

22-
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.
21+
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.
2322

2423
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/).
2524

26-
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.
25+
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.
2726

2827
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.
2928

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

32-
Two views are available when viewing a payload:
31+
When you open an event, two payload views are available:
3332

3433
* The **Pretty view** is a recreation of the API call you made that was sent to Segment.
3534
* 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.
@@ -48,12 +47,12 @@ Here is an example of what the Event Delivery tool looks like:
4847
![Event Delivery tool example](/docs/connections/images/edelivery_jXaoBuF6.png)
4948

5049

51-
Event Delivery is most useful when
50+
Event Delivery is most useful: 
5251

5352
- **When data seems to be missing in your destination.**
54-
For example, you have Google Analytics set up as a destination and your recent data looks incomplete
53+
For example, you have Google Analytics set up as a destination and your recent data looks incomplete.
5554
- **When setting up a destination for the first time.** 
56-
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. 
55+
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. 
5756

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

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

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

70-
**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.
69+
Before you begin, select a time period from the drop-down menu. The Event Delivery display updates to show only data for that period.
7170

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

7473
#### Key metrics
7574

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

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

80-
- **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
79+
- **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)
8180

82-
- **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.
81+
- **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.
8382

8483
#### Error details
8584

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

9594
This view includes: 
9695

97-
- **Description**
98-
The event delivery UI provides a human-friendly summary of the error, based on the payload Segment received back from the partner.
99-
- **Actions**
100-
These are actions you can take, based on what Segment knows about the issue. 
101-
- **More Info**
102-
Links to any documentation that might be helpful to you. 
103-
- **Sample payloads**
104-
To help you debug, Segment provides sample payloads from every step of the data's journey:
105-
- **You Sent** - the data you sent to Segment's API.
106-
107-
- **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. 
96+
- **Description**: The event delivery UI provides a human-friendly summary of the error, based on the payload Segment received back from the partner.
97+
- **Actions**: These are actions you can take, based on what Segment knows about the issue. 
98+
- **More Info**: Links to any documentation that might be helpful to you. 
99+
- **Sample payloads**: To help you debug, Segment provides sample payloads from every step of the data's journey.
100+
- **You Sent**: The data you sent to Segment's API.
101+
- **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. 
102+
- **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. 
108103

109-
- **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. 
110-
111-
View Segment's list of [Integration Error Codes](/docs/connections/integration_error_codes/) for more information about what might cause an error.
104+
View Segment's list of [Integration Error Codes](/docs/connections/integration_error_codes/) for more details.
112105

113106
### Trends
114107

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

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

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

0 commit comments

Comments
 (0)