iilyak commented on code in PR #5491: URL: https://github.com/apache/couchdb/pull/5491#discussion_r2056461118
########## src/couch_stats/src/csrt.erl: ########## @@ -0,0 +1,489 @@ +% Licensed under the Apache License, Version 2.0 (the "License"); you may not +% use this file except in compliance with the License. You may obtain a copy of +% the License at +% +% http://www.apache.org/licenses/LICENSE-2.0 +% +% Unless required by applicable law or agreed to in writing, software +% distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +% WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +% License for the specific language governing permissions and limitations under +% the License. + +-module(csrt). + +-include_lib("couch/include/couch_db.hrl"). +-include_lib("couch_stats_resource_tracker.hrl"). + +%% PidRef API +-export([ + destroy_pid_ref/0, + destroy_pid_ref/1, + create_pid_ref/0, + get_pid_ref/0, + get_pid_ref/1, + set_pid_ref/1 +]). + +%% Context API +-export([ + create_context/2, + create_coordinator_context/2, + create_worker_context/3, + destroy_context/0, + destroy_context/1, + get_resource/0, + get_resource/1, + set_context_dbname/1, + set_context_dbname/2, + set_context_handler_fun/1, + set_context_handler_fun/2, + set_context_username/1, + set_context_username/2 +]). + +%% Public API +-export([ + is_enabled/0, + is_enabled_init_p/0, + do_report/2, + maybe_report/2 +]). + +%% stats collection api +-export([ + accumulate_delta/1, + add_delta/2, + docs_written/1, + extract_delta/1, + get_delta/0, + inc/1, + inc/2, + ioq_called/0, + js_filtered/1, + make_delta/0, + rctx_delta/2, + maybe_add_delta/1, + maybe_add_delta/2, + maybe_inc/2, + should_track_init_p/1 +]). + +%% aggregate query api +-export([ + active/0, + active/1, + active_coordinators/0, + active_coordinators/1, + active_workers/0, + active_workers/1, + count_by/1, + find_by_nonce/1, + find_by_pid/1, + find_by_pidref/1, + find_workers_by_pidref/1, + group_by/2, + group_by/3, + sorted/1, + sorted_by/1, + sorted_by/2, + sorted_by/3 +]). + +%% +%% PidRef operations +%% + +-spec get_pid_ref() -> maybe_pid_ref(). +get_pid_ref() -> + csrt_util:get_pid_ref(). + +-spec get_pid_ref(Rctx :: rctx()) -> pid_ref(). +get_pid_ref(Rctx) -> + csrt_util:get_pid_ref(Rctx). + +-spec set_pid_ref(PidRef :: pid_ref()) -> pid_ref(). +set_pid_ref(PidRef) -> + csrt_util:set_pid_ref(PidRef). + +-spec create_pid_ref() -> pid_ref(). +create_pid_ref() -> + csrt_server:create_pid_ref(). + +-spec destroy_pid_ref() -> maybe_pid_ref(). +destroy_pid_ref() -> + destroy_pid_ref(get_pid_ref()). + +%%destroy_pid_ref(undefined) -> +%% undefined; +-spec destroy_pid_ref(PidRef :: maybe_pid_ref()) -> maybe_pid_ref(). +destroy_pid_ref(_PidRef) -> + erase(?PID_REF). + +%% +%% Context lifecycle API +%% + +%% TODO: shouldn't need this? +%% create_resource(#rctx{} = Rctx) -> +%% csrt_server:create_resource(Rctx). + +-spec create_worker_context(From, MFA, Nonce) -> pid_ref() | false when + From :: pid_ref(), MFA :: mfa(), Nonce :: term(). +create_worker_context(From, {M, F, _A}, Nonce) -> + case is_enabled() of + true -> + Type = #rpc_worker{from = From, mod = M, func = F}, + create_context(Type, Nonce); + false -> + false + end. + +-spec create_coordinator_context(Httpd, Path) -> pid_ref() | false when + Httpd :: #httpd{}, Path :: list(). +create_coordinator_context(#httpd{method = Verb, nonce = Nonce}, Path0) -> + case is_enabled() of + true -> + Path = list_to_binary([$/ | Path0]), + Type = #coordinator{method = Verb, path = Path}, + create_context(Type, Nonce); + false -> + false + end. + +-spec create_context(Type :: rctx_type(), Nonce :: term()) -> pid_ref(). +create_context(Type, Nonce) -> + Rctx = csrt_server:new_context(Type, Nonce), + %% TODO: which approach + %% PidRef = csrt_server:pid_ref(Rctx), + PidRef = get_pid_ref(Rctx), + set_pid_ref(PidRef), + csrt_util:set_delta_zero(Rctx), + csrt_util:set_delta_a(Rctx), + csrt_server:create_resource(Rctx), + csrt_logger:track(Rctx), + PidRef. + +-spec set_context_dbname(DbName :: binary()) -> boolean(). +set_context_dbname(DbName) -> + set_context_dbname(DbName, get_pid_ref()). + +-spec set_context_dbname(DbName, PidRef) -> boolean() when + DbName :: binary(), PidRef :: pid_ref() | undefined. +set_context_dbname(_, undefined) -> + false; +set_context_dbname(DbName, PidRef) -> + is_enabled() andalso csrt_server:set_context_dbname(DbName, PidRef). + +-spec set_context_handler_fun(Fun :: function()) -> boolean(). +set_context_handler_fun(Fun) when is_function(Fun) -> + case is_enabled() of + false -> + false; + true -> + FProps = erlang:fun_info(Fun), + Mod = proplists:get_value(module, FProps), + Func = proplists:get_value(name, FProps), + update_handler_fun(Mod, Func, get_pid_ref()) + end. + +-spec set_context_handler_fun(Mod :: atom(), Func :: atom()) -> boolean(). +set_context_handler_fun(Mod, Func) when + is_atom(Mod) andalso is_atom(Func) +-> + case is_enabled() of + false -> + false; + true -> + update_handler_fun(Mod, Func, get_pid_ref()) + end. + +-spec update_handler_fun(Mod, Func, PidRef) -> boolean() when + Mod :: atom(), Func :: atom(), PidRef :: maybe_pid_ref(). +update_handler_fun(_, _, undefined) -> + false; +update_handler_fun(Mod, Func, PidRef) -> + Rctx = get_resource(PidRef), + %% TODO: #coordinator{} assumption needs to adapt for other types + #coordinator{} = Coordinator0 = csrt_server:get_context_type(Rctx), + Coordinator = Coordinator0#coordinator{mod = Mod, func = Func}, + csrt_server:set_context_type(Coordinator, PidRef), + ok. Review Comment: The type spec of the `update_handler_fun` declares return type as `boolean()`, please change `ok` to `true` or update spec. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: notifications-unsubscr...@couchdb.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
