Skip to content

Commit 7719cf7

Browse files
pedrosousaOxyjun
andauthored
[WAF] Refactor Security Events (#20092)
* Make Security Events a single page * Rename Activity log ==> Sampled logs * Move Validation Checks page to additional tools --------- Co-authored-by: Jun Lee <[email protected]>
1 parent b50d8d2 commit 7719cf7

File tree

33 files changed

+214
-310
lines changed

33 files changed

+214
-310
lines changed

public/_redirects

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1343,6 +1343,9 @@
13431343
/waf/tools/scrape-shield/server-side-excludes/ /waf/tools/scrape-shield/ 301
13441344
/waf/rate-limiting-rules/create-account-dashboard/ /waf/account/rate-limiting-rulesets/create-dashboard/ 301
13451345
/waf/managed-rules/deploy-account-dashboard/ /waf/account/managed-rulesets/deploy-dashboard/ 301
1346+
/waf/analytics/security-events/free-plan/ /waf/analytics/security-events/ 301
1347+
/waf/analytics/security-events/paid-plans/ /waf/analytics/security-events/ 301
1348+
/waf/analytics/security-events/additional-information/ /waf/tools/validation-checks/ 301
13461349

13471350
# waiting-room
13481351
/waiting-room/how-to/mobile-traffic/ /waiting-room/how-to/json-response/ 301
-84.7 KB
Binary file not shown.
-16.6 KB
Binary file not shown.
-10.3 KB
Loading
139 KB
Loading

src/content/docs/ddos-protection/reference/analytics.mdx

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,21 @@ sidebar:
66
head:
77
- tag: title
88
content: DDoS analytics
9-
109
---
1110

1211
You can view DDoS analytics in different dashboards, depending on your service and plan:
1312

14-
- The [Security Events dashboard](/waf/analytics/security-events/) provides you with visibility into L7 security events that target your zone, including HTTP DDoS attacks and TCP attacks. The dashboard displays mitigations of HTTP DDoS attacks as HTTP DDoS events. These events are also available via [Cloudflare Logs](/logs/).
13+
- The [Security Events dashboard](/waf/analytics/security-events/) provides you with visibility into L7 security events that target your zone, including HTTP DDoS attacks and TCP attacks. The dashboard displays mitigations of HTTP DDoS attacks as HTTP DDoS events. These events are also available via [Cloudflare Logs](/logs/).
1514

1615
- The [Network Analytics dashboard](/analytics/network-analytics/) provides you with visibility into L3/4 traffic and DDoS attacks that target your IP ranges or Spectrum applications.
1716

1817
## Availability
1918

20-
21-
22-
| Service | Free | Pro | Business | Enterprise |
23-
| ------------- | ----------------- | --------------- | --------------- | ----------------- |
24-
| WAF/CDN | Activity log only | Security Events | Security Events | Security Events |
25-
| Spectrum/BYOIP |||| Network Analytics |
26-
| Magic Transit |||| Network Analytics |
27-
28-
19+
| Service | Free | Pro | Business | Enterprise |
20+
| -------------- | ----------------- | --------------- | --------------- | ----------------- |
21+
| WAF/CDN | Sampled logs only | Security Events | Security Events | Security Events |
22+
| Spectrum/BYOIP |||| Network Analytics |
23+
| Magic Transit |||| Network Analytics |
2924

3025
## Remarks
3126

src/content/docs/fundamentals/reference/cloudflare-ray-id.mdx

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,20 @@ A **Cloudflare Ray ID** is an identifier given to every request that goes throug
88
Ray IDs are particularly useful when evaluating Security Events for patterns or false positives or more generally understanding your application traffic.
99

1010
:::caution
11-
1211
Ray IDs are not guaranteed to be unique for every request. In some situations, different requests may have the same Ray ID.
1312
:::
1413

1514
## Look up Ray IDs
1615

1716
### Security events
1817

19-
All customers can view Ray IDs and associated information — IP address, user agent, ASN, etc. — by looking through the [Activity Log](/waf/analytics/security-events/) in Security Events.
18+
All customers can view Ray IDs and associated information — IP address, user agent, ASN, etc. — by looking through [sampled logs](/waf/analytics/security-events/#sampled-logs) in Security Events.
2019

21-
![Example list of events in the Activity log, with one of the events expanded to show its details](~/assets/images/waf/events-activity-log.png)
20+
![Example list of events in sampled logs, with one of the events expanded to show its details](~/assets/images/waf/events-sampled-logs.png)
2221

23-
Additionally, you can [add filters](/waf/analytics/security-events/paid-plans/#adjusting-displayed-data) to look for specific Ray IDs.
22+
Additionally, you can [add filters](/waf/analytics/security-events/#adjust-displayed-data) to look for specific Ray IDs.
2423

25-
![Example of adding a new filter in Security Events for the Allow action](~/assets/images/waf/events-add-filter-free.png)
24+
![Example of adding a new filter in Security Events for the Block action](~/assets/images/waf/events-add-filter.png)
2625

2726
Please note that Security Events may use sampled data to improve performance. If sampled data is applied to your search, you might not see all events, and filters might not return the expected results. To display more events, select a smaller timeframe.
2827

src/content/docs/support/troubleshooting/http-status-codes/4xx-client-error.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Cloudflare may serve `403` responses in the following scenarios:
7171
- [DDoS Protection](/ddos-protection/), which is enabled by default on zones onboarded to Cloudflare, IP applications onboarded to Spectrum, and IP Prefixes onboarded to Magic Transit.
7272
- Most [1xxx Cloudflare error codes](/support/troubleshooting/cloudflare-errors/troubleshooting-cloudflare-1xxx-errors/).
7373
- The [Browser Integrity Check](/waf/tools/browser-integrity-check/).
74-
- [Validation Checks](/waf/analytics/security-events/additional-information/).
74+
- [Validation Checks](/waf/tools/validation-checks/).
7575

7676
Cloudflare may also serve an unstyled `403` error page in specific cases. These errors are not logged because they occur early in Cloudflare's infrastructure, before domain configuration is loaded. An example is:
7777

Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
---
2+
title: Security Events
3+
pcx_content_type: concept
4+
sidebar:
5+
order: 2
6+
---
7+
8+
import { FeatureTable, GlossaryTooltip } from "~/components";
9+
10+
Security Events allows you to review <GlossaryTooltip term="mitigated request">mitigated requests</GlossaryTooltip> and helps you tailor your security configurations.
11+
12+
The main elements of the dashboard are the following:
13+
14+
- [Events summary](#events-summary): Provides the number of security events on traffic during the selected time period, grouped according to the selected dimension (for example, Action, Host, Country).
15+
- [Events by service](#events-by-service): Lists the security-related activity per security feature (for example, WAF, API Shield).
16+
- [Top events by source](#top-events-by-source): Provides details of the traffic flagged or actioned by a Cloudflare security feature (for example, IP addresses, User Agents, Paths, Countries, Hosts, ASNs).
17+
- [Sampled logs](#sampled-logs): Summarizes security events by date to show the action taken and the applied Cloudflare security product.
18+
19+
Security Events displays information about requests actioned or flagged by Cloudflare security products, including features such as [Browser Integrity Check](/waf/tools/browser-integrity-check/). Each incoming HTTP request might generate one or more security events. The Security Events dashboard only shows these events, not the HTTP requests themselves.
20+
21+
## Availability
22+
23+
Available features vary according to your Cloudflare plan:
24+
25+
<FeatureTable id="security.security_events" />
26+
27+
## Location in the dashboard
28+
29+
Security Events is available for your zone in **Security** > **Events**.
30+
31+
Additionally, Enterprise customers have access to the account-level dashboard in Account Home > **Security Center** > **Security Events**.
32+
33+
## Adjust displayed data
34+
35+
You can apply multiple filters and exclusions to narrow the scope of Security Events and adjust the report duration. Modifying the duration, filters, or exclusions affects the analytics data displayed on the entire page including **Sampled logs** and all graphs.
36+
37+
![Example of adding a new filter in Security Events for the Block action](~/assets/images/waf/events-add-filter.png)
38+
39+
### Add filters
40+
41+
You can adjust the scope of analytics by manually entering filter conditions. Alternatively, select **Filter** or **Exclude** to filter by a field value. These buttons appear when you hover the analytics data legend.
42+
43+
To manually add a filter:
44+
45+
1. Select **Add filter**.
46+
2. Select a field, an operator, and a value. For example, to filter events by IP address, select _IP_ for **Action**, select _equals_ for the operator, and enter the IP address.
47+
3. Select **Apply**.
48+
49+
Take the following into account when entering filter values:
50+
51+
- Do not add quotes around values.
52+
- Do not enter the `AS` prefix when entering ASN numbers. For example, enter `1423` instead of `AS1423`.
53+
- Wildcards are not supported.
54+
55+
### Adjust report duration
56+
57+
To adjust report duration, select the desired duration from the dropdown in **Security Events**. The default value is `Previous 24 hours`.
58+
59+
The available report duration values depend on your Cloudflare plan. Refer to [Availability](#availability) for details.
60+
61+
## Create custom rule from current filters
62+
63+
To create a [custom rule](/waf/custom-rules/create-dashboard/) based on your current filters and exclusions, select **Create custom rule** in **Security Events**.
64+
65+
## Events summary
66+
67+
The **Events summary** section provides the number of security events on traffic during the selected time period, grouped according to the selected dimension (for example, **Action**, **Host**, **Country**, or **ASN**).
68+
69+
![Filter by action by selecting Filter when hovering the desired action in Events summary](~/assets/images/waf/events-summary.png)
70+
71+
You can adjust the displayed data according to one of the values by selecting **Filter** or **Exclude** when hovering the legend.
72+
73+
## Events by service
74+
75+
The **Events by service** section lists the activity per Cloudflare security feature (for example, **Managed rules** or **API Shield**).
76+
77+
You can adjust the scope of Security Events to one of the displayed services by selecting **Filter** or **Exclude** when hovering the legend or by selecting the corresponding graph bar.
78+
79+
## Top events by source
80+
81+
In **Top events by source** you can find details of the traffic flagged or actioned by a security feature — for example, **IP Addresses**, **User Agents**, **Paths**, and **Countries**.
82+
83+
You can adjust the scope of Security Events to one of the listed source values by selecting **Filter** or **Exclude** when hovering the value.
84+
85+
:::note
86+
A deleted custom/firewall rule or rate limiting rule will show as `Rule unavailable` under **Firewall rules** or **Rate limit rules**. To check the changes made within your Cloudflare account, review your [Audit logs](/fundamentals/setup/account/account-security/review-audit-logs/).
87+
:::
88+
89+
## Sampled logs
90+
91+
**Sampled logs** summarizes security events by date to show the action taken and the applied Cloudflare security feature.
92+
93+
![Example list of events in Sampled logs, with one of the events expanded to show its details](~/assets/images/waf/events-sampled-logs.png)
94+
95+
Security events are shown by individual event rather than by request. For example, if a single request triggers three different security features, the security events will show three individual events in **Sampled logs**.
96+
97+
Expand each event to check its details, and define filters and exclusions based on the event's field values. Select the **Filter** or **Exclude** button when hovering a field to add the field value to the filters or exclusions list of the displayed analytics. To download the event data in JSON format, select **Export event JSON**.
98+
99+
### Displayed columns
100+
101+
To configure the columns displayed in **Sampled logs**, select **Edit columns**. This gives you flexibility depending on the type of analysis that you need to perform.
102+
103+
For example, if you are diagnosing a bot-related issue, you may want to display the **User agent** and the **Country** columns. On the other hand, if you are trying to identify a DDoS attack, you may want to display the **IP address**, **ASN**, and **Path** columns.
104+
105+
### Event actions
106+
107+
For details on most actions that appear in **Sampled logs**, refer to [Actions](/ruleset-engine/rules-language/actions/).
108+
109+
Besides the actions you can select when configuring rules in Cloudflare security products, you may also find events with the following associated actions:
110+
111+
- _Connection Close_
112+
- _Force Connection Close_
113+
114+
For details on these actions, refer to [HTTP DDoS Attack Protection parameters](/ddos-protection/managed-rulesets/http/override-parameters/#action).
115+
116+
The [_Managed Challenge (Recommended)_](/waf/reference/cloudflare-challenges/#managed-challenge-recommended) action that may appear in **Sampled logs** is available in the following security features and products: WAF custom rules, rate limiting rules, Bot Fight Mode, IP Access rules, User Agent Blocking rules, and firewall rules (deprecated).
117+
118+
### Export event log data
119+
120+
You can export a set of up to 500 raw events from **Sampled logs** in JSON format. Export event data to combine and analyze Cloudflare data with your own stored in a separate system or database, such as a <GlossaryTooltip term="SIEM">SIEM system</GlossaryTooltip>. The data you export will reflect any filters you have applied.
121+
122+
To export the displayed events (up to 500), select **Export** in **Sampled logs**.
123+
124+
## Share Security Events filters
125+
126+
When you add a filter and specify a report duration (time window) in Security Events, the Cloudflare dashboard URL changes to reflect the parameters you configured. You can share that URL with other users so that they can analyze the same information that you see.
127+
128+
For example, after adding a filter for `Action equals Managed Challenge` and setting the report duration to 72 hours, the URL should look like the following:
129+
130+
`https://dash.cloudflare.com/{account_id}/example.net/security/events?action=managed_challenge&time-window=4320`
131+
132+
## Print or download PDF report
133+
134+
To print or download a snapshot report from your security events dashboard, select **Print report** in **Security Events**. Your web browser's printing interface will present you with options for printing or downloading the PDF report.
135+
136+
The generated report will reflect all applied filters.
137+
138+
## Known limitations
139+
140+
Security Events currently has these limitations:
141+
142+
- Security Events may use sampled data to improve performance. If your search uses sampled data, Security Events might not display all events and filters might not return the expected results. To display more events, select a smaller time frame.
143+
144+
- The Cloudflare dashboard may show an inaccurate number of events per page. Data queries are highly optimized, but this means that pagination may not always work because the source data may have been sampled. The GraphQL Analytics API does not have this pagination issue.
145+
146+
- Triggered OWASP rules appear in the Security Events page under **Additional logs**, but they are not included in exported JSON files.

src/content/docs/waf/analytics/security-events/free-plan.mdx

Lines changed: 0 additions & 34 deletions
This file was deleted.

0 commit comments

Comments
 (0)