Skip to content

Commit a4314a0

Browse files
marciocloudflaremarciocloudflare
authored
[MCONN] Troubleshooting dash (#25119)
* new metrics info * added new troubleshooting info * added troubleshooting partial * updated with dashbutton * removed extra space * added tab and bold * corrected dash * refined text * refined text * refined text
1 parent 14013dd commit a4314a0

File tree

3 files changed

+145
-44
lines changed

3 files changed

+145
-44
lines changed

‎src/content/docs/magic-wan/configuration/connector/device-metrics.mdx‎

Lines changed: 55 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -5,57 +5,69 @@ sidebar:
55
order: 8
66
---
77

8-
import { DashButton } from "~/components";
8+
Cloudflare customers can inspect metrics for a specific Magic WAN Connector in the Cloudflare dashboard. These metrics help you troubleshoot potential issues with your Connector. Refer to [Troubleshooting](/magic-wan/configuration/connector/troubleshooting/) for more information.
99

10-
Cloudflare customers can inspect metrics for a specific Magic WAN Connector in the Cloudflare dashboard. The Magic WAN Connector device metrics measured by Cloudflare include:
11-
12-
- CPU load
13-
- System temperature (this is always zero for Virtual Connector)
14-
- Disk utilization
15-
- Memory utilization
16-
17-
To check for Connector metrics:
18-
19-
1. In the Cloudflare dash, go to the **Configuration* page.
20-
21-
<DashButton url="/?to=/:account/magic-wan/configuration" />
22-
23-
2. In the **Connectors** tab, select the Connector you want to check metrics for.
24-
3. In the side panel that opens, scroll down to **Usage information**.
25-
26-
### Query metrics with GraphQL
10+
## Query metrics with GraphQL
2711

2812
Customers can query Cloudflare's GraphQL API to fetch their Magic WAN Connector device metrics. The Cloudflare dashboard displays Magic WAN Connector device metrics over the past one hour. Via the GraphQL API, customers can query for up to 30 days of historical Magic WAN Connector device metrics.
2913

3014
For example:
3115

3216
```graphql graphql-api-explorer
33-
query MagicWanDeviceMetrics(
34-
$accountTag: string!
35-
$datetimeStart: Time
36-
$datetimeEnd: Time
17+
query telemetry(
18+
$accountTag: string
19+
$snapshotsFilter: AccountMconnTelemetrySnapshotsAdaptiveGroupsFilter_InputObject!
20+
$snapshotMountsFilter: AccountMconnTelemetrySnapshotMountsAdaptiveGroupsFilter_InputObject!
21+
$snapshotThermalsFilter: AccountMconnTelemetrySnapshotThermalsAdaptiveGroupsFilter_InputObject!
22+
$limit: int64!
3723
) {
38-
viewer {
39-
accounts(filter: { accountTag: $accountTag }) {
40-
mconnTelemetrySnapshotsAdaptiveGroups(
41-
limit: 100
42-
filter: {
43-
datetime_geq: $datetimeStart
44-
datetime_lt: $datetimeEnd
45-
}
46-
) {
47-
max {
48-
loadAverage1m
49-
cpuCount
50-
memoryFreeBytes
51-
memoryTotalBytes
52-
}
53-
dimensions {
54-
connectorId
55-
}
56-
}
57-
}
58-
}
24+
viewer {
25+
accounts(filter: { accountTag: $accountTag }) {
26+
snapshots: mconnTelemetrySnapshots(
27+
filter: $snapshotsFilter
28+
limit: $limit
29+
orderBy: [datetimeFiveMinutes_DESC]
30+
) {
31+
max {
32+
cpuCount
33+
loadAverage1m
34+
memoryFreeBytes
35+
memoryTotalBytes
36+
}
37+
dimensions {
38+
connectorId
39+
datetimeFiveMinutes
40+
}
41+
}
42+
snapshotMounts: mconnTelemetrySnapshotMounts(
43+
filter: $snapshotMountsFilter
44+
limit: $limit
45+
orderBy: [datetimeFiveMinutes_DESC]
46+
) {
47+
max {
48+
availableBytes
49+
totalBytes
50+
}
51+
dimensions {
52+
connectorId
53+
datetimeFiveMinutes
54+
}
55+
}
56+
snapshotThermals: mconnTelemetrySnapshotThermals(
57+
filter: $snapshotThermalsFilter
58+
limit: $limit
59+
orderBy: [datetimeFiveMinutes_DESC, connectorId_DESC]
60+
) {
61+
max {
62+
currentCelcius
63+
}
64+
dimensions {
65+
connectorId
66+
datetimeFiveMinutes
67+
}
68+
}
69+
}
70+
}
5971
}
6072
```
6173

‎src/content/docs/magic-wan/configuration/connector/troubleshooting.mdx‎

Lines changed: 79 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,84 @@ sidebar:
55
order: 10
66
---
77

8+
import { Render } from "~/components";
9+
10+
## Device metrics
11+
12+
Cloudflare customers can inspect metrics for a specific Magic WAN Connector in the Cloudflare dashboard. These metrics help you troubleshoot potential issues with your Connector. The information spans categories such as:
13+
14+
- Performance analytics
15+
- Port analytics
16+
- Event logs
17+
- DHCP leasing information
18+
19+
To find the information above and start troubleshooting your Connector:
20+
21+
<Render file="mconn/troubleshooting" product="networking-services" />
22+
23+
### Performance analytics
24+
25+
In Performance analytics you can review your Connector's performance over time including:
26+
27+
- Kernel boot time (how long it has been running and if it is activated or not)
28+
- Last device snapshot (this also shows the frequency with which your device captures the snapshots that are used in several troubleshooting procedures)
29+
- CPU temperature
30+
- CPU load over time
31+
- Used RAM over time
32+
33+
To access performance analytics:
34+
35+
<Render file="mconn/troubleshooting" product="networking-services" />
36+
4. Select **Performance analytics**.
37+
38+
### Port analytics
39+
40+
Port analytics gives you access to information related to the packets sent and received through the ports in your Connector. You can adjust the time range for the information displayed in the dashboard regarding to:
41+
42+
- Rate for packets sent and received
43+
- Rate for data sent and received
44+
45+
The dashboard provides this information for all active ports in your Connector. To access port analytics:
46+
47+
<Render file="mconn/troubleshooting" product="networking-services" />
48+
4. Select **Port analytics**.
49+
50+
### Event logs
51+
52+
Use Event logs to identify general patterns and changes over time. This is useful to find correlations with other data and gather deeper insights into your Connector. The following event logs are available:
53+
54+
- `Init`: Initialized `mcon-agent` process. This process manages Connector.
55+
- `Leave`: Stopped `mcon-agent` process.
56+
- `StartAttestation`: Started attestation to verify the integrity of Connector before allowing the device to connect to your account.
57+
- `FinishAttestationSuccess`: Finished attestation successfully.
58+
- `FinishAttestationFailure`: Failed attestation.
59+
- `StartRotateCryptKey`: Started cryptography key rotation.
60+
- `FinishRotateCryptKeySuccess`: Finished cryptography key rotation.
61+
- `FinishRotateCryptKeyFailure`: Failed cryptography key rotation.
62+
- `StartRotatePki`: Started public key infrastructure (PKI) rotation.
63+
- `FinishRotatePkiSuccess`: Finished PKI rotation.
64+
- `FinishRotatePkiFailure`: Failed PKI rotation.
65+
- `StartUpgrade`: Began Connector's operating system upgrade.
66+
- `FinishUpgradeSuccess`: Finished operating system upgrade.
67+
- `FinishUpgradeFailure`: Failed operating system upgrade.
68+
- `Reconcile`: Cloudflare is comparing the system's current state against its desired state.
69+
- `ConfigureCloudflaredTunnel`: Configured Cloudflare Tunnel to debug device.
70+
71+
To access event logs:
72+
73+
<Render file="mconn/troubleshooting" product="networking-services" />
74+
4. Select **Events**.
75+
5. You can filter results by specific events, and by time.
76+
77+
### DHCP leasing
78+
79+
Refer to the DHCP leasing section to identify DHCP assigned leases and their expiration dates. To access DHCP leasing:
80+
81+
<Render file="mconn/troubleshooting" product="networking-services" />
82+
4. Select **DHCP leasing**.
83+
84+
## Troubleshooting tips
85+
886
If you are experiencing difficulties with your Magic WAN Connector, refer to the following tips to troubleshoot what might be happening.
987

1088
## I have set up a site, but my Connector is not working
@@ -31,4 +109,4 @@ Magic WAN Connector sends a heartbeat periodically to Cloudflare. You can [acces
31109

32110
## What do I do in the event of hardware issues with Magic WAN Connector?
33111

34-
Cloudflare is the single point of contact for any issues related to Magic WAN Connector, including issues with hardware. When required, Cloudflare Support will work with our partner, TD Synnex, to resolve any issues with the physical device.
112+
Cloudflare is the single point of contact for any issues related to Magic WAN Connector, including issues with hardware. When required, Cloudflare Support will work with our partner, TD Synnex, to resolve any issues with the physical device.

‎src/content/partials/networking-services/mconn/troubleshooting.mdx‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
{}
3+
---
4+
5+
import { DashButton } from "~/components";
6+
7+
1. In the Cloudflare dashboard, go to the **Configuration** page.
8+
9+
<DashButton url="/?to=/:account/magic-wan/configuration" />
10+
11+
2. In the **Connectors** tab, select the Connector you want to check metrics for > **View analytics**.

0 commit comments

Comments
 (0)