Skip to content

Commit c363ab2

Browse files
victor-perovvictor-perov
authored
Point graphql-api/sampling to introspection (cloudflare#6753)
This commit removes the list of nodes, that backed by adaptively sampled data. Instead, we should rely on discovery, like introspection. **Network Analytics v2** nodes are not with "fixed" sampling and share the same adaptive logic, so I think it's better to remove them from the Fixed sampling table to reduce confusion. Users should solely rely on Node's description while they introspect the schema.
1 parent 9e2f52f commit c363ab2

File tree

1 file changed

+7
-20
lines changed
  • content/analytics/graphql-api/sampling

1 file changed

+7
-20
lines changed

‎content/analytics/graphql-api/sampling/index.md

Lines changed: 7 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -13,26 +13,12 @@ In a small number of cases, the analytics provided on the Cloudflare dashboard a
1313

1414
## Sampled datasets
1515

16-
Cloudflare Analytics builds the following datasets from sampled data:
16+
Cloudflare GraphQL API exposes datasets that powered by adaptive sampling. These
17+
nodes have **Adaptive** in the name and can be discovered through
18+
[introspection][1].
1719

18-
{{<table-wrap>}}
19-
20-
| Data set | Nodes |
21-
| :---------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
22-
| Firewall Activity Log | `firewallEventsAdaptive` `firewallEventsAdaptiveByTimeGroups` |
23-
| Firewall Analytics | `firewallEventsAdaptiveGroups` |
24-
| Firewall Rule Preview | `firewallRulePreviewGroups` |
25-
| Network Analytics | `ipFlows1mGroups`\*<br/> `ipFlows1hGroups`\*<br/> `ipFlows1dGroups`\*<br/> `ipFlows1mAttacksGroups`\* |
26-
| Network Analytics v2<br/> for Magic Transit customers | `magicTransitNetworkAnalyticsAdaptiveGroups`<br/> `dosdNetworkAnalyticsAdaptiveGroups`<br/> `dosdAttackAnalyticsGroups`<br/> `flowtrackdNetworkAnalyticsAdaptiveGroups`<br/> `magicFirewallNetworkAnalyticsAdaptiveGroups` |
27-
| Network Analytics v2<br/> for Spectrum customers<br/> (Enterprise plans only) | `spectrumNetworkAnalyticsAdaptiveGroups`<br/> `dosdNetworkAnalyticsAdaptiveGroups`<br/> `dosdAttackAnalyticsGroups` |
28-
| Workers Metrics | `workersInvocationsAdaptive` |
29-
| Magic Firewall Analytics | `magicFirewallSamplesAdaptiveGroups` |
30-
31-
{{</table-wrap>}}
32-
33-
\* These nodes are deprecated. Refer to [Deprecated data nodes](/analytics/graphql-api/features/data-sets/#deprecated-data-nodes) for more information.
34-
35-
The presence of sampled data is called out in the Cloudflare dashboard and in the description of the dataset in the API.
20+
The presence of sampled data is also called out in the Cloudflare dashboard and
21+
in the description of the dataset in the API.
3622

3723
## Why sampling is applied
3824

@@ -54,10 +40,11 @@ The following data nodes are based on fixed sampling, where the sample rate does
5440
| :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5541
| Firewall Rules Preview<br /><p><b>Nodes:</b><br />`firewallRulePreviewGroups`</p> | 1% | Use with caution. A 1% sample rate does not provide accurate estimates for datasets smaller than a certain threshold, a scenario the Cloudflare dashboard calls out explicitly but the API does not. |
5642
| Network Analytics<br /><p><b>Nodes:</b><br />`ipFlows1mGroups`<br />`ipFlows1hGroups`<br />`ipFlows1dGroups`<br />`ipFlows1mAttacksGroups`</p> | 0.012% | Sampling rate is in terms of packet count (1 of every 8,192 packets). |
57-
| Network Analytics v2<br /><p><b>Nodes:</b><br />`dosdNetworkAnalyticsAdaptiveGroups`<br />`dosdAttackAnalyticsGroups`<br />`flowtrackdNetworkAnalyticsAdaptiveGroups`<br />`magicFirewallNetworkAnalyticsAdaptiveGroups`<br />`magicTransitNetworkAnalyticsAdaptiveGroups`<br />`spectrumNetworkAnalyticsAdaptiveGroups`</p> | Depends on the node. | Sample rate is 1/100 for Magic Firewall, 1/10,000 for `dosd`, and dynamic for `flowtrackd`. Refer to the [NAv2 migration guide](/analytics/graphql-api/migration-guides/network-analytics-v2/#node-comparison) for details. |
5843

5944
{{</table-wrap>}}
6045

6146
## Access to raw data
6247

6348
Because sampling is primarily adaptive and automatically adjusts to provide an accurate estimate, the sampling rate cannot be directly controlled. Enterprise customers have access to raw data via Cloudflare Logs.
49+
50+
[1]: </analytics/graphql-api/features/discovery/introspection/>

0 commit comments

Comments
 (0)