- Notifications
You must be signed in to change notification settings - Fork7
A real-time monitoring and interaction tool for clojure.core.async.flow
License
clojure/core.async.flow-monitor
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
A real-time monitoring and interaction tool forclojure.core.async.flow
Flow Monitor provides a web-based interface for visualizing, monitoring, and interacting with clojure.core.async.flow
With Flow Monitor, you can observe the structure of your flow, track the state of processes and the async channels between them, control process execution by pausing and resuming them, inject data into channels, and view any errors or messages that emerge from the flow.
Add the following dependency to your project:
;; deps.edn{:deps {io.github.clojure/core.async.flow-monitor {:git/tag"v0.1.1":git/sha"61e8d31"}}}
(:require [clojure.core.async.flow-monitor:as monitor] [clojure.core.async.flow:as flow]);; Create a flow(defmy-flow (flow/create-flow ...));; Start the monitoring server(defserver-state (monitor/start-server {:flow my-flow:port9876}));; The web interface will be available at:;; http://localhost:9876/index.html
You can provide custom Transit write handlers to properly serialize types that aren't natively supported by Transit (used for visualizing state). These handlers should follow the format expected by cognitect.transit/writer :handlers. If not provided, the default handler will be used, which converts objects to strings.
(:require [clojure.core.async.flow-monitor:as monitor] [clojure.core.async.flow:as flow] [cognitect.transit:as transit] [java.time:as time])(:import [java.time Instant ZoneId] [java.time.format DateTimeFormatter])(defmy-flow (flow/create-flow ...))(defnformat-instant [instant] (.format (.withZone (DateTimeFormatter/ofPattern"MMMM d, yyyy") (ZoneId/systemDefault)) instant))(definstant-write-handler (transit/write-handler"instant-long" (fn [instant] (format-instant instant))))(defserver-state (monitor/start-server {:flow my-flow:port9876:handlers {Instant instant-write-handler}}))
(monitor/stop-server server-state)You can run multiple monitoring servers simultaneously to monitor different flows:
(defserver1 (monitor/start-server {:flow flow1:port9876}))(defserver2 (monitor/start-server {:flow flow2:port9877})); unique unused port;; Stop them independently(monitor/stop-server server1)(monitor/stop-server server2)
It is common for the state to contain credentials and other sensitive information not intended to be displayed in the monitor. Filter predicates can optionally be provided when starting the monitor to filter the state data of flow procs.
;; Create a flow(defmy-flow (flow/create-flow ...));; Start the monitoring server;;; In this example;;; The :categorize proc will have the :salary value removed;;; and :db-pass will be removed from all procs other than :categorize(defserver-state (monitor/start-server {:flow my-flow:state-filters {:categorize (fn [[k v]] (not=:salary k)):default (fn [[k v]] (not=:db-pass k))}}))
It is valid to create a cyclical flow. The monitor displays procs without a[to-pid inid] at the top as roots. A circular flow will need to specify the intended root explicitly. A vector of :pid keywords can optionally be provided when starting the monitor to designate the root procs.
(defflow-config {:procs ...:conns [[[:a:out] [:b:in]] [[:b:out] [:a:in]]]});; Create a flow(defmy-flow (flow/create-flow flow-config));; Start the monitoring server specifying the root proc(s)(defserver-state (monitor/start-server {:flow my-flow;; Multiple roots can be provided if desired:root [:a]}));; Inline static flow graphs also require the root to be specified for circular flows(static/graph flow-config [:a])
BothCursive andCalva support displaying HTML in the editor. A static graph can be generated from your flow-config and displayed in either of those editor environments with the following:
(:require [clojure.core.async.flow-static:refer [graph]] [clojure.core.async.flow:as flow]);; Create a flow(defflow-config {:procs ...:conns ...}) (graph flow-config); Takes a config not what is returned from create-flow(defmy-flow (flow/create-flow flow-config))
Contributing to Clojure projects requires a signed Contributor Agreement. Pull requests and GitHub issues are not accepted; please use thecore.async.flow-monitor JIRA project to report problems or enhancements.
Copyright © 2025
Distributed under the Eclipse Public License v 1.0
About
A real-time monitoring and interaction tool for clojure.core.async.flow
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.
Contributors2
Uh oh!
There was an error while loading.Please reload this page.