Module Std.Log

module Log: Log

module Level: sig .. end

module Message: sig .. end

module Rotation: sig .. end

module Output: sig .. end

module type Global_intf = sig .. end

module Blocking: sig .. end

module Make_global: functor (Empty : sig
end) -> Global_intf

module Global: Global_intf

type t

val set_level : t -> Level.t -> unit

set_level sets the level of the given log. Messages sent at a level less than the current level will not be output.

val set_output : t -> Output.t list -> unit

set_output changes the output type of the log, which can be useful when daemonizing. The new output type will be applied to all subsequent messages.

val close : t -> unit

close closes a log so that further write attempts will raise an error.

val flushed : t -> unit Import.Deferred.t

flushed returns a Deferred.t that is fulfilled when the last message delivered to t before the call to flushed is out the door.

val create : level:Level.t -> output:Output.t list -> t

create create a new log

val raw : ?tags:(string * string) list ->
       t -> ('a, unit, string, unit) Pervasives.format4 -> 'a

raw printf like logging for raw (no level) messages. Raw messages are still output with a timestamp.

val info : ?tags:(string * string) list ->
       t -> ('a, unit, string, unit) Pervasives.format4 -> 'a

info printf like logging at the `Info log level

val error : ?tags:(string * string) list ->
       t -> ('a, unit, string, unit) Pervasives.format4 -> 'a

error printf like logging at the `Info log level

val debug : ?tags:(string * string) list ->
       t -> ('a, unit, string, unit) Pervasives.format4 -> 'a

error printf like logging at the `Info log level

val printf : ?tags:(string * string) list ->
       ?level:Level.t ->
       t -> ('a, unit, string, unit) Pervasives.format4 -> 'a

printf generalized printf style logging

val sexp : ?tags:(string * string) list ->
       ?level:Level.t -> t -> 'a -> ('a -> Core.Std.Sexp.t) -> unit

sexp logging of values without first converting them to a string. In the case where the log level would discard this message no conversion will ever be done.

val of_lazy : ?tags:(string * string) list ->
       ?level:Level.t -> t -> string Core.Std.Lazy.t -> unit

of_lazy logging of lazy values. In the case where the log level would discard this message no evaluation will ever be forced.

val message : t -> Message.t -> unit

module Reader: sig .. end

val ounit_tests : unit -> OUnit.test

create f returns a t, given a function that actually performs the final output work. It is the responsibility of the write function to contain all state, and to clean up after itself when it is garbage collected (which may require a finalizer).

The "stock" output modules support a sexp and bin_prot output format, and other output modules should make efforts to support them as well where it is meaningful/appropriate to do so.

The unit Deferred returned by the function should not be fulfilled until the all of the messages in the given queue are completely handled (e.g. written to disk).

logging functions as the functions that operate on a given log. In this case they operate on a single log global to the module

raw printf like logging for raw (no level) messages. Raw messages are still output with a timestamp.

info printf like logging at the `Info log level

error printf like logging at the `Info log level

error printf like logging at the `Info log level

set_level sets the level of the given log. Messages sent at a level less than the current level will not be output.

set_output changes the output type of the log, which can be useful when daemonizing. The new output type will be applied to all subsequent messages.

close closes a log so that further write attempts will raise an error.

flushed returns a Deferred.t that is fulfilled when the last message delivered to t before the call to flushed is out the door.

create create a new log

raw printf like logging for raw (no level) messages. Raw messages are still output with a timestamp.

info printf like logging at the `Info log level

error printf like logging at the `Info log level

error printf like logging at the `Info log level

printf generalized printf style logging

sexp logging of values without first converting them to a string. In the case where the log level would discard this message no conversion will ever be done.

of_lazy logging of lazy values. In the case where the log level would discard this message no evaluation will ever be forced.