Skip to content

Commit e9ad0f8

Browse files
committed
DOC-359 Adding initial draft of sync health + history doc
1 parent a0de1d4 commit e9ad0f8

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: Data Lakes Sync History and Sync Health
3+
---
4+
{% include content/plan-grid.md name="data-lakes" %}
5+
6+
Segment generates reports about each sync to your data lake so you can monitor sync performance. The sync health page provides information about trends in volume synced to your data lake over the last 30 days and the sync history provides detailed information about the syncs preformed on the data lake over the last two days. The sync data for both reports updates in real time.
7+
8+
> info ""
9+
> This feature is currently in Public Beta. Segment’s [First-Access and Beta terms](https://segment.com/legal/first-access-beta-preview/) govern the use of this feature.
10+
11+
## Sync history
12+
The Sync History table shows detailed information about the most recent syncs to the data lake. The sync history table includes the following fields:
13+
* **Sync status:** The status of the sync: either 'Success,' where all rows synced correctly, 'Partial Success,' indicating some rows synced correctly, or 'Failed,' were no rows synced correctly
14+
* **Start time:** The time the sync began
15+
* **Duration:** How long the sync took to complete
16+
* **Synced rows:** The number of rows that were synced with the data lake
17+
* **Notices:** Any notes about the sync: if no data is synced, the notices column will read "No data found"
18+
19+
<!--- add screenshot here showing the sync history page --->
20+
21+
Selecting a row in the Sync history table opens a tab with more information about the results of the sync and a detailed breakdown of sync duration.
22+
23+
<!--- need to update the procedure for accessing the sync history/sync health pages --->
24+
25+
To access the Sync history page, open the **My Destinations** page and select the data lake.
26+
27+
## Sync health
28+
The Sync Health bar chart provides an overview of the volume of rows that synced to your data lake each day for the last 30 days.
29+
30+
Selecting a bar from the bar chart opens the Daily Row Volume table, which provides a breakdown of which collections synced, how many rows from each collection were synced, and the percentage of all synced rows that each collection of properties represents.
31+
32+
<!--- add screenshot here/need to update the procedure for accessing the sync history/sync health pages --->
33+
34+
## Data Lakes Reports FAQ
35+
36+
##### What is the maximum sync history you can view?
37+
The sync history shows the last 30 days worth of data.
38+
39+
##### How do Sync History and Sync Health compare?
40+
The Sync History feature shows detailed information about most recent syncs to a data lake (spanning approximately two days,) while the sync health tab shows just the volume synced to the data lake over the last thirty days.
41+
42+
##### How can I select which collections and properties are synced with the data lake?
43+
You can select what collections and properties are synced with the data lake by updating the settings on the data lakes destination page.
44+
45+
To access the settings page, select the Data Lakes destination from the My Destinations page. On the Warehouse Overview page, in the schema table, select the data lake you'd like to update. On the Sync History page, select the Settings tab. In the table, select the connections and properties you'd like to sync to the data lake.
46+

0 commit comments

Comments
 (0)