diff --git a/docs/reference/notifications-events-filters.md b/docs/reference/notifications-events-filters.md index 0d20dd5978..5c07827aff 100644 --- a/docs/reference/notifications-events-filters.md +++ b/docs/reference/notifications-events-filters.md @@ -487,6 +487,33 @@ The following frequency options control how often the notification triggers: } ``` +## Platform events + +Platform events are account-level events that are not scoped to a single application instance, customer, release, or channel. + +### Egress Threshold Reached + +When monthly registry egress for the team reaches a configured threshold. + +The Egress Threshold Reached event evaluates the current calendar month's registry egress for the team. When the total reaches or exceeds the configured threshold, Replicated sends one notification for the subscription, threshold, and month. The notification can fire again in a later month, or if the threshold configuration is changed. + +#### Filters + +| Filter | JSON key | Required | Description | +|--------|----------|----------|-------------| +| Threshold (TiB) | `thresholdTiB` | **Yes** | Monthly registry egress threshold in tebibytes. Provide as a string, for example `"5"` or `"5.5"`. | + +#### JSON definition + +```json +{ + "eventType": "platform.egress_threshold_reached", + "filters": { + "thresholdTiB": "5" + } +} +``` + ## Release events ### Release Created diff --git a/docs/vendor/event-notifications-create.mdx b/docs/vendor/event-notifications-create.mdx index 2fc4ef77fc..e0e8028890 100644 --- a/docs/vendor/event-notifications-create.mdx +++ b/docs/vendor/event-notifications-create.mdx @@ -186,6 +186,15 @@ As a Release Engineer, I want alerts when an air gap bundle build fails on a tes - Filter - Channel: Select "Unstable", "Beta", or "Stable", depending on the channels you monitor - **Delivery Method:** Webhook to your team chat or email to your release engineering alias +### Operations manager: Registry egress threshold + +As an Operations Manager, I want alerts when monthly registry egress reaches an expected threshold. This helps me investigate usage changes before the billing period ends. + +- **Event Type:** Egress Threshold Reached +- **Configuration:** + - Filter - Threshold (TiB): Enter the monthly egress threshold, for example `5` +- **Delivery Method:** Email to your operations alias or webhook to your monitoring system + ### Development leader: Paid customer downloads release assets As a Development Leader, I want to be notified when a paid customer pulls release assets to initiate a paid install. diff --git a/docs/vendor/event-notifications.mdx b/docs/vendor/event-notifications.mdx index 4ad69ced4d..ab03db5cfe 100644 --- a/docs/vendor/event-notifications.mdx +++ b/docs/vendor/event-notifications.mdx @@ -19,7 +19,9 @@ This section describes the types of events and filters that are available for cr ### Supported event types -You can create notifications for various types of events, including events related to application instances, customers, support bundles, releases, and channels. For example, you can get a notification when an instance reaches a Ready state in the customer environment, when the customer uploads a new support bundle, or when a customer license is expiring soon. +You can create notifications for application instances, customers, support bundles, releases, channels, and platform-level usage. + +For example, you can get a notification when an instance reaches a Ready state. You can also get notifications for support bundle uploads, expiring customer licenses, or monthly registry egress thresholds. For the full list of available event types and event-specific filters, see [Event types and filters](/reference/notifications-events-filters). @@ -95,4 +97,3 @@ Event Notifications has the following limitations: - Notification events generated are not included in the [Instance Bulk Data Export API](instance-data-export) - It is possible to create a notification for some resource types, such as customers and support bundles, but not to access the notification linked asset due to your allowed user permissions. This is most likely to impact teams with [enterprise and custom RBAC policies](team-management-rbac-configuring). For example, someone with the [Sales RBAC role](team-management-rbac-configuring) can create a notification for a customer uploading a support bundle, but does not have permission to view the linked specific customer bundle due to their RBAC role permissions. - The Release Assets Downloaded event might fire per chart or image if the customer pulls each separately as part of your installation instructions. Because release assets might be shared across many of your release versions, the Vendor Portal records the event at the chart/image level and does not associate the event with a specific release version. If you find this alert too noisy, reach out to us to further discuss your specific use case. - diff --git a/docs/vendor/packaging-private-images.md b/docs/vendor/packaging-private-images.md index f112fc5e38..4877426ba1 100644 --- a/docs/vendor/packaging-private-images.md +++ b/docs/vendor/packaging-private-images.md @@ -308,6 +308,8 @@ To duplicate an existing external registry: You can view image pull activity for each of your external registries that are connected to the Replicated proxy registry. This includes a summary of recent pull activity as well as the full history of image pulls. +The **Image Registries** page also shows total registry egress for the current calendar month. You can use this value with the **Egress Threshold Reached** notification event to get alerted when monthly registry egress reaches a configured threshold. For more information, see [Event types and filters](/reference/notifications-events-filters#egress-threshold-reached). + You can also use the Replicated Vendor API `/v3/external_registry/logs` endpoint to get image pull activity. For more information, see [Get the logs for a specific external registry either by endpoint or slug, or both](https://replicated-vendor-api.readme.io/reference/externalregistrylogs) in the Vendor API documentation. * To view a summary of recent pull activity: In the **Vendor Portal**, go to **Image Registries > Available Image Registries > [Registry Name] > Recent Pull Activity**. @@ -363,4 +365,4 @@ You can also use the Replicated Vendor API `/v3/external_registry/logs` endpoint Was successful If the registry operation was successful - \ No newline at end of file +