package vlt

  1. Overview
  2. Docs
A variant of Bolt logging tool

Install 

dune-project
 Dependency

github.com Readme Edit opam file Versions (3)

Authors

  1. X
    Xavier Clerc
  2. C
    Codinuum

Maintainers

  1. C
    codinuum@me.com

Sources

v0.2.5.tar.gz
sha256=756a6cba94204cda45ee767ca5f7e52ec321873dd53de48025c32dba1e03de24
md5=c0f22efcafa1119a9c82ffd9d7422da2

doc/vlt/Vlt/Filter/index.html

Module Vlt.FilterSource

This module defines the concept of filter, that is predicate over an event. It is possible to register new filters through the register function. Initially, all the filters defined in this file are registered (using the function name as the registration name).

Definitions
Sourcetype t = Event.t -> bool

The type of event filters.

A filter should return true iff the passed event is of interest.

Sourceval register : string -> t -> unit

register n f registers the filter f with name n, replacing any existing filter with the same name.

Sourceval register_unnamed : t -> string

Similar to register except that an unused name is generated and returned.

Sourceval get : string -> t

get n returns the filter registered with name n.

Raises Not_found if no filter exists with the passed name.

Trivial filters
Sourceval all : t

Filter that always returns true.

Sourceval none : t

Filter that always returns false.

Time filters
Sourceval before : int -> t

before t returns a filter that returns true iff relative time of the event is strictly below t.

Sourceval after : int -> t

after t returns a filter that returns true iff relative time of the event is strictly above t.

Level filters
Sourceval trace_or_below : t

Filter that returns true iff level is Level.TRACE or below.

Sourceval debug_or_below : t

Filter that returns true iff level is Level.DEBUG or below.

Sourceval info_or_below : t

Filter that returns true iff level is Level.INFO or below.

Sourceval warn_or_below : t

Filter that returns true iff level is Level.WARN or below.

Sourceval error_or_below : t

Filter that returns true iff level is Level.ERROR or below.

Sourceval fatal_or_below : t

Filter that returns true iff level is Level.FATAL or below.

Sourceval trace_or_above : t

Filter that returns true iff level is Level.TRACE or above.

Sourceval debug_or_above : t

Filter that returns true iff level is Level.DEBUG or above.

Sourceval info_or_above : t

Filter that returns true iff level is Level.INFO or above.

Sourceval warn_or_above : t

Filter that returns true iff level is Level.WARN or above.

Sourceval error_or_above : t

Filter that returns true iff level is Level.ERROR or above.

Sourceval fatal_or_above : t

Filter that returns true iff level is Level.FATAL or above.

Sourceval level_below : Level.t -> t

level_equal l returns a filter that return true iff the level is below l.

Sourceval level_above : Level.t -> t

level_equal l returns a filter that return true iff the level is above l.

Sourceval level_equal : Level.t -> t

level_equal l returns a filter that return true iff the level is equal to l.

Logger filters
Sourceval logger_equal : Name.t -> t

logger_equal l returns a filter that returns true iff logger is equal to l.

Sourceval logger_not_equal : Name.t -> t

logger_not_equal l returns a filter that returns true iff logger is different from l.

File filters
Sourceval file_defined : t

Filter that returns true iff file is different from "", and "<nofile>".

Sourceval file_undefined : t

Filter that returns true iff file is equal to "", or "<nofile>".

Sourceval file_equal : string -> t

file_equal f returns a filter that returns true iff file is equal to f.

Sourceval file_not_equal : string -> t

file_not_equal f returns a filter that returns true iff file is different from f.

Position filters
Sourceval line_defined : t

Filter that returns true iff line is above 0.

Sourceval line_undefined : t

Filter that returns true iff line is not above 0.

Sourceval column_defined : t

Filter that returns true iff column is above 0.

Sourceval column_undefined : t

Filter that returns true iff column is not above 0.

Message filters
Sourceval message_defined : t

Filter that returns true iff message is different from "".

Sourceval message_undefined : t

Filter that returns true iff message is equal to "".

Sourceval message_paje : t

Filter that return true iff the message is a Pajé one.

Sourceval message_not_paje : t

Filter that return true iff the message is not a Pajé one.

Sourceval message_daikon : t

Filter that return true iff the message is a Daikon one.

Sourceval message_not_daikon : t

Filter that return true iff the message is not a Daikon one.

Property filters
Sourceval properties_empty : t

Filter that returns true iff property list is empty.

Sourceval properties_not_empty : t

Filter that returns true iff property list is not empty.

Sourceval property_defined : string -> t

property_defined n returns a filter that returns true iff the property named n is defined.

Sourceval property_undefined : string -> t

property_undefined n returns a filter that returns true iff the property named n is not defined.

Sourceval property_equal : string -> string -> t

property_equal n v returns a filter that returns true iff the property named n is defined and has value v.

Sourceval property_not_equal : string -> string -> t

property_not_equal n v returns a filter that returns true iff the property named n is defined and has a value different from v, or is not defined.

Sourceval property_equal_pred : string -> (string -> bool) -> t

property_equal_pred n p returns a filter that returns true iff the property named n is defined with value v, and p v equals true.

Sourceval property_not_equal_pred : string -> (string -> bool) -> t

property_not_equal_pred n p returns a filter that returns true iff the property named n is defined with value v and p v equals false, or is not defined.

Exception filters
Sourceval exception_some : t

Filter that returns true iff error matches Some _.

Sourceval exception_none : t

Filter that returns true iff error is equal to None.

Combinators over filters
Sourceval logand : t -> t -> t

Constructs a filter that is the conjunction of the passed ones.

Sourceval (&&&) : t -> t -> t

Shorthand for logand.

Sourceval logor : t -> t -> t

Constructs a filter that is the disjunction of the passed ones.

Sourceval (|||) : t -> t -> t

Shorthand for logor.

Sourceval logxor : t -> t -> t

Constructs a filter that is the exclusive disjunction of the passed ones.

Sourceval (^^^) : t -> t -> t

Shorthand for logxor.

Sourceval not : t -> t

Constructs a filter that is the negation of the passed one.

Sourceval for_all : t list -> t

Constructs a filter that returns true iff all the filters from the list return true.

Sourceval (!&&&) : t list -> t

Shorthand for for_all.

Sourceval exists : t list -> t

Constructs a filter that returns true iff at least one filter from the list returns true.

Sourceval (!|||) : t list -> t

Shorthand for exists.