Skip to content

PatMartin/visual-ops

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 

Repository files navigation

visual-ops

Diagram and visualization generation for Ops4J, powered by PlantUML.

This is an optional plugin module. Add it to a project that already depends on ops4j-core and groovy-ops to generate sequence diagrams, tree/mindmap diagrams, and flow/state diagrams directly from JSON record streams.


Overview

visual-ops treats JSON records as structured diagram data. Each operation reads fields from the incoming records, builds a PlantUML source document via Groovy templating, renders it to an image or text output, and writes the result downstream. This makes it straightforward to produce architectural, workflow, or analytical diagrams as a pipeline stage rather than as a separate post-processing step.


Operations

Operation Description
visual-sequence (VisualSequence) Renders a UML sequence diagram. Reads source, destination, and comment fields from each record to produce the sequence interactions. Useful for visualizing event flows, API call traces, or message logs.
visual-tree (VisualTree) Renders a tree or mindmap diagram from hierarchical JSON. Traverses the record structure to build parent-child relationships in PlantUML. Useful for visualizing data taxonomies or dependency trees.
visual-flow (VisualFlow) Renders a flow or state diagram that shows transitions between states. Reads state and transition fields from records to construct the diagram. Useful for visualizing state machines, process flows, or decision trees.

Usage Examples

Visualize a sequence of API calls from a log file:

cat api-trace.json | visual-sequence -src service -dst target -msg action

Render a dependency tree from hierarchical JSON:

cat dependencies.json | visual-tree

Generate a state-transition diagram from event records:

cat events.json | visual-flow -state status -next next_status

Configuration

visual-ops registers itself automatically. No additional configuration file is required beyond what ops4j-core and groovy-ops provide.


Key Dependencies

Dependency Purpose
ops4j-core Ops4J runtime and base classes
groovy-ops Groovy template rendering used to build PlantUML source
PlantUML Diagram rendering engine

About

Visual support for ops4j.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages