From eae925ea1121ee7a3b0c5fbc9060810ee53c3d98 Mon Sep 17 00:00:00 2001 From: Phillip Jones Date: Wed, 25 Sep 2024 14:09:52 -0700 Subject: [PATCH] Updates to event notifications docs (#17035) * Updated event notifications docs. Removed beta label for event notifications. * Minor copy changes --- .../docs/r2/buckets/event-notifications.mdx | 50 +++++++++---------- .../docs/workers/wrangler/commands.mdx | 10 ---- 2 files changed, 25 insertions(+), 35 deletions(-) diff --git a/src/content/docs/r2/buckets/event-notifications.mdx b/src/content/docs/r2/buckets/event-notifications.mdx index 8dfe89545103f0..ae520e627efd47 100644 --- a/src/content/docs/r2/buckets/event-notifications.mdx +++ b/src/content/docs/r2/buckets/event-notifications.mdx @@ -5,12 +5,6 @@ pcx_content_type: how-to 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. -:::note[Open Beta] - -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). - -::: - ## Get started with event notifications ### Prerequisites @@ -21,13 +15,23 @@ Before getting started, you will need: - An existing queue. If you do not already have a queue, refer to [Create a queue](/queues/get-started/#3-create-a-queue). - A [consumer Worker](/queues/reference/how-queues-works/#create-a-consumer-worker) or [HTTP pull](/queues/configuration/pull-consumers/) enabled on your Queue. -### Set up Wrangler +### Enable event notifications via Dashboard + +1. From the Cloudflare dashboard, select **R2** from the sidebar. +2. Select the bucket you'd like to add an event notification rule to. +3. Switch to the **Settings** tab, then scroll down to the **Event notifications** card. +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. +5. Select **Add notification**. -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). +### Enable event notifications via Wrangler -### Enable event notifications on your R2 bucket +#### Set up Wrangler -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`. +To begin, install [`npm`](https://docs.npmjs.com/getting-started). Then [install Wrangler, the Developer Platform CLI](/workers/wrangler/install-and-update/). + +#### Enable event notifications on your R2 bucket + +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). ```sh npx wrangler r2 bucket notification create --event-type --queue @@ -48,6 +52,10 @@ $ npx wrangler r2 bucket notification create --event-type @@ -81,18 +89,15 @@ For a more complete step-by-step example, refer to the [Log and store upload eve object-delete - - Triggered when an object is explicitly removed from the bucket. -
-
- Note: During the beta, deletes that occur as a result of object - lifecycle policies will not trigger this event. - + Triggered when an object is explicitly removed from the bucket.
  • DeleteObject
    • +
  • + LifecycleDeletion +
@@ -224,12 +229,7 @@ Queue consumers receive notifications as [Messages](/queues/configuration/javasc -## Limitations - -During the beta, event notifications has the following limitations: +## Notes -- 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. -- For a given bucket, only one event notification rule can be created per queue. -- Each bucket can have up to 5 event notification rules. -- Deletes that occur as a result of object lifecycle policies will not trigger an event notification. -- Event notifications are not available for buckets with [jursdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions). +- Event notifications are not available for buckets with [jursdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions) (_coming soon_). +- 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. diff --git a/src/content/docs/workers/wrangler/commands.mdx b/src/content/docs/workers/wrangler/commands.mdx index cb4525b15166ed..dedfc0272eddff 100644 --- a/src/content/docs/workers/wrangler/commands.mdx +++ b/src/content/docs/workers/wrangler/commands.mdx @@ -939,11 +939,6 @@ wrangler r2 bucket list ### `notification create` -:::note - -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). -::: - Create an [event notification](/r2/buckets/event-notifications/) rule for an R2 bucket. ```txt @@ -989,11 +984,6 @@ wrangler r2 bucket notification list ### `sippy enable` -:::note - -Sippy is currently in beta. To report bugs or request features, fill out the [Cloudflare R2 incremental migration feedback form](https://forms.gle/7WuCsbu5LmWkQVu76). -::: - Enable [Sippy](/r2/data-migration/sippy/) incremental migration for a bucket. ```txt