Cleanup is_enabled settings

rel/overlay/etc/default.ini

@@ -1122,16 +1122,23 @@ url = {{nouveau_url}}
 
 ; Couch Stats Resource Tracker (CSRT)
 [csrt]
-enabled = true
-;enabled = false
-;should_truncate_reports = false
+enable = true
+enable_init_p = true
+enable_reporting = true
+;enable = false
+;enable_init_p = false
+;enable_reporting = false
+;
+
+; Truncate reports to not include zero values for counter fields
+;should_truncate_reports = true
 
 ; CSRT Rexi Server RPC Worker Spawn Tracking
 ; Enable these to enable additional metrics for RPC worker spawn rates
 ; measuring how often RPC workers are spawned by way of rexi_server:init_p.
 ; Mod and Function are separated by double underscores.
 [csrt.init_p]
-enabled = false
+;enable = true
 fabric_rpc__all_docs = true
 fabric_rpc__changes = true
 fabric_rpc__map_view = true

src/couch_stats/src/couch_stats_resource_tracker.hrl

@@ -120,7 +120,7 @@
     %% ?COUCH_BT_GET_KP_NODE = 0 :: non_neg_integer(),
     get_kv_node = 0 :: non_neg_integer(),
     get_kp_node = 0 :: non_neg_integer()
-    %% Add these later
+    %% "Example to extend CSRT"
     %%write_kv_node = 0 :: non_neg_integer(),
     %%write_kp_node = 0 :: non_neg_integer()
 }).
@@ -143,6 +143,7 @@
         | js_filtered_docs
         | get_kv_node
         | get_kp_node.
+        %% "Example to extend CSRT"
         %%| write_kv_node
         %%| write_kp_node.
 

src/couch_stats/src/csrt.erl

@@ -473,7 +473,7 @@ t_static_map_translations(_) ->
     ).
 
 t_should_track_init_p(_) ->
-    config:set(?CSRT_INIT_P, "enabled", "true", false),
+    config:set(?CSRT, "enable_init_p", "true", false),
     Metrics = [
         [fabric_rpc, all_docs, spawned],
         [fabric_rpc, changes, spawned],
@@ -488,7 +488,7 @@ t_should_track_init_p(_) ->
     [?assert(should_track_init_p(M), M) || M <- Metrics].
 
 t_should_not_track_init_p(_) ->
-    config:set(?CSRT_INIT_P, "enabled", "true", false),
+    config:set(?CSRT, "enable_init_p", "true", false),
     Metrics = [
         [couch_db, name, spawned],
         [couch_db, get_db_info, spawned],

src/couch_stats/src/csrt_logger.erl

@@ -127,7 +127,7 @@ deregister_matcher(Name) ->
 
 -spec log_process_lifetime_report(PidRef :: pid_ref()) -> ok.
 log_process_lifetime_report(PidRef) ->
-    case csrt_util:is_enabled() of
+    case csrt_util:is_enabled() andalso csrt_util:is_enabled_reporting() of
         true ->
             maybe_report("csrt-pid-usage-lifetime", PidRef);
         false ->
@@ -190,6 +190,7 @@ is_match(_Rctx, undefined) ->
 is_match(#rctx{} = Rctx, Matchers) when is_map(Matchers) ->
     maps:size(find_matches([Rctx], Matchers)) > 0.
 
+%% Generate a report for the Rctx if it triggers an active Matcher
 -spec maybe_report(ReportName :: string(), PidRef :: maybe_pid_ref()) -> ok.
 maybe_report(ReportName, PidRef) ->
     Rctx = csrt_server:get_resource(PidRef),
@@ -201,7 +202,7 @@ maybe_report(ReportName, PidRef) ->
             ok
     end.
 
-%% Whether or not to remove zero value fields from reports
+%% Whether or not to remove zero value fields from reports to save on volume
 -spec should_truncate_reports() -> boolean().
 should_truncate_reports() ->
     config:get_boolean(?CSRT, "should_truncate_reports", true).

src/couch_stats/src/csrt_util.erl

@@ -14,6 +14,7 @@
 
 -export([
     is_enabled/0,
+    is_enabled_reporting/0,
     is_enabled_init_p/0,
     get_pid_ref/0,
     get_pid_ref/1,
@@ -68,25 +69,32 @@ is_enabled() ->
         true ->
             rand:uniform(100) > 80;
         false ->
-            config:get_boolean(?CSRT, "enabled", true)
+            config:get_boolean(?CSRT, "enable", true)
     end.
 -else.
 -spec is_enabled() -> boolean().
 is_enabled() ->
     %% TODO: toggle back to false before merging
-    config:get_boolean(?CSRT, "enabled", true).
+    config:get_boolean(?CSRT, "enable", true).
 -endif.
 
 -spec is_enabled_init_p() -> boolean().
 is_enabled_init_p() ->
-    config:get_boolean(?CSRT_INIT_P, "enabled", true).
+    %% TODO: toggle back to false before merging
+    config:get_boolean(?CSRT, "enable_init_p", true).
 
 -spec should_track_init_p(Mod :: atom(), Func :: atom()) -> boolean().
 should_track_init_p(fabric_rpc, Func) ->
     is_enabled_init_p() andalso config:get_boolean(?CSRT_INIT_P, fabric_conf_key(Func), false);
 should_track_init_p(_Mod, _Func) ->
     false.
 
+%% Toggle to disable all reporting
+-spec is_enabled_reporting() -> boolean().
+is_enabled_reporting() ->
+    %% TODO: toggle back to false before merging
+    config:get_boolean(?CSRT, "enable_reporting", true).
+
 %% Monotnonic time now in native format using time forward only event tracking
 -spec tnow() -> integer().
 tnow() ->
@@ -463,7 +471,7 @@ enable_init_p() ->
     enable_init_p(base_metrics()).
 
 enable_init_p(Metrics) ->
-    config:set(?CSRT_INIT_P, "enabled", "true", false),
+    config:set(?CSRT, "enable_init_p", "true", false),
     enable_init_p_metrics(Metrics).
 
 enable_init_p_metrics() ->
@@ -476,7 +484,7 @@ disable_init_p() ->
     disable_init_p(base_metrics()).
 
 disable_init_p(Metrics) ->
-    config:set(?CSRT_INIT_P, "enabled", "false", false),
+    config:set(?CSRT, "enable_init_p", "false", false),
     disable_init_p_metrics(Metrics).
 
 disable_init_p_metrics() ->