package orsetto

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

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.

type invalid = [
  1. | `Invalid
]

The priority level for events indicating that an internal program function has been called with invalid arguments. Code=7000.

type fail = [
  1. | `Fail
]

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.

type error = [
  1. | `Error
]

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.

type warn = [
  1. | `Warn
]

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.

type notice = [
  1. | `Notice
]

The priority level for events indicating exceptional information about the processing of the program useful for diagnosing external processes. Code=2000.

type info = [
  1. | `Info
]

The priority level for events indicating normal information about the processing of the program useful for diagnosing external processes. Code=2000.

type debug = [
  1. | `Debug
]

The priority level for events describing internal processing of the program for the purpose of diagnosing programming errors. Code=1000.

type basic = [
  1. | invalid
  2. | fail
  3. | error
  4. | warn
  5. | notice
  6. | info
  7. | debug
]

The priority levels corresponding to events that the basic agent has public methods for journaling.

type enable = [
  1. | `None
  2. | `All
]

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.

type level = [
  1. | basic
  2. | enable
]

The sum of all basic priority levels.