|
| 1 | +--- |
| 2 | +pcx_content_type: reference |
| 3 | +title: Custom dashboards |
| 4 | +sidebar: |
| 5 | + order: 3 |
| 6 | +--- |
| 7 | + |
| 8 | +Custom dashboards allow you to create tailored dashboards to monitor application security, performance, and usage. You can create monitors for ongoing monitoring of a previous incident, use them to identify indicators of suspicious activity, and access templates to help you get started. |
| 9 | + |
| 10 | +Dashboards provide a visual interface that displays key metrics and analytics, helping you monitor and analyze data efficiently. Different dashboards serve different purposes. For example, a security dashboard tracks attack attempts and threats, a performance dashboard monitors API latency and uptime, and a usage dashboard analyzes traffic patterns and user behavior. |
| 11 | + |
| 12 | +Different metrics serve distinct roles in providing insights into your application's performance. For example, total HTTP requests offers an overview of traffic volume, while average response time helps assess application speed. Additionally, usage metrics such as traffic patterns and user behavior provide insight into how users interact with your application. These metrics together enable you to spot trends, identify problems, and make informed, data-driven decisions. |
| 13 | + |
| 14 | +:::note |
| 15 | +Custom dashboards is currently available to customers participating in the Log Explorer beta. To begin using custom dashboards, you will first need to request access to [Log Explorer](/logs/log-explorer/). |
| 16 | +::: |
| 17 | + |
| 18 | +## Create a new dashboard |
| 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. |
| 21 | + |
| 22 | + |
| 23 | +When creating a dashboard, you have two options: building one from scratch or using a pre-designed template. |
| 24 | + |
| 25 | +- A **from-scratch dashboard** gives you full control over its structure, allowing you to choose the exact datasets, metrics, and visualizations that fit your needs. This approach is ideal if you have specific monitoring goals or need a highly customized view of your data. |
| 26 | +- On the other hand, **templates** provide a faster way to set up a dashboard with commonly used metrics and charts. They are useful for standard use cases, such as monitoring security threats, API performance, or bot traffic. Templates help you get started quickly while still allowing modifications to fit your requirements. |
| 27 | + |
| 28 | +Choosing between these options depends on whether you need a quick setup with predefined insights or a fully customized dashboard tailored to your unique analysis needs. |
| 29 | + |
| 30 | +### Create a dashboard from scratch |
| 31 | + |
| 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. |
| 33 | + |
| 34 | +#### Create a new chart |
| 35 | + |
| 36 | +To create a new chart, select **Add chart**. There are two ways to create a chart: |
| 37 | + |
| 38 | +- **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. |
| 40 | + |
| 41 | +Refer to the following sections for more information about the charts, datasets, fields, metrics, and filters available. |
| 42 | + |
| 43 | +##### Chart types |
| 44 | + |
| 45 | +The available chart types include: |
| 46 | + |
| 47 | +- **Timeseries**: Displays trends over time, enabling comparisons across multiple series. |
| 48 | +- **Categorical**: Compares proportions across different series. |
| 49 | +- **Stat**: Highlights a single value, showing its delta and sparkline for quick insights. |
| 50 | +- **Percentage**: Represents one value as a percentage of another. |
| 51 | +- **Top N**: Identifies the highest-ranking values for a given attribute. |
| 52 | + |
| 53 | +##### Datasets and metrics |
| 54 | + |
| 55 | +The available metrics and filters vary based on the dataset you want to use. For example, when using the HTTP Requests dataset, you can select **origin response duration** as a metric. You can then choose your preferred aggregation method for that metric, such as total, median, or quantiles. The following table outlines the datasets, fields, and available metrics: |
| 56 | + |
| 57 | + |
| 58 | +| Dataset | Field | Definition | Metrics | |
| 59 | +|-----------------|-----------------|------------|---------| |
| 60 | +| HTTP Requests | Requests | The number of requests sent by a client to a server over the HTTP protocol. | Total | |
| 61 | +| | DNS Response Time | The time taken for a DNS query to be resolved, measured from when a request is made to when a response is received. | Total, Average, Median, 95th percentile, 99th percentile | |
| 62 | +| | Time to First Byte | The duration from when a request is made to when the first byte of the response is received from the server. | Total, Average, Median, 95th percentile, 99th percentile | |
| 63 | +| | Bytes returned to the Client | The amount of data (in bytes) sent from the server to the client in response to requests. | Total, Average, Median, 95th percentile, 99th percentile | |
| 64 | +| | Number of visits | Unique visits or sessions to a website or application. | Total | |
| 65 | +| | Origin response duration | The time taken by the origin server to process and respond to a request. | Total, Average, Median, 95th percentile, 99th percentile | |
| 66 | +| Security Events | Security events | Actions taken by Application Security products such as WAF and Bot Management. | Total | |
| 67 | + |
| 68 | +##### Filters |
| 69 | + |
| 70 | +You can also adjust the scope of your analytics by entering filter conditions. This allows you to focus on the most relevant data. |
| 71 | + |
| 72 | +1. Select **Add filter**. |
| 73 | +2. Select a **field**, an **operator**, and a **value**. For example, to filter events by source IP address, select the _Source IP_ field, select the _equals_ operator, and enter the _IP address_. |
| 74 | +3. Select **Apply**. |
| 75 | + |
| 76 | +### Create a dashboard from a template |
| 77 | + |
| 78 | +Alternatively, you can choose to create your dashboard using a pre-designed dashboard template. The templates available are: |
| 79 | + |
| 80 | +- **Bot monitoring**: Allows you to identify automated traffic accessing your website. |
| 81 | +- **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 | +- **Account takeover**: Allows you to monitor login attempts, usage of leaked credentials, and account takeover attacks. |
| 84 | + |
| 85 | +## Edit a dashboard or chart |
| 86 | + |
| 87 | +After creating your dashboard, to view your saved dashboards, select **Back to all dashboards** to access the full list. Regardless of the way you choose to create your dashboard, you can always edit existing charts and add new ones as needed. |
| 88 | + |
| 89 | +## Further analysis |
| 90 | + |
| 91 | +For each chart, you can: |
| 92 | + |
| 93 | +- Review related traffic in [Security Analytics](/waf/analytics/security-analytics/). |
| 94 | +- Explore detailed logs in [Log Explorer](/logs/log-explorer/). |
| 95 | + |
| 96 | +This ensures deeper insights into your application's security, performance, and usage patterns. |
0 commit comments