You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content/docs/log-explorer/custom-dashboards.mdx
+9-4Lines changed: 9 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,8 +17,10 @@ Custom dashboards is currently available to customers participating in the Log E
17
17
18
18
## Create a new dashboard
19
19
20
-
To create a new dashboard, log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login) and select your account. Then, navigate to **Log Explorer** and open the **Dashboards** section.
20
+
To create a new dashboard:
21
21
22
+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login) and select your account.
23
+
2. Go to **Log Explorer** > **Dashboards**.
22
24
23
25
When creating a dashboard, you have two options: building one from scratch or using a pre-designed template.
24
26
@@ -29,14 +31,14 @@ Choosing between these options depends on whether you need a quick setup with pr
29
31
30
32
### Create a dashboard from scratch
31
33
32
-
When creating a dashboard from scratch, select the option **Create a new**. You can follow the instructions in the following sections to start adding charts to your dashboard.
34
+
When creating a dashboard from scratch, select the option **Create new**. You can follow the instructions in the following sections to start adding charts to your dashboard.
33
35
34
36
#### Create a new chart
35
37
36
38
To create a new chart, select **Add chart**. There are two ways to create a chart:
37
39
38
40
-**Use a prompt**: Enter a query like `Compare status code ranges over time.` The AI model decides the most appropriate visualization and constructs your chart configuration.
39
-
-**Customize your chart**: Select the chart elements manually, including the chart type, title, dataset to query, metrics, and filters. This option gives you full control over your chart’s structure.
41
+
-**Customize your chart**: Select the chart elements manually, including the chart type, title, dataset to query, metrics, and filters. This option gives you full control over your chart's structure.
40
42
41
43
Refer to the following sections for more information about the charts, datasets, fields, metrics, and filters available.
42
44
@@ -79,8 +81,11 @@ Alternatively, you can choose to create your dashboard using a pre-designed dash
79
81
80
82
-**Bot monitoring**: Allows you to identify automated traffic accessing your website.
81
83
-**API Security**: Allows you to monitor data transfers and exceptions for API endpoints in your application.
82
-
-**API Performance**: Allows you to view timing data for API endpoints in your application, along with error rates.
83
84
-**Account takeover**: Allows you to monitor login attempts, usage of leaked credentials, and account takeover attacks.
85
+
-**API Performance**: Allows you to view timing data for API endpoints in your application, along with error rates.
86
+
-**Performance monitoring**: Allows you to identify slow hosts and paths on your origin server, and view time to first byte metrics over time.
87
+
88
+
Choose one of the templates and select **Use template**.
Copy file name to clipboardExpand all lines: src/content/docs/log-explorer/log-search.mdx
+14-32Lines changed: 14 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ At the account level, the datasets available are:
22
22
23
23
## Authentication
24
24
25
-
Log Explorer is available to users with the following permissions:
25
+
Log Search is available to users with the following permissions:
26
26
27
27
-**Logs Edit**: users with Logs Edit permissions can enable datasets.
28
28
-**Logs Read**: users with Logs Read permissions can run queries via the UI or API.
@@ -48,10 +48,10 @@ In order for Log Explorer to begin storing logs, you need to enable the desired
48
48
49
49
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login) and select your account or domain (also known).
50
50
2. Go to **Log Explorer** > **Manage datasets**.
51
-
3. Select **Add a dataset** to select the datasets you want to query. You can always return to this page to enable more datasets or manage your existing ones.
51
+
3. Select **Add dataset** to select the datasets you want to query.
52
+
4. Choose a dataset and then a zone. Then, select **Add**. You can always return to this page to enable more datasets or manage your existing ones.
52
53
53
54
:::note
54
-
55
55
It may take a few minutes for the logs to become available for querying.
56
56
:::
57
57
@@ -108,15 +108,13 @@ Filtering and viewing your logs is available via the Cloudflare Dashboard or via
108
108
109
109
110
110
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login) and select your account.
111
-
2. Go to **Log Explorer** > .
112
-
3.From the dropdown, select the **Dataset** you want to use and in **Columns** select the dataset fields. If you selected a zone scoped that dataset, select the zone you would like to use.
113
-
4.Select a **Limit**. That is the maximum number of results to return, for example, 50.
111
+
2. Go to **Log Explorer** > **Log Search**.
112
+
3.Select the **Dataset** you want to use and in **Columns** select the dataset fields. If you selected a zone scoped dataset, select the zone you would like to use.
113
+
4.Enter a **Limit**. A limit is the maximum number of results to return, for example, 50.
114
114
5. Select the **Time period** from which you want to query, for example, the previous 12 hours.
115
-
6. Select **Add filter** to create your query. Select a **Field**, an **Operator**, and a **Value**.
116
-
7. A query preview is displayed. Select **Custom SQL**, if you would like to change it.
117
-
8. Select **Run Query** when you are done. The results are displayed below within the **Query results** section.
118
-
119
-
115
+
6. Select **Add filter** to create your query. Select a **Field**, an **Operator**, and a **Value**, then select **Apply**.
116
+
7. A query preview is displayed. Select **Custom SQL** to change the query.
117
+
8. Select **Run query** when you are done. The results are displayed below within the **Query results** section.
120
118
121
119
:::note
122
120
@@ -128,7 +126,7 @@ You can also access the Log Explorer dashboard directly from the [Security Analy
128
126
129
127
Log Explorer exposes a query endpoint that uses a familiar SQL syntax for querying your logs generated with Cloudflare's network.
130
128
131
-
For example, to find an HTTP request with a specific [Ray ID](/fundamentals/reference/cloudflare-ray-id/), you can perform the following SQL query.
129
+
For example, to find an HTTP request with a specific [Ray ID](/fundamentals/reference/cloudflare-ray-id/), you can perform the following SQL query:
@@ -155,7 +153,7 @@ Which returns the following HTTP request details:
155
153
}
156
154
```
157
155
158
-
For another example using an account-level dataset, to find Cloudflare Access requests with selected columns from a specific timeframe, you can perform the following SQL query.
156
+
For another example using an account-level dataset, to find Cloudflare Access requests with selected columns from a specific timeframe, you can perform the following SQL query:
@@ -191,23 +189,11 @@ Which returns the following request details:
191
189
192
190
### Save queries
193
191
194
-
After selecting all the fields for your query, you can save it by selecting **Save query**. Provide a name and description to help identify it later. To view your saved and recent queries, select **Queries** — they will appear in a side panel where you can rename, duplicate, or delete any query.
195
-
## Output formats
196
-
197
-
Log Explorer output can be presented in different formats, besides JSON: JSON Lines (also known as NDJSON), CSV, and plain text. The plain text uses ASCII tables similar to psql's `aligned` output mode. Besides the convenience factor of not having to translate the format on the client side, JSON Lines, CSV, and plain text formats have the advantage of being streamed from the API. So for large result sets, you will get a response earlier.
192
+
After selecting all the fields for your query, you can save it by selecting **Save query**. Provide a name and description to help identify it later. To view your saved and recent queries, select **Queries** — they will appear in a side panel where you can insert a new query, or delete any query.
198
193
199
-
You can choose the output format with an HTTP `Accept` header, as shown in the table below:
All the tables supported by Log Explorer contain a special column called `date`, which helps to narrow down the amount of data that is scanned to respond to your query, resulting in faster query response times. The value of `date` must be in the form of `YYYY-MM-DD`. For example, to query logs that occurred on October 12, 2023, add the following to your `WHERE` clause: `date = '2023-10-12'`. The column supports the standard operators of `<`, `>`, and `=`.
196
+
All the tables supported by Log Explorer contain a special column called `date`, which helps to narrow down the amount of data that is scanned to respond to your query, resulting in faster query response times. The value of `date` must be in the form of `YYYY-MM-DD`. For example, to query logs that occurred on October 12, 2023, add the following to your `WHERE` clause: `date = '2023-10-12'`. The column supports the standard operators of `<`, `>`, and `=`:
@@ -241,10 +227,6 @@ The `WHERE` clause filters the rows returned by a query based on specified condi
241
227
242
228
The `GROUP BY` clause is used to group rows that have the same values into summary rows.
243
229
244
-
### HAVING
245
-
246
-
The `HAVING` clause is similar to the `WHERE` clause but is used specifically with the `GROUP BY` clause. It filters groups of rows based on specified conditions after the `GROUP BY` operation has been performed.
247
-
248
230
### ORDER BY
249
231
250
232
The `ORDER BY` clause is used to sort the result set by one or more columns in ascending or descending order.
0 commit comments