package ephemeral

  1. Overview
  2. Docs

Source file logging.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
(** logging.ml - Custom logging and error messages *)

(** Represents the severity of a log statement *)
type log_type =
  | Log_None
  | Log_Debug
  | Log_Info
  | Log_Warning
  | Log_Error
  | Log_Critical

let _GLOBAL_LOG_LEVEL = Log_Info

(** Follows the order in the type definition, \[0:5\]*)
let int_of_log = function
  | Log_Debug ->
      1
  | Log_Info ->
      2
  | Log_Warning ->
      3
  | Log_Error ->
      4
  | Log_Critical ->
      5
  | Log_None ->
      0

(** For exits, their appropriate return code and the message type *)
type return_code = int * string

let rc_Ok = (0, "OK")

and rc_Error = (1, "ERROR")

and rc_Parsing = (2, "PARSING")

(** ANSI encoding for bold text *)
let ansi_bold = "\x1b[1m"

(** ANSI encoding for red text *)
let ansi_red = "\x1b[38:5:196m"

(** ANSI encoding for orange text *)
let ansi_orange = "\x1b[38:5:208m"

(** ANSI encoding for yellow text *)
let ansi_yellow = "\x1b[38:5:178m"

(** ANSI encoding for plain text *)
let ansi_reset = "\x1b[0m"

(** ANSI encoding for bold red text *)
let error_red = ansi_bold ^ ansi_red

(** ANSI encoding for bold orange text *)
let error_orange = ansi_bold ^ ansi_orange

(** ANSI encoding for bold yellow text *)
let error_yellow = ansi_bold ^ ansi_yellow

(** Gets the string representation of a {!log_type}*)
let string_of_log = function
  | Log_Debug ->
      ansi_bold ^ "[DEBUG]"
  | Log_Info ->
      ansi_bold ^ "[INFO]"
  | Log_Warning ->
      ansi_yellow ^ "[WARNING]"
  | Log_Error ->
      ansi_orange ^ "[ERROR]"
  | Log_Critical ->
      ansi_red ^ "[CRITICAL]"
  | Log_None ->
      ansi_reset ^ "[NONE]"

(** A fatal log statement that immediately exits the program *)
let fatal rc fmt =
  Printf.ksprintf
    (fun msg ->
      Printf.fprintf stderr
        "%s[%s] - %s%s\n----------------------------------------\n" error_red
        (snd rc) ansi_reset msg ;
      flush stderr ;
      exit (fst rc) )
    fmt

(** Prints log statements to stdout/stderr *)
let _log log_level fmt =
  if log_level = Log_None || int_of_log _GLOBAL_LOG_LEVEL > int_of_log log_level
  then
    Printf.ksprintf (fun _ -> ()) fmt
  else
    Printf.ksprintf
      (fun msg ->
        let stream =
          if log_level = Log_Debug || log_level = Log_Info then
            stdout
          else
            stderr
        in
        Printf.fprintf stream "LOG:%s%s - %s\n" (string_of_log log_level)
          ansi_reset msg ;
        flush stream )
      fmt

let err fmt = _log Log_Error fmt