package tezos-base

You can search for identifiers within the package.

in-package search v0.2.0

tezos-base
- Tezos_base
  - Block_header
  - Block_locator
  - Bounded
    
    BOUNDS
    
    Int16
    
    B
    
    Int31
    
    B
    
    Int32
    
    B
    
    Int64
    
    B
    
    Int8
    
    B
    
    Non_negative_int32
    
    S
    
    Uint16
    
    B
    
    Uint8
    
    B
  - Dal_srs
  - Data_encoding_wrapper
  - Distributed_db_version
    
    Name
  - Fitness
  - Genesis
    
    Parameters
  - Internal_event_config
  - Mempool
  - Network_version
  - Operation
  - P2p_addr
  - P2p_connection
    
    Id
    
    Info
    
    Map
    
    P2p_event
    
    Set
    
    Table
  - P2p_identity
  - P2p_peer
    
    Error_table
    
    Filter
    
    Info
    
    Pool_event
    
    State
  - P2p_peer_id
    
    Error_table
    
    Map
    
    Set
    
    Table
    
    WeakRingTable
    
    H
  - P2p_point
    
    Filter
    
    Id
    
    Info
    
    Map
    
    Pool_event
    
    Set
    
    State
    
    Table
  - P2p_rejection
  - P2p_stat
  - P2p_version
  - Point_parser
  - Protocol
    
    Meta
  - S
    
    HASHABLE
    
    T
  - Sized
    
    MakeSizedMap
    
    Map
    
    MakeSizedSet
    
    Set
    
    SizedMap
    
    SizedSet
  - Test_chain_status
  - Time
    
    Protocol
    
    System
    
    Map
    
    Set
    
    Span
    
    Table
  - TzPervasives
    
    Bytes
    
    Empty
    
    Filename
    
    Infix
    
    Legacy_monad_globals
    
    List
    
    Lwt_result_syntax
    
    Lwt_syntax
    
    Result_syntax
    
    String
    
    Hashtbl
    
    Map
    
    Set
    
    TzTrace
    
    Wrapped_error_monad
  - User_activated
  - Worker_intf
    
    NAME
    
    REQUEST
    
    TYPES
    
    VIEW
  - Worker_types
tezos-base.p2p-identity-file
- Tezos_base_p2p_identity_file
  - Identity_file
tezos-base.unix
- Tezos_base_unix

Legend:
Library
Module
Module type
Parameter
Class
Class type

Configure the event-logging framework for UNIx-based applications.

The JSON-file-friendly definition of the configuration of the internal-events framework. It allows one to activate registered event sinks.

module Configuration : sig ... end

val env_var_name : string

This is the environment variable name that contains the a list of URIs on which events can be reported (see init).

val init : 
  ?log_cfg:Tezos_stdlib_unix.Lwt_log_sink_unix.cfg ->
  ?internal_events:Tezos_base.Internal_event_config.t ->
  unit ->
  unit Lwt.t

Initialize the internal-event sinks by looking at the ?internal_events argument and then at the (whitespace separated) list of URIs in the "TEZOS_EVENTS_CONFIG" environment variable, if an URI does not have a scheme it is expected to be a path to a configuration JSON file (cf. Configuration.of_file), e.g.: export TEZOS_EVENTS_CONFIG="unix-files:///tmp/events-unix debug://", or export TEZOS_EVENTS_CONFIG="debug:// /path/to/config.json".

The function also initializes the Lwt_log_sink_unix module (corresponding to the "TEZOS_LOG" environment variable).

internal_events is the value of configured sinks of command calling init.

log_cfg is the configuration specific to the default sinks if applicable.

val close : unit -> unit Lwt.t

Call close on all the sinks.

make_with_defaults ?enable_default_daily_logs_at ?internal_events creates internal event configuration using default values depending on parameters.

If internal_events is provided, nothing is modified. Otherwise default values are used.

enable_default_daily_logs_at adds daily rotating sink at the given path with the following value: "file-descriptor-path:///<daily_logs_path>/daily.log ?create-dirs=true&daily-logs=7&section-prefix=info&format=pp"

val make_with_defaults : 
  ?internal_events:Tezos_base.Internal_event_config.t ->
  ?enable_default_daily_logs_at:string ->
  unit ->
  Tezos_base.Internal_event_config.t

val init_with_defaults : 
  ?internal_events:Tezos_base.Internal_event_config.t ->
  ?enable_default_daily_logs_at:string ->
  ?log_cfg:Tezos_stdlib_unix.Lwt_log_sink_unix.cfg ->
  unit ->
  unit Lwt.t

Calls init with the same arguments as make_with_defaults