Directory / iohk-monitoring-framework / README.md

You are browsing a mirror of a file hosted on GitHub. View original

Documentation

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.

One-pagers

Logging overview

A summary of logging on a single page.

A single-page description of benchmarking.

Expose of monitoring.

Presentations

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

OverviewModules

Components

Components

Activity

Activity

STM observer

STMObserver

Configuration

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