Querying
This document explains various query options available in the Grafana Cloudflare data source plugin. Once you installed and configured the data source, you can query the Cloudflare data via Grafana Explore or through dashboard.
Query types/Actions
The first step of the querying is selecting the Action/Query Type. Each action / query type represents an API in the Cloudflare. Once you selected the Action/Query Type, you have to provide relevant additional information required for the API.
Some APIs require to pass mandatory parameters and they are available next to the action selection. If there are any optional parameters, they are available in the Optional parameters section of the query editor
Accounts
Accounts in one of fundamental entity in Cloudflare. Read more about accounts in the Cloudflare documentation.
List accounts
This action lists all accounts you have ownership or verified access to.
Key | Description |
---|---|
Action | List accounts / accounts |
You can read about the underlying API for this query type in the Cloudflare documentation.
Account details
This action get information about a specific account that you are a member of.
Key | Description |
---|---|
Action | Account details / account |
Account ID | Cloudflare account id |
You can read about the underlying API for this query type in the Cloudflare documentation.
Zones
Domains that are added to the Cloudflare accounts are usually referred as Cloudflare Zones. Read more about Zones in the Cloudflare documentation.
List zones
This action lists, searches, sorts, and filters your zones.
Key | Description |
---|---|
Action | List zones / zones |
You can read about the underlying API for this query type in the Cloudflare documentation.
DNS Analytics
Report
This action retrieves a list of summarized aggregate metrics over a given time period. See Analytics API properties for detailed information about the available query parameters.
This action retrieves a list of aggregate metrics grouped by time interval. See Analytics API properties for detailed information about the available query parameters.
Key | Description |
---|---|
Action | DNS analytics report / zones-dns-analytics-report |
Zone ID | Cloudflare zone id |
Metrics | List of metrics you want to retrieve |
Dimensions | List of dimensions to group results by |
Limit | Limit number of returned metrics |
This API also require you to pass the time range via
since
anduntil
parameters. Instead of you manually passing the time range, the plugin automatically passes the Grafana dashboard time range.
You can read about the underlying API for this query type in the Cloudflare documentation.
Time series/By time
This action retrieves a list of aggregate metrics grouped by time interval. See Analytics API properties for detailed information about the available query parameters.
Key | Description |
---|---|
Action | DNS analytics by time / zones-dns-analytics-report-bytime |
Zone ID | Cloudflare zone id |
Metrics | List of metrics you want to retrieve |
Dimensions | List of dimensions to group results by |
This API also require you to pass the time range via
since
anduntil
parameters. Instead of you manually passing the time range, the plugin automatically passes the Grafana dashboard time range.
You can read about the underlying API for this query type in the Cloudflare documentation.
Radar
Cloudflare Radar is a hub that showcases global Internet traffic, attack, and technology trends and insights. Cloudflare Radar is powered by data from Cloudflare’s global network, as well as aggregated and anonymized data from Cloudflare’s 1.1.1.1 public DNS Resolver.
With Grafana Cloudflare data source, you can query various radar dataset data via the radar API.
Radar APIs
The following radar data can be queried via grafana
- Get datasets
- Get bot class summary/time series
- Get user agent families time series
- Get device type summary/time series
- Get HTTP protocols summary/time series
- Get HTTP versions Summary/time series
- Get IP versions summary/time series
- Get operation systems summary/time series
- Get TLS versions summary/time series
- Get NewFlows time series
- Internet outages and anomalies