package octez-libs

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

Source file logs_simple_config.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
(*****************************************************************************)
(*                                                                           *)
(* Open Source License                                                       *)
(* Copyright (c) 2018 Dynamic Ledger Solutions, Inc. <contact@tezos.com>     *)
(* Copyright (c) 2023 Nomadic Labs, <contact@nomadic-labs.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.                                                 *)
(*                                                                           *)
(*****************************************************************************)

module Output = struct
  type t = Null | Stdout | Stderr | File of string | Syslog of Syslog.facility

  let to_string : t -> string = function
    | Null -> "/dev/null"
    | Stdout -> "stdout"
    | Stderr -> "stderr"
    | File fp -> fp
    | Syslog Auth -> "syslog:auth"
    | Syslog Authpriv -> "syslog:authpriv"
    | Syslog Cron -> "syslog:cron"
    | Syslog Daemon -> "syslog:daemon"
    | Syslog FTP -> "syslog:ftp"
    | Syslog Kernel -> "syslog:kernel"
    | Syslog Local0 -> "syslog:local0"
    | Syslog Local1 -> "syslog:local1"
    | Syslog Local2 -> "syslog:local2"
    | Syslog Local3 -> "syslog:local3"
    | Syslog Local4 -> "syslog:local4"
    | Syslog Local5 -> "syslog:local5"
    | Syslog Local6 -> "syslog:local6"
    | Syslog Local7 -> "syslog:local7"
    | Syslog LPR -> "syslog:lpr"
    | Syslog Mail -> "syslog:mail"
    | Syslog News -> "syslog:news"
    | Syslog Syslog -> "syslog:syslog"
    | Syslog User -> "syslog:user"
    | Syslog UUCP -> "syslog:uucp"
    | Syslog NTP -> "syslog:ntp"
    | Syslog Security -> "syslog:security"
    | Syslog Console -> "syslog:console"

  let of_string : string -> t = function
    | "/dev/null" | "null" -> Null
    | "stdout" -> Stdout
    | "stderr" -> Stderr
    | "syslog:auth" -> Syslog Auth
    | "syslog:authpriv" -> Syslog Authpriv
    | "syslog:cron" -> Syslog Cron
    | "syslog:daemon" -> Syslog Daemon
    | "syslog:ftp" -> Syslog FTP
    | "syslog:kernel" -> Syslog Kernel
    | "syslog:local0" -> Syslog Local0
    | "syslog:local1" -> Syslog Local1
    | "syslog:local2" -> Syslog Local2
    | "syslog:local3" -> Syslog Local3
    | "syslog:local4" -> Syslog Local4
    | "syslog:local5" -> Syslog Local5
    | "syslog:local6" -> Syslog Local6
    | "syslog:local7" -> Syslog Local7
    | "syslog:lpr" -> Syslog LPR
    | "syslog:mail" -> Syslog Mail
    | "syslog:news" -> Syslog News
    | "syslog:syslog" -> Syslog Syslog
    | "syslog:user" -> Syslog User
    | "syslog:uucp" -> Syslog UUCP
    | "syslog:ntp" -> Syslog NTP
    | "syslog:security" -> Syslog Security
    | "syslog:console" -> Syslog Console
    (* | s when start_with "syslog:" FIXME error or warning. *)
    | fp ->
        (* TODO check absolute path *)
        File fp

  let encoding =
    let open Data_encoding in
    conv to_string of_string string

  let of_string str =
    try Some (Data_encoding.Json.destruct encoding (`String str))
    with _ -> None

  let to_string output =
    match Data_encoding.Json.construct encoding output with
    | `String res -> res
    | #Data_encoding.json -> assert false

  let pp fmt output = Format.fprintf fmt "%s" (to_string output)
end

type cfg = {
  output : Output.t;
  default_level : Internal_event.level;
  rules : string option;
  colors : bool;
}

let create_cfg ?(output = Output.Stderr)
    ?(default_level = Internal_event.Notice) ?(colors = true) ?rules () =
  {output; default_level; rules; colors}

let default_cfg = create_cfg ()

let cfg_encoding =
  let open Data_encoding in
  conv
    (fun {output; default_level; rules; colors} ->
      (output, default_level, colors, rules))
    (fun (output, default_level, colors, rules) ->
      {output; default_level; rules; colors})
    (obj4
       (dft
          "output"
          ~description:
            "Output for the logging function. Either 'stdout', 'stderr' or the \
             name of a log file ."
          Output.encoding
          default_cfg.output)
       (dft
          "level"
          ~description:
            "Verbosity level: one of 'fatal', 'error', 'warn','notice', \
             'info', 'debug'."
          Internal_event.Level.encoding
          default_cfg.default_level)
       (dft
          "colors"
          ~description:"Enables light coloring in logs."
          Data_encoding.bool
          default_cfg.colors)
       (opt
          "rules"
          ~description:
            "Fine-grained logging instructions. Same format as described in \
             `octez-node run --help`, DEBUG section. In the example below, \
             sections 'p2p' and all sections starting by 'client' will have \
             their messages logged up to the debug level, whereas the rest of \
             log sections will be logged up to the notice level."
          string))
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