Skip to content

docs: Connection Timeline #43339

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 7, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ products: all

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.

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

:::note
The Streams status and Records loaded graphs are available in Airbyte Cloud and Airbyte Enterprise.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,23 @@
products: all
---

# Review the sync history
# Review the Connection Timeline

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.
The Connection Timeline displays information about several types of relevant connection events. The following events are included in the Connection Timeline:
- Sync
- Refresh
- Clear
- Version changes
- Schema changes
- Connection configuration changes

![Job History](./assets/connection-job-history.png)
![Timeline](./assets/cloud-timeline-page.png)

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:
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.

## Sync, Refresh, and Clear events

Syncs, [Refreshes](/operator-guides/refreshes), and [Clears](/operator-guides/clear) will have a status associated to the event.

| Status | Description |
| ------------------- | ----------------------------------------------------------------- |
Expand All @@ -18,11 +28,7 @@ To review the sync history, click a connection in the list and navigate to the "
| Cancelled | The sync was cancelled manually before finishing |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Are we gonna use "Partially Succeeded" or "Incompleted"?
  2. Not sure if we need to add "manually started" events here? But yeah.."started" is not a final status.
  3. And for Cancelled events, in the Description column do we need to let them know that we are also tracking and showing who manually cancelled/started the event?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense!

Updated to "Incomplete".
Added these two notes: "Airbyte will also separately record when a sync has been manually started by a user. " and "Where relevant, the event will also show the user who took the action."

| Running | The sync is currently running |

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.

## Sync summary

Each sync shows the time the sync was initiated and additional metadata. This information can help in understanding sync performance over time.
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.

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

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).
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.

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.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/using-airbyte/getting-started/set-up-a-connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Once you've set up all the connection settings, click "Set up connection". You'v

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.

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

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

Expand Down
4 changes: 3 additions & 1 deletion docusaurus/redirects.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@
- from: /cloud/dbt-cloud-integration
to: /cloud/managing-airbyte-cloud/dbt-cloud-integration
- from: /cloud/managing-airbyte-cloud/review-sync-summary
to: /cloud/managing-airbyte-cloud/review-sync-history
to: /cloud/managing-airbyte-cloud/review-connection-timeline
- from: /cloud/managing-airbyte-cloud/review-sync-history
to: /cloud/managing-airbyte-cloud/review-connection-timeline
- from: /cloud/managing-airbyte-cloud/review-connection-state
to: /cloud/managing-airbyte-cloud/manage-connection-state
- from: /cloud/managing-airbyte-cloud/edit-stream-configuration
Expand Down
2 changes: 1 addition & 1 deletion docusaurus/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -528,7 +528,7 @@ module.exports = {
label: "Managing Syncs",
items: [
"cloud/managing-airbyte-cloud/review-connection-status",
"cloud/managing-airbyte-cloud/review-sync-history",
"cloud/managing-airbyte-cloud/review-connection-timeline",
"operator-guides/browsing-output-logs",
"operator-guides/clear",
"operator-guides/refreshes",
Expand Down
Loading