From a2861229bbda91e6bd433303912ddbe260080186 Mon Sep 17 00:00:00 2001 From: Varun Arora Date: Mon, 19 Feb 2018 07:02:11 -0800 Subject: [PATCH] [logging] add_string_opt function that takes a string option as its data Summary: - JsonBuilder now has an add_string_opt function that takes a string option instead of a string - Further alphabetized EventLogger Reviewed By: dulmarod Differential Revision: D7011763 fbshipit-source-id: 73f1a4b --- infer/src/base/EventLogger.ml | 94 ++++++++++++++-------------- infer/src/base/EventLogger.mli | 28 ++++----- infer/src/opensource/JsonBuilder.ml | 4 ++ infer/src/opensource/JsonBuilder.mli | 2 + 4 files changed, 66 insertions(+), 62 deletions(-) diff --git a/infer/src/base/EventLogger.ml b/infer/src/base/EventLogger.ml index 5e39dd4a3..9a9637533 100644 --- a/infer/src/base/EventLogger.ml +++ b/infer/src/base/EventLogger.ml @@ -71,7 +71,39 @@ end = struct new_id end -let bind_default opt map_func prev = match opt with Some x -> map_func x prev | None -> prev +type analysis_stats = + { analysis_nodes_visited: int + ; analysis_status: SymOp.failure_kind option + ; analysis_total_nodes: int + ; clang_method_kind: ProcAttributes.clang_method_kind + ; lang: string + ; method_location: Location.t + ; method_name: string + ; num_preposts: int + ; symops: int } + +let create_analysis_stats_row base record = + let open JsonBuilder in + base |> add_int ~key:"analysis_nodes_visited" ~data:record.analysis_nodes_visited + |> add_string ~key:"analysis_status" + ~data: + (Option.value_map record.analysis_status ~default:"OK" ~f:(fun stats_failure -> + SymOp.failure_kind_to_string stats_failure )) + |> add_int ~key:"analysis_total_nodes" ~data:record.analysis_total_nodes + |> add_string ~key:"clang_method_kind" + ~data:(ProcAttributes.string_of_clang_method_kind record.clang_method_kind) + |> add_string ~key:"lang" ~data:record.lang + |> add_string ~key:"method_location" + ~data: + (String.concat + [ string_of_int record.method_location.line + ; ":" + ; string_of_int record.method_location.col ]) + |> add_string ~key:"source_file" ~data:(SourceFile.to_rel_path record.method_location.file) + |> add_string ~key:"method_name" ~data:record.method_name + |> add_int ~key:"num_preposts" ~data:record.num_preposts + |> add_int ~key:"symops" ~data:record.symops + type frontend_exception = { ast_node: string option @@ -84,7 +116,7 @@ type frontend_exception = let create_frontend_exception_row base record = let open JsonBuilder in - base |> bind_default record.ast_node (fun ast_node -> add_string ~key:"ast_node" ~data:ast_node) + base |> add_string_opt ~key:"ast_node" ~data:record.ast_node |> add_string ~key:"exception_triggered_location" ~data:(String.concat [record.exception_file; ":"; string_of_int record.exception_line]) |> add_string ~key:"exception_type" ~data:record.exception_type @@ -121,56 +153,22 @@ let create_procedures_translated_row base record = |> add_string ~key:"source_file" ~data:(SourceFile.to_rel_path record.source_file) -type analysis_stats = - { analysis_nodes_visited: int - ; analysis_status: SymOp.failure_kind option - ; analysis_total_nodes: int - ; clang_method_kind: ProcAttributes.clang_method_kind - ; lang: string - ; method_location: Location.t - ; method_name: string - ; num_preposts: int - ; symops: int } - -let create_analysis_stats_row base record = - let open JsonBuilder in - base |> add_int ~key:"analysis_nodes_visited" ~data:record.analysis_nodes_visited - |> add_string ~key:"analysis_status" - ~data: - (Option.value_map record.analysis_status ~default:"OK" ~f:(fun stats_failure -> - SymOp.failure_kind_to_string stats_failure )) - |> add_int ~key:"analysis_total_nodes" ~data:record.analysis_total_nodes - |> add_string ~key:"clang_method_kind" - ~data:(ProcAttributes.string_of_clang_method_kind record.clang_method_kind) - |> add_string ~key:"lang" ~data:record.lang - |> add_string ~key:"method_location" - ~data: - (String.concat - [ string_of_int record.method_location.line - ; ":" - ; string_of_int record.method_location.col ]) - |> add_string ~key:"source_file" ~data:(SourceFile.to_rel_path record.method_location.file) - |> add_string ~key:"method_name" ~data:record.method_name - |> add_int ~key:"num_preposts" ~data:record.num_preposts - |> add_int ~key:"symops" ~data:record.symops - - type event = - | UncaughtException of exn * int + | AnalysisStats of analysis_stats | FrontendException of frontend_exception | ProceduresTranslatedSummary of procedures_translated - | AnalysisStats of analysis_stats + | UncaughtException of exn * int let string_of_event event = match event with - | UncaughtException _ -> - "UncaughtException" + | AnalysisStats _ -> + "AnalysisStats" | FrontendException _ -> "FrontendException" | ProceduresTranslatedSummary _ -> "ProceduresTranslatedSummary" - | AnalysisStats _ -> - "AnalysisStats" + | UncaughtException _ -> + "UncaughtException" let sequence_ctr = ref 0 @@ -214,16 +212,16 @@ module LoggerImpl : S = struct |> add_int ~key:"time" ~data:(int_of_float (Unix.time ())) in ( match event with - | UncaughtException (exn, exitcode) -> - base |> add_string ~key:"exception" ~data:(Caml.Printexc.exn_slot_name exn) - |> add_string ~key:"exception_info" ~data:(Exn.to_string exn) - |> add_int ~key:"exitcode" ~data:exitcode + | AnalysisStats record -> + create_analysis_stats_row base record | FrontendException record -> create_frontend_exception_row base record | ProceduresTranslatedSummary record -> create_procedures_translated_row base record - | AnalysisStats record -> - create_analysis_stats_row base record ) + | UncaughtException (exn, exitcode) -> + base |> add_string ~key:"exception" ~data:(Caml.Printexc.exn_slot_name exn) + |> add_string ~key:"exception_info" ~data:(Exn.to_string exn) + |> add_int ~key:"exitcode" ~data:exitcode ) |> JsonBuilder.to_json diff --git a/infer/src/base/EventLogger.mli b/infer/src/base/EventLogger.mli index 288364e31..4aa3ffa75 100644 --- a/infer/src/base/EventLogger.mli +++ b/infer/src/base/EventLogger.mli @@ -7,6 +7,17 @@ * of patent rights can be found in the PATENTS file in the same directory. *) +type analysis_stats = + { analysis_nodes_visited: int + ; analysis_status: SymOp.failure_kind option + ; analysis_total_nodes: int + ; clang_method_kind: ProcAttributes.clang_method_kind + ; lang: string + ; method_location: Location.t + ; method_name: string + ; num_preposts: int + ; symops: int } + type frontend_exception = { ast_node: string option ; exception_file: string @@ -22,22 +33,11 @@ type procedures_translated = ; procedures_translated_total: int ; source_file: SourceFile.t } -type analysis_stats = - { analysis_nodes_visited: int - ; analysis_status: SymOp.failure_kind option - ; analysis_total_nodes: int - ; clang_method_kind: ProcAttributes.clang_method_kind - ; lang: string - ; method_location: Location.t - ; method_name: string - ; num_preposts: int - ; symops: int } - type event = + | AnalysisStats of analysis_stats + | FrontendException of frontend_exception + | ProceduresTranslatedSummary of procedures_translated | UncaughtException of exn * int (** exception, exitcode *) - | FrontendException of frontend_exception (** record of caught exception *) - | ProceduresTranslatedSummary of procedures_translated (** record of procedures translated *) - | AnalysisStats of analysis_stats (** record of stats from procedure analysis *) val get_log_identifier : unit -> string diff --git a/infer/src/opensource/JsonBuilder.ml b/infer/src/opensource/JsonBuilder.ml index 990055bc7..d4156572f 100644 --- a/infer/src/opensource/JsonBuilder.ml +++ b/infer/src/opensource/JsonBuilder.ml @@ -15,6 +15,10 @@ let empty = [] let add_string t ~key ~data = (key, `String data) :: t +let add_string_opt t ~key ~data = + match data with Some data -> add_string t ~key ~data | None -> t + + let add_int t ~key ~data = (key, `Int data) :: t let to_json t = Yojson.Basic.to_string (`Assoc t) diff --git a/infer/src/opensource/JsonBuilder.mli b/infer/src/opensource/JsonBuilder.mli index 73a4085af..057f2baa9 100644 --- a/infer/src/opensource/JsonBuilder.mli +++ b/infer/src/opensource/JsonBuilder.mli @@ -13,6 +13,8 @@ val empty : t val add_string : t -> key:string -> data:string -> t +val add_string_opt : t -> key:string -> data:string option -> t + val add_int : t -> key:string -> data:int -> t val to_json : t -> string