diff --git a/docs/cloud/managing-airbyte-cloud/assets/cloud-status-page.png b/docs/cloud/managing-airbyte-cloud/assets/cloud-status-page.png new file mode 100644 index 0000000000000..1db868a9bf28f Binary files /dev/null and b/docs/cloud/managing-airbyte-cloud/assets/cloud-status-page.png differ diff --git a/docs/cloud/managing-airbyte-cloud/assets/cloud-timeline-page.png b/docs/cloud/managing-airbyte-cloud/assets/cloud-timeline-page.png new file mode 100644 index 0000000000000..5bd09a47d4c2b Binary files /dev/null and b/docs/cloud/managing-airbyte-cloud/assets/cloud-timeline-page.png differ diff --git a/docs/cloud/managing-airbyte-cloud/assets/connection-status-page.png b/docs/cloud/managing-airbyte-cloud/assets/connection-status-page.png deleted file mode 100644 index 4b78e3db30a61..0000000000000 Binary files a/docs/cloud/managing-airbyte-cloud/assets/connection-status-page.png and /dev/null differ diff --git a/docs/cloud/managing-airbyte-cloud/review-connection-status.md b/docs/cloud/managing-airbyte-cloud/review-connection-status.md index feb33f1bcfc85..e220f7370ace1 100644 --- a/docs/cloud/managing-airbyte-cloud/review-connection-status.md +++ b/docs/cloud/managing-airbyte-cloud/review-connection-status.md @@ -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. diff --git a/docs/cloud/managing-airbyte-cloud/review-sync-history.md b/docs/cloud/managing-airbyte-cloud/review-connection-timeline.md similarity index 59% rename from docs/cloud/managing-airbyte-cloud/review-sync-history.md rename to docs/cloud/managing-airbyte-cloud/review-connection-timeline.md index fec7102217630..57f338172c76d 100644 --- a/docs/cloud/managing-airbyte-cloud/review-sync-history.md +++ b/docs/cloud/managing-airbyte-cloud/review-connection-timeline.md @@ -2,27 +2,36 @@ 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 +- Connector Version changes (coming soon) +- Schema changes (coming soon) +- Connection configuration changes (coming soon) -![Job History](./assets/connection-job-history.png) +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. -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: +![Timeline](./assets/cloud-timeline-page.png) + +## Sync, Refresh, and Clear events + +Completed Syncs, [Refreshes](/operator-guides/refreshes), and [Clears](/operator-guides/clear) will have a status associated to the event. | Status | Description | | ------------------- | ----------------------------------------------------------------- | | Succeeded | 100% of the data has been extracted and loaded to the destination | -| Partially Succeeded | A subset of the data has been loaded to the destination | -| Failed | None of the data has been loaded to the destination | -| Cancelled | The sync was cancelled manually before finishing | +| Incomplete | The sync encountered an error, and should resolve itself. A subset or none of the data has been loaded to the destination. | +| 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. | +| Cancelled | The sync was cancelled manually before finishing. | | 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 +Airbyte will also separately record when a sync has been manually started by a user. -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 | | ------------------------------ | ------------------------------------------------------------- | @@ -31,7 +40,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. diff --git a/docs/using-airbyte/getting-started/assets/getting-started-connection-complete.png b/docs/using-airbyte/getting-started/assets/getting-started-connection-complete.png index f034a559f0263..56423d06263ef 100644 Binary files a/docs/using-airbyte/getting-started/assets/getting-started-connection-complete.png and b/docs/using-airbyte/getting-started/assets/getting-started-connection-complete.png differ diff --git a/docs/using-airbyte/getting-started/set-up-a-connection.md b/docs/using-airbyte/getting-started/set-up-a-connection.md index ed93bee22b8a7..e05076a86d315 100644 --- a/docs/using-airbyte/getting-started/set-up-a-connection.md +++ b/docs/using-airbyte/getting-started/set-up-a-connection.md @@ -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: diff --git a/docusaurus/redirects.yml b/docusaurus/redirects.yml index ba392ee43bd88..064626acbb5db 100644 --- a/docusaurus/redirects.yml +++ b/docusaurus/redirects.yml @@ -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 diff --git a/docusaurus/sidebars.js b/docusaurus/sidebars.js index 9452f04261fe7..d7effa151c125 100644 --- a/docusaurus/sidebars.js +++ b/docusaurus/sidebars.js @@ -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",