Skip to content

Commit 481f093

Browse files
docs: Adjust wording and headers for viz (#605)
Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
1 parent e2c1b4d commit 481f093

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/src/logging-visualization.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Dagger has built-in and easily accessible logs visualization capabilities.
55
Currently, there are two general mechanisms to visualize logs:
66
`show_logs`/`render_logs`, and `MultiEventLog` consumers.
77

8+
## Logs visualization with show_logs/render_logs
89
The former (`show_logs`/`render_logs`) renders a logs `Dict` (acquired from
910
`fetch_logs!`) either to an `IO` (via `show_logs`) or by returning a renderable
1011
object (via `render_logs`). This system is designed for rendering a single
@@ -25,8 +26,9 @@ Built-in rendering support exists for:
2526
- `render_logs(logs, :graphviz)` to generate a graph diagram of executed tasks and their dependencies (requires `GraphViz.jl` to be loaded)
2627
- `render_logs(logs, :plots_gantt)` to generate a Gantt chart of task execution across all processors (requires `Plots.jl` and `DataFrames.jl` to be loaded)
2728

28-
The latter (`MultiEventLog`) allows for continuously rendering logs as they're
29-
generated, permitting real-time visualization of Dagger's operations. This
29+
## Continuous visualization with MultiEventLog
30+
The `MultiEventLog` mechanism is designed for continuous rendering of logs as they are generated,
31+
which permits real-time visualization of Dagger's operations. This
3032
logic is utilized in `DaggerWebDash`, which provides a web-based dashboard for
3133
visualizing Dagger's operations as a real-time Gantt chart and set of plots for
3234
various system metrics (CPU usage, memory usage, worker utilization, etc.).

0 commit comments

Comments
 (0)