Skip to content

Commit 6a63ffa

Browse files
authored
docs: Connection Timeline (#43339)
1 parent 9611495 commit 6a63ffa

9 files changed

+26
-15
lines changed
Loading
Loading
Binary file not shown.

docs/cloud/managing-airbyte-cloud/review-connection-status.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ products: all
66

77
Each connection you've set up in your Workspace has a **Status** page that displays the connection's current status, timing of the next scheduled sync, and a summary of historic sync trends. Reviewing this page allows you to monitor the health of your connection.
88

9-
![Connection Status](./assets/connection-status-page.png)
9+
![Connection Status](./assets/cloud-status-page.png)
1010

1111
:::note
1212
The Streams status and Records loaded graphs are available in Airbyte Cloud and Airbyte Enterprise.

docs/cloud/managing-airbyte-cloud/review-sync-history.md docs/cloud/managing-airbyte-cloud/review-connection-timeline.md

+20-11
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,36 @@
22
products: all
33
---
44

5-
# Review the sync history
5+
# Review the connection timeline
66

7-
The job history displays information about synced data, such as the amount of data moved, the number of records read and committed, and the total sync time. Reviewing this summary can help you monitor the sync performance and identify any potential issues.
7+
The Connection Timeline displays information about several types of relevant connection events. The following events are included in the Connection Timeline:
8+
- Sync
9+
- Refresh
10+
- Clear
11+
- Connector Version changes (coming soon)
12+
- Schema changes (coming soon)
13+
- Connection configuration changes (coming soon)
814

9-
![Job History](./assets/connection-job-history.png)
15+
To review the Connection Timeline, click a connection in the list and navigate to the "Timeline" tab to view its event history. The page displays recent events and their statuses. Where relevant, the event will also show the user who took the action.
1016

11-
To review the sync history, click a connection in the list and navigate to the "Job History" tab to view its sync history. The page displays recent syncs and their statuses. The sync status is defined as:
17+
![Timeline](./assets/cloud-timeline-page.png)
18+
19+
## Sync, Refresh, and Clear events
20+
21+
Completed Syncs, [Refreshes](/operator-guides/refreshes), and [Clears](/operator-guides/clear) will have a status associated to the event.
1222

1323
| Status | Description |
1424
| ------------------- | ----------------------------------------------------------------- |
1525
| Succeeded | 100% of the data has been extracted and loaded to the destination |
16-
| Partially Succeeded | A subset of the data has been loaded to the destination |
17-
| Failed | None of the data has been loaded to the destination |
18-
| Cancelled | The sync was cancelled manually before finishing |
26+
| Incomplete | The sync encountered an error, and should resolve itself. A subset or none of the data has been loaded to the destination. |
27+
| Failed | The sync encountered a fatal error, and needs user intervention to resolve. A subset or none of the data has been loaded to the destination. |
28+
| Cancelled | The sync was cancelled manually before finishing. |
1929
| Running | The sync is currently running |
2030

21-
If you have recently run a [refresh](/operator-guides/refreshes) or [clear](/operator-guides/clear), you will also see this noted on the Job History page and their corresponding status.
2231

23-
## Sync summary
32+
Airbyte will also separately record when a sync has been manually started by a user.
2433

25-
Each sync shows the time the sync was initiated and additional metadata. This information can help in understanding sync performance over time.
34+
For sync and refresh events, Airbyte also shows the volume of synced data, such as the amount of data moved, the number of records read and committed, and the total sync time. Reviewing this timeline can help you monitor the connection and identify any potential issues.
2635

2736
| Data | Description |
2837
| ------------------------------ | ------------------------------------------------------------- |
@@ -31,7 +40,7 @@ Each sync shows the time the sync was initiated and additional metadata. This in
3140
| x loaded records | Number of records the destination confirmed it received. |
3241
| xh xm xs | Total time (hours, minutes, seconds) for the sync to complete |
3342

34-
While most syncs only contain a single attempt, a sync can sometimes fail. In the event of a failure, Airbyte will make several attempts to sync your data before waiting for the next sync to retry. You can read more about our retry approach [here](../../understanding-airbyte/jobs.md#retry-rules).
43+
While most syncs only contain a single attempt, a sync can sometimes fail. In the event of a failure, Airbyte will make several attempts to sync your data before waiting for the next sync to retry. You can read more about our retry approach [here](../../understanding-airbyte/jobs.md#retry-rules). If multiple attempts are used in a sync, you can open the logs to see individual logs from each attempt.
3544

3645
Airbyte summarizes metrics in the sync summary across all the attempts in the sync. As a result, you may observe that the number of records extracted is higher than the number of records loaded if an attempt fails during the extraction process. A successful sync status means that all the records from the source have been successfully written to the destination.
3746

Loading

docs/using-airbyte/getting-started/set-up-a-connection.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Once you've set up all the connection settings, click "Set up connection". You'v
4242

4343
Once you've finished setting up the connection, you will be automatically redirected to a connection overview containing all the tools you need to keep track of your connection.
4444

45-
![Connection dashboard](./assets/getting-started-status-page.png)
45+
![Connection dashboard](./assets/getting-started-connection-complete.png)
4646

4747
Here's a basic overview of the tabs and their use:
4848

docusaurus/redirects.yml

+3-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@
2626
- from: /cloud/dbt-cloud-integration
2727
to: /cloud/managing-airbyte-cloud/dbt-cloud-integration
2828
- from: /cloud/managing-airbyte-cloud/review-sync-summary
29-
to: /cloud/managing-airbyte-cloud/review-sync-history
29+
to: /cloud/managing-airbyte-cloud/review-connection-timeline
30+
- from: /cloud/managing-airbyte-cloud/review-sync-history
31+
to: /cloud/managing-airbyte-cloud/review-connection-timeline
3032
- from: /cloud/managing-airbyte-cloud/review-connection-state
3133
to: /cloud/managing-airbyte-cloud/manage-connection-state
3234
- from: /cloud/managing-airbyte-cloud/edit-stream-configuration

docusaurus/sidebars.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -528,7 +528,7 @@ module.exports = {
528528
label: "Managing Syncs",
529529
items: [
530530
"cloud/managing-airbyte-cloud/review-connection-status",
531-
"cloud/managing-airbyte-cloud/review-sync-history",
531+
"cloud/managing-airbyte-cloud/review-connection-timeline",
532532
"operator-guides/browsing-output-logs",
533533
"operator-guides/clear",
534534
"operator-guides/refreshes",

0 commit comments

Comments
 (0)