package easy_logging

  1. Overview
  2. Docs

Module Handlers.FileHandlerSource

Module to create handlers that output to a file.

Sourcetype config = {
  1. logs_folder : string;
    (*

    Path in which logs files will be written.

    *)
  2. truncate : bool;
    (*

    Truncate/append if file already exists.

    *)
  3. file_perms : int;
    (*

    Unix file permissions.

    *)
  4. date_prefix : string option;
    (*

    Optional date prefix format string.

    *)
  5. versioning : int option;
    (*

    Optionaly generate new file name.

    *)
  6. suffix : string;
    (*

    Constant suffix.

    *)
}

Configuration when creating a file handler.

  • The date_prefix value is an optional Calender Printer String (as specified in the Calendar documentation), that will format the time at which the handler is created, and used as a prefix.
  • If the versioning value is not None, a versionning number is appended to the filename, based on already existing files. The integer gives the padding of versionning numbers. THIS OPTION MIGHT DISAPPEAR IN FUTURE RELEASES.
Sourceval default_config : config
Sourceval generate_prefix : config -> string
Sourceval generate_filename : config -> string -> string
Sourceval create_file : config -> string -> out_channel
Sourceval make : ?config:??? -> Easy_logging__.Logging_types.level -> string -> t

make ~config level filename_base creates a Handler that will output logs to the file created from filename_base and config

Sourceval make_rotating : ?config:??? -> Easy_logging__.Logging_types.level -> string -> int -> int -> t

make_rotating ~config level filename_base max_kbytes backup_count creates a Handler that will output logs to a rotating set of files. The files are from filename_base and config. When the size of a log file is about to exceed max_kbytes kb, a new file is created, and older log files are renamed. See the python RotatingFileHandler.