Skip to content

Commit a1cd5b4

Browse files
Repeater migration doc (#1692)
* rip repater, your days are numbered * Update repeater-migration.md (#1697) I answered 2/3 TODOs; I'll find out the answer to the ConfigAPI data loss question on Monday. Thank you! * a few minor polishes * Change format to look better rendered * format Co-authored-by: Jennifer Skene <[email protected]>
1 parent 51b0a5a commit a1cd5b4

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: Migrating Repeater destinations to multi-instance Destinations
3+
hidden: true
4+
---
5+
6+
[Multi-instance destination capabilities](/docs/connections/destinations/add-destination#connecting-one-source-to-multiple-instances-of-a-destination) can replace the legacy Repeater destination, which was previously used to forward data from a single Segment source to multiple instances of a destination.
7+
Compared to using a Repeater, multi-instance destination configurations simplify setup, provide better observability into event delivery, and reduce event volume, which reduces your costs. However, it does not replace the Repeater in all situations. If you’re using a Repeater for data transformations or to filter Personas events, you will need to continue using the Repeater.
8+
9+
> success ""
10+
> Segment recommends that you test the migration process in a staging environment to check your changes, **before** you change any production configurations.
11+
12+
> warning ""
13+
> Before you begin, check that the Repeater destination you want to replace does not perform any data transformation, or filter Personas events. If a Repeater instance uses these, you cannot migrate to multi-instance, and must continue using Repeater.
14+
15+
16+
17+
## Step 1. Identify
18+
19+
**Identify the Repeater instances that you can replace by connecting new instances of a destination to a single source.**
20+
21+
To understand the function of a Repeater, go to its Settings page, and look at Write Keys. These tell you which sources it sends data to.
22+
23+
If the Repeater has filters, but does not filter out Personas events specifically, you can you can re-create these filters in the multi-instance configuration using [destination filters](/docs/connections/destinations/destination-filters/).
24+
25+
## Step 2. Create a replacement
26+
27+
**Create the new destination instances in your workspace and configure settings.**
28+
29+
1. **Settings:**
30+
When you first create a new destination instance, you can simplify the set up process by copying settings from an existing destination instance. Segment recommends that you use this feature when you migrate off Repeater, to minimize typos and missed configuration fields.
31+
2. **Authentication:**
32+
Enter the correct authentication information. Make sure it's for the correct destination instance!
33+
3. **Destination Filters:**
34+
Each destination instance can have unique destination filters. If you want the destination filters to be the same as the previous instance, you must configure them either using the Segment web app, or using the [Segment ConfigAPI](https://reference.segmentapis.com/#6c12fbe8-9f84-4a6c-848e-76a2325cb3c5).
35+
4. **Do not enable the destination instances yet**, as this will send duplicate data to your destinations.
36+
37+
## Step 3. Test
38+
39+
**Test that your new destination instances are configured correctly, and that data arrives in the expected way.**
40+
41+
You can create a QA instance of your destination to verify that it is configured correctly and is reporting data. Then create a production instance of the destination, and copy the settings from the QA instance. Be sure the authentication settings point to the production instance of your destination!
42+
43+
## Step 4. Disable the repeater
44+
45+
**Disable the repeater and enable the new destination instance.**
46+
47+
1. If you created a QA instance of the Repeater and you created a QA destination instance, you can test this process before you use production data.
48+
49+
50+
2. You can disable the repeater and enable the new destination instance manually in the Segment web app, or by using the [Segment Config API](/docs/config-api/).
51+
52+
- **If the destination can de-duplicate events**, enable the new instance of the destination, and _then_ disable the Repeater.
53+
- **If the destination does not de-duplicate events**, you can disable the Repeater and then enable the new instance of the destination.
54+
This could result in minor data loss during the few seconds between the Repeater being disabled and the new destination instance being enabled. You can use the Segment Config API [Update Destination endpoint](https://reference.segmentapis.com/#f25d9ac1-3e20-4635-8687-26ed4153086d) to disable and enable destinations quickly, which can minimize the time between these two actions. However, we cannot guarantee that no data will be lost.
55+
If your workspace is on the Business Tier, and the destination supports [Replay](/docs/guides/what-is-replay/), you can replay the data from that period into the new destination instance. Replays are available for any destinations which support cloud-mode data (meaning data routed through Segment) and which also process timestamps. Contact your CSM for more information about replays. If the destination does not de-duplicate events and replays are not available, you can manually delete duplicate events in the destination.

0 commit comments

Comments
 (0)