Skip to content

Commit b726b1a

Browse files
andre-j3suspedrosousa
andre-j3sus
and
pedrosousa
authored
[Radar] Update glossary (#19378)
--------- Co-authored-by: Pedro Sousa <[email protected]>
1 parent 6a187f0 commit b726b1a

16 files changed

+401
-256
lines changed

‎.gitignore‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,6 @@ pnpm-debug.log*
2525

2626
.wrangler
2727
/assets/secrets
28-
/worker/functions/
28+
/worker/functions/
29+
30+
.idea

‎src/content/docs/radar/concepts/aggregation-intervals.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,4 @@ For example, when requesting one day of data, the default aggregation interval i
1717
| `15m` | 15 minutes frequency. |
1818
| `1h` | One hour frequency. |
1919
| `1d` | One day frequency. |
20+
| `1w` | One week frequency. |

‎src/content/docs/radar/concepts/bot-classes.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ sidebar:
88

99
A bot class in Radar is a grouping of [bot scores](/bots/concepts/bot-score).
1010

11-
Scores between 1 to 29 are classified as bot traffic. Scores equal or above 30 are classified as non-bot/human traffic.
11+
Scores between 1 and 29 are classified as bot traffic. Scores equal or above 30 are classified as non-bot/human traffic.
1212

1313
| Class | Description |
1414
| -------------------- | ---------------------------- |

‎src/content/docs/radar/concepts/normalization.mdx‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,13 @@ Refer to the `result.meta.normalization` property in the response to check which
1212

1313
## Method
1414

15-
| Method | Description |
16-
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17-
| `PERCENTAGE` | Values represent percentages. |
18-
| `PERCENTAGE_CHANGE` | Values represent a [percentage change](https://en.wikipedia.org/wiki/Relative_change_and_difference#Percentage_change) from a baseline period. |
19-
| `MIN_MAX` | Values have been normalized using [min-max](https://en.wikipedia.org/wiki/Feature_scaling#Rescaling_\(min-max_normalization\)). |
20-
| `MIN0_MAX` | Values have been normalized using min-max, but setting the minimum value to `0`. Equivalent to a proportion of the maximum value in the entire response, scaled between 0 and 1. |
21-
| `RAW_VALUES` | Values are raw and have not been changed. |
15+
| Method | Description |
16+
| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17+
| `PERCENTAGE` | Values represent percentages. |
18+
| `PERCENTAGE_CHANGE` | Values represent a [percentage change](https://en.wikipedia.org/wiki/Relative_change_and_difference#Percentage_change) from a baseline period. |
19+
| `OVERLAPPED_PERCENTAGE` | Values represent percentages that exceed 100% due to overlap. |
20+
| `MIN_MAX` | Values have been normalized using [min-max](https://en.wikipedia.org/wiki/Feature_scaling#Rescaling_\(min-max_normalization\)). |
21+
| `MIN0_MAX` | Values have been normalized using min-max, but setting the minimum value to `0`. Equivalent to a proportion of the maximum value in the entire response, scaled between 0 and 1. |
22+
| `RAW_VALUES` | Values are raw and have not been changed. |
2223

2324
If you want to compare values across locations/time ranges/etc., in endpoints that normalize values using min-max, you must do so in the same request. This is done by asking for multiple series. All values will then be normalized using the same minimum and maximum value and can safely be compared against each other. Refer to [Make comparisons](/radar/get-started/making-comparisons/) for more information.

‎src/content/docs/radar/get-started/error-codes.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
pcx_content_type: reference
3-
title: Radar API Error Codes
3+
title: Radar API error codes
44
sidebar:
55
order: 3
66
head:
77
- tag: title
8-
content: Radar API Error Codes
8+
content: Radar API error codes
99

1010
---
1111

‎src/content/docs/radar/get-started/making-comparisons.mdx‎

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ sidebar:
88

99
When comparing time series, across locations/time ranges/etc., in endpoints that normalize values using [min-max](/radar/concepts/normalization), you must do so in the same request. This is done by asking for multiple series. All values will then be normalized using the same minimum and maximum value and can safely be compared against each other.
1010

11-
[Netflows](/radar/investigate/netflows) values are normalized using [min0-max](/radar/concepts/normalization), so we will use it as an example. Refer to [Get NetFlow time series](/api/resources/radar/subresources/netflows/methods/timeseries/) for more information.
11+
[NetFlows](/radar/investigate/netflows) values are normalized using [min0-max](/radar/concepts/normalization), so we will use it as an example. Refer to [Get NetFlow time series](/api/resources/radar/subresources/netflows/methods/timeseries/) for more information.
1212

1313
## Compare locations
1414

@@ -27,7 +27,7 @@ The second series has the following parameters:
2727

2828
`name=pt_data&dateRange=7d&location=PT`
2929

30-
All of these parameters are arrays and it is the position in the array that defines the series the filter belongs to. Refer to [NetFlow's endpoint](/api/resources/radar/subresources/netflows/methods/timeseries/) for more information on the available parameters.
30+
All of these parameters are arrays, and it is the position in the array that defines the series the filter belongs to. Refer to [NetFlow's endpoint](/api/resources/radar/subresources/netflows/methods/timeseries/) for more information on the available parameters.
3131

3232
The response (shortened below for brevity) uses the provided `name` property to wrap the timestamps and corresponding values. If we chart this data, it becomes obvious that Cloudflare received much less traffic from Portugal than from the United States.
3333

@@ -50,6 +50,7 @@ The response (shortened below for brevity) uses the provided `name` property to
5050
"endTime": "2022-11-02T17:00:00Z"
5151
},
5252
"aggInterval": "ONE_HOUR",
53+
// ...
5354
}
5455
}
5556
}
@@ -113,13 +114,15 @@ In the above example, we requested for an [aggregation interval](/radar/concepts
113114
The `result` property should return a response like this:
114115

115116
```json
116-
"tonga": {
117-
"timestamps": ["2022-10-15T02:00:00Z", "2022-10-15T03:00:00Z", "2022-10-15T04:00:00Z", "2022-10-15T05:00:00Z"],
118-
"values": ["1.0", "0.832473", "0.820083", "0.79408"]
119-
},
120-
"tonga_outage": {
121-
"timestamps": ["2022-01-15T02:00:00Z", "2022-01-15T03:00:00Z", "2022-01-15T04:00:00Z", "2022-01-15T05:00:00Z"],
122-
"values": ["0.354105", "0.357287", "0.181811", "0.044198"]
117+
{
118+
"tonga": {
119+
"timestamps": ["2022-10-15T02:00:00Z", "2022-10-15T03:00:00Z", "2022-10-15T04:00:00Z", "2022-10-15T05:00:00Z"],
120+
"values": ["1.0", "0.832473", "0.820083", "0.79408"]
121+
},
122+
"tonga_outage": {
123+
"timestamps": ["2022-01-15T02:00:00Z", "2022-01-15T03:00:00Z", "2022-01-15T04:00:00Z", "2022-01-15T05:00:00Z"],
124+
"values": ["0.354105", "0.357287", "0.181811", "0.044198"]
125+
}
123126
}
124127
```
125128

‎src/content/docs/radar/glossary.mdx‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,10 @@ Internet connectivity can experience outages or disruptions due to a number of f
110110

111111
An early warning signal that an Internet outage may be underway on a given network or in a given country is an anomalous drop in traffic as compared to historical traffic patterns and trends. Internet anomalies listed in the Cloudflare Radar Outage Center represent an algorithmically-observed anomalous drop in traffic for the listed entity. If a given entry is marked as verified, it means that we have manually corroborated the observed drop in traffic across multiple Cloudflare data sources and/or third-party sources such as [IODA](https://ioda.inetintel.cc.gatech.edu/), or third-party sources of information, such as those listed above. In the case of the latter, an associated Internet outage event will be opened, with the event listed in the Internet Outages table (and API).
112112

113+
## Internet services ranking
114+
115+
Internet services ranking is based on our anonymized and aggregated 1.1.1.1 resolver data, complies with our [privacy policy](https://www.cloudflare.com/en-gb/privacypolicy/), and aims to identify the top most popular Internet services that reflect how people use the Internet globally. A service represents one or more domains aggregated together. Ranking popularity metric is best described as the estimated number of unique users that access domains associated with a service, over some period of time.
116+
113117
## Internet traffic trends
114118

115119
Trends observed in Internet traffic originating globally or within a given location or autonomous system within the selected time range, based on aggregated data from our network.
@@ -154,6 +158,14 @@ Network-level DDoS attacks graphs are based on traffic measured in bytes.
154158

155159
The Post-Quantum Encryption Adoption graph shows the share of HTTPS requests to Cloudflare that are encrypted with post-quantum (PQ) cryptography. Additional details about Cloudflare's support for PQ cryptography can be found at [Cloudflare Research](https://pq.cloudflareresearch.com/).
156160

161+
## Robots.txt
162+
163+
A [robots.txt](https://www.cloudflare.com/learning/bots/what-is-robots-txt/) file contains instructions for bots that tell them which webpages they can and cannot access.
164+
165+
The data displayed for robots.txt is based on successfully parsed robots.txt files from the top 10,000 domains. From these files, we count the occurrences of each user agent under the "Allow" and "Disallow" directives. A user agent is classified as "fully allowed" or "fully disallowed" if the directive value is "*". Otherwise, if the user agent is only allowed or disallowed to crawl specific paths, it is classified as "partially allowed" or "partially disallowed."
166+
167+
Currently, we only include AI-focused user agents listed in the [ai.robots.txt](https://github.com/ai-robots-txt/ai.robots.txt) repository.
168+
157169
## TCP resets and timeouts
158170

159171
In the Transmission Control Protocol (TCP), client-initiated connection resets (via the RST flag, TCP's "panic button") are atypical, and indicate to the server that *something went wrong* requiring the connection to be closed immediately. Similarly, connection timeouts (where the server closes a connection due to an unresponsive client) should not happen in conventional data exchanges. For comparison, a typical TCP connection consists of a 3-way handshake initiated by a client with a SYN packet to the server, then a data exchange moderated with ACK and PSH flags in the data packets, and finally a graceful close initiated from either side with a FIN packet. A FIN close is considered graceful because it ensures both sides complete their data transfer before closing the connection. In contrast, a timeout or RST flag triggers a hard stop, even if data is waiting to be sent or acknowledged. See [RFC 9293](https://datatracker.ietf.org/doc/html/rfc9293) for more details on the TCP protocol.
@@ -205,3 +217,7 @@ The data displayed on domain-specific geographic traffic patterns is based solel
205217
## WHOIS
206218

207219
WHOIS is a standard for publishing the contact and nameserver information for all registered domains. Each registrar maintains their own WHOIS service. Anyone can query the registrar's WHOIS service to reveal the data behind a given domain.
220+
221+
## Workers AI
222+
223+
[Workers AI](/workers-ai/) allows you to run machine learning models, on the Cloudflare network, from your own code -- whether that be from Workers, Pages, or anywhere via the Cloudflare API. The data displayed for Workers AI is based on the number of Cloudflare accounts using a model during a specific time interval.

‎src/content/docs/radar/investigate/application-layer-attacks.mdx‎

Lines changed: 104 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Like in [HTTP requests](/radar/investigate/http-requests), these endpoints can b
3030
Let us examine the global distribution of mitigated requests by product.
3131

3232
```bash
33-
curl "https://api.cloudflare.com/client/v4/radar/attacks/layer7/timeseries_groups?aggInterval=1h&dateRange=1d&name=attacks&format=json" \
33+
curl "https://api.cloudflare.com/client/v4/radar/attacks/layer7/timeseries_groups/mitigation_product?aggInterval=1h&dateRange=1d&name=attacks&format=json" \
3434
--header "Authorization: Bearer <API_TOKEN>"
3535
```
3636

@@ -56,6 +56,7 @@ From the abbreviated response below, we can conclude that distributed denial-of-
5656
"startTime": "2022-11-05T11:00:00Z",
5757
"endTime": "2022-11-06T11:00:00Z"
5858
},
59+
// ...
5960
}
6061
}
6162
}
@@ -75,14 +76,23 @@ curl "https://api.cloudflare.com/client/v4/radar/attacks/layer7/summary?location
7576
```
7677

7778
```json
78-
"attacks_gb": {
79-
"waf": "75.012138",
80-
"ddos": "18.539149",
81-
"ip_reputation": "5.721021",
82-
"access_rules": "0.592515",
83-
"bot_management": "0.131998",
84-
"api_shield": "0.003178",
85-
"data_loss_prevention": "0.0"
79+
{
80+
"success": true,
81+
"errors": [],
82+
"result": {
83+
"attacks_gb": {
84+
"waf": "75.012138",
85+
"ddos": "18.539149",
86+
"ip_reputation": "5.721021",
87+
"access_rules": "0.592515",
88+
"bot_management": "0.131998",
89+
"api_shield": "0.003178",
90+
"data_loss_prevention": "0.0"
91+
},
92+
"meta": {
93+
// ...
94+
}
95+
}
8696
}
8797
```
8898

@@ -106,37 +116,44 @@ curl "https://api.cloudflare.com/client/v4/radar/attacks/layer7/top/locations/ta
106116
"success": true,
107117
"errors": [],
108118
"result": {
109-
"attacks_target": [{
110-
"targetCountryName": "Belgium",
111-
"targetCountryAlpha2": "BE",
112-
"value": "18.536740",
113-
"rank": 1
114-
}, {
115-
"targetCountryName": "United States",
116-
"targetCountryAlpha2": "US",
117-
"value": "16.116210",
118-
"rank": 2
119-
}, {
120-
"targetCountryName": "China",
121-
"targetCountryAlpha2": "CN",
122-
"value": "13.864696",
123-
"rank": 3
124-
}, {
125-
"targetCountryName": "India",
126-
"targetCountryAlpha2": "IN",
127-
"value": "4.344139",
128-
"rank": 4
129-
}, {
130-
"targetCountryName": "Germany",
131-
"targetCountryAlpha2": "DE",
132-
"value": "4.182777",
133-
"rank": 5
134-
}],
119+
"attacks_target": [
120+
{
121+
"targetCountryName": "Belgium",
122+
"targetCountryAlpha2": "BE",
123+
"value": "18.536740",
124+
"rank": 1
125+
},
126+
{
127+
"targetCountryName": "United States",
128+
"targetCountryAlpha2": "US",
129+
"value": "16.116210",
130+
"rank": 2
131+
},
132+
{
133+
"targetCountryName": "China",
134+
"targetCountryAlpha2": "CN",
135+
"value": "13.864696",
136+
"rank": 3
137+
},
138+
{
139+
"targetCountryName": "India",
140+
"targetCountryAlpha2": "IN",
141+
"value": "4.344139",
142+
"rank": 4
143+
},
144+
{
145+
"targetCountryName": "Germany",
146+
"targetCountryAlpha2": "DE",
147+
"value": "4.182777",
148+
"rank": 5
149+
}
150+
],
135151
"meta": {
136152
"dateRange": {
137153
"startTime": "2022-11-05T12:00:00Z",
138154
"endTime": "2022-11-06T12:00:00Z"
139155
},
156+
// ...
140157
}
141158
}
142159
}
@@ -159,43 +176,58 @@ curl "https://api.cloudflare.com/client/v4/radar/attacks/layer7/top/attacks?limi
159176

160177
A typical response will be similar to the following:
161178

162-
```
163-
[{
164-
"originCountryName": "United States",
165-
"originCountryAlpha2": "US",
166-
"targetCountryName": "United States",
167-
"targetCountryAlpha2": "US",
168-
"value": "3.790724",
169-
"rank": 1
170-
}, {
171-
"originCountryName": "United States",
172-
"originCountryAlpha2": "US",
173-
"targetCountryName": "Belgium",
174-
"targetCountryAlpha2": "BE",
175-
"value": "3.602177",
176-
"rank": 2
177-
}, {
178-
"originCountryName": "China",
179-
"originCountryAlpha2": "CN",
180-
"targetCountryName": "Netherlands",
181-
"targetCountryAlpha2": "NL",
182-
"value": "3.017341",
183-
"rank": 3
184-
}, {
185-
"originCountryName": "China",
186-
"originCountryAlpha2": "CN",
187-
"targetCountryName": "China",
188-
"targetCountryAlpha2": "CN",
189-
"value": "2.472068",
190-
"rank": 4
191-
}, {
192-
"originCountryName": "Indonesia",
193-
"originCountryAlpha2": "ID",
194-
"targetCountryName": "China",
195-
"targetCountryAlpha2": "CN",
196-
"value": "2.056729",
197-
"rank": 5
198-
}]
179+
```json
180+
{
181+
"success": true,
182+
"errors": [],
183+
"result": {
184+
"top_0": [
185+
{
186+
"originCountryName": "United States",
187+
"originCountryAlpha2": "US",
188+
"targetCountryName": "United States",
189+
"targetCountryAlpha2": "US",
190+
"value": "3.790724",
191+
"rank": 1
192+
},
193+
{
194+
"originCountryName": "United States",
195+
"originCountryAlpha2": "US",
196+
"targetCountryName": "Belgium",
197+
"targetCountryAlpha2": "BE",
198+
"value": "3.602177",
199+
"rank": 2
200+
},
201+
{
202+
"originCountryName": "China",
203+
"originCountryAlpha2": "CN",
204+
"targetCountryName": "Netherlands",
205+
"targetCountryAlpha2": "NL",
206+
"value": "3.017341",
207+
"rank": 3
208+
},
209+
{
210+
"originCountryName": "China",
211+
"originCountryAlpha2": "CN",
212+
"targetCountryName": "China",
213+
"targetCountryAlpha2": "CN",
214+
"value": "2.472068",
215+
"rank": 4
216+
},
217+
{
218+
"originCountryName": "Indonesia",
219+
"originCountryAlpha2": "ID",
220+
"targetCountryName": "China",
221+
"targetCountryAlpha2": "CN",
222+
"value": "2.056729",
223+
"rank": 5
224+
}
225+
],
226+
"meta": {
227+
// ...
228+
}
229+
}
230+
}
199231
```
200232

201233
This means that 3.79% of all mitigated requests are from and to the US, 3.6% of all mitigated requests are from the US to Belgium, etc..

0 commit comments

Comments
 (0)