Skip to content

Commit 4fa34fd

Browse files
patriciasantaanadaisyfaithauma
authored andcommitted
[Bots] bot detection alerts (#21929)
* bot alerts * Apply suggestions from code review * tiny edits * Apply suggestions from code review
1 parent 19590f5 commit 4fa34fd

File tree

3 files changed

+91
-1
lines changed

3 files changed

+91
-1
lines changed
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
pcx_content_type: reference
3+
title: Bot Detection Alerts
4+
sidebar:
5+
order: 4
6+
7+
---
8+
9+
import { AvailableNotifications } from "~/components"
10+
11+
Bot alerts inform you when Cloudflare detects spikes in your traffic with any of the following characteristics:
12+
13+
- A global spike in traffic that have a bot score of less than 30.
14+
- An increase in traffic on available dimensions in [Custom Bot Detection Alerts](#custom-bot-detection-alerts).
15+
- Filters of your choosing in [Custom Bot Detection Alerts](#custom-bot-detection-alerts).
16+
17+
---
18+
19+
## Alert types
20+
21+
<AvailableNotifications product="Bots" />
22+
23+
### Set up a bot detection alert
24+
25+
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.
26+
27+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account.
28+
2. Go to **Notifications**.
29+
3. In **Notifications**, select **Add**.
30+
4. Select **Bot Management** from the Product list.
31+
5. Choose one of the available bot detection alerts (depending on whether you want to set up custom filters and/or grouping):
32+
- Bot Detection Alert
33+
- Custom Bot Detection Alert
34+
6. Enter a notification name and (optionally) a description.
35+
7. Select the domain(s) to monitor for this alert.
36+
8. Configure a delivery method for the notification. The available delivery methods depend on your Cloudflare plan. For more information, refer to [Cloudflare Notifications](/notifications/).
37+
9. If you are creating a notification for Custom Bot Detection Alert, define the parameters that will filter the notifications you will receive.
38+
10. Select **Save**.
39+
40+
---
41+
42+
## Alert logic
43+
44+
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).
45+
46+
Z-score is calculated with a long window duration of six hours and short window duration of five minutes.
47+
48+
Bot Detection Alerts are delivered with Cloudflare’s Notifications system via email, webhook, or Pager Duty.
49+
50+
You will not receive duplicate alerts within the same one-hour time frame, except in rare cases where different alert values simultaneously trigger alerts.
51+
52+
In addition to the information above, Custom Bot Detection Alerts allow you to include or exclude certain conditions:
53+
54+
- User-agent
55+
- Hostname
56+
- URI Path
57+
- IP Source Address
58+
- AS Num
59+
- JA3 Fingerprint
60+
- JA4 Fingerprint
61+
- Bot Detection IDs
62+
63+
You can also choose to group by the following dimensions so that they can be alerted of volumetric anomalies based on:
64+
65+
- JA4 Fingerprint (removes the filter of bot score < 30)
66+
- AS Num
67+
- Bot Detection IDs
68+
69+
:::note
70+
Bot Detection Alerts exclude [verified bots](/bots/concepts/bot/verified-bots/categories/).
71+
:::

src/content/docs/bots/reference/sample-terms.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
pcx_content_type: reference
33
title: Sample terms
44
sidebar:
5-
order: 4
5+
order: 5
66

77
---
88

src/content/notifications/index.yaml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,25 @@ entries:
1919
* Argo Smart Routing has **Notify when total bytes of traffic exceeds** as a threshold.
2020
* Load Balancing has **Notify when total number of DNS Queries exceeds** as a threshold.
2121
22+
- name: Bot Detection Alert
23+
audience: Enterprise customers who want to be notified when Cloudflare detects a spike in bot traffic on their zones.
24+
availability: Accounts with at least one Enterprise zone.
25+
associatedProducts: Bots
26+
nextSteps: Select the [Security Analytics](/waf/analytics/security-analytics/) link enclosed in the alert message. Contact support if additional advice is needed on how to investigate the attack further.
27+
otherFilters: None.
28+
additional_information: After an alert is created on the dashboard, it may take up to 30 minutes before sufficient data is available to begin detecting traffic anomalies. Verified bot traffic is excluded from bot alerts.
29+
30+
- name: Custom Bot Detection Alert
31+
audience: Enterprise customers who want to be notified when Cloudflare detects a spike in bot traffic on their zones.
32+
availability: Accounts with at least one Enterprise zone.
33+
associatedProducts: Bots
34+
nextSteps: Select the [Security Analytics](/waf/analytics/security-analytics/) link enclosed in the alert message. Contact support if additional advice is needed on how to investigate the attack further.
35+
otherFilters: Refer to the [alert logic](/bots/reference/alerts/#alert-logic) for more information on additional filters or groupings.
36+
additional_information: |-
37+
After an alert is created on the dashboard, it may take up to 30 minutes before sufficient data is available to begin detecting traffic anomalies. Verified bot traffic is excluded from both basic and advanced bot alerts.
38+
39+
Alerts with grouping could cause potential noise if you set them up for a high-traffic zone. Grouping alerts function as if you set up separate policies with a filter for each value. Alerts may trigger multiple values in the same group as long as the traffic for each value reaches the threshold of 200.
40+
2241
- name: Brand Protection Alerts
2342
audience: Customers who want a summary of activity related to [Brand Protection](/security-center/brand-protection/).
2443
availability: Professional plans or higher.

0 commit comments

Comments
 (0)