Log Analysis Workflows¶
CLI workflow¶
- Install
mdengine[log]. - Run
md-log --helpto list flags. - Provide input (Log files, directories, OTLP sidecars, streaming sources (tail, Kafka, Redis, websocket, stdin)) and output path.
- Inspect generated Markdown and sidecar assets.
API workflow¶
- Install
mdengine[log,api]. - Start uvicorn on
md_generator.logAPI module (see Deployment). - Call sync endpoint for small payloads or job endpoint for large conversions.
- Poll job status and download artifact when complete.
Processing pipeline¶
flowchart TD
Start[Start] --> InputLoad[Load_input]
InputLoad --> Validate[Validate_options]
Validate --> Transform[Core_conversion]
Transform --> Render[Render_Markdown]
Render --> Package[Write_output_or_ZIP]
Package --> End[Complete]
Async job flow¶
Where job routes exist, background work uses in-process threads or domain job managers; results land in job workspace + download.
sequenceDiagram
participant Client
participant API
participant Worker
participant Storage
Client->>API: POST job
API->>Storage: create workspace
API->>Worker: enqueue
API-->>Client: job_id
Worker->>Storage: write artifacts
Client->>API: GET status/download
API-->>Client: ZIP or Markdown
Streaming and incremental processing¶
md-log stream— tail, stdin, Kafka, Redis, or websocket sources (streaming.*in YAML).md-log presets— list parser presets (generic, springboot, logback, json, …).--resume— incremental checkpoint resume (incremental.*in YAML).- Knowledge graph — enable
knowledge_graph.enabledfor service/event graph Markdown + Mermaid.