Skip to content

Commit 345b70b

Browse files
committed
docs: Update scheduler viz docs
1 parent 22378a1 commit 345b70b

File tree

2 files changed

+15
-13
lines changed

2 files changed

+15
-13
lines changed

docs/src/logging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ called. Let's construct one:
3232

3333
```julia
3434
ctx = Context()
35-
ml = TimspanLogging.MultiEventLog()
35+
ml = TimespanLogging.MultiEventLog()
3636

3737
# Add the BytesAllocd consumer to the log as `:bytes`
3838
ml[:bytes] = Dagger.Events.BytesAllocd()

docs/src/scheduler-visualization.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,24 @@ easiest way to get started with the web dashboard for new users.
1616
For manual usage, the following snippet of code will suffice:
1717

1818
```julia
19+
using Dagger, DaggerWebDash, TimespanLogging
20+
1921
ctx = Context() # or `ctx = Dagger.Sch.eager_context()` for eager API usage
20-
ml = Dagger.MultiEventLog()
22+
ml = TimespanLogging.MultiEventLog()
2123

2224
## Add some logging events of interest
2325

24-
ml[:core] = Dagger.Events.CoreMetrics()
25-
ml[:id] = Dagger.Events.IDMetrics()
26-
ml[:timeline] = Dagger.Events.TimelineMetrics()
26+
ml[:core] = TimespanLogging.Events.CoreMetrics()
27+
ml[:id] = TimespanLogging.Events.IDMetrics()
28+
ml[:timeline] = TimespanLogging.Events.TimelineMetrics()
2729
# ...
2830

2931
# (Optional) Enable profile flamegraph generation with ProfileSVG
3032
ml[:profile] = DaggerWebDash.ProfileMetrics()
3133
ctx.profile = true
3234

3335
# Create a LogWindow; necessary for real-time event updates
34-
lw = Dagger.Events.LogWindow(20*10^9, :core)
36+
lw = TimespanLogging.Events.LogWindow(20*10^9, :core)
3537
ml.aggregators[:logwindow] = lw
3638

3739
# Create the D3Renderer server on port 8080
@@ -40,20 +42,20 @@ d3r = DaggerWebDash.D3Renderer(8080)
4042
## Add some plots! Rendered top-down in order
4143

4244
# Show an overview of all generated events as a Gantt chart
43-
push!(d3r, GanttPlot(:core, :id, :esat, :psat; title="Overview"))
45+
push!(d3r, DaggerWebDash.GanttPlot(:core, :id, :esat, :psat; title="Overview"))
4446

4547
# Show various numerical events as line plots over time
46-
push!(d3r, LinePlot(:core, :wsat, "Worker Saturation", "Running Tasks"))
47-
push!(d3r, LinePlot(:core, :loadavg, "CPU Load Average", "Average Running Threads"))
48-
push!(d3r, LinePlot(:core, :bytes, "Allocated Bytes", "Bytes"))
49-
push!(d3r, LinePlot(:core, :mem, "Available Memory", "% Free"))
48+
push!(d3r, DaggerWebDash.LinePlot(:core, :wsat, "Worker Saturation", "Running Tasks"))
49+
push!(d3r, DaggerWebDash.LinePlot(:core, :loadavg, "CPU Load Average", "Average Running Threads"))
50+
push!(d3r, DaggerWebDash.LinePlot(:core, :bytes, "Allocated Bytes", "Bytes"))
51+
push!(d3r, DaggerWebDash.LinePlot(:core, :mem, "Available Memory", "% Free"))
5052

5153
# Show a graph rendering of compute tasks and data movement between them
5254
# Note: Profile events are ignored if absent from the log
53-
push!(d3r, GraphPlot(:core, :id, :timeline, :profile, "DAG"))
55+
push!(d3r, DaggerWebDash.GraphPlot(:core, :id, :timeline, :profile, "DAG"))
5456

5557
# TODO: Not yet functional
56-
#push!(d3r, ProfileViewer(:core, :profile, "Profile Viewer"))
58+
#push!(d3r, DaggerWebDash.ProfileViewer(:core, :profile, "Profile Viewer"))
5759

5860
# Add the D3Renderer as a consumer of special events generated by LogWindow
5961
push!(lw.creation_handlers, d3r)

0 commit comments

Comments
 (0)