package octez-libs

  1. Overview
  2. Docs
package octez-libs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file internal_event_unix.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
(*****************************************************************************)
(*                                                                           *)
(* Open Source License                                                       *)
(* Copyright (c) 2018 Dynamic Ledger Solutions, Inc. <contact@tezos.com>     *)
(*                                                                           *)
(* Permission is hereby granted, free of charge, to any person obtaining a   *)
(* copy of this software and associated documentation files (the "Software"),*)
(* to deal in the Software without restriction, including without limitation *)
(* the rights to use, copy, modify, merge, publish, distribute, sublicense,  *)
(* and/or sell copies of the Software, and to permit persons to whom the     *)
(* Software is furnished to do so, subject to the following conditions:      *)
(*                                                                           *)
(* The above copyright notice and this permission notice shall be included   *)
(* in all copies or substantial portions of the Software.                    *)
(*                                                                           *)
(* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR*)
(* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,  *)
(* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL   *)
(* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER*)
(* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING   *)
(* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER       *)
(* DEALINGS IN THE SOFTWARE.                                                 *)
(*                                                                           *)
(*****************************************************************************)

open Tezos_error_monad.TzLwtreslib
open Tezos_event_logging
open Error_monad

module Configuration = struct
  include Tezos_base.Internal_event_config

  let of_file path =
    let open Lwt_result_syntax in
    let* json = Lwt_utils_unix.Json.read_file path in
    protect (fun () -> return (Data_encoding.Json.destruct encoding json))
end

(* FIXME https://gitlab.com/tezos/tezos/-/issues/4837

   This environment variable is problematic when the octez-node in not
   run with [Singleprocess]. *)
let env_var_name = "TEZOS_EVENTS_CONFIG"

module Event = struct
  include Internal_event.Simple

  let section = ["internal_event_unix"]

  let loaded_from_env =
    declare_2
      ~section
      ~name:"uri_loaded_from_env"
      ~msg:"Loaded URIs from environment"
      ~level:Notice
      ("variable", Data_encoding.string)
      ("value", Data_encoding.string)
end

let init_raw ~internal_events () =
  let _ =
    (* This is just here to force the linking (and hence
       initialization) of all these modules: *)
    [
      File_descriptor_sink.Sink_implementation_path.uri_scheme;
      File_event_sink.Sink_implementation.uri_scheme;
    ]
  in
  let open Lwt_result_syntax in
  let*! r =
    let* () =
      match Sys.(getenv_opt env_var_name) with
      | None -> return_unit
      | Some s ->
          let uris =
            TzString.split_no_empty ' ' s
            |> List.concat_map (TzString.split_no_empty '\n')
            |> List.concat_map (TzString.split_no_empty '\t')
            |> List.filter (( <> ) "")
            |> List.map Uri.of_string
          in
          let* () =
            List.iter_es
              (fun uri ->
                match Uri.scheme uri with
                | None ->
                    let* cfg = Configuration.of_file (Uri.path uri) in
                    Internal_event_config.apply cfg
                | Some _ -> Internal_event.All_sinks.activate uri)
              uris
          in
          let*! () = Event.(emit loaded_from_env (env_var_name, s)) in
          return_unit
    in
    Configuration.apply internal_events
  in
  match r with
  | Ok () -> Lwt.return_unit
  | Error el ->
      Format.kasprintf
        Lwt.fail_with
        "ERROR@ Initializing Internal_event_unix:@ %a\n%!"
        Error_monad.pp_print_trace
        el

let close () =
  let open Lwt_syntax in
  let* r = Internal_event.All_sinks.close () in
  match r with
  | Ok () -> Lwt.return_unit
  | Error el ->
      Format.kasprintf
        Lwt.fail_with
        "ERROR@ closing Internal_event_unix:@ %a\n%!"
        Error_monad.pp_print_trace
        el

open Filename.Infix

let default_daily_logs_at ~daily_logs_path ~section_prefixes =
  Internal_event_config.make_config_uri
    ~create_dirs:true
    ~daily_logs:7
    ~level:Info
    ~format:"pp-rfc5424"
    ~section_prefixes
    (`Path (daily_logs_path // "daily.log"))

let make_default_internal_events ~rules ~verbosity ~colors
    ~(log_output : Logs_simple_config.Output.t) ~daily_logs_path
    ~daily_logs_section_prefixes =
  (* By default the node has two logs output:
     - on the configured [log_output] using the configured [verbosity] and
       a short pretty printing
     - on disk, with a 7 days rotation with an info verbosity level and a
       standard pretty printing *)
  let origin, rules = Level_config_rules.find_log_rules rules in
  let section_prefixes =
    match rules with
    | Some rules -> (
        try Level_config_rules.parse_rules rules
        with _ ->
          Printf.ksprintf
            Stdlib.failwith
            "Incorrect log rules defined in %s"
            origin)
    | None -> []
  in
  let user_events =
    let kind =
      match log_output with
      | Stdout -> `Stdout
      | Stderr -> `Stderr
      | File fp -> `Path fp
      | Null -> `Null
      | Syslog _ -> `Syslog (Logs_simple_config.Output.to_string log_output)
    in
    Internal_event_config.make_config_uri
      ~level:verbosity
      ~section_prefixes
      ~colors
      ~format:"pp-short"
      kind
  in
  let sinks = [user_events] in
  let sinks =
    match daily_logs_path with
    | Some daily_logs_path ->
        let internal_logs_events =
          default_daily_logs_at
            ~section_prefixes:daily_logs_section_prefixes
            ~daily_logs_path
        in
        internal_logs_events :: sinks
    | None -> sinks
  in
  Internal_event_config.make_custom sinks

let make_with_defaults ?verbosity ?enable_default_daily_logs_at
    ?(daily_logs_section_prefixes = [])
    ?(log_cfg = Logs_simple_config.default_cfg) () =
  make_default_internal_events
    ~rules:log_cfg.rules
    ~verbosity:(Option.value verbosity ~default:log_cfg.default_level)
    ~colors:log_cfg.colors
    ~log_output:log_cfg.output
    ~daily_logs_path:enable_default_daily_logs_at
    ~daily_logs_section_prefixes

let init ?config:(internal_events = make_with_defaults ()) () =
  let open Lwt_syntax in
  let* () = init_raw ~internal_events () in
  return_unit

let enable_default_daily_logs_at ~daily_logs_path =
  let uri = default_daily_logs_at ~section_prefixes:[] ~daily_logs_path in
  Internal_event.All_sinks.activate uri
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct