File tree Expand file tree Collapse file tree 3 files changed +74
-4
lines changed
node-operators/infrastructure Expand file tree Collapse file tree 3 files changed +74
-4
lines changed Original file line number Diff line number Diff line change @@ -35,6 +35,30 @@ The frontend connects to multiple services with configurable endpoints:
3535- ** GraphQL endpoint** : External MinaScan API (e.g.
3636 ` https://api.minascan.io/node/devnet/v1/graphql ` )
3737
38+ <!-- prettier-ignore-start -->
39+
40+ :::caution Memory profiler and debugger are separate sidecar services
41+
42+ The memory profiler and network debugger are **not part of the main node
43+ binary**. They are separate sidecar services that must be run alongside your
44+ node to enable these features in the dashboard.
45+
46+ To use these features:
47+
48+ - **Memory profiler**: See the
49+ [memory profiler setup guide](/docs/node-operators/infrastructure/memory-profiler)
50+ for instructions on running the memory profiler sidecar.
51+ - **Network debugger**: See the
52+ [network debugger setup guide](/docs/node-operators/infrastructure/network-debugger)
53+ for instructions on running the network debugger sidecar.
54+
55+ Without these sidecars running, the corresponding dashboard features will not be
56+ available.
57+
58+ :::
59+
60+ <!-- prettier-ignore-stop -->
61+
3862#### Further, let's examine the used endpoints
3963
4064### Node status and information
Original file line number Diff line number Diff line change @@ -7,7 +7,29 @@ sidebar_position: 6
77# Memory Profiler
88
99This section is still a work in progress. It will cover nodes running with a
10- memory profiler for performance analysis and optimization. The memory profiler
11- data is used by the node dashboard for debugging purposes.
10+ memory profiler for performance analysis and optimization.
11+
12+ <!-- prettier-ignore-start -->
13+
14+ :::info Memory profiler usage in the dashboard
15+
16+ The memory profiler is a **separate sidecar service** that runs alongside your
17+ node. It provides memory allocation analysis data that the
18+ [Node Dashboard](/docs/developers/frontend/api-endpoints) uses for performance
19+ debugging.
20+
21+ The dashboard consumes the memory profiler's API to visualize:
22+
23+ - Hierarchical memory resource allocation (treemap visualization)
24+ - Memory usage by function and executable
25+ - Memory allocation call stacks
26+
27+ For API details, see the
28+ [Memory profiler API endpoints](/docs/developers/frontend/api-endpoints#memory-profiler)
29+ section in the API reference.
30+
31+ :::
32+
33+ <!-- prettier-ignore-stop -->
1234
1335Track progress: [Issue #1207](https://github.com/o1-labs/mina-rust/issues/1207)
Original file line number Diff line number Diff line change @@ -7,7 +7,31 @@ sidebar_position: 7
77# Network Debugger
88
99This section is still a work in progress. It will cover nodes running with the
10- network debugger for network analysis and troubleshooting. The network debugger
11- data is used by the node dashboard for debugging purposes.
10+ network debugger for network analysis and troubleshooting.
11+
12+ <!-- prettier-ignore-start -->
13+
14+ :::info Network debugger usage in the dashboard
15+
16+ The network debugger is a **separate sidecar service** that runs alongside your
17+ node. It captures and stores detailed network traffic data that the
18+ [Node Dashboard](/docs/developers/frontend/api-endpoints) uses for network
19+ analysis and troubleshooting.
20+
21+ The dashboard consumes the network debugger's API to visualize:
22+
23+ - Block propagation messages and timing analysis
24+ - Network message inspection with filtering
25+ - Connection management and monitoring
26+ - Message decryption statistics
27+ - Low-level protocol debugging (hex dumps)
28+
29+ For API details, see the
30+ [Debugger API endpoints](/docs/developers/frontend/api-endpoints#debugger-api-endpoints)
31+ section in the API reference.
32+
33+ :::
34+
35+ <!-- prettier-ignore-stop -->
1236
1337Track progress: [Issue #1365](https://github.com/o1-labs/mina-rust/issues/1365)
You can’t perform that action at this time.
0 commit comments