package async_unix

You can search for identifiers within the package.

in-package search v0.2.0

async_unix
- Async_unix
  - Async_config
  - Clock
    
    Event
    
    Status
    
    Or_timeout
  - Dump_core_on_job_delay
    
    How_to_dump
  - Fd
    
    Close
    
    Kind
  - In_thread
    
    Helper_thread
    
    Priority
    
    When_finished
  - Io_stats
  - LargeFile
  - Log
    
    Blocking
    
    Output
    
    For_testing
    
    Global
    
    For_testing
    
    Global_intf
    
    For_testing
    
    Level
    
    Stable
    
    V1
    
    Make_global
    
    For_testing
    
    Message
    
    Stable
    
    V0
    
    V2
    
    Output
    
    Format
    
    Stable
    
    V1
    
    Reader
    
    Expert
    
    Rotation
    
    Id_intf
  - Overwrite_
  - Print
  - Printf
  - Process
    
    Lines_or_sexp
    
    Output
    
    Stable
    
    V1
  - Reader
    
    For_testing
    
    Id
    
    Hash_queue
    
    Hash_set
    
    Provide_bin_io
    
    X
    
    Provide_of_sexp
    
    X
    
    Map
    
    Key
    
    Provide_bin_io
    
    Key
    
    Provide_hash
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Replace_polymorphic_compare
    
    Set
    
    Elt
    
    Named
    
    Provide_bin_io
    
    Elt
    
    Provide_hash
    
    Elt
    
    Provide_of_sexp
    
    Elt
    
    Table
    
    Provide_bin_io
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Read_result
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Monad_infix
  - Require_explicit_time_source
    
    Clock
    
    Event
    
    Status
    
    Or_timeout
    
    Date
    
    Scheduler
    
    Time
    
    Ofday
    
    Time_ns
    
    Ofday
  - Scheduler
  - Sexp
  - Shutdown
  - Signal
  - Socket
    
    Address
    
    Blocking_sexp
    
    Inet
    
    Blocking_sexp
    
    Show_port_in_test
    
    Unix
    
    Family
    
    Opt
    
    Type
  - Sys
  - Tcp
    
    Bind_to_address
    
    Bind_to_port
    
    Server
    
    Where_to_connect
    
    Where_to_listen
  - Thread_safe
  - Unix
    
    Addr_info
    
    Blocking_sexp
    
    File_kind
    
    Map
    
    Key
    
    Provide_bin_io
    
    Key
    
    Provide_hash
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Replace_polymorphic_compare
    
    Set
    
    Elt
    
    Named
    
    Provide_bin_io
    
    Elt
    
    Provide_hash
    
    Elt
    
    Provide_of_sexp
    
    Elt
    
    Group
    
    Fields
    
    Direct
    
    Host
    
    Inet_addr
    
    Lock
    
    Lock_mechanism
    
    Lock_mode
    
    Name_info
    
    Passwd
    
    Fields
    
    Direct
    
    Private
    
    Wait
    
    Protocol_family
    
    Socket
    
    Address
    
    Blocking_sexp
    
    Inet
    
    Blocking_sexp
    
    Show_port_in_test
    
    Unix
    
    Family
    
    Opt
    
    Type
    
    Stats
    
    Fields
    
    Direct
    
    Terminal_io
  - Writer
    
    Backing_out_channel
    
    Destroy_or_keep
    
    Flush_result
    
    Id
    
    Hash_queue
    
    Hash_set
    
    Provide_bin_io
    
    X
    
    Provide_of_sexp
    
    X
    
    Map
    
    Key
    
    Provide_bin_io
    
    Key
    
    Provide_hash
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Replace_polymorphic_compare
    
    Set
    
    Elt
    
    Named
    
    Provide_bin_io
    
    Elt
    
    Provide_hash
    
    Elt
    
    Provide_of_sexp
    
    Elt
    
    Table
    
    Provide_bin_io
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Line_ending
    
    Terminate_with
async_unix.thread_pool
- Thread_pool
  - Helper_thread
  - Priority
async_unix.thread_safe_ivar
- Thread_safe_ivar
async_unix.thread_safe_pipe
- Thread_safe_pipe
  - If_closed
  - Written_or_closed

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t

Description of boundaries for file rotation.

If all fields are None the file will never be rotated. Any field set to Some will cause rotation to happen when that boundary is crossed. Multiple boundaries may be set. Log rotation always causes incrementing rotation conditions (e.g., size) to reset.

The condition keep is special and does not follow the rules above. When a log is rotated, keep is examined and logs that do not fall under its instructions are deleted. This deletion takes place on rotation only, and so may not happen. The meaning of keep options are:

`All -- never delete
`Newer_than span -- delete files with a timestamp older than Time.sub (Time.now ()) span. This normally means keeping files that contain at least one message logged within span. If span is short enough this option can delete a just-rotated file.
`At_least i -- keep the i most recent files

Log rotation does not support symlinks, and you're encouraged to avoid them in production applications. Issues with symlinks:

You can't tail symlinks without being careful (e.g., you must remember to pass -F to `tail`).
Symlinks are hard to reason about when the program crashes, especially on startup (i.e., is the symlink pointing me at the right log file?).
Atomicity is hard.
Symlinks encourage tailing, which is a bad way to communicate information.
They complicate archiving processes (the symlink must be skipped).

val sexp_of_t : t -> Sexplib0.Sexp.t

module type Id_intf = sig ... end

val create : 
  ?messages:int ->
  ?size:Core.Byte_units.t ->
  ?time:Time_unix.Ofday.t ->
  ?zone:Time_unix.Zone.t ->
  keep:[ `All | `Newer_than of Time_unix.Span.t | `At_least of int ] ->
  naming_scheme:
    [ `Numbered | `Timestamped | `Dated | `User_defined of (module Id_intf) ] ->
  unit ->
  t

val default : ?zone:Time_unix.Zone.t -> unit -> t

Sane defaults for log rotation.

Writes dated log files. Files are rotated every time the day changes in the given zone (uses the machine's zone by default). If the dated log file already exists, it's appended to.

Logs are never deleted. Best practice is to have an external mechanism archive old logs for long-term storage.