package orsetto
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=585297372d7f6cfb830214e9ef22d6d072a39b2a1591ef90f1ee2bcfe144cad3
md5=6bb6a7ba88bf2c7595a0b332921e60b4
doc/orsetto.cf/Cf_journal/Basic/index.html
Module Cf_journal.Basic
A module defining basic diagnostic event journaling with a simple set of priority levels associated to integer priority codes.
Event journaling with integer priority codes.
include Profile with type priority := int
class type 'level prioritizer = object ... end
The class type of prioritizer classes. Defines methods for converting priority levels into 1) their corresponding code, and 2) their corresponding message tag.
class 'level event : 'level prioritizer -> 'level -> string -> object ... end
The minimal class of diagnostic events. Use new event p v m
to construct an event
object with the prioritizer p
, the priority level v
, and the message m
.
class type 'event archiver = object ... end
The base class for event archivers. Use inherit archiver
to derive a subclass that defines the emit
method to archive a diagnostic event into a journaling system.
class virtual 'archiver agent : 'level prioritizer -> 'level -> 'archiver list -> object ... end
The base class for journaling agents. Use inherit agent p v s
to derive a subclass that defines the private event_
method to construct an event object with a priority level and a message text using the prioritizer p
. Sets the initial priority code minimum to v
, and the initial list of archivers to s
.
The priority level for events indicating that an internal program function has been called with invalid arguments. Code=7000.
The priority level for events indicating that an internal program function has failed, results may have been lost and recovery is not expected. Code=6000.
The priority level for events indicating that a program has encountered invalid input. The program is expected to recover and continue processing further valid input correctly. Code=5000.
The priority level for events indicating that a program has encountered unexpected input, indicating that an external process may have failed. The program is expected to continue processing further input normally. Code=4000.
The priority level for events indicating exceptional information about the processing of the program useful for diagnosing external processes. Code=2000.
The priority level for events indicating normal information about the processing of the program useful for diagnosing external processes. Code=2000.
The priority level for events describing internal processing of the program for the purpose of diagnosing programming errors. Code=1000.
The priority levels corresponding to events that the basic agent has public methods for journaling.
Additional priority levels corresponding to limit levels in the basic event prioritizer used for completely enabling or disabling all messages. These levels do not have message tags defined.