Skip to content

Commit c49935a

Browse files
authored
Merge pull request #461 from segmentio/repo-sync
repo sync
2 parents e062c5c + bd9bd60 commit c49935a

File tree

7 files changed

+70
-59
lines changed

7 files changed

+70
-59
lines changed

.github/styles/Vocab/Docs/accept.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Amberflo
2222
Appboy
2323
Appsflyer
2424
async
25+
background(?:ed|ing)
2526
Blitzllama
2627
blocklist
2728
boolean
@@ -100,4 +101,5 @@ viewability
100101
waitlist
101102
WebKit
102103
Wootric
104+
Xcode
103105
Zendesk

src/connections/destinations/catalog/mixpanel/index.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,18 @@ If you want to track the `page` or `screen` calls to Mixpanel with the name or c
4747
> info ""
4848
> Beginning with "Consolidate Page" calls, the following options are each *mutually exclusive*. [See the code for details](https://github.com/segmentio/analytics.js-integrations/blob/master/integrations/mixpanel/lib/index.js#L96-L139){:target="_blank"}.
4949
50+
### Prioritization of settings
5051

52+
When you use the Mixpanel destination in Cloud-mode, Segment sends events for each option you select. This may result in Mixpanel receiving duplicate events for a single page call.
5153

52-
If you select "Track all Pages to Mixpanel", all `page` calls regardless of how you have customized it will send a `Loaded A Page`. Even if you have the other options enabled, Segment sends this call to prevent double counting your pageviews.
54+
When you use the Mixpanel destination in Device-mode, Segment prioritizes the options to prevent duplicate calls as follows:
5355

54-
If you select "Track Categorized Pages to Mixpanel", Segment sends a `Viewed [category] Page` event.
5556

56-
If you select "Track Named Pages to Mixpanel", Segment sends a `Viewed [name] Page` event.
57+
- If you select "Track all Pages to Mixpanel", all `page` calls regardless of how you have customized it will send a `Loaded A Page`. Even if you have the other options enabled, Segment sends this call to prevent double counting your pageviews.
58+
59+
- If you select "Track Categorized Pages to Mixpanel", Segment sends a `Viewed [category] Page` event.
60+
61+
- If you select "Track Named Pages to Mixpanel", Segment sends a `Viewed [name] Page` event.
5762

5863
> info ""
5964
> If both Option 2 and 3 are enabled, Segment gives precedence to `category`. If you pass both `category` and `name`, (for example, `analytics.page('category', 'name');`), Segment sends a `Viewed category name Page` to Mixpanel.
@@ -339,9 +344,6 @@ Segment doesn't map `$library_version` since that is reserved for Mixpanel's lib
339344

340345
## Features
341346

342-
### Autotrack
343-
344-
Mixpanel discontinued the Autotrack feature in February 2021. The feature is no longer available for use.
345347

346348
### People
347349

@@ -584,7 +586,7 @@ You can check a specific user profile in Mixpanel for Computed Traits by going t
584586

585587
Computed traits without a lookback window search across all historical events, and update in real time.
586588

587-
Computed traits with a lookback window only search across events that occurred within the specified timeframe. Computed traits *with* a lookback window are updated hourly.
589+
Computed traits with a lookback window only search across events that occurred within the specified time frame. Computed traits *with* a lookback window are updated hourly.
588590

589591
![](images/pers-03-lookback.png)
590592

@@ -624,7 +626,7 @@ You can check a specific user profile in Mixpanel for audience events by going t
624626

625627
Audiences without a lookback window searches across all historical events and update in real time.
626628

627-
Audiences with a lookback window only search across events that occurred within the specified timeframe. Audiences *with* a lookback window are updated hourly.
629+
Audiences with a lookback window only search across events that occurred within the specified time frame. Audiences *with* a lookback window are updated hourly.
628630

629631

630632
![](images/pers-10-lookback.png)

src/connections/event-delivery.md

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@ The Event Delivery tool helps you understand if data is reaching your destinatio
66

77
Segment sends billions of events to destinations every week. If Segment encounters any errors when attempting to deliver your data, Segment reports them in the Event Delivery tool.
88

9-
Here is an example of what the Event Delivery tool looks like:
9+
Here's an example of what the Event Delivery tool looks like:
1010

11-
![](images/edelivery_jXaoBuF6.png)
11+
![An Event Delivery example](images/edelivery_jXaoBuF6.png)
1212

1313
## When to use Event Delivery
1414

1515
Scenarios when this tool will be useful: 
1616

1717
- **When data seems to be missing in your destination.**
18-
For example, you have Google Analytics set up as a destination and your recent data looks incomplete
18+
For example, you have Google Analytics set up as a destination and your recent data looks incomplete.
1919
- **When setting up a destination for the first time.** 
2020
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. 
2121

@@ -27,32 +27,32 @@ Scenarios when this tool will be useful: 
2727
This feature is only available for server side integrations (also known as cloud-mode destinations). You will not be able to use this for client side / device-mode destinations as device-mode data is sent directly to the tool's API. To be report on deliverability, the data must be sent to Destinations using Segment's APIs. 
2828

2929
> warning ""
30-
> **Not available for Warehouses or Amazon S3**. These destinations work differently to our other destinations, and aren't supported at this time.
30+
> **Not available for Warehouses or Amazon S3**. These destinations work differently from other destinations in Segment, and aren't supported at this time.
3131
3232

3333
## Where do I find it? 
3434

3535
Event Delivery can be accessed within any supported destination in the App. It's located on the tab under "Settings" for each destination. 
3636

37-
![](images/find-edelivery.png)
37+
![Where you can find Event Delivery in the app](images/find-edelivery.png)
3838

3939

4040
## How do I use Event Delivery?
4141

42-
The UI consists of 3 key parts that report on Segment's ability to deliver your source data - Key Metrics, Error Details and Delivery Trends. Reporting on core functionality from top to bottom: 
42+
The UI consists of three key parts that report on Segment's ability to deliver your source data - Key Metrics, Error Details, and Delivery Trends. Reporting on core functionality from top to bottom: 
4343

4444
## 1. Time period
4545

4646

47-
There is a drop down menu to select your time period. All of the UI is updated based on the time period you select. 
47+
There's a drop down menu to select your time period. All of the UI is updated based on the time period you select. 
4848

49-
![](images/edelivery_Qs4r85sc.png)
49+
![Select a time period](images/edelivery_Qs4r85sc.png)
5050

5151
## 2. Key Metrics
5252

5353
From left to right in the above graphic:
5454

55-
- **Delivered:** This tells you the number of messages Segment successfully delivered to a destination in the time period you selected
55+
- **Delivered:** This tells you the number of messages Segment successfully delivered to a destination in the time period you selected.
5656

5757
- **Not Delivered:** This count tells you the number of messages Segment was unable to deliver. If this number is higher than zero, you will see the reasons for this failure in the errors table below. 
5858

@@ -63,45 +63,48 @@ From left to right in the above graphic:
6363

6464
The purpose of the table is to provide you a summary of the different errors we've seen in a given period and the most important information on them. All of the rows in the table are clickable and expand to give you more information. 
6565

66-
![](images/edelivery_V6hldpCl.png)
66+
![View error details](images/edelivery_V6hldpCl.png)
67+
68+
> info ""
69+
> View Segment's list of [Integration Error Codes](/docs/connections/integration_error_codes/) for more information about what might cause an error.
6770
6871
### Error detail view
6972

70-
When we see an error, we want to give you as much information to help you solve your problem. See below for an example of what this view looks like. 
73+
When there's an error, Segment wants to give you as much information as possible to help you resolve the issue. See below for an example of what this view looks like. 
7174

72-
![](images/edelivery_CgNb4wVN.png)
75+
![An example of the error details view](images/edelivery_CgNb4wVN.png)
7376

7477
This view includes: 
7578

7679
#### Description
7780

78-
The event delivery UI provides a human-friendly summary of the error, based on the payload we received back from the partner
81+
The event delivery UI provides a human-friendly summary of the error, based on the payload Segment received back from the partner.
7982

8083
#### Actions
8184

82-
These are actions we think you can take to solve the issue, based on what we know about the issue. 
85+
These are actions you can take, based on what Segment knows about the issue. 
8386

8487
#### More Info
8588

86-
Links to any documentation that we think could be helpful to you 
89+
This section displays links to any documentation that might be helpful to you. 
8790

8891

8992
#### Sample payloads
9093

91-
To help you debug we provide sample payloads from every step of the data's journey through Segment
94+
To help you debug, Segment provides sample payloads from every step of the data's journey:
9295

93-
- **You Sent** - the data you sent to Segment's API
96+
- **You Sent** - the data you sent to Segment's API.
9497

95-
- **Request to Destination** - the request we 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. 
98+
- **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. 
9699

97-
- **Response from Destination** - the response we 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. 
100+
- **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. 
98101

99102

100103
## 4. Trends
101104

102-
When debugging, it's helpful to see when issues start, stop and trend over time. 
105+
When debugging, it's helpful to see when issues start, stop, and trend over time. 
103106

104-
![](images/edelivery_9FRFTAso.png)
107+
![Event Delivery trends](images/edelivery_9FRFTAso.png)
105108

106109
#### Event Delivery
107110

src/connections/functions/destination-functions.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ All functions are scoped to your workspace, so members of other workspaces can't
1717

1818

1919
> note ""
20-
> Destination functions does not accept data from [Object Cloud sources](/docs/connections/sources/#object-cloud-sources).
20+
> Destination functions doesn't accept data from [Object Cloud sources](/docs/connections/sources/#object-cloud-sources).
2121
2222
## Create a destination function
2323

@@ -35,9 +35,9 @@ When you click **Build**, a code editor appears. Use the editor to write the cod
3535
Segment invokes a separate part of the function (called a "handler") for each event type that you send to your destination function.
3636

3737
> info ""
38-
> Your function is not invoked for an event if you've configured a [destination filter](/docs/connections/destinations/destination-filters/), and the event doesn't pass the filter.
38+
> Your function isn't invoked for an event if you've configured a [destination filter](/docs/connections/destinations/destination-filters/), and the event doesn't pass the filter.
3939
40-
The default source code template includes handlers for all event types. You do not need to implement all of them - just use the ones you need, and skip the ones you don't.
40+
The default source code template includes handlers for all event types. You don't need to implement all of them - just use the ones you need, and skip the ones you don't.
4141

4242
Destination functions can define handlers for each message type in the [Segment spec](/docs/connections/spec/):
4343

@@ -129,7 +129,7 @@ async function onTrack(event) {
129129
}
130130

131131
```
132-
If you do not supply a function for an event type, Segment throws an `EventNotSupported` error by default.
132+
If you don't supply a function for an event type, Segment throws an `EventNotSupported` error by default.
133133

134134
You can read more about [error handling](#destination-functions-logs-and-errors) below.
135135

@@ -271,15 +271,15 @@ async function onIdentifyBatch(events, settings) {
271271

272272
### Configure your batch parameters
273273

274-
By default, Functions waits up to 10 seconds to form a batch of 20 events. You can increase the number of events included in each batch (up to 400 events per batch) by contacting [Segment support](https://segment.com/help/contact/){:target="_blank"}. Segment recommends users who wish to include fewer than 20 events per batch use destination functions without the `onBatch` handler.
274+
By default, Functions waits up to 10 seconds to form a batch of 20 events. You can increase the number of events included in each batch (up to 400 events per batch) by contacting [Segment support](https://segment.com/help/contact/){:target="_blank"}. Segment recommends users who wish to include fewer than 20 events per batch use destination functions without the `onBatch` handler.
275275

276276
### Test the batch handler
277277

278-
The [Functions editing environment](/docs/connections/functions/environment/) supports testing batch handlers.
278+
The [Functions editing environment](/docs/connections/functions/environment/) supports testing batch handlers.
279279

280-
To test the batch handler:
281-
1. In the right panel of the Functions editor, click **customize the event yourself** to enter Manual Mode.
282-
2. Add events as a JSON array, with one event per element.
280+
To test the batch handler:
281+
1. In the right panel of the Functions editor, click **customize the event yourself** to enter Manual Mode.
282+
2. Add events as a JSON array, with one event per element.
283283
3. Click **Run** to preview the batch handler with the specified events.
284284

285285
> note ""
@@ -291,7 +291,7 @@ The [Config API](/docs/config-api/) Functions/Preview endpoint also supports tes
291291

292292
### Handling batching errors
293293

294-
Standard [function error types](/docs/connections/functions/destination-functions/#destination-functions-error-types) apply to batch handlers. Segment attempts to retry the batch in the case of Timeout or Retry errors. For all other error types, Segment discards the batch. It is also possible to report a partial failure by returning status of each event in the batch. Segment retries only the failed events in a batch until those events are successful or until they result in a permanent error.
294+
Standard [function error types](/docs/connections/functions/destination-functions/#destination-functions-error-types) apply to batch handlers. Segment attempts to retry the batch in the case of Timeout or Retry errors. For all other error types, Segment discards the batch. It's also possible to report a partial failure by returning status of each event in the batch. Segment retries only the failed events in a batch until those events are successful or until they result in a permanent error.
295295

296296
```json
297297
[
@@ -357,6 +357,8 @@ A function can throw errors, or Segment might encounter errors while invoking yo
357357

358358
Segment only attempts to send the event to your destination function again if a **Retry** error occurs.
359359

360+
You can view Segment's list of [Integration Error Codes](/docs/connections/integration_error_codes/) for more information about what might cause an error.
361+
360362
### Destination functions logs
361363

362364
If your function throws an error, execution halts immediately. Segment captures the event, any outgoing requests/responses, any logs the function might have printed, as well as the error itself.
@@ -470,6 +472,6 @@ The [Event Delivery tab](/docs/connections/event-delivery/) continues to show me
470472

471473
##### How does batching impact function use and cost?
472474

473-
A function's use depends on the number of times it is invoked, and the amount of time it takes to execute. When you enable batching, Segment invokes your function _once per batch_ rather than once per event. The volume of events flowing through the function determines the number of batches, which determines the number of invocations.
475+
A function's use depends on the number of times it's invoked, and the amount of time it takes to execute. When you enable batching, Segment invokes your function _once per batch_ rather than once per event. The volume of events flowing through the function determines the number of batches, which determines the number of invocations.
474476

475477
If you're sending your batch to an external service, the execution time of the function depends on the end-to-end latency of that service's batch endpoint, which may be higher than an endpoint that receives a single event.

src/connections/integration_error_codes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ id: integrationerrors
1313
| errors.awaiting-retry.429 | Rate limit exceeded. contact the partner to raise your limit or avoid sending events in burst. |
1414
| errors.awaiting-retry.5xx | The partner's API report an internal error. Consider disabling this integration or contact the integration partner to address this issue. |
1515
| errors.awaiting-retry.ENOTFOUND<br>errors.awaiting-retry.ECONNREFUSED <br>errors.awaiting-retry.ECONNRESET<br>errors.awaiting-retry.ECONNABORTED<br>errors.awaiting-retry.EHOSTUNREACH<br>errors.awaiting-retry.EAI_AGAIN | Segment is unable to establish a connection with the partner's server. This could mean your Segment configurations contain some invalid settings or that the integration is no longer operational. If your configurations are valid, consider disabling this integration or contact the integration partner to address this issue. |
16-
| Others | Refer to the error message you receive for more information. Refer to our <a href="/docs/connections/test-connections/"> How do I test my connections guide</a> for more debugging help.
16+
| Others | Refer to the error message you receive for more information. See the article, [Testing Connections](/docs/connections/test-connections/) for more debugging help.

0 commit comments

Comments
 (0)