Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Sync Log Summary Doc #15181

Merged
merged 8 commits into from
Aug 3, 2022
Merged

Sync Log Summary Doc #15181

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
618728b
edited table
sophia-wiley Jul 27, 2022
f7e477c
added the sync log doc section
sophia-wiley Aug 1, 2022
27ea270
edited formatting
sophia-wiley Aug 1, 2022
26336ea
Edited table
sophia-wiley Aug 2, 2022
f85b827
Edited formatting
sophia-wiley Aug 2, 2022
29b6cc9
Edited line spacing
sophia-wiley Aug 2, 2022
a3f15eb
Ediiting spacing
sophia-wiley Aug 2, 2022
e8bd8b0
Edited line spacing
sophia-wiley Aug 2, 2022
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
89 changes: 82 additions & 7 deletions docs/cloud/managing-airbyte-cloud.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,23 +28,29 @@ To add a user to your workspace:
To switch between workspaces:

1. On the Airbyte Cloud dashboard, click the current workspace name under the Airbyte logo in the left-hand navigation bar.

2. Click **View all workspaces**.

3. Click the name of the workspace you want to switch to.

### Rename a workspace

To rename a workspace:

1. On the Airbyte Cloud dashboard, click **Settings** in the left-hand navigation bar.
1. On the Airbyte Cloud dashboard, click **Settings** in the left-hand navigation bar.

2. In the Workspace Settings sidebar, click **General Settings**.

3. In the Workspace name field, enter the new name for your workspace. Click **Save**.

### Delete a workspace

To delete a workspace:

1. On the Airbyte Cloud dashboard, click **Settings** in the left-hand navigation bar.
1. On the Airbyte Cloud dashboard, click **Settings** in the left-hand navigation bar.

2. In the Workspace Settings sidebar, click **General Settings**.

3. Click **Delete your workspace**.

## Single Workspace vs. Multiple Workspaces
Expand All @@ -58,19 +64,23 @@ You can use one or multiple workspaces with Airbyte Cloud.
| 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. |

### Billing
| Number of Workspaces | Benefits | Considerations |
|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 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). |
| 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. |
| Number of Workspaces | Benefits | Considerations |
|----------------------|-------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
| 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). |
| 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. |

## Manage Airbyte Cloud notifications

To set up Slack notifications:

1. On the Airbyte Cloud dashboard, click **Settings** in the left-hand navigation bar.
1. On the Airbyte Cloud dashboard, click **Settings** in the left-hand navigation bar.

2. In the Workspace Settings sidebar, click **Notifications.**

3. [Create an Incoming Webhook for Slack](https://api.slack.com/messaging/webhooks).

4. Navigate back to the Airbyte Cloud dashboard > Settings > Notifications and enter the Webhook URL. Click **Save changes**.

5. Toggle the **Send notifications when sync fails** and **Send notifications when sync succeeds** buttons as required.

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

## View the Sync Log Summary
The sync log summary shows if a sync succeeded, failed, cancelled, or is currently running.

To view the sync log summary:
1. On the [Airbyte Cloud](http://cloud.airbyte.io/) dashboard, click **Connections**.

The Connections page displays.

2. Click a connection in the list to view its sync history.

3. Under Sync History, a list of syncs for that connection is displayed.

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

4. For more information about a sync, click the sync log dropdown.

## Sync Log Summary
### Succeeded
The log summary for a successful sync shows the following data.

| Log | Description |
|--------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
| 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. |
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Amruta-Ranade, do you think I should change "x GB (also measured in KB, MB)" to something like "x KB, x MB, or x GB"?

Copy link
Contributor

Choose a reason for hiding this comment

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

Nah I think it's fine as is :)

| x emitted records | Number of records read from the source during the sync. |
| x committed records | Number of records the destination confirmed it received. |
| xh xm xs | Total time (hours, minutes, seconds) for the sync and basic normalization, if enabled, to complete. |
| Sync or Reset | The action that was performed (either a sync or a [reset](https://docs.airbyte.com/operator-guides/reset/)). |

:::note

In a successful sync, the number of emitted records and committed records should be the same.

:::

### Cancelled
The log summary for a cancelled sync may show the following data.

| Log | Description |
|----------------|-------------------------------------------------------------------------------------------------|
| NaN Bytes | Since the sync was cancelled, the log does not show how much data was moved before cancelling. |
| No records | Since the sync was cancelled, the log does not show emitted or committed records. |
| xh xm xs | Total time (hours, minutes, seconds) between the beginning of sync and when it was cancelled. |
| Sync or Reset | The action that was performed (either a sync or a reset). |
| Failure Origin | The cause of the sync cancellation. |

:::note

Airbyte will try to sync your data three times. After a third failure, it will stop attempting to sync.

:::

### Failed
The log summary for a failed sync may show the following data.

| Log | Description |
|----------------|---------------------------------------------------------------------------------------------|
| NaN Bytes | Since the sync failed, the amount of data is zero. |
| No records | Since the sync failed, there are no emitted or committed records. |
| xh xm xs | Total time (hours, minutes, seconds) between the beginning of the sync and when it failed. |
| Sync or Reset | The action that was performed (either a sync or a reset). |
| Failure Origin | The cause of the sync failure. |

### Running
The sync log summary displays **Running** when the sync is actively running.

## Buy Credits

This section guides you through purchasing credits on Airbyte Cloud. An Airbyte [credit](https://docs.airbyte.com/cloud/core-concepts/#credits) is a unit of measure used to pay for Airbyte resources when you run a sync. See [Pricing](https://airbyte.com/pricing) for more information.
Expand Down