Use a forwarder so each component updates their depth and chunk size

The other Observer components e.g. xenops need a forwarder to notify
them of any changes to the export_chunk_size and max_depth as they do
not have access to xapi_globs/xapi.conf

Signed-off-by: Steven Woods <[email protected]>

Author: snwoods

ocaml/tests/test_cluster.ml

@@ -34,9 +34,11 @@ let test_clusterd_rpc ~__context call =
       | "Observer.init"
       | "Observer.set_trace_log_dir"
       | "Observer.set_export_interval"
+      | "Observer.set_export_chunk_size"
       | "Observer.set_host_id"
       | "Observer.set_max_traces"
       | "Observer.set_max_spans"
+      | "Observer.set_max_depth"
       | "Observer.set_max_file_size"
       | "Observer.set_compress_tracing_files" )
     , _ ) ->

ocaml/xapi-idl/cluster/cli-help.t

@@ -21,10 +21,14 @@
 
          Observer.set_endpoints [OPTION]… dbg uuid endpoints
 
+         Observer.set_export_chunk_size [OPTION]… dbg int
+  
          Observer.set_export_interval [OPTION]… dbg float
 
          Observer.set_host_id [OPTION]… dbg string
 
+         Observer.set_max_depth [OPTION]… dbg int
+  
          Observer.set_max_file_size [OPTION]… dbg int
 
          Observer.set_max_spans [OPTION]… dbg int

ocaml/xapi-idl/lib/observer_helpers.ml

@@ -138,6 +138,10 @@ module ObserverAPI (R : RPC) = struct
     declare "Observer.set_export_interval" []
       (dbg_p @-> float_p @-> returning unit_p err)
 
+  let set_export_chunk_size =
+    declare "Observer.set_export_chunk_size" []
+      (dbg_p @-> int_p @-> returning unit_p err)
+
   let set_max_spans =
     declare "Observer.set_max_spans" []
       (dbg_p @-> int_p @-> returning unit_p err)
@@ -146,6 +150,10 @@ module ObserverAPI (R : RPC) = struct
     declare "Observer.set_max_traces" []
       (dbg_p @-> int_p @-> returning unit_p err)
 
+  let set_max_depth =
+    declare "Observer.set_max_depth" []
+      (dbg_p @-> int_p @-> returning unit_p err)
+
   let set_max_file_size =
     declare "Observer.set_max_file_size" []
       (dbg_p @-> int_p @-> returning unit_p err)
@@ -193,10 +201,14 @@ module type Server_impl = sig
 
   val set_export_interval : context -> dbg:debug_info -> interval:float -> unit
 
+  val set_export_chunk_size : context -> dbg:debug_info -> size:int -> unit
+
   val set_max_spans : context -> dbg:debug_info -> spans:int -> unit
 
   val set_max_traces : context -> dbg:debug_info -> traces:int -> unit
 
+  val set_max_depth : context -> dbg:debug_info -> depth:int -> unit
+
   val set_max_file_size : context -> dbg:debug_info -> file_size:int -> unit
 
   val set_host_id : context -> dbg:debug_info -> host_id:string -> unit
@@ -227,8 +239,12 @@ module Server (Impl : Server_impl) () = struct
     S.set_export_interval (fun dbg interval ->
         Impl.set_export_interval () ~dbg ~interval
     ) ;
+    S.set_export_chunk_size (fun dbg size ->
+        Impl.set_export_chunk_size () ~dbg ~size
+    ) ;
     S.set_max_spans (fun dbg spans -> Impl.set_max_spans () ~dbg ~spans) ;
     S.set_max_traces (fun dbg traces -> Impl.set_max_traces () ~dbg ~traces) ;
+    S.set_max_depth (fun dbg depth -> Impl.set_max_depth () ~dbg ~depth) ;
     S.set_max_file_size (fun dbg file_size ->
         Impl.set_max_file_size () ~dbg ~file_size
     ) ;

ocaml/xapi-idl/lib/observer_helpers.mli

@@ -77,6 +77,11 @@ module ObserverAPI : functor (R : Idl.RPC) -> sig
   (** [set_export_interval dbg interval] notifies the fowarder that the interval
       between trace exports has been set to [interval]. *)
 
+  val set_export_chunk_size :
+    (debug_info -> int -> (unit, Errors.error) R.comp) R.res
+  (** [set_export_chunk_size dbg size] notifies the fowarder that the max size
+      of each chunk of finished spans exported has been set to [size]. *)
+
   val set_max_spans : (debug_info -> int -> (unit, Errors.error) R.comp) R.res
   (** [set_max_spans dbg spans] notifies the fowarder that the max number of
       spans has been set to [spans]. *)
@@ -85,6 +90,10 @@ module ObserverAPI : functor (R : Idl.RPC) -> sig
   (** [set_max_traces dbg traces] notifies the fowarder that the max number of
       traces has been set to [traces]. *)
 
+  val set_max_depth : (debug_info -> int -> (unit, Errors.error) R.comp) R.res
+  (** [set_max_depth dbg depth] notifies the fowarder that the max depth of
+      a span in a trace has been set to [depth]. *)
+
   val set_max_file_size :
     (debug_info -> int -> (unit, Errors.error) R.comp) R.res
   (** [set_max_file_size dbg file_size] notifies the fowarder that the max file
@@ -135,10 +144,14 @@ module type Server_impl = sig
 
   val set_export_interval : context -> dbg:debug_info -> interval:float -> unit
 
+  val set_export_chunk_size : context -> dbg:debug_info -> size:int -> unit
+
   val set_max_spans : context -> dbg:debug_info -> spans:int -> unit
 
   val set_max_traces : context -> dbg:debug_info -> traces:int -> unit
 
+  val set_max_depth : context -> dbg:debug_info -> depth:int -> unit
+
   val set_max_file_size : context -> dbg:debug_info -> file_size:int -> unit
 
   val set_host_id : context -> dbg:debug_info -> host_id:string -> unit
@@ -176,10 +189,14 @@ module Server : functor (_ : Server_impl) () -> sig
 
     val set_export_interval : (debug_info -> float -> unit) -> unit
 
+    val set_export_chunk_size : (debug_info -> int -> unit) -> unit
+
     val set_max_spans : (debug_info -> int -> unit) -> unit
 
     val set_max_traces : (debug_info -> int -> unit) -> unit
 
+    val set_max_depth : (debug_info -> int -> unit) -> unit
+
     val set_max_file_size : (debug_info -> int -> unit) -> unit
 
     val set_host_id : (debug_info -> string -> unit) -> unit
@@ -215,10 +232,14 @@ module Client : sig
 
   val set_export_interval : debug_info -> float -> unit
 
+  val set_export_chunk_size : debug_info -> int -> unit
+
   val set_max_spans : debug_info -> int -> unit
 
   val set_max_traces : debug_info -> int -> unit
 
+  val set_max_depth : debug_info -> int -> unit
+
   val set_max_file_size : debug_info -> int -> unit
 
   val set_host_id : debug_info -> string -> unit

ocaml/xapi-idl/lib/observer_skeleton.ml

@@ -36,10 +36,14 @@ module Observer = struct
 
   let set_export_interval ctx ~dbg ~interval = unimplemented __FUNCTION__
 
+  let set_export_chunk_size ctx ~dbg ~size = unimplemented __FUNCTION__
+
   let set_max_spans ctx ~dbg ~spans = unimplemented __FUNCTION__
 
   let set_max_traces ctx ~dbg ~traces = unimplemented __FUNCTION__
 
+  let set_max_depth ctx ~dbg ~depth = unimplemented __FUNCTION__
+
   let set_max_file_size ctx ~dbg ~file_size = unimplemented __FUNCTION__
 
   let set_host_id ctx ~dbg ~host_id = unimplemented __FUNCTION__

ocaml/xapi-idl/lib/observer_skeleton.mli

@@ -34,10 +34,14 @@ module Observer : sig
 
   val set_export_interval : context -> dbg:string -> interval:float -> unit
 
+  val set_export_chunk_size : context -> dbg:string -> size:int -> unit
+
   val set_max_spans : context -> dbg:string -> spans:int -> unit
 
   val set_max_traces : context -> dbg:string -> traces:int -> unit
 
+  val set_max_depth : context -> dbg:string -> depth:int -> unit
+
   val set_max_file_size : context -> dbg:string -> file_size:int -> unit
 
   val set_host_id : context -> dbg:string -> host_id:string -> unit

ocaml/xapi/xapi_observer.ml

@@ -48,10 +48,14 @@ module type ObserverInterface = sig
 
   val set_export_interval : __context:Context.t -> interval:float -> unit
 
+  val set_export_chunk_size : __context:Context.t -> size:int -> unit
+
   val set_max_spans : __context:Context.t -> spans:int -> unit
 
   val set_max_traces : __context:Context.t -> traces:int -> unit
 
+  val set_max_depth : __context:Context.t -> depth:int -> unit
+
   val set_max_file_size : __context:Context.t -> file_size:int -> unit
 
   val set_host_id : __context:Context.t -> host_id:string -> unit
@@ -93,6 +97,10 @@ module Observer : ObserverInterface = struct
     debug "xapi Observer.set_export_interval" ;
     Tracing_export.set_export_interval interval
 
+  let set_export_chunk_size ~__context ~size =
+    debug "xapi Observer.set_export_chunk_size" ;
+    Tracing_export.set_export_chunk_size size
+
   let set_max_spans ~__context ~spans =
     debug "xapi Observer.set_max_spans" ;
     Tracing.Spans.set_max_spans spans
@@ -101,6 +109,10 @@ module Observer : ObserverInterface = struct
     debug "xapi Observer.set_max_traces" ;
     Tracing.Spans.set_max_traces traces
 
+  let set_max_depth ~__context ~depth =
+    debug "xapi Observer.set_max_depth" ;
+    Tracing.Spans.set_max_depth depth
+
   let set_max_file_size ~__context ~file_size =
     debug "xapi Observer.set_max_file_size" ;
     Tracing_export.Destination.File.set_max_file_size file_size
@@ -189,6 +201,12 @@ module Xapi_cluster = struct
       let dbg = Context.string_of_task __context in
       S.Observer.set_export_interval dbg interval
 
+    let set_export_chunk_size ~__context ~size =
+      debug "xapi_cluster Observer.set_export_chunk_size" ;
+      let module S = (val local_client ~__context : XAPI_CLUSTER) in
+      let dbg = Context.string_of_task __context in
+      S.Observer.set_export_chunk_size dbg size
+
     let set_max_spans ~__context ~spans =
       debug "xapi_cluster Observer.set_max_spans" ;
       let module S = (val local_client ~__context : XAPI_CLUSTER) in
@@ -201,6 +219,12 @@ module Xapi_cluster = struct
       let dbg = Context.string_of_task __context in
       S.Observer.set_max_traces dbg traces
 
+    let set_max_depth ~__context ~depth =
+      debug "xapi_cluster Observer.set_max_depth" ;
+      let module S = (val local_client ~__context : XAPI_CLUSTER) in
+      let dbg = Context.string_of_task __context in
+      S.Observer.set_max_depth dbg depth
+
     let set_max_file_size ~__context ~file_size =
       debug "xapi_cluster Observer.set_max_file_size" ;
       let module S = (val local_client ~__context : XAPI_CLUSTER) in
@@ -370,10 +394,14 @@ module Dom0ObserverConfig (ObserverComponent : OBSERVER_COMPONENT) :
 
   let set_export_interval ~__context:_ ~interval:_ = ()
 
+  let set_export_chunk_size ~__context:_ ~size:_ = ()
+
   let set_max_spans ~__context:_ ~spans:_ = ()
 
   let set_max_traces ~__context:_ ~traces:_ = ()
 
+  let set_max_depth ~__context:_ ~depth:_ = ()
+
   let set_max_file_size ~__context:_ ~file_size:_ = ()
 
   let set_host_id ~__context:_ ~host_id:_ = ()
@@ -542,6 +570,10 @@ let set_export_interval ~__context interval component =
   let module Forwarder = (val get_forwarder component : ObserverInterface) in
   Forwarder.set_export_interval ~__context ~interval
 
+let set_export_chunk_size ~__context size component =
+  let module Forwarder = (val get_forwarder component : ObserverInterface) in
+  Forwarder.set_export_chunk_size ~__context ~size
+
 let set_max_spans ~__context spans component =
   let module Forwarder = (val get_forwarder component : ObserverInterface) in
   Forwarder.set_max_spans ~__context ~spans
@@ -550,6 +582,10 @@ let set_max_traces ~__context traces component =
   let module Forwarder = (val get_forwarder component : ObserverInterface) in
   Forwarder.set_max_traces ~__context ~traces
 
+let set_max_depth ~__context depth component =
+  let module Forwarder = (val get_forwarder component : ObserverInterface) in
+  Forwarder.set_max_depth ~__context ~depth
+
 let set_max_file_size ~__context file_size component =
   let module Forwarder = (val get_forwarder component : ObserverInterface) in
   Forwarder.set_max_file_size ~__context ~file_size
@@ -585,8 +621,10 @@ let initialise_observer_component ~__context component =
 let initialise_observer_meta ~__context component =
   set_trace_log_dir ~__context !Xapi_globs.trace_log_dir component ;
   set_export_interval ~__context !Xapi_globs.export_interval component ;
+  set_export_chunk_size ~__context !Xapi_globs.export_chunk_size component ;
   set_max_spans ~__context !Xapi_globs.max_spans component ;
   set_max_traces ~__context !Xapi_globs.max_traces component ;
+  set_max_depth ~__context !Xapi_globs.max_span_depth component ;
   set_max_file_size ~__context !Xapi_globs.max_observer_file_size component ;
   set_host_id ~__context (Helpers.get_localhost_uuid ()) component ;
   set_compress_tracing_files ~__context
@@ -599,8 +637,6 @@ let initialise_observer ~__context component =
   initialise_observer_component ~__context component
 
 let initialise ~__context =
-  Tracing.Spans.set_max_depth !Xapi_globs.max_span_depth ;
-  Tracing_export.set_export_chunk_size !Xapi_globs.export_chunk_size ;
   List.iter (initialise_observer_meta ~__context) (startup_components ()) ;
   Db.Observer.get_all ~__context
   |> List.iter (fun self ->

ocaml/xapi/xapi_xenops.ml

@@ -4493,6 +4493,11 @@ module Observer = struct
     let dbg = Context.string_of_task __context in
     Client.Observer.set_export_interval dbg interval
 
+  let set_export_chunk_size ~__context ~size =
+    let module Client = (val make_client (default_xenopsd ()) : XENOPS) in
+    let dbg = Context.string_of_task __context in
+    Client.Observer.set_export_chunk_size dbg size
+
   let set_max_spans ~__context ~spans =
     let module Client = (val make_client (default_xenopsd ()) : XENOPS) in
     let dbg = Context.string_of_task __context in
@@ -4503,6 +4508,11 @@ module Observer = struct
     let dbg = Context.string_of_task __context in
     Client.Observer.set_max_traces dbg traces
 
+  let set_max_depth ~__context ~depth =
+    let module Client = (val make_client (default_xenopsd ()) : XENOPS) in
+    let dbg = Context.string_of_task __context in
+    Client.Observer.set_max_depth dbg depth
+
   let set_max_file_size ~__context ~file_size =
     let module Client = (val make_client (default_xenopsd ()) : XENOPS) in
     let dbg = Context.string_of_task __context in

ocaml/xenopsd/lib/xenops_server.ml

@@ -4311,6 +4311,12 @@ module Observer = struct
       (fun () -> Tracing_export.set_export_interval interval)
       ()
 
+  let set_export_chunk_size _ dbg size =
+    debug "Observer.set_export_chunk_size : dbg=%s" dbg ;
+    Debug.with_thread_associated dbg
+      (fun () -> Tracing_export.set_export_chunk_size size)
+      ()
+
   let set_max_spans _ dbg spans =
     debug "Observer.set_max_spans : dbg=%s" dbg ;
     Debug.with_thread_associated dbg
@@ -4323,6 +4329,12 @@ module Observer = struct
       (fun () -> Tracing.Spans.set_max_traces traces)
       ()
 
+  let set_max_depth _ dbg depth =
+    debug "Observer.set_max_depth : dbg=%s" dbg ;
+    Debug.with_thread_associated dbg
+      (fun () -> Tracing.Spans.set_max_depth depth)
+      ()
+
   let set_max_file_size _ dbg file_size =
     debug "Observer.set_max_file_size : dbg=%s" dbg ;
     Debug.with_thread_associated dbg
@@ -4446,8 +4458,10 @@ let _ =
   Server.Observer.init (Observer.init ()) ;
   Server.Observer.set_trace_log_dir (Observer.set_trace_log_dir ()) ;
   Server.Observer.set_export_interval (Observer.set_export_interval ()) ;
+  Server.Observer.set_export_chunk_size (Observer.set_export_chunk_size ()) ;
   Server.Observer.set_max_spans (Observer.set_max_spans ()) ;
   Server.Observer.set_max_traces (Observer.set_max_traces ()) ;
+  Server.Observer.set_max_depth (Observer.set_max_depth ()) ;
   Server.Observer.set_max_file_size (Observer.set_max_file_size ()) ;
   Server.Observer.set_host_id (Observer.set_host_id ()) ;
   Server.Observer.set_compress_tracing_files