Skip to content

Commit 46b977a

Browse files
[Docs] March 2024 Release Notes (#36871)
Co-authored-by: Natik Gadzhi <[email protected]>
1 parent 1e9ee1d commit 46b977a

15 files changed

+113
-128
lines changed
Loading
Loading
Loading
Loading
Loading
Loading
Loading

docs/cloud/managing-airbyte-cloud/manage-airbyte-cloud-notifications.md

+36-43
Original file line numberDiff line numberDiff line change
@@ -10,81 +10,74 @@ This page provides guidance on how to manage notifications for Airbyte, allowing
1010

1111
| Type of Notification | Description |
1212
|------------------------|---------------------------------------------------------------------------------------------------------------------|
13-
| Failed Syncs | A sync from any of your connections fails. Note that if sync runs frequently or if there are many syncs in the workspace these types of events can be noisy |
14-
| Successful Syncs | A sync from any of your connections succeeds. Note that if sync runs frequently or if there are many syncs in the workspace these types of events can be noisy
15-
| Automated Connection Updates | A connection is updated automatically (ex. a source schema is automatically updated) |
16-
| Connection Updates Requiring Action | A connection update requires you to take action (ex. a breaking schema change is detected) |
17-
| Warning - Repeated Failures | A connection will be disabled soon due to repeated failures. It has failed 50 times consecutively or there were only failed jobs in the past 7 days |
18-
| Sync Disabled - Repeated Failures | A connection was automatically disabled due to repeated failures. It will be disabled when it has failed 100 times consecutively or has been failing for 14 days in a row |
19-
| Warning - Upgrade Required (Cloud only) | A new connector version is available and requires manual upgrade |
20-
| Sync Disabled - Upgrade Required (Cloud only) | One or more connections were automatically disabled due to a connector upgrade deadline passing
13+
| **Failed Syncs** | A sync from any of your connections fails. Note that if sync runs frequently or if there are many syncs in the workspace these types of events can be noisy |
14+
| **Successful Syncs** | A sync from any of your connections succeeds. Note that if sync runs frequently or if there are many syncs in the workspace these types of events can be noisy
15+
| **Automated Connection Updates** | A connection is updated automatically (ex. a source schema is automatically updated) |
16+
| **Connection Updates Requiring Action** | A connection update requires you to take action (ex. a breaking schema change is detected) |
17+
| **Warning - Repeated Failures** | A connection will be disabled soon due to repeated failures. It has failed 50 times consecutively or there were only failed jobs in the past 7 days |
18+
| **Sync Disabled - Repeated Failures** | A connection was automatically disabled due to repeated failures. It will be disabled when it has failed 100 times consecutively or has been failing for 14 days in a row |
19+
| **Warning - Upgrade Required** (Cloud only) | A new connector version is available and requires manual upgrade |
20+
| **Sync Disabled - Upgrade Required** (Cloud only) | One or more connections were automatically disabled due to a connector upgrade deadline passing
21+
22+
### Enabling schema update notifications
23+
24+
To be notified of any source schema changes, make sure you have enabled `Automatic Connection Updates` and `Connection Updates Requiring Action` notifications. If these are off, even if you turned on schema update notifications in a connection's settings, Airbyte will *NOT* send out any notifications related to these types of events.
25+
26+
To edit this setting, click **Connections** and select the connection you want to receive notifications for. Click the **Settings** tab on the Connection page. In the **Advanced Settings**, toggle **Schema update notifications**.
27+
2128

2229
## Configure Email Notification Settings
2330

2431
<AppliesTo cloud />
2532

26-
To set up email notifications:
33+
To set up email notifications, click **Settings** and navigate to **Workspace** > **Notifications**.
2734

28-
1. In the Airbyte UI, click **Settings** and navigate to **Notifications**.
35+
Toggle which messages you'd like to receive from Airbyte. All email notifications will be sent by default to the creator of the workspace.
2936

30-
2. Toggle which messages you'd like to receive from Airbyte. All email notifications will be sent by default to the creator of the workspace. To change the recipient, edit and save the **notification email recipient**. If you would like to send email notifications to more than one recipient, you can enter an email distribution list (ie Google Group) as the recipient.
31-
32-
3. Click **Save changes**.
37+
![](./assets/notifications-email.png)
3338

3439
:::note
3540
All email notifications except for Successful Syncs are enabled by default.
3641
:::
3742

38-
## Configure Slack Notification settings
43+
### Modify the email recipient
44+
To change the recipient, edit and save the **notification email recipient**. If you would like to send email notifications to more than one recipient, you can enter an email distribution list (ie Google Group) as the recipient.
3945

40-
To set up Slack notifications:
46+
## Configure Slack Notification settings
4147

42-
If you're more of a visual learner, just head over to [this video](https://www.youtube.com/watch?v=NjYm8F-KiFc&ab_channel=Airbyte) to learn how to do this. You can also refer to the Slack documentation on how to [create an incoming webhook for Slack](https://api.slack.com/messaging/webhooks).
48+
If you're more of a visual learner, head over to [this video](https://www.youtube.com/watch?v=NjYm8F-KiFc&ab_channel=Airbyte) to learn how to do this. You can also refer to the Slack documentation on how to [create an incoming webhook for Slack](https://api.slack.com/messaging/webhooks).
4349

4450
### Create a Slack app
4551

46-
1. **Create a Slack App**: Navigate to https://api.slack.com/apps/. Select `Create an App`.
52+
1. To set up Slack notifications, navigate to https://api.slack.com/apps/. Select `Create an App`.
4753

48-
![](../../.gitbook/assets/notifications_create_slack_app.png)
54+
![](./assets/notification-slack-create-app.png)
4955

5056
2. Select `From Scratch`. Enter your App Name (e.g. Airbyte Sync Notifications) and pick your desired Slack workspace.
5157

52-
3. **Set up the webhook URL.**: in the left sidebar, click on `Incoming Webhooks`. Click the slider button in the top right to turn the feature on. Then click `Add New Webhook to Workspace`.
58+
3. **Enable Incoming Webhooks**: in the left sidebar, click on `Incoming Webhooks`. Click the slider button in the top right to turn the feature on. Then click `Add New Webhook to Workspace`.
5359

54-
![](../../.gitbook/assets/notifications_add_new_webhook.png)
60+
![](./assets/notification-slack-add-webhook.png)
5561

56-
4. Pick the channel that you want to receive Airbyte notifications in (ideally a dedicated one), and click `Allow` to give it permissions to access the channel. You should see the bot show up in the selected channel now. You will see an active webhook right above the `Add New Webhook to Workspace` button.
62+
4. Select the channel that you want to receive Airbyte notifications in (ideally a dedicated one), and click `Allow` to give it permissions to access the channel. You should see the bot show up in the selected channel now. You will see an active webhook right above the `Add New Webhook to Workspace` button.
5763

58-
![](../../.gitbook/assets/notifications_webhook_url.png)
64+
![](./assets/notification-slack-webhook-url-success.png)
5965

6066
5. Click `Copy.` to copy the link to your clipboard, which you will need to enter into Airbyte.
6167

62-
Your Webhook URL should look something like this:
63-
64-
![](../../.gitbook/assets/notifications_airbyte_notification_settings.png)
68+
Your Webhook URL should look similar to this:
6569

70+
```
71+
https://hooks.slack.com/services/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PM1
72+
```
6673

6774
### Enable the Slack notification in Airbyte
6875

69-
1. In the Airbyte UI, click **Settings** and navigate to **Notifications**.
70-
71-
2. Paste the copied webhook URL to `Webhook URL`. Using a Slack webook is recommended. On this page, you can toggle each slider decide whether you want notifications on each notification type.
72-
73-
3. **Test it out.**: you can click `Test` to send a test message to the channel. Or, just run a sync now and try it out! If all goes well, you should receive a notification in your selected channel that looks like this:
74-
75-
![](../../.gitbook/assets/notifications_slack_message.png)
76-
77-
You're done!
78-
79-
4. Click **Save changes**.
80-
81-
## Enable schema update notifications
76+
1. Click **Settings** and navigate to **Notifications**. On this page, you can toggle each slider decide whether you want notifications on each notification type. Paste the copied webhook URL to `Webhook URL`.
8277

83-
To be notified of any source schema changes:
84-
1. Make sure you have enabled `Automatic Connection Updates` and `Connection Updates Requiring Action` notifications. If these are off, even if you turned on schema update notifications in a connection's settings, Airbyte will *NOT* send out any notifications related to these types of events.
78+
3. **Test it out**: you can click `Test` to send a test message to the channel. Or, just run a sync now and try it out! For a successful sync, you should receive a notification that looks like this:
8579

86-
2. In the Airbyte UI, click **Connections** and select the connection you want to receive notifications for.
80+
![](./assets/notification-slack-success.png)
8781

88-
3. Click the **Settings** tab on the Connection page.
8982

90-
4. Toggle **Schema update notifications**.
83+
4. Click **Save changes** to ensure you continue to receive alerts about your Airbyte syncs.

docs/cloud/managing-airbyte-cloud/manage-credits.md

+6-10
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ Airbyte [credits](https://airbyte.com/pricing) are used to pay for Airbyte resou
88

99
## Buy credits
1010

11-
To purchase credits directly through the UI,
11+
1. To purchase credits directly through the UI, click **Billing** in the left-hand sidebar. The billing page displays the available credits, total credit usage, and the credit usage per connection.
1212

13-
1. Click **Billing** in the left-hand sidebar.
13+
:::tip
1414

15-
2. If you are unsure of how many credits you need, use our [Cost Estimator](https://www.airbyte.com/pricing) or click **Talk to Sales** to find the right amount for your team.
15+
If you are unsure of how many credits you need, use our [Cost Estimator](https://www.airbyte.com/pricing) or click **Talk to Sales** to find the right amount for your team.
1616

17-
3. Click **Buy credits**.
17+
:::
1818

19-
4. Determine the quantity of credits you intend to purchase. Adjust the **credit quantity**. When you're ready, click **Checkout**.
19+
2. Click **Buy credits**. Enter the quantity of credits you intend to purchase and adjust the **credit quantity** accordingly. When you're ready, click **Checkout**.
2020

2121
:::note
2222

@@ -30,11 +30,7 @@ To purchase credits directly through the UI,
3030

3131
5. You'll be renavigated to a Stripe payment page. If this is your first time purchasing, you'll be asked for payment details. After you enter your billing address, sales tax (if applicable) is calculated and added to the total.
3232

33-
6. Click **Pay**.
34-
35-
Your payment is processed. The Billing page displays the available credits, total credit usage, and the credit usage per connection.
36-
37-
A receipt for your purchase is sent to your email.
33+
6. Click **Pay** to process your payment. A receipt for your purchase is automatically sent to your email.
3834

3935
:::note
4036

docs/cloud/managing-airbyte-cloud/manage-data-residency.md

+2-18
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,7 @@ While the data is processed in a data plane of the chosen residency, the cursor
1818

1919
When you set the default data residency, it applies your preference to new connections only. If you do not adjust the default data residency, the [Airbyte Default](configuring-connections.md) region is used (United States). If you want to change the data residency for an individual connection, you can do so in its [connection settings](configuring-connections.md).
2020

21-
To choose your default data residency:
22-
23-
1. In the Airbyte UI, click **Settings**.
24-
25-
2. Click **Data Residency**.
26-
27-
3. Click the dropdown and choose the location for your default data residency.
28-
29-
4. Click **Save changes**.
21+
To choose your default data residency, click **Settings** in the Airbyte UI. Navigate to **Workspace** > **Data Residency**. Use the dropdown to choose the location for your default data residency and save your changes.
3022

3123
:::info
3224

@@ -37,15 +29,7 @@ Depending on your network configuration, you may need to add [IP addresses](/ope
3729
## Choose the data residency for a connection
3830
You can additionally choose the data residency for your connection in the connection settings. You can choose the data residency when creating a new connection, or you can set the default data residency for your workspace so that it applies for any new connections moving forward.
3931

40-
To choose a custom data residency for your connection:
41-
42-
1. In the Airbyte UI, click **Connections** and then click the connection that you want to change.
43-
44-
2. Click the **Settings** tab.
45-
46-
3. Click the **Data residency** dropdown and choose the location for your default data residency.
47-
48-
4. Click **Save changes**
32+
To choose a custom data residency for your connection, click **Connections** in the Airbyte UI and then select the connection that you want to configure. Navigate to the **Settings** tab, open the **Advanced Settings**, and select the **Data residency** for the connection.
4933

5034
:::note
5135

docs/release_notes/march_2024.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# March 2024
2+
## airbyte v0.51.0 to v0.56.0
3+
4+
This page includes new features and improvements to the Airbyte Cloud and Airbyte Open Source platforms.
5+
6+
## ✨ Highlights
7+
8+
Airbyte now supports **OpenID Connect (OIDC) SSO** for Airbyte Enterprise and Airbyte Cloud Teams. This enables companies to use Airbyte with Entra ID/AD via the OIDC protocol.
9+
10+
Airbyte certified our [Microsoft SQL Server source](/integrations/sources/mssql) to support terabyte-sized tables, expanded datetime data types, and reliability improvements.
11+
12+
Airbyte migrated our [Redshift destination](https://github.com/airbytehq/airbyte/pull/36255) to the [Destinations V2](./upgrading_to_destinations_v2) framework. This enables you to map tables one-to-one with your source, experience better error handling (particularly with large records), and deliver data incrementally.
13+
14+
15+
## Platform Releases
16+
17+
In addition to our OpenID Connect support, we also released:
18+
19+
- A major upgrade to our Docker and Helm deployments, which simplifies how external logs are configured. Learn more about the specific changes in our [migration guide](/deploying-airbyte/on-kubernetes-via-helm#migrate-from-old-chart-to-airbyte-v0520-and-latest-chart-version).
20+
21+
- A breaking change to Docker deployments. Containers no longer run as the `root` user. If you are upgrading from an older version, the `airbyte_workspace` docker volume must be recreated to fix the ownership of staging directories under `/tmp` (in the container). Alternatively, you can manually update the ownership (`airbyte:airbyte`) of the directory mount point /tmp/workspace in all containers where `airbyte_workspace` is mounted (see: `docker-compose.yaml`)
22+
23+
- Our major version upgrades (Airbyte Cloud only) now only require manual upgrading when you are actively syncing a stream that has changed. Otherwise, syncs will continue as is and the version will be upgraded automatically for you.
24+
25+
## Connector Improvements
26+
27+
In addition to our MS-SQL certification, we also released a few notable Connector improvements:
28+
29+
- We released several connector builder enhancements, including support for raw YAML blocks, modification the start date when testing, and added the ability to adjust page/slice/record limits. We also resolved bugs in page size and interpolation inputs, improved the switching time between YAML and UI, and fixed several layout issues.
30+
- Our [Bing source](https://github.com/airbytehq/airbyte/pull/35812) includes the following new streams: `Audience Performance Report`, `Goals And Funnels Report`, `Product Dimension Performance Report`
31+
- Our [JIRA source](https://github.com/airbytehq/airbyte/pull/35656) now contains more fields to the following streams: `board_issues`,`filter_sharing`,`filters`,`issues`, `permission_schemes`, `sprint_issues`,`users_groups_detailed` and `workflows`
32+
- Our [Snapchat Source](https://github.com/airbytehq/airbyte/pull/35660) now contains additional fields in the `ads`, `adsquads`, `creatives`, and `media` streams.

docs/using-airbyte/core-concepts/namespaces.md

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

77
Namespaces are used to generally organize data, separate tests and production data, and enforce permissions. In most cases, namespaces are schemas in the database you're replicating to.
88

9-
As a part of connection setup, you select where in the destination you want to write your data. Note: The default configuration is **Destination default**.
9+
As a part of connection setup, you select where in the destination you want to write your data. Note: The default configuration is **Destination-defined**.
1010

1111
| Destination Namespace | Description |
1212
| ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |

docs/using-airbyte/core-concepts/readme.md

+4
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,10 @@ For more details, see our [dbt integration documentation](/cloud/managing-airbyt
108108

109109
A workspace is a grouping of sources, destinations, connections, and other configurations. It lets you collaborate with team members and share resources across your team under a shared billing account.
110110

111+
## Organization
112+
113+
Organizations let you collaborate with team members and share workspaces across your team.
114+
111115
## Glossary of Terms
112116

113117
You can find a extended list of [Airbyte specific terms](https://glossary.airbyte.com/term/airbyte-glossary-of-terms/), [data engineering concepts](https://glossary.airbyte.com/term/data-engineering-concepts) or many [other data related terms](https://glossary.airbyte.com/).

0 commit comments

Comments
 (0)