This framework provides logging, bench-marking and monitoring.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Alexander Diemand 531e8889ba
reworked; ready for nix
3 years ago
Cardano.BM [#11] images remade 3 years ago
haddock haddock documentation for tracer-transformers 3 years ago
one-pager moved to 'one-pager' directory; added to READMEs; general fonts used 3 years ago
planning Milestone planning (#223) 3 years ago
pres-20181204 remake html of presentation 2018-12-04 3 years ago
pres-20190409 logging one-pager and presentation pdf 3 years ago
.gitignore [#133] documentation for configuration and its editor gui 3 years ago
Activity.png [#13] rename 'doc/' to 'docs/' 4 years ago
Backend_STM.png [#13] rename 'doc/' to 'docs/' 4 years ago
CardanoShell_Components.png [#13] rename 'doc/' to 'docs/' 4 years ago
CardanoShell_Seq.png [#13] rename 'doc/' to 'docs/' 4 years ago
Code.lhs reworked; ready for nix 3 years ago
Components.png [#13] rename 'doc/' to 'docs/' 4 years ago
ConfigEditor.png New screenshot of Configuration Editor. 3 years ago
Config_OutputSelection.png [#13] rename 'doc/' to 'docs/' 4 years ago
Config_SeverityFilter.png [#13] rename 'doc/' to 'docs/' 4 years ago
ConfigurationModel.png [#11] images remade 3 years ago
Makefile reworked; ready for nix 3 years ago
Monitoring_Spec.txt [#50] WIP monitoring backend added 3 years ago
OverviewModules.png [#11] images remade 3 years ago Update 3 years ago
STMObserver.png [#13] rename 'doc/' to 'docs/' 4 years ago
SetupProcedure.png [#13] rename 'doc/' to 'docs/' 4 years ago
Subsystems.png [#13] rename 'doc/' to 'docs/' 4 years ago
Trace_SeverityFilter.png [#13] rename 'doc/' to 'docs/' 4 years ago
aggregation.tex [#117] code in inline floats 3 years ago
configuration.tex Fix scale of Configuration editor screenshot. 3 years ago
contravariant.tex Improving documentation: new overview, diagrams, contravariant functor presentation. 3 years ago
local.fmt [#166] reorganised documentation 3 years ago
monitoring.tex [#117] polished 3 years ago
mu-benchmarks.tex PDF: tag 'spec' instead of 'verbatim'. 3 years ago
output-selection.tex [#117] polished 3 years ago
references.fmt [#277] more documentation added 3 years ago
requirements.tex [#117] polished 3 years ago
shell.nix [#117] code in inline floats 3 years ago
traces.tex [#117] code in inline floats 3 years ago


In the docs/ directory, enter a nix-shell to have access to the required tools to generate documentation. Then, simply run make. This will produce the IOHK-Monitoring.pdf from the source code.


Logging overview

A summary of logging on a single page.

A single-page description of benchmarking.

Expose of monitoring.


Presentation 2019-04-09

The second presentation with more focus on contravariant Tracer and how the switchboard routes messages to the backends.

Presentation 2019-04-09

Contravariant Functor

Presentation 2018-12-04

This was the first presentation of iohk-monitoring-framework:

Presentation 2018-12-04

Haddock documentation

Haddock automatically generates documentation from source code:

package contra-tracer

package tracer-transformers

UML Diagrams

Diagrams have been edited with BOUML, a light-weight and fast UML editor. License: "free of use", no license.

Overview modules






STM observer



configure output selection

Output selection

configure severity filter

Severity filter

apply severity filter

Application of Severity Filter

Setup procedure

Setup procedure

Backend state machine

Backend state machine

Integration in Cardano.Shell

CardanoShell components

CardanoShell sequence