Log Analysis Module Overview¶
Purpose¶
The Log Analysis module (md_generator.log) converts Log files, directories, OTLP sidecars, streaming sources (tail, Kafka, Redis, websocket, stdin) into Parsed events, summaries, incidents, knowledge graph, clustering, embedding exports, incremental checkpoints. It exists so teams can publish searchable, diff-friendly Markdown from operational inputs without maintaining separate documentation pipelines per format.
Problem solved¶
- Manual copy/paste from Log files, directories, OTLP sidecars, streaming sources (tail, Kafka, Redis, websocket, stdin) into wikis does not scale.
- Downstream AI/RAG workflows need stable text and asset bundles.
- CI and gateways need a consistent CLI/API surface across
mdenginemodules.
When to use¶
- You need repeatable Markdown export from Log files, directories, OTLP sidecars, streaming sources (tail, Kafka, Redis, websocket, stdin).
- You want CLI automation, HTTP conversion, or MCP tool integration (where implemented).
- You can install the
logoptional extra (andapifor HTTP services).
When not to use¶
- Inputs fall outside supported formats or size limits enforced by the module.
- You require authenticated multi-tenant SaaS features (not provided by this module; use gateway auth).
- You need transactional writes into application databases (this module documents or transforms; it does not own app schemas except metadata export modules).
Package facts¶
| Item | Value |
|---|---|
| Import path | md_generator.log |
| Source tree | src/md_generator/log |
| CLI | md-log |
| Alternate CLI | mdengine log-to-md |
| PyPI extra | log |
| Complexity tier | complex |
| API service name | log-to-md |
Primary entry points¶
extract_to_markdownrun_pipelineLogRunConfigload_run_configiter_stream_lines