-
Notifications
You must be signed in to change notification settings - Fork 10k
[Bots] bot detection alerts #21929
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.
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
Merged
Merged
[Bots] bot detection alerts #21929
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| --- | ||
| pcx_content_type: reference | ||
| title: Bot Detection Alerts | ||
| sidebar: | ||
| order: 4 | ||
|
|
||
| --- | ||
|
|
||
| import { AvailableNotifications } from "~/components" | ||
|
|
||
| Bot alerts inform you when Cloudflare detects spikes in your traffic with any of the following characteristics: | ||
|
|
||
| - A global spike in traffic that have a bot score of less than 30. | ||
| - An increase in traffic on available dimensions in [Custom Bot Detection Alerts](#custom-bot-detection-alerts). | ||
| - Filters of your choosing in [Custom Bot Detection Alerts](#custom-bot-detection-alerts). | ||
|
|
||
| --- | ||
|
|
||
| ## Alert types | ||
|
|
||
| <AvailableNotifications product="Bots" /> | ||
|
|
||
| ### Set up a bot detection alert | ||
|
|
||
| To receive Bot alerts, you must [configure a notification](/notifications/get-started/). Notifications help you stay up to date with your Cloudflare account through email, PagerDuty, or webhooks, depending on your Cloudflare plan. | ||
|
|
||
| 1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account. | ||
| 2. Select **Notifications**. | ||
| 3. In **Notifications**, select **Add**. | ||
| 4. Choose one of the available bot detection alerts (depending on whether you want to set up custom filters and/or grouping): | ||
| - Bot Detection Alert | ||
| - Custom Bot Detection Alert | ||
| 5. Enter a notification name and (optionally) a description. | ||
| 6. Select the domain(s) to monitor for this alert. | ||
| 7. Configure a delivery method for the notification. The available delivery methods depend on your Cloudflare plan. For more information, refer to [Cloudflare Notifications](/notifications/). | ||
| 8. If you are creating a notification for Custom Bot Detection Alert, define the parameters that will filter the notifications you will receive. | ||
| 9. Select **Save**. | ||
|
|
||
| --- | ||
|
|
||
| ## Alert logic | ||
|
|
||
| The Bot Detection Alert notifies users when Cloudflare detects an abnormal spike to their zone where the Z-score > [3.5](https://blog.cloudflare.com/introducing-thresholds-in-security-event-alerting-a-z-score-love-story/) and bot requests > 200/5 minutes in bot traffic (bot score < 30). | ||
|
|
||
| Z-score is calculated with a long window duration of six hours and short window duration of five minutes. | ||
|
|
||
| Bot Detection Alerts are delivered with Cloudflare’s Notifications system via email, webhook, or Pager Duty. | ||
|
|
||
| You will not receive duplicate alerts within the same one-hour time frame, except in rare cases where different alert values simultaneously trigger alerts. | ||
|
|
||
| In addition to the information above, Custom Bot Detection Alerts allow you to include or exclude certain conditions: | ||
|
|
||
| - User-agent | ||
| - Hostname | ||
| - URI Path | ||
| - IP Source Address | ||
| - AS Num | ||
| - JA3 Fingerprint | ||
| - JA4 Fingerprint | ||
| - Bot Detection IDs | ||
|
|
||
| You can also choose to group by the following dimensions so that they can be alerted of volumetric anomalies based on: | ||
| - JA4 Fingerprint (removes the filter of bot score < 30) | ||
patriciasantaana marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - AS Num | ||
| - Bot Detection IDs | ||
|
|
||
| :::note | ||
| Bot Detection Alerts exclude [verified bots](/bots/concepts/bot/verified-bots/categories/). | ||
| ::: | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,7 +2,7 @@ | |
| pcx_content_type: reference | ||
| title: Sample terms | ||
| sidebar: | ||
| order: 4 | ||
| order: 5 | ||
|
|
||
| --- | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.