getting rid of http connection_type for tcp/tls data in/out metrics

Author: DenysGonchar

big_tests/tests/bosh_SUITE.erl

@@ -107,7 +107,7 @@ acks_test_cases() ->
 %%--------------------------------------------------------------------
 
 init_per_suite(Config) ->
-    instrument_helper:start(instrumentation_events(), negative_instrumentation_events()),
+    instrument_helper:start(instrumentation_events()),
     Config1 = dynamic_modules:save_modules(host_type(), Config),
     escalus:init_per_suite([{escalus_user_db, {module, escalus_ejabberd}} | Config1]).
 
@@ -195,9 +195,6 @@ create_and_terminate_session(Config) ->
     [instrument_helper:assert(Event, Label, fun(#{byte_size := BS}) -> BS > 0 end)
      || {Event, Label} <- instrumentation_events(), Event =/= c2s_message_processed],
 
-    %% Verify C2S listener is not used
-    instrument_helper:assert_not_emitted(negative_instrumentation_events()),
-
     %% Assert the session was terminated.
     wait_for_zero_bosh_sessions().
 
@@ -954,11 +951,4 @@ instrumentation_events() ->
     instrument_helper:declared_events(mod_bosh, [])
     ++ [{c2s_message_processed, #{host_type => domain_helper:host_type()}},
         {xmpp_element_size_out, #{connection_type => c2s}, #{metrics => #{byte_size => histogram}}},
-        {xmpp_element_size_in, #{connection_type => c2s}, #{metrics => #{byte_size => histogram}}}]
-    -- negative_instrumentation_events().
-
-negative_instrumentation_events() ->
-    [{tcp_data_out, #{connection_type => c2s}},
-     {tcp_data_in, #{connection_type => c2s}},
-     {tls_data_out, #{connection_type => c2s}},
-     {tls_data_in, #{connection_type => c2s}}].
+        {xmpp_element_size_in, #{connection_type => c2s}, #{metrics => #{byte_size => histogram}}}].

big_tests/tests/websockets_SUITE.erl

@@ -54,7 +54,7 @@ suite() ->
 %%--------------------------------------------------------------------
 
 init_per_suite(Config) ->
-    instrument_helper:start(instrumentation_events(), negative_instrumentation_events()),
+    instrument_helper:start(instrumentation_events()),
     Config1 = escalus:init_per_suite(Config),
     Config2 = setup_listeners(Config1),
     escalus:create_users(Config2, escalus:get_users([alice, geralt, geralt_s, carol])).
@@ -116,8 +116,6 @@ metrics_test(Config) ->
                                                    (#{time := Time}) -> Time > 0 end)
          || {Event, Label} <- instrumentation_events()],
 
-        %% Verify C2S listener is not used
-        instrument_helper:assert_not_emitted(negative_instrumentation_events()),
         ok
         end).
 
@@ -172,11 +170,4 @@ instrumentation_events() ->
     instrument_helper:declared_events(mod_websockets, [])
     ++ [{c2s_message_processed, #{host_type => domain_helper:host_type()}},
         {xmpp_element_size_out, #{connection_type => c2s}, #{metrics => #{byte_size => histogram}}},
-        {xmpp_element_size_in, #{connection_type => c2s}, #{metrics => #{byte_size => histogram}}}]
-    -- negative_instrumentation_events().
-
-negative_instrumentation_events() ->
-    [{tcp_data_out, #{connection_type => c2s}},
-     {tcp_data_in, #{connection_type => c2s}},
-     {tls_data_out, #{connection_type => c2s}},
-     {tls_data_in, #{connection_type => c2s}}].
+        {xmpp_element_size_in, #{connection_type => c2s}, #{metrics => #{byte_size => histogram}}}].

src/c2s/mongoose_c2s.erl

@@ -65,6 +65,33 @@
 
 -export_type([packet/0, data/0, state/0, state/1, fsm_res/0, fsm_res/1, retries/0]).
 
+-export([instrumentation/0]).
+-ignore_xref([instrumentation/0]).
+
+-spec instrumentation() -> [mongoose_instrument:spec()].
+instrumentation() ->
+    Acc = [
+        {tcp_data_in, #{connection_type => c2s}, #{metrics => #{byte_size => spiral}}},
+        {tcp_data_out, #{connection_type => c2s}, #{metrics => #{byte_size => spiral}}},
+        {tls_data_in, #{connection_type => c2s}, #{metrics => #{byte_size => spiral}}},
+        {tls_data_out, #{connection_type => c2s}, #{metrics => #{byte_size => spiral}}},
+        {xmpp_element_size_out, #{connection_type => c2s}, #{metrics => #{byte_size => histogram}}},
+        {xmpp_element_size_in, #{connection_type => c2s}, #{metrics => #{byte_size => histogram}}}
+    ],
+    lists:foldl(fun instrumentation/2, Acc, ?ALL_HOST_TYPES).
+
+-spec instrumentation(mongooseim:host_type(), [mongoose_instrument:spec()]) ->
+     [mongoose_instrument:spec()].
+instrumentation(HostType, Acc) when is_binary(HostType) ->
+    [{c2s_message_processed, #{host_type => HostType},
+      #{metrics => #{time => histogram}}},
+     {c2s_auth_failed, #{host_type => HostType},
+      #{metrics => #{count => spiral}}},
+     {c2s_element_in, #{host_type => HostType},
+      #{metrics => maps:from_list([{Metric, spiral} || Metric <- mongoose_listener:element_spirals()])}},
+     {c2s_element_out, #{host_type => HostType},
+      #{metrics => maps:from_list([{Metric, spiral} || Metric <- mongoose_listener:element_spirals()])}} | Acc].
+
 %%%----------------------------------------------------------------------
 %%% gen_statem
 %%%----------------------------------------------------------------------

src/c2s/mongoose_c2s_listener.erl

@@ -3,41 +3,14 @@
 -include("mongoose.hrl").
 
 -behaviour(mongoose_listener).
--export([listener_spec/1, instrumentation/1]).
+-export([listener_spec/1]).
 
 -behaviour(ranch_protocol).
 -export([start_link/3]).
 
 %% Hook handlers
 -export([handle_user_open_session/3]).
 
--export([instrumentation/0]).
--ignore_xref([instrumentation/0]).
-
--spec instrumentation(_) -> [mongoose_instrument:spec()].
-instrumentation(_) ->
-    lists:foldl(fun instrumentation/2, instrumentation(), ?ALL_HOST_TYPES).
-
--spec instrumentation() -> [mongoose_instrument:spec()].
-instrumentation() ->
-    [{tcp_data_in, #{connection_type => c2s}, #{metrics => #{byte_size => spiral}}},
-     {tcp_data_out, #{connection_type => c2s}, #{metrics => #{byte_size => spiral}}},
-     {tls_data_in, #{connection_type => c2s}, #{metrics => #{byte_size => spiral}}},
-     {tls_data_out, #{connection_type => c2s}, #{metrics => #{byte_size => spiral}}},
-     {xmpp_element_size_out, #{connection_type => c2s}, #{metrics => #{byte_size => histogram}}},
-     {xmpp_element_size_in, #{connection_type => c2s}, #{metrics => #{byte_size => histogram}}}].
-
--spec instrumentation(_, _) -> [mongoose_instrument:spec()].
-instrumentation(HostType, Acc) when is_binary(HostType) ->
-    [{c2s_message_processed, #{host_type => HostType},
-      #{metrics => #{time => histogram}}},
-     {c2s_auth_failed, #{host_type => HostType},
-      #{metrics => #{count => spiral}}},
-     {c2s_element_in, #{host_type => HostType},
-      #{metrics => maps:from_list([{Metric, spiral} || Metric <- mongoose_listener:element_spirals()])}},
-     {c2s_element_out, #{host_type => HostType},
-      #{metrics => maps:from_list([{Metric, spiral} || Metric <- mongoose_listener:element_spirals()])}} | Acc].
-
 %% mongoose_listener
 -spec listener_spec(mongoose_listener:options()) -> supervisor:child_spec().
 listener_spec(Opts) ->

src/ejabberd_cowboy.erl

@@ -52,13 +52,8 @@
 
 -spec instrumentation(mongoose_listener:options()) -> [mongoose_instrument:spec()].
 instrumentation(#{handlers := Handlers}) ->
-    PerModule = [Spec || #{module := Module} <- Handlers,
-                         Spec <- mongoose_http_handler:instrumentation(Module)],
-    [{tcp_data_in, #{connection_type => http}, #{metrics => #{byte_size => spiral}}},
-     {tcp_data_out, #{connection_type => http}, #{metrics => #{byte_size => spiral}}},
-     {tls_data_in, #{connection_type => http}, #{metrics => #{byte_size => spiral}}},
-     {tls_data_out, #{connection_type => http}, #{metrics => #{byte_size => spiral}}}
-     | PerModule].
+    [Spec || #{module := Module} <- Handlers,
+             Spec <- mongoose_http_handler:instrumentation(Module)].
 
 -spec listener_spec(mongoose_listener:options()) -> supervisor:child_spec().
 listener_spec(Opts) ->

src/listeners/mongoose_listener.erl

@@ -110,7 +110,9 @@ stop_listener(Opts) ->
 %% Each listener module could be started more than once on different ports.
 -spec instrumentation([options()]) -> [mongoose_instrument:spec()].
 instrumentation(Listeners) ->
-    lists:usort([Spec || Listener <- Listeners, Spec <- listener_instrumentation(Listener)]).
+    %% c2s instrumentation is shared between Bosh, Websockets and TCP listeners
+    lists:usort([Spec || Listener <- Listeners, Spec <- listener_instrumentation(Listener)])
+    ++ mongoose_c2s:instrumentation().
 
 -spec listener_instrumentation(options()) -> [mongoose_instrument:spec()].
 listener_instrumentation(Opts = #{module := Module}) ->

src/listeners/mongoose_xmpp_socket.erl

@@ -23,8 +23,6 @@
          get_transport/1,
          get_conn_type/1]).
 
--callback new(ranch:ref(), mongoose_listener:connection_type(), mongoose_listener:options()) ->
-    {state(), mongoose_listener:connection_type()}.
 -callback peername(state()) -> mongoose_transport:peer().
 -callback tcp_to_tls(state(), mongoose_listener:options(), side()) ->
     {ok, state()} | {error, term()}.
@@ -97,11 +95,10 @@ accept(ranch_ssl, Type, Ref, LOpts) ->
                              ranch_ref = Ref, ip = {PeerIp, PeerPort}},
     activate(SocketState),
     SocketState;
-accept(Module, Type, Ref, LOpts) ->
-    {State, NewType} = Module:new(Ref, Type, LOpts),
+accept(Module, Type, State, _LOpts) ->
     PeerIp = Module:peername(State),
     SocketState = #xmpp_socket{module = Module, state = State,
-                               connection_type = NewType, ip = PeerIp},
+                               connection_type = Type, ip = PeerIp},
     activate(SocketState),
     SocketState.
 

src/mod_bosh_socket.erl

@@ -20,8 +20,7 @@
          get_cached_responses/1]).
 
 %% mongoose_xmpp_socket callbacks
--export([new/3,
-         peername/1,
+-export([peername/1,
          tcp_to_tls/3,
          handle_data/2,
          activate/1,
@@ -1051,11 +1050,6 @@ ignore_undefined(Map) ->
 
 %% mongoose_xmpp_socket callbacks
 
--spec new(mod_bosh:socket(), mongoose_listener:connection_type(), mongoose_listener:options()) ->
-    {mod_bosh:socket(), mongoose_listener:connection_type()}.
-new(Socket, _, _LOpts) ->
-    {Socket, http}.
-
 -spec peername(mod_bosh:socket()) -> mongoose_transport:peer().
 peername(#bosh_socket{peer = Peer}) ->
     Peer.

src/mod_websockets.erl

@@ -21,8 +21,7 @@
          terminate/3]).
 
 %% mongoose_xmpp_socket callbacks
--export([new/3,
-         peername/1,
+-export([peername/1,
          tcp_to_tls/3,
          handle_data/2,
          activate/1,
@@ -367,11 +366,6 @@ case_insensitive_match(_, []) ->
 
 %% mongoose_xmpp_socket callbacks
 
--spec new(socket(), mongoose_listener:connection_type(), mongoose_listener:options()) ->
-    {socket(), mongoose_listener:connection_type()}.
-new(Socket, _, _LOpts) ->
-    {Socket, http}.
-
 -spec peername(socket()) -> mongoose_transport:peer().
 peername(#websocket{peername = PeerName}) ->
     PeerName.