Source file internal_event.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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
open Error_monad
module List = struct
include List
include Tezos_stdlib.TzList
end
module String = struct
include String
include Tezos_stdlib.TzString
module Set = Tezos_error_monad.TzLwtreslib.Set.Make (String)
end
let valid_char c =
match c with
| '0' .. '9' | 'a' .. 'z' | 'A' .. 'Z' | '@' | '-' | '_' | '+' | '=' | '~' ->
true
| _ -> false
let check_name_exn : string -> (string -> char -> exn) -> unit =
fun name make_exn ->
String.iter
(fun c -> if valid_char c then () else raise (make_exn name c))
name ;
()
type level = Debug | Info | Notice | Warning | Error | Fatal
let default_error_fallback_logger =
ref (fun s ->
Format.eprintf "%s" s ;
Lwt.return_unit)
module Level = struct
type t = level
let default = Info
let to_string = function
| Debug -> "debug"
| Info -> "info"
| Notice -> "notice"
| Warning -> "warning"
| Error -> "error"
| Fatal -> "fatal"
let of_string str =
let str = String.lowercase_ascii str in
match str with
| "debug" -> Some Debug
| "info" -> Some Info
| "notice" -> Some Notice
| "warning" -> Some Warning
| "error" -> Some Error
| "fatal" -> Some Fatal
| _ -> None
let encoding =
let open Data_encoding in
string_enum
(List.map
(fun l -> (to_string l, l))
[Debug; Info; Notice; Warning; Error; Fatal])
include Compare.Make (struct
type nonrec t = t
let compare = Stdlib.compare
end)
end
module Section : sig
type t
include Compare.S with type t := t
val empty : t
val make_sanitized : string list -> t
val name : t -> string
val is_prefix : prefix:t -> t -> bool
val encoding : t Data_encoding.t
val to_string_list : t -> string list
val pp : Format.formatter -> t -> unit
val equal : t -> t -> bool
end = struct
type t = {path : string list}
include Compare.Make (struct
type nonrec t = t
let compare = Stdlib.compare
end)
let empty = {path = []}
let name s = String.concat "." s.path
let make sl =
List.iter
(fun s ->
check_name_exn s (fun name char ->
Printf.ksprintf
(fun s -> Invalid_argument s)
"Internal_event.Section: invalid name %S (contains %c)"
name
char))
sl ;
{path = sl}
let make_sanitized sl =
List.map (String.map (fun c -> if valid_char c then c else '_')) sl |> make
let to_string_list s = s.path
let is_prefix ~prefix main =
try
let _ =
List.fold_left
(fun prev elt ->
match prev with
| t :: q when String.equal t elt -> q
| _ -> raise Not_found)
main.path
prefix.path
in
true
with Not_found -> false
let encoding =
let open Data_encoding in
conv (fun {path; _} -> path) (fun l -> make l) (list string)
let pp fmt section =
Format.fprintf
fmt
"%a"
(Format.pp_print_list
~pp_sep:(fun fmt () -> Format.pp_print_char fmt '.')
Format.pp_print_string)
section.path
end
let registered_sections = ref String.Set.empty
let get_registered_sections () = String.Set.to_seq !registered_sections
let register_section section =
registered_sections :=
String.Set.add (Section.name section) !registered_sections
module type EVENT_DEFINITION = sig
type t
val section : Section.t option
val name : string
val doc : string
val pp : all_fields:bool -> block:bool -> Format.formatter -> t -> unit
val encoding : t Data_encoding.t
val level : level
end
module type EVENT = sig
include EVENT_DEFINITION
val emit : ?section:Section.t -> t -> unit tzresult Lwt.t
end
type 'a event_definition = (module EVENT_DEFINITION with type t = 'a)
module type SINK = sig
type t
val uri_scheme : string
val configure : Uri.t -> t tzresult Lwt.t
val should_handle : ?section:Section.t -> t -> _ event_definition -> bool
val handle :
t -> 'a event_definition -> ?section:Section.t -> 'a -> unit tzresult Lwt.t
val close : t -> unit tzresult Lwt.t
end
type 'a sink_definition = (module SINK with type t = 'a)
module All_sinks = struct
type registered =
| Registered : {
scheme : string;
definition : 'a sink_definition;
}
-> registered
type active =
| Active : {
scheme : string;
configuration : Uri.t;
sink : 'a;
definition : 'a sink_definition;
}
-> active
let registered : registered list ref = ref []
let active : active list ref = ref []
let find_registered scheme_to_find =
List.find
(function Registered {scheme; _} -> String.equal scheme scheme_to_find)
!registered
let register (type a) m =
let module S = (val m : SINK with type t = a) in
match find_registered S.uri_scheme with
| None ->
registered :=
Registered {scheme = S.uri_scheme; definition = m} :: !registered
| Some _ ->
Printf.ksprintf
Stdlib.invalid_arg
"Internal_event: registering duplicate URI scheme: %S"
S.uri_scheme
type activation_error_reason =
| Missing_uri_scheme of string
| Uri_scheme_not_registered of string
type error += Activation_error of activation_error_reason
let () =
let description =
"Activation of an Internal Event SINK with an URI failed"
in
let title = "Internal Event Sink: Wrong Activation URI" in
register_error_kind
`Permanent
~id:"internal-event-activation-error"
~title
~description
~pp:
(fun ppf -> function
| Missing_uri_scheme uri ->
Format.fprintf ppf "%s: Missing URI scheme %S" title uri
| Uri_scheme_not_registered uri ->
Format.fprintf ppf "%s: URI scheme not registered %S" title uri)
Data_encoding.(
union
[
case
~title:"missing-uri-scheme"
(Tag 0)
(obj1 (req "missing-uri-scheme" (obj1 (req "uri" string))))
(function Missing_uri_scheme uri -> Some uri | _ -> None)
(fun uri -> Missing_uri_scheme uri);
case
~title:"non-registered-uri-scheme"
(Tag 2)
(obj1 (req "non-registered-uri-scheme" (obj1 (req "uri" string))))
(function Uri_scheme_not_registered uri -> Some uri | _ -> None)
(fun uri -> Uri_scheme_not_registered uri);
])
(function Activation_error reason -> Some reason | _ -> None)
(fun reason -> Activation_error reason)
let activate uri =
let open Lwt_result_syntax in
match Uri.scheme uri with
| None -> tzfail (Activation_error (Missing_uri_scheme (Uri.to_string uri)))
| Some scheme_to_activate ->
let* act =
match find_registered scheme_to_activate with
| None ->
tzfail
(Activation_error
(Uri_scheme_not_registered (Uri.to_string uri)))
| Some (Registered {scheme; definition}) ->
let activate (type a) scheme definition =
let module S = (val definition : SINK with type t = a) in
let* sink = S.configure uri in
return (Active {scheme; configuration = uri; definition; sink})
in
activate scheme definition
in
active := act :: !active ;
return_unit
let close ?(except = fun _ -> false) () =
let open Lwt_syntax in
let close_one (type a) sink definition =
let module S = (val definition : SINK with type t = a) in
S.close sink
in
let next_active, to_close_list =
List.partition
(fun act ->
match act with Active {configuration; _} -> except configuration)
!active
in
active := next_active ;
let+ close_results =
List.map_s
(fun (Active {sink; definition; _}) -> close_one sink definition)
to_close_list
in
Result_syntax.tzjoin close_results
let handle def section v =
let handle (type a) sink definition =
let open Lwt_result_syntax in
let module S = (val definition : SINK with type t = a) in
if S.should_handle ?section sink def then S.handle ?section sink def v
else return_unit
in
List.iter_es
(function Active {sink; definition; _} -> handle sink definition)
!active
let pp_state fmt () =
let open Format in
let pp_list_of_sinks name list pp =
pp_open_box fmt 2 ;
pp_print_if_newline fmt () ;
pp_print_string fmt "* " ;
fprintf fmt "%s: [" name ;
pp_print_cut fmt () ;
pp_print_list
~pp_sep:(fun fmt () ->
pp_print_string fmt "," ;
pp_print_space fmt ())
pp
fmt
list ;
pp_close_box fmt () ;
pp_print_cut fmt () ;
pp_print_string fmt "]"
in
pp_open_box fmt 0 ;
pp_list_of_sinks
"Registered sinks"
!registered
(fun fmt (Registered {scheme; _}) -> fprintf fmt "\"%s://..\"" scheme) ;
pp_print_break fmt 2 0 ;
pp_list_of_sinks
"Active sinks"
!active
(fun fmt (Active {configuration; _}) ->
fprintf fmt "\"%a\"" Uri.pp_hum configuration) ;
pp_print_cut fmt () ;
pp_close_box fmt () ;
()
end
module Generic = struct
type definition =
| Definition :
(Section.t option * string * 'a event_definition)
-> definition
type event = Event : (string * 'a event_definition * 'a) -> event
type with_name = < doc : string ; name : string >
let json_schema (Definition (_, _, d)) :
< schema : Json_schema.schema ; with_name > =
let aux (type a) (ev : a event_definition) =
let module E = (val ev : EVENT_DEFINITION with type t = a) in
object
method name = E.name
method doc = E.doc
method schema = Data_encoding.Json.schema E.encoding
end
in
aux d
let explode_event (Event (_, def, ev)) =
let aux (type a) def ev =
let module M = (val def : EVENT_DEFINITION with type t = a) in
object
method name = M.name
method doc = M.doc
method pp fmt () = M.pp ~all_fields:true ~block:true fmt ev
method json = Data_encoding.Json.construct M.encoding ev
end
in
aux def ev
end
module All_definitions = struct
open Generic
let all : definition list ref = ref []
let registration_exn fmt =
Format.kasprintf
(fun s ->
Invalid_argument ("Internal_event registration error: " ^ s))
fmt
let add (type a) ev =
let module E = (val ev : EVENT_DEFINITION with type t = a) in
match
List.find
(function Definition (s, n, _) -> E.section = s && E.name = n)
!all
with
| Some _ ->
raise
(registration_exn
"duplicate Event name: %a %S"
(Format.pp_print_option Section.pp)
E.section
E.name)
| None ->
check_name_exn
E.name
(registration_exn "invalid event name: %S contains '%c'") ;
all := Definition (E.section, E.name, ev) :: !all
let get () = !all
let find match_name =
List.find (function Definition (_, n, _) -> match_name n) !all
end
module Make (E : EVENT_DEFINITION) : EVENT with type t = E.t = struct
include E
let emit ?section x = All_sinks.handle (module E) section x
let () = All_definitions.add (module E)
end
module Simple = struct
type 'a t = {name : string; emit : 'a -> unit tzresult Lwt.t}
let emit simple_event parameters =
Lwt.try_bind
(fun () -> simple_event.emit parameters)
(function
| Ok () -> Lwt.return_unit
| Error trace ->
Format.eprintf
"@[<hv 2>Failed to send event '%s':@ %a@]@."
simple_event.name
Error_monad.pp_print_trace
trace ;
Lwt.return_unit)
(fun exc ->
Format.eprintf
"@[<hv 2>Failed to send event '%s':@ %s@]@."
simple_event.name
(Printexc.to_string exc) ;
Lwt.return_unit)
let emit__dont_wait__use_with_care simple_event parameters =
Lwt.dont_wait
(fun () -> emit simple_event parameters)
(fun exc -> raise exc)
let make_section names =
match names with
| None -> None
| Some names ->
let section = Section.make_sanitized names in
register_section section ;
Some section
let pp_print_compact_float fmt value = Format.fprintf fmt "%g" value
let max_shortened_string_length = 64
let ellipsis = "[...]"
let pp_print_shortened_string fmt value =
let len = String.length value in
if len = 0 then Format.pp_print_string fmt "\"\""
else
let escape len =
let rec loop i =
if i >= len then false
else
match value.[i] with
| '\000' .. '\032' | '\127' .. '\255' ->
true
| '\033' .. '\126' ->
loop (i + 1)
in
loop 0
in
if String.length value > max_shortened_string_length then
let length_without_ellipsis =
max_shortened_string_length - String.length ellipsis
in
let prefix = String.sub value 0 length_without_ellipsis in
if escape length_without_ellipsis then
Format.fprintf fmt "\"%s%s\"" prefix ellipsis
else Format.fprintf fmt "%s%s" prefix ellipsis
else if escape len then Format.fprintf fmt "%S" value
else Format.pp_print_string fmt value
let rec pp_human_readable :
'a. never_empty:bool -> 'a Data_encoding.t -> _ -> 'a -> _ =
fun (type a) ~never_empty (encoding : a Data_encoding.t) fmt (value : a) ->
match encoding.encoding with
| Null -> if never_empty then Format.pp_print_string fmt "N/A"
| Empty -> if never_empty then Format.pp_print_string fmt "N/A"
| Ignore -> if never_empty then Format.pp_print_string fmt "N/A"
| Constant name -> pp_print_shortened_string fmt name
| Bool -> Format.pp_print_bool fmt value
| Int8 -> Format.pp_print_int fmt value
| Uint8 -> Format.pp_print_int fmt value
| Int16 _ -> Format.pp_print_int fmt value
| Uint16 _ -> Format.pp_print_int fmt value
| Int31 _ -> Format.pp_print_int fmt value
| Int32 _ -> Format.fprintf fmt "%ld" value
| Int64 _ -> Format.fprintf fmt "%Ld" value
| N -> Format.pp_print_string fmt (Z.to_string value)
| Z -> Format.pp_print_string fmt (Z.to_string value)
| RangedInt _ -> Format.pp_print_int fmt value
| RangedFloat _ -> pp_print_compact_float fmt value
| Float -> pp_print_compact_float fmt value
| Bytes _ -> pp_print_shortened_string fmt (Bytes.to_string value)
| String _ -> pp_print_shortened_string fmt value
| Bigstring _ -> Format.pp_print_string fmt "<bigstring>"
| Padded (encoding, _) -> pp_human_readable ~never_empty encoding fmt value
| String_enum (table, _) -> (
match Stdlib.Hashtbl.find_opt table value with
| None -> if never_empty then Format.pp_print_string fmt "N/A"
| Some (name, _) -> pp_print_shortened_string fmt name)
| Array _ -> if never_empty then Format.pp_print_string fmt "<array>"
| List _ -> if never_empty then Format.pp_print_string fmt "<list>"
| Obj (Req {encoding; _} | Dft {encoding; _}) ->
pp_human_readable ~never_empty encoding fmt value
| Obj (Opt {encoding; _}) ->
Option.iter (pp_human_readable ~never_empty encoding fmt) value
| Objs _ -> if never_empty then Format.pp_print_string fmt "<obj>"
| Tup encoding -> pp_human_readable ~never_empty encoding fmt value
| Tups _ -> if never_empty then Format.pp_print_string fmt "<tuple>"
| Union
{
cases =
[
Case {encoding; proj; _};
Case {encoding = {encoding = Null; _}; _};
];
_;
} -> (
match proj value with
| None -> if never_empty then Format.pp_print_string fmt "null"
| Some value -> pp_human_readable ~never_empty encoding fmt value)
| Union _ -> if never_empty then Format.pp_print_string fmt "<union>"
| Mu _ -> if never_empty then Format.pp_print_string fmt "<recursive>"
| Conv {proj; encoding; _} ->
pp_human_readable ~never_empty encoding fmt (proj value)
| Describe {encoding; _} ->
pp_human_readable ~never_empty encoding fmt value
| Splitted {json_encoding; _} -> (
match Json_encoding.construct json_encoding value with
| `Null -> if never_empty then Format.pp_print_string fmt "N/A"
| `Bool value -> Format.pp_print_bool fmt value
| `Float value -> pp_print_compact_float fmt value
| `String value -> pp_print_shortened_string fmt value
| `A _ -> if never_empty then Format.pp_print_string fmt "<list>"
| `O _ -> if never_empty then Format.pp_print_string fmt "<obj>")
| Dynamic_size {encoding; _} ->
pp_human_readable ~never_empty encoding fmt value
| Check_size {encoding; _} ->
pp_human_readable ~never_empty encoding fmt value
| Delayed make_encoding ->
pp_human_readable ~never_empty (make_encoding ()) fmt value
type parameter =
| Parameter :
string
* 'a Data_encoding.t
* 'a
* (Format.formatter -> 'a -> unit) option
-> parameter
type msg_atom = Text of string | Variable of int | Space
let invalid_msg reason msg =
invalid_arg
(Printf.sprintf
"Internal_event.Simple: invalid message string: %S: %s"
msg
reason)
let parse_msg variable_names msg =
let len = String.length msg in
let rec find_variable_begin acc atom_start i =
let add_text () =
if i <= atom_start then acc
else Text (String.sub msg atom_start (i - atom_start)) :: acc
in
if i >= len then add_text ()
else if msg.[i] = '{' then
let acc = add_text () in
let i = i + 1 in
find_variable_end acc i i
else if msg.[i] = ' ' then
let acc = Space :: add_text () in
let i = i + 1 in
find_variable_begin acc i i
else find_variable_begin acc atom_start (i + 1)
and find_variable_end acc atom_start i =
if i >= len then invalid_msg "unmatched '{'" msg
else if msg.[i] = '}' then
let variable_name = String.sub msg atom_start (i - atom_start) in
let rec loop index = function
| [] ->
invalid_msg
(Printf.sprintf "unbound variable: %S" variable_name)
msg
| varname :: _ when String.equal varname variable_name ->
let acc = Variable index :: acc in
let i = i + 1 in
find_variable_begin acc i i
| _ :: variable_names -> loop (index + 1) variable_names
in
loop 0 variable_names
else find_variable_end acc atom_start (i + 1)
in
find_variable_begin [] 0 0 |> List.rev
let pp_log_message ~all_fields ~block (msg : msg_atom list) fmt fields =
let fields = List.map (fun field -> (field, ref false)) fields in
if block then Format.fprintf fmt "@[<hov 2>" ;
let pp_msg_atom = function
| Text text -> Format.pp_print_string fmt text
| Variable index -> (
match List.nth_opt fields index with
| None ->
Format.pp_print_string fmt "???"
| Some (Parameter (_name, enc, value, pp), used) -> (
used := true ;
match pp with
| None -> pp_human_readable ~never_empty:true enc fmt value
| Some pp -> pp fmt value))
| Space ->
if block then Format.pp_print_space fmt () else Format.fprintf fmt " "
in
List.iter pp_msg_atom msg ;
let first_field = ref true in
let print_field (Parameter (name, enc, value, pp), used) =
if not !used then
let value =
let pp =
match pp with
| None -> pp_human_readable ~never_empty:false enc
| Some pp -> pp
in
Format.asprintf "%a" pp value
in
if String.length value > 0 then
if !first_field then (
first_field := false ;
Format.fprintf fmt "@ (%s = %s" name value)
else Format.fprintf fmt ",@ %s = %s" name value
in
if all_fields then List.iter print_field fields ;
if not !first_field then Format.fprintf fmt ")" ;
if block then Format.fprintf fmt "@]"
let with_version ~name encoding =
Data_encoding.With_version.encoding
~name
(Data_encoding.With_version.first_version encoding)
let declare_0 ?section ~name ~msg ?(level = Info) () =
let section = make_section section in
let parsed_msg = parse_msg [] msg in
let module Definition : EVENT_DEFINITION with type t = unit = struct
type t = unit
let doc = msg
let section = section
let name = name
let pp ~all_fields ~block fmt () =
pp_log_message ~all_fields ~block parsed_msg fmt []
let encoding = with_version ~name Data_encoding.unit
let level = level
end in
let module Event = Make (Definition) in
{name; emit = (fun () -> Event.emit ?section ())}
let declare_1 (type a) ?section ~name ~msg ?(level = Info) ?pp1
(f1_name, (f1_enc : a Data_encoding.t)) =
let section = make_section section in
let parsed_msg = parse_msg [f1_name] msg in
let module Definition : EVENT_DEFINITION with type t = a = struct
type t = a
let doc = msg
let section = section
let name = name
let pp ~all_fields ~block fmt f1 =
pp_log_message
~all_fields
~block
parsed_msg
fmt
[Parameter (f1_name, f1_enc, f1, pp1)]
let encoding = with_version ~name f1_enc
let level = level
end in
let module Event = Make (Definition) in
{name; emit = (fun parameter -> Event.emit ?section parameter)}
let declare_2 (type a b) ?section ~name ~msg ?(level = Info) ?pp1
(f1_name, (f1_enc : a Data_encoding.t)) ?pp2
(f2_name, (f2_enc : b Data_encoding.t)) =
let section = make_section section in
let parsed_msg = parse_msg [f1_name; f2_name] msg in
let module Definition : EVENT_DEFINITION with type t = a * b = struct
type t = a * b
let doc = msg
let section = section
let name = name
let pp ~all_fields ~block fmt (f1, f2) =
pp_log_message
~all_fields
~block
parsed_msg
fmt
[
Parameter (f1_name, f1_enc, f1, pp1);
Parameter (f2_name, f2_enc, f2, pp2);
]
let encoding =
with_version ~name
@@ Data_encoding.obj2
(Data_encoding.req f1_name f1_enc)
(Data_encoding.req f2_name f2_enc)
let level = level
end in
let module Event = Make (Definition) in
{name; emit = (fun parameters -> Event.emit ?section parameters)}
let declare_3 (type a b c) ?section ~name ~msg ?(level = Info) ?pp1
(f1_name, (f1_enc : a Data_encoding.t)) ?pp2
(f2_name, (f2_enc : b Data_encoding.t)) ?pp3
(f3_name, (f3_enc : c Data_encoding.t)) =
let section = make_section section in
let parsed_msg = parse_msg [f1_name; f2_name; f3_name] msg in
let module Definition : EVENT_DEFINITION with type t = a * b * c = struct
type t = a * b * c
let doc = msg
let section = section
let name = name
let pp ~all_fields ~block fmt (f1, f2, f3) =
pp_log_message
~all_fields
~block
parsed_msg
fmt
[
Parameter (f1_name, f1_enc, f1, pp1);
Parameter (f2_name, f2_enc, f2, pp2);
Parameter (f3_name, f3_enc, f3, pp3);
]
let encoding =
with_version ~name
@@ Data_encoding.obj3
(Data_encoding.req f1_name f1_enc)
(Data_encoding.req f2_name f2_enc)
(Data_encoding.req f3_name f3_enc)
let level = level
end in
let module Event = Make (Definition) in
{name; emit = (fun parameters -> Event.emit ?section parameters)}
let declare_4 (type a b c d) ?section ~name ~msg ?(level = Info) ?pp1
(f1_name, (f1_enc : a Data_encoding.t)) ?pp2
(f2_name, (f2_enc : b Data_encoding.t)) ?pp3
(f3_name, (f3_enc : c Data_encoding.t)) ?pp4
(f4_name, (f4_enc : d Data_encoding.t)) =
let section = make_section section in
let parsed_msg = parse_msg [f1_name; f2_name; f3_name; f4_name] msg in
let module Definition : EVENT_DEFINITION with type t = a * b * c * d =
struct
type t = a * b * c * d
let doc = msg
let section = section
let name = name
let pp ~all_fields ~block fmt (f1, f2, f3, f4) =
pp_log_message
~all_fields
~block
parsed_msg
fmt
[
Parameter (f1_name, f1_enc, f1, pp1);
Parameter (f2_name, f2_enc, f2, pp2);
Parameter (f3_name, f3_enc, f3, pp3);
Parameter (f4_name, f4_enc, f4, pp4);
]
let encoding =
with_version ~name
@@ Data_encoding.obj4
(Data_encoding.req f1_name f1_enc)
(Data_encoding.req f2_name f2_enc)
(Data_encoding.req f3_name f3_enc)
(Data_encoding.req f4_name f4_enc)
let level = level
end in
let module Event = Make (Definition) in
{name; emit = (fun parameters -> Event.emit ?section parameters)}
let declare_5 (type a b c d e) ?section ~name ~msg ?(level = Info) ?pp1
(f1_name, (f1_enc : a Data_encoding.t)) ?pp2
(f2_name, (f2_enc : b Data_encoding.t)) ?pp3
(f3_name, (f3_enc : c Data_encoding.t)) ?pp4
(f4_name, (f4_enc : d Data_encoding.t)) ?pp5
(f5_name, (f5_enc : e Data_encoding.t)) =
let section = make_section section in
let parsed_msg =
parse_msg [f1_name; f2_name; f3_name; f4_name; f5_name] msg
in
let module Definition : EVENT_DEFINITION with type t = a * b * c * d * e =
struct
type t = a * b * c * d * e
let doc = msg
let section = section
let name = name
let pp ~all_fields ~block fmt (f1, f2, f3, f4, f5) =
pp_log_message
~all_fields
~block
parsed_msg
fmt
[
Parameter (f1_name, f1_enc, f1, pp1);
Parameter (f2_name, f2_enc, f2, pp2);
Parameter (f3_name, f3_enc, f3, pp3);
Parameter (f4_name, f4_enc, f4, pp4);
Parameter (f5_name, f5_enc, f5, pp5);
]
let encoding =
with_version ~name
@@ Data_encoding.obj5
(Data_encoding.req f1_name f1_enc)
(Data_encoding.req f2_name f2_enc)
(Data_encoding.req f3_name f3_enc)
(Data_encoding.req f4_name f4_enc)
(Data_encoding.req f5_name f5_enc)
let level = level
end in
let module Event = Make (Definition) in
{name; emit = (fun parameters -> Event.emit ?section parameters)}
let declare_6 (type a b c d e f) ?section ~name ~msg ?(level = Info) ?pp1
(f1_name, (f1_enc : a Data_encoding.t)) ?pp2
(f2_name, (f2_enc : b Data_encoding.t)) ?pp3
(f3_name, (f3_enc : c Data_encoding.t)) ?pp4
(f4_name, (f4_enc : d Data_encoding.t)) ?pp5
(f5_name, (f5_enc : e Data_encoding.t)) ?pp6
(f6_name, (f6_enc : f Data_encoding.t)) =
let section = make_section section in
let parsed_msg =
parse_msg [f1_name; f2_name; f3_name; f4_name; f5_name; f6_name] msg
in
let module Definition :
EVENT_DEFINITION with type t = a * b * c * d * e * f = struct
type t = a * b * c * d * e * f
let doc = msg
let section = section
let name = name
let pp ~all_fields ~block fmt (f1, f2, f3, f4, f5, f6) =
pp_log_message
~all_fields
~block
parsed_msg
fmt
[
Parameter (f1_name, f1_enc, f1, pp1);
Parameter (f2_name, f2_enc, f2, pp2);
Parameter (f3_name, f3_enc, f3, pp3);
Parameter (f4_name, f4_enc, f4, pp4);
Parameter (f5_name, f5_enc, f5, pp5);
Parameter (f6_name, f6_enc, f6, pp6);
]
let encoding =
with_version ~name
@@ Data_encoding.obj6
(Data_encoding.req f1_name f1_enc)
(Data_encoding.req f2_name f2_enc)
(Data_encoding.req f3_name f3_enc)
(Data_encoding.req f4_name f4_enc)
(Data_encoding.req f5_name f5_enc)
(Data_encoding.req f6_name f6_enc)
let level = level
end in
let module Event = Make (Definition) in
{name; emit = (fun parameters -> Event.emit ?section parameters)}
let declare_7 (type a b c d e f g) ?section ~name ~msg ?(level = Info) ?pp1
(f1_name, (f1_enc : a Data_encoding.t)) ?pp2
(f2_name, (f2_enc : b Data_encoding.t)) ?pp3
(f3_name, (f3_enc : c Data_encoding.t)) ?pp4
(f4_name, (f4_enc : d Data_encoding.t)) ?pp5
(f5_name, (f5_enc : e Data_encoding.t)) ?pp6
(f6_name, (f6_enc : f Data_encoding.t)) ?pp7
(f7_name, (f7_enc : g Data_encoding.t)) =
let section = make_section section in
let parsed_msg =
parse_msg
[f1_name; f2_name; f3_name; f4_name; f5_name; f6_name; f7_name]
msg
in
let module Definition :
EVENT_DEFINITION with type t = a * b * c * d * e * f * g = struct
type t = a * b * c * d * e * f * g
let doc = msg
let section = section
let name = name
let pp ~all_fields ~block fmt (f1, f2, f3, f4, f5, f6, f7) =
pp_log_message
~all_fields
~block
parsed_msg
fmt
[
Parameter (f1_name, f1_enc, f1, pp1);
Parameter (f2_name, f2_enc, f2, pp2);
Parameter (f3_name, f3_enc, f3, pp3);
Parameter (f4_name, f4_enc, f4, pp4);
Parameter (f5_name, f5_enc, f5, pp5);
Parameter (f6_name, f6_enc, f6, pp6);
Parameter (f7_name, f7_enc, f7, pp7);
]
let encoding =
with_version ~name
@@ Data_encoding.obj7
(Data_encoding.req f1_name f1_enc)
(Data_encoding.req f2_name f2_enc)
(Data_encoding.req f3_name f3_enc)
(Data_encoding.req f4_name f4_enc)
(Data_encoding.req f5_name f5_enc)
(Data_encoding.req f6_name f6_enc)
(Data_encoding.req f7_name f7_enc)
let level = level
end in
let module Event = Make (Definition) in
{name; emit = (fun parameters -> Event.emit ?section parameters)}
let declare_8 (type a b c d e f g h) ?section ~name ~msg ?(level = Info) ?pp1
(f1_name, (f1_enc : a Data_encoding.t)) ?pp2
(f2_name, (f2_enc : b Data_encoding.t)) ?pp3
(f3_name, (f3_enc : c Data_encoding.t)) ?pp4
(f4_name, (f4_enc : d Data_encoding.t)) ?pp5
(f5_name, (f5_enc : e Data_encoding.t)) ?pp6
(f6_name, (f6_enc : f Data_encoding.t)) ?pp7
(f7_name, (f7_enc : g Data_encoding.t)) ?pp8
(f8_name, (f8_enc : h Data_encoding.t)) =
let section = make_section section in
let parsed_msg =
parse_msg
[f1_name; f2_name; f3_name; f4_name; f5_name; f6_name; f7_name; f8_name]
msg
in
let module Definition :
EVENT_DEFINITION with type t = a * b * c * d * e * f * g * h = struct
type t = a * b * c * d * e * f * g * h
let doc = msg
let section = section
let name = name
let pp ~all_fields ~block fmt (f1, f2, f3, f4, f5, f6, f7, f8) =
pp_log_message
~all_fields
~block
parsed_msg
fmt
[
Parameter (f1_name, f1_enc, f1, pp1);
Parameter (f2_name, f2_enc, f2, pp2);
Parameter (f3_name, f3_enc, f3, pp3);
Parameter (f4_name, f4_enc, f4, pp4);
Parameter (f5_name, f5_enc, f5, pp5);
Parameter (f6_name, f6_enc, f6, pp6);
Parameter (f7_name, f7_enc, f7, pp7);
Parameter (f8_name, f8_enc, f8, pp8);
]
let encoding =
with_version ~name
@@ Data_encoding.obj8
(Data_encoding.req f1_name f1_enc)
(Data_encoding.req f2_name f2_enc)
(Data_encoding.req f3_name f3_enc)
(Data_encoding.req f4_name f4_enc)
(Data_encoding.req f5_name f5_enc)
(Data_encoding.req f6_name f6_enc)
(Data_encoding.req f7_name f7_enc)
(Data_encoding.req f8_name f8_enc)
let level = level
end in
let module Event = Make (Definition) in
{name; emit = (fun parameters -> Event.emit ?section parameters)}
end
module Lwt_worker_logger = struct
module Started_event = Make (struct
type t = unit
let section = None
let name = "lwt-worker_started"
let encoding = Data_encoding.constant "started"
let pp ~all_fields:_ ~block:_ ppf () = Format.fprintf ppf "started"
let doc = "Worker started event"
let level = Debug
end)
module Ended_event = Make (struct
type t = unit
let section = None
let name = "lwt-worker_ended"
let encoding = Data_encoding.constant "ended"
let pp ~all_fields:_ ~block:_ ppf () = Format.fprintf ppf "ended"
let doc = "Worker ended event"
let level = Debug
end)
module Failed_event = Make (struct
type t = string
let section = None
let name = "lwt-worker_failed"
let encoding = Data_encoding.(obj1 (req "error" string))
let pp ~all_fields:_ ~block:_ ppf error =
Format.fprintf ppf "failed with %s" error
let doc = "Worker failed event"
let level = Error
end)
let on_event name event =
let open Lwt_syntax in
let section = Section.make_sanitized ["lwt-worker"; name] in
let* r =
match event with
| `Started -> Started_event.emit ~section ()
| `Ended -> Ended_event.emit ~section ()
| `Failed msg -> Failed_event.emit ~section msg
in
match r with
| Ok () -> Lwt.return_unit
| Error errs ->
Format.kasprintf
!default_error_fallback_logger
"failed to log worker event:@ %a@\n"
Error_monad.pp_print_trace
errs
end