Skip to content

Commit e2526ff

Browse files
sophia-wileysophia-wiley
authored
Sync Log Summary Doc (#15181)
* edited table * added the sync log doc section * edited formatting * Edited table * Edited formatting * Edited line spacing * Ediiting spacing * Edited line spacing
1 parent c05b3f0 commit e2526ff

File tree

1 file changed

+82
-7
lines changed

1 file changed

+82
-7
lines changed

‎docs/cloud/managing-airbyte-cloud.md

Lines changed: 82 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,23 +28,29 @@ To add a user to your workspace:
2828
To switch between workspaces:
2929

3030
1. On the Airbyte Cloud dashboard, click the current workspace name under the Airbyte logo in the left-hand navigation bar.
31+
3132
2. Click **View all workspaces**.
33+
3234
3. Click the name of the workspace you want to switch to.
3335

3436
### Rename a workspace
3537

3638
To rename a workspace:
3739

38-
1. On the Airbyte Cloud dashboard, click **Settings** in the left-hand navigation bar.
40+
1. On the Airbyte Cloud dashboard, click **Settings** in the left-hand navigation bar.
41+
3942
2. In the Workspace Settings sidebar, click **General Settings**.
43+
4044
3. In the Workspace name field, enter the new name for your workspace. Click **Save**.
4145

4246
### Delete a workspace
4347

4448
To delete a workspace:
4549

46-
1. On the Airbyte Cloud dashboard, click **Settings** in the left-hand navigation bar.
50+
1. On the Airbyte Cloud dashboard, click **Settings** in the left-hand navigation bar.
51+
4752
2. In the Workspace Settings sidebar, click **General Settings**.
53+
4854
3. Click **Delete your workspace**.
4955

5056
## Single Workspace vs. Multiple Workspaces
@@ -58,19 +64,23 @@ You can use one or multiple workspaces with Airbyte Cloud.
5864
| Multiple | You can create multiple workspaces to allow certain users to access the data. | Since you have to manage user access for each workspace individually, it can get complicated if you have many users in multiple workspaces. |
5965

6066
### Billing
61-
| Number of Workspaces | Benefits | Considerations |
62-
|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
63-
| Single | You can use the same payment method for all purchases. | Credits pay for the use of resources in a workspace when you run a sync. Resource usage cannot be divided and paid for separately (for example, you cannot bill different departments in your organization for the usage of some credits in one workspace). |
64-
| Multiple | Workspaces are independent of each other, so you can use a different payment method card for each workspace (for example, different credit cards per department in your organization). | You can use the same payment method for different workspaces, but each workspace is billed separately. Managing billing for each workspace can become complicated if you have many workspaces. |
67+
| Number of Workspaces | Benefits | Considerations |
68+
|----------------------|-------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
69+
| Single | You can use the same payment method for all purchases. | Credits pay for the use of resources in a workspace when you run a sync. Resource usage cannot be divided and paid for separately (for example, you cannot bill different departments in your organization for the usage of some credits in one workspace). |
70+
| Multiple | Workspaces are independent of each other, so you can use a different payment method card for each workspace (for example, different credit cards per department in your organization). | You can use the same payment method for different workspaces, but each workspace is billed separately. Managing billing for each workspace can become complicated if you have many workspaces. |
6571

6672
## Manage Airbyte Cloud notifications
6773

6874
To set up Slack notifications:
6975

70-
1. On the Airbyte Cloud dashboard, click **Settings** in the left-hand navigation bar.
76+
1. On the Airbyte Cloud dashboard, click **Settings** in the left-hand navigation bar.
77+
7178
2. In the Workspace Settings sidebar, click **Notifications.**
79+
7280
3. [Create an Incoming Webhook for Slack](https://api.slack.com/messaging/webhooks).
81+
7382
4. Navigate back to the Airbyte Cloud dashboard > Settings > Notifications and enter the Webhook URL. Click **Save changes**.
83+
7484
5. Toggle the **Send notifications when sync fails** and **Send notifications when sync succeeds** buttons as required.
7585

7686
## Understand Airbyte Cloud limits
@@ -87,6 +97,71 @@ Understanding the following limitations will help you better manage Airbyte Clou
8797
* Shortest sync schedule: Every 60 min
8898
* Schedule accuracy: +/- 30 min
8999

100+
## View the Sync Log Summary
101+
The sync log summary shows if a sync succeeded, failed, cancelled, or is currently running.
102+
103+
To view the sync log summary:
104+
1. On the [Airbyte Cloud](http://cloud.airbyte.io/) dashboard, click **Connections**.
105+
106+
The Connections page displays.
107+
108+
2. Click a connection in the list to view its sync history.
109+
110+
3. Under Sync History, a list of syncs for that connection is displayed.
111+
112+
The sync status is displayed (Succeeded, Cancelled, Failed, or Running) along with the [summary of the sync log](<https://docs.airbyte.com/cloud/managing-airbyte-cloud#sync-log-summary>).
113+
114+
4. For more information about a sync, click the sync log dropdown.
115+
116+
## Sync Log Summary
117+
### Succeeded
118+
The log summary for a successful sync shows the following data.
119+
120+
| Log | Description |
121+
|--------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
122+
| x GB (also measured in KB, MB) | Amount of data moved during the sync. If basic normalization is on, the amount of data would not change since normalization occurs in the destination. |
123+
| x emitted records | Number of records read from the source during the sync. |
124+
| x committed records | Number of records the destination confirmed it received. |
125+
| xh xm xs | Total time (hours, minutes, seconds) for the sync and basic normalization, if enabled, to complete. |
126+
| Sync or Reset | The action that was performed (either a sync or a [reset](https://docs.airbyte.com/operator-guides/reset/)). |
127+
128+
:::note
129+
130+
In a successful sync, the number of emitted records and committed records should be the same.
131+
132+
:::
133+
134+
### Cancelled
135+
The log summary for a cancelled sync may show the following data.
136+
137+
| Log | Description |
138+
|----------------|-------------------------------------------------------------------------------------------------|
139+
| NaN Bytes | Since the sync was cancelled, the log does not show how much data was moved before cancelling. |
140+
| No records | Since the sync was cancelled, the log does not show emitted or committed records. |
141+
| xh xm xs | Total time (hours, minutes, seconds) between the beginning of sync and when it was cancelled. |
142+
| Sync or Reset | The action that was performed (either a sync or a reset). |
143+
| Failure Origin | The cause of the sync cancellation. |
144+
145+
:::note
146+
147+
Airbyte will try to sync your data three times. After a third failure, it will stop attempting to sync.
148+
149+
:::
150+
151+
### Failed
152+
The log summary for a failed sync may show the following data.
153+
154+
| Log | Description |
155+
|----------------|---------------------------------------------------------------------------------------------|
156+
| NaN Bytes | Since the sync failed, the amount of data is zero. |
157+
| No records | Since the sync failed, there are no emitted or committed records. |
158+
| xh xm xs | Total time (hours, minutes, seconds) between the beginning of the sync and when it failed. |
159+
| Sync or Reset | The action that was performed (either a sync or a reset). |
160+
| Failure Origin | The cause of the sync failure. |
161+
162+
### Running
163+
The sync log summary displays **Running** when the sync is actively running.
164+
90165
## Buy Credits
91166

92167
This section guides you through purchasing credits on Airbyte Cloud. An Airbyte [credit](https://airbyte.com/pricing) is a unit of measure used to pay for Airbyte resources when you run a sync.

0 commit comments

Comments
 (0)