Skip to content

Commit 9341441

Browse files
jonesphillippatriciasantaana
authored andcommitted
Updates to event notifications docs (#17035)
* Updated event notifications docs. Removed beta label for event notifications. * Minor copy changes
1 parent f57dec7 commit 9341441

File tree

2 files changed

+25
-35
lines changed

2 files changed

+25
-35
lines changed

src/content/docs/r2/buckets/event-notifications.mdx

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,6 @@ pcx_content_type: how-to
55

66
Event notifications send messages to your [queue](/queues/) when data in your R2 bucket changes. You can consume these messages with a [consumer Worker](/queues/reference/how-queues-works/#create-a-consumer-worker) or [pull over HTTP](/queues/configuration/pull-consumers/) from outside of Cloudflare Workers.
77

8-
:::note[Open Beta]
9-
10-
The event notifications feature is currently in open beta. To report bugs or request features, go to the #r2-storage channel in the [Cloudflare Developer Discord](https://discord.cloudflare.com) or fill out the [feedback form](https://forms.gle/2HBKD9zG9PFiU4v79).
11-
12-
:::
13-
148
## Get started with event notifications
159

1610
### Prerequisites
@@ -21,13 +15,23 @@ Before getting started, you will need:
2115
- An existing queue. If you do not already have a queue, refer to [Create a queue](/queues/get-started/#3-create-a-queue).
2216
- A [consumer Worker](/queues/reference/how-queues-works/#create-a-consumer-worker) or [HTTP pull](/queues/configuration/pull-consumers/) enabled on your Queue.
2317

24-
### Set up Wrangler
18+
### Enable event notifications via Dashboard
19+
20+
1. From the Cloudflare dashboard, select **R2** from the sidebar.
21+
2. Select the bucket you'd like to add an event notification rule to.
22+
3. Switch to the **Settings** tab, then scroll down to the **Event notifications** card.
23+
4. Select **Add notification** and choose the queue you'd like to receive notifications and the [type of events](/r2/buckets/event-notifications/#event-types) that will trigger them.
24+
5. Select **Add notification**.
2525

26-
To begin, refer to [Install/Update Wrangler](/workers/wrangler/install-and-update/#install-wrangler) to install Wrangler, the Cloudflare Developer Platform CLI. Log into Wrangler with the [`wrangler login` command](/workers/wrangler/commands/#login).
26+
### Enable event notifications via Wrangler
2727

28-
### Enable event notifications on your R2 bucket
28+
#### Set up Wrangler
2929

30-
To enable event notifications, add an event notification rule to your bucket by running the [`r2 bucket notification create` command](/workers/wrangler/commands/#notification-create). Event notification rules determine the [event types](/r2/buckets/event-notifications/#event-types) that trigger notifications and enable filtering based on object `prefix` and `suffix`.
30+
To begin, install [`npm`](https://docs.npmjs.com/getting-started). Then [install Wrangler, the Developer Platform CLI](/workers/wrangler/install-and-update/).
31+
32+
#### Enable event notifications on your R2 bucket
33+
34+
Log in to Wrangler with the [`wrangler login` command](/workers/wrangler/commands/#login). Then add an [event notification rule](/r2/buckets/event-notifications/#event-notification-rules) to your bucket by running the [`r2 bucket notification create` command](/workers/wrangler/commands/#notification-create).
3135

3236
```sh
3337
npx wrangler r2 bucket notification create <BUCKET_NAME> --event-type <EVENT_TYPE> --queue <QUEUE_NAME>
@@ -48,6 +52,10 @@ $ npx wrangler r2 bucket notification create <BUCKET_NAME> --event-type <EVENT_T
4852

4953
For a more complete step-by-step example, refer to the [Log and store upload events in R2 with event notifications](/r2/examples/upload-logs-event-notifications/) example.
5054

55+
## Event notification rules
56+
57+
Event notification rules determine the [event types](/r2/buckets/event-notifications/#event-types) that trigger notifications and optionally enable filtering based on object `prefix` and `suffix`. You can have up to 100 event notification rules per R2 bucket.
58+
5159
## Event types
5260

5361
<table>
@@ -81,18 +89,15 @@ For a more complete step-by-step example, refer to the [Log and store upload eve
8189
<td>
8290
<code>object-delete</code>
8391
</td>
84-
<td>
85-
Triggered when an object is explicitly removed from the bucket.
86-
<br />
87-
<br />
88-
<b>Note</b>: During the beta, deletes that occur as a result of object
89-
lifecycle policies will not trigger this event.
90-
</td>
92+
<td>Triggered when an object is explicitly removed from the bucket.</td>
9193
<td>
9294
<ul>
9395
<li>
9496
<code>DeleteObject</code>
9597
</li>
98+
<li>
99+
<code>LifecycleDeletion</code>
100+
</li>
96101
</ul>
97102
</td>
98103
</tr>
@@ -224,12 +229,7 @@ Queue consumers receive notifications as [Messages](/queues/configuration/javasc
224229
</tbody>
225230
</table>
226231

227-
## Limitations
228-
229-
During the beta, event notifications has the following limitations:
232+
## Notes
230233

231-
- Queues [per-queue message throughput](/queues/platform/limits/) is currently 400 messages per second. If your workload produces more than 400 notifications per second, messages may be dropped.
232-
- For a given bucket, only one event notification rule can be created per queue.
233-
- Each bucket can have up to 5 event notification rules.
234-
- Deletes that occur as a result of object lifecycle policies will not trigger an event notification.
235-
- Event notifications are not available for buckets with [jursdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions).
234+
- Event notifications are not available for buckets with [jursdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions) (_coming soon_).
235+
- Queues [per-queue message throughput](/queues/platform/limits/) is currently 5,000 messages per second. If your workload produces more than 5,000 notifications per second, we recommend splitting notification rules across multiple queues.

src/content/docs/workers/wrangler/commands.mdx

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -938,11 +938,6 @@ wrangler r2 bucket list
938938

939939
### `notification create`
940940

941-
:::note
942-
943-
Event notifications is currently in beta. To report bugs or request features, fill out the [Cloudflare R2 event notification feedback form](https://forms.gle/2HBKD9zG9PFiU4v79).
944-
:::
945-
946941
Create an [event notification](/r2/buckets/event-notifications/) rule for an R2 bucket.
947942

948943
```txt
@@ -988,11 +983,6 @@ wrangler r2 bucket notification list <NAME>
988983

989984
### `sippy enable`
990985

991-
:::note
992-
993-
Sippy is currently in beta. To report bugs or request features, fill out the [Cloudflare R2 incremental migration feedback form](https://forms.gle/7WuCsbu5LmWkQVu76).
994-
:::
995-
996986
Enable [Sippy](/r2/data-migration/sippy/) incremental migration for a bucket.
997987

998988
```txt

0 commit comments

Comments
 (0)