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 e2eba48f66
Update README.md
3 years ago
.buildkite Added timeouts for CI. (#402) 3 years ago
.github Minor fixes for migration to master 3 years ago
ci [DEVOPS-1222] Build with iohk/nix and nix-tools. 4 years ago
contra-tracer turning warnings into errors 3 years ago
docs Merge pull request #414 from input-output-hk/tracing-verbosity-level 3 years ago
iohk-monitoring new properties: HasSeverityAnnotation et al. 3 years ago
nix [#406] documentation, nix 3 years ago
scripts Fixed typo. 3 years ago
tracer-transformers turning warnings into errors 3 years ago
.gitattributes [DEVOPS-1222] Build with iohk/nix and nix-tools. 4 years ago
.gitignore the generated documentation shall not be committed anymore 3 years ago
.stack-to-nix.cache [#243] scribe to output to systemd journal 3 years ago
CODEOWNERS updated automatically assigned reviewers of PRs 3 years ago
CONTRIBUTING.md Minor fixes for migration to master 3 years ago
LICENSE updated licence 3 years ago
NOTICE updated licence 3 years ago
PLAN.md milestone planning 3 years ago
README.md Update README.md 3 years ago
bors.toml [DEVOPS-1222] Build with iohk/nix and nix-tools. 4 years ago
cabal.project include Neil's tracer transformers and adapt 3 years ago
default.nix [#119] Changes for logging in SimM. (#128) 4 years ago
lib.nix [#268] Minor fixes. 3 years ago
release.nix Add Windows cross build of library to CI required job 3 years ago
shell.nix [#155] cross compilation 3 years ago
stack.yaml Upgrade to Stack 13.26 3 years ago

README.md

iohk-monitoring-framework

Release version Build status Coverage Status

This framework provides logging, benchmarking and monitoring.

documentation

Documentation of the source code and tests in PDF format. Please, download the PDF file and open it in an external viewer. It contains links for easier navigation in the source code. Those links are not active in the online viewer.

Slides of our presentations are available in html format.

And, introductory one-pagers on logging and benchmarking are available in pdf format.

module dependencies

Overview of modules

building and testing

cabal new-build all

cabal new-test all

examples

Some examples are available in the directory examples:

  • simple - run with cabal new-run example-simple
  • complex - run with cabal new-run example-complex

These showcase the usage of this framework in an application. The complex example includes EKGView (http://localhost:12789) and the configuration editor (http://localhost:13789).

Edit runtime configuration

development

  • cabal new-build all and cabal new-test all
  • ghcid -c "cabal new-repl" watches for file changes and recompiles them immediately