mirror of
https://github.com/processone/ejabberd.git
synced 2024-06-02 21:17:12 +02:00
ead7e21037
Offline sessions should not be counted when reporting the number of connected resources. Apart from that, this number is now also reported when using a non-default session management backend.
274 lines
8.6 KiB
Erlang
274 lines
8.6 KiB
Erlang
%%%----------------------------------------------------------------------
|
|
%%% File : mod_stats.erl
|
|
%%% Author : Alexey Shchepin <alexey@process-one.net>
|
|
%%% Purpose : Basic statistics.
|
|
%%% Created : 11 Jan 2003 by Alexey Shchepin <alexey@process-one.net>
|
|
%%%
|
|
%%%
|
|
%%% ejabberd, Copyright (C) 2002-2016 ProcessOne
|
|
%%%
|
|
%%% This program is free software; you can redistribute it and/or
|
|
%%% modify it under the terms of the GNU General Public License as
|
|
%%% published by the Free Software Foundation; either version 2 of the
|
|
%%% License, or (at your option) any later version.
|
|
%%%
|
|
%%% This program is distributed in the hope that it will be useful,
|
|
%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
%%% General Public License for more details.
|
|
%%%
|
|
%%% You should have received a copy of the GNU General Public License along
|
|
%%% with this program; if not, write to the Free Software Foundation, Inc.,
|
|
%%% 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
%%%
|
|
%%%----------------------------------------------------------------------
|
|
|
|
-module(mod_stats).
|
|
|
|
-author('alexey@process-one.net').
|
|
|
|
-protocol({xep, 39, '0.6.0'}).
|
|
|
|
-behaviour(gen_mod).
|
|
|
|
-export([start/2, stop/1, process_local_iq/3,
|
|
mod_opt_type/1, depends/2]).
|
|
|
|
-include("ejabberd.hrl").
|
|
-include("logger.hrl").
|
|
-include("jlib.hrl").
|
|
|
|
start(Host, Opts) ->
|
|
IQDisc = gen_mod:get_opt(iqdisc, Opts, fun gen_iq_handler:check_type/1,
|
|
one_queue),
|
|
gen_iq_handler:add_iq_handler(ejabberd_local, Host,
|
|
?NS_STATS, ?MODULE, process_local_iq, IQDisc).
|
|
|
|
stop(Host) ->
|
|
gen_iq_handler:remove_iq_handler(ejabberd_local, Host,
|
|
?NS_STATS).
|
|
|
|
depends(_Host, _Opts) ->
|
|
[].
|
|
|
|
process_local_iq(_From, To,
|
|
#iq{id = _ID, type = Type, xmlns = XMLNS,
|
|
sub_el = SubEl, lang = Lang} =
|
|
IQ) ->
|
|
case Type of
|
|
set ->
|
|
Txt = <<"Value 'set' of 'type' attribute is not allowed">>,
|
|
IQ#iq{type = error, sub_el = [SubEl, ?ERRT_NOT_ALLOWED(Lang, Txt)]};
|
|
get ->
|
|
#xmlel{children = Els} = SubEl,
|
|
Node = str:tokens(fxml:get_tag_attr_s(<<"node">>, SubEl),
|
|
<<"/">>),
|
|
Names = get_names(Els, []),
|
|
case get_local_stats(To#jid.server, Node, Names, Lang) of
|
|
{result, Res} ->
|
|
IQ#iq{type = result,
|
|
sub_el =
|
|
[#xmlel{name = <<"query">>,
|
|
attrs = [{<<"xmlns">>, XMLNS}],
|
|
children = Res}]};
|
|
{error, Error} ->
|
|
IQ#iq{type = error, sub_el = [SubEl, Error]}
|
|
end
|
|
end.
|
|
|
|
get_names([], Res) -> Res;
|
|
get_names([#xmlel{name = <<"stat">>, attrs = Attrs}
|
|
| Els],
|
|
Res) ->
|
|
Name = fxml:get_attr_s(<<"name">>, Attrs),
|
|
case Name of
|
|
<<"">> -> get_names(Els, Res);
|
|
_ -> get_names(Els, [Name | Res])
|
|
end;
|
|
get_names([_ | Els], Res) -> get_names(Els, Res).
|
|
|
|
-define(STAT(Name),
|
|
#xmlel{name = <<"stat">>, attrs = [{<<"name">>, Name}],
|
|
children = []}).
|
|
|
|
get_local_stats(_Server, [], [], _Lang) ->
|
|
{result,
|
|
[?STAT(<<"users/online">>), ?STAT(<<"users/total">>),
|
|
?STAT(<<"users/all-hosts/online">>),
|
|
?STAT(<<"users/all-hosts/total">>)]};
|
|
get_local_stats(Server, [], Names, _Lang) ->
|
|
{result,
|
|
lists:map(fun (Name) -> get_local_stat(Server, [], Name)
|
|
end,
|
|
Names)};
|
|
get_local_stats(_Server, [<<"running nodes">>, _],
|
|
[], _Lang) ->
|
|
{result,
|
|
[?STAT(<<"time/uptime">>), ?STAT(<<"time/cputime">>),
|
|
?STAT(<<"users/online">>),
|
|
?STAT(<<"transactions/committed">>),
|
|
?STAT(<<"transactions/aborted">>),
|
|
?STAT(<<"transactions/restarted">>),
|
|
?STAT(<<"transactions/logged">>)]};
|
|
get_local_stats(_Server, [<<"running nodes">>, ENode],
|
|
Names, Lang) ->
|
|
case search_running_node(ENode) of
|
|
false ->
|
|
Txt = <<"No running node found">>,
|
|
{error, ?ERRT_ITEM_NOT_FOUND(Lang, Txt)};
|
|
Node ->
|
|
{result,
|
|
lists:map(fun (Name) -> get_node_stat(Node, Name) end,
|
|
Names)}
|
|
end;
|
|
get_local_stats(_Server, _, _, Lang) ->
|
|
Txt = <<"No statistics found for this item">>,
|
|
{error, ?ERRT_FEATURE_NOT_IMPLEMENTED(Lang, Txt)}.
|
|
|
|
-define(STATVAL(Val, Unit),
|
|
#xmlel{name = <<"stat">>,
|
|
attrs =
|
|
[{<<"name">>, Name}, {<<"units">>, Unit},
|
|
{<<"value">>, Val}],
|
|
children = []}).
|
|
|
|
-define(STATERR(Code, Desc),
|
|
#xmlel{name = <<"stat">>, attrs = [{<<"name">>, Name}],
|
|
children =
|
|
[#xmlel{name = <<"error">>,
|
|
attrs = [{<<"code">>, Code}],
|
|
children = [{xmlcdata, Desc}]}]}).
|
|
|
|
get_local_stat(Server, [], Name)
|
|
when Name == <<"users/online">> ->
|
|
case catch ejabberd_sm:get_vh_session_list(Server) of
|
|
{'EXIT', _Reason} ->
|
|
?STATERR(<<"500">>, <<"Internal Server Error">>);
|
|
Users ->
|
|
?STATVAL((iolist_to_binary(integer_to_list(length(Users)))),
|
|
<<"users">>)
|
|
end;
|
|
get_local_stat(Server, [], Name)
|
|
when Name == <<"users/total">> ->
|
|
case catch
|
|
ejabberd_auth:get_vh_registered_users_number(Server)
|
|
of
|
|
{'EXIT', _Reason} ->
|
|
?STATERR(<<"500">>, <<"Internal Server Error">>);
|
|
NUsers ->
|
|
?STATVAL((iolist_to_binary(integer_to_list(NUsers))),
|
|
<<"users">>)
|
|
end;
|
|
get_local_stat(_Server, [], Name)
|
|
when Name == <<"users/all-hosts/online">> ->
|
|
Users = ejabberd_sm:connected_users_number(),
|
|
?STATVAL((iolist_to_binary(integer_to_list(Users))), <<"users">>);
|
|
get_local_stat(_Server, [], Name)
|
|
when Name == <<"users/all-hosts/total">> ->
|
|
NumUsers = lists:foldl(fun (Host, Total) ->
|
|
ejabberd_auth:get_vh_registered_users_number(Host)
|
|
+ Total
|
|
end,
|
|
0, ?MYHOSTS),
|
|
?STATVAL((iolist_to_binary(integer_to_list(NumUsers))),
|
|
<<"users">>);
|
|
get_local_stat(_Server, _, Name) ->
|
|
?STATERR(<<"404">>, <<"Not Found">>).
|
|
|
|
get_node_stat(Node, Name)
|
|
when Name == <<"time/uptime">> ->
|
|
case catch ejabberd_cluster:call(Node, erlang, statistics,
|
|
[wall_clock])
|
|
of
|
|
{badrpc, _Reason} ->
|
|
?STATERR(<<"500">>, <<"Internal Server Error">>);
|
|
CPUTime ->
|
|
?STATVAL(list_to_binary(
|
|
io_lib:format("~.3f",
|
|
[element(1, CPUTime) / 1000])),
|
|
<<"seconds">>)
|
|
end;
|
|
get_node_stat(Node, Name)
|
|
when Name == <<"time/cputime">> ->
|
|
case catch ejabberd_cluster:call(Node, erlang, statistics, [runtime])
|
|
of
|
|
{badrpc, _Reason} ->
|
|
?STATERR(<<"500">>, <<"Internal Server Error">>);
|
|
RunTime ->
|
|
?STATVAL(list_to_binary(
|
|
io_lib:format("~.3f",
|
|
[element(1, RunTime) / 1000])),
|
|
<<"seconds">>)
|
|
end;
|
|
get_node_stat(Node, Name)
|
|
when Name == <<"users/online">> ->
|
|
case catch ejabberd_cluster:call(Node, ejabberd_sm,
|
|
dirty_get_my_sessions_list, [])
|
|
of
|
|
{badrpc, _Reason} ->
|
|
?STATERR(<<"500">>, <<"Internal Server Error">>);
|
|
Users ->
|
|
?STATVAL((iolist_to_binary(integer_to_list(length(Users)))),
|
|
<<"users">>)
|
|
end;
|
|
get_node_stat(Node, Name)
|
|
when Name == <<"transactions/committed">> ->
|
|
case catch ejabberd_cluster:call(Node, mnesia, system_info,
|
|
[transaction_commits])
|
|
of
|
|
{badrpc, _Reason} ->
|
|
?STATERR(<<"500">>, <<"Internal Server Error">>);
|
|
Transactions ->
|
|
?STATVAL((iolist_to_binary(integer_to_list(Transactions))),
|
|
<<"transactions">>)
|
|
end;
|
|
get_node_stat(Node, Name)
|
|
when Name == <<"transactions/aborted">> ->
|
|
case catch ejabberd_cluster:call(Node, mnesia, system_info,
|
|
[transaction_failures])
|
|
of
|
|
{badrpc, _Reason} ->
|
|
?STATERR(<<"500">>, <<"Internal Server Error">>);
|
|
Transactions ->
|
|
?STATVAL((iolist_to_binary(integer_to_list(Transactions))),
|
|
<<"transactions">>)
|
|
end;
|
|
get_node_stat(Node, Name)
|
|
when Name == <<"transactions/restarted">> ->
|
|
case catch ejabberd_cluster:call(Node, mnesia, system_info,
|
|
[transaction_restarts])
|
|
of
|
|
{badrpc, _Reason} ->
|
|
?STATERR(<<"500">>, <<"Internal Server Error">>);
|
|
Transactions ->
|
|
?STATVAL((iolist_to_binary(integer_to_list(Transactions))),
|
|
<<"transactions">>)
|
|
end;
|
|
get_node_stat(Node, Name)
|
|
when Name == <<"transactions/logged">> ->
|
|
case catch ejabberd_cluster:call(Node, mnesia, system_info,
|
|
[transaction_log_writes])
|
|
of
|
|
{badrpc, _Reason} ->
|
|
?STATERR(<<"500">>, <<"Internal Server Error">>);
|
|
Transactions ->
|
|
?STATVAL((iolist_to_binary(integer_to_list(Transactions))),
|
|
<<"transactions">>)
|
|
end;
|
|
get_node_stat(_, Name) ->
|
|
?STATERR(<<"404">>, <<"Not Found">>).
|
|
|
|
search_running_node(SNode) ->
|
|
search_running_node(SNode,
|
|
mnesia:system_info(running_db_nodes)).
|
|
|
|
search_running_node(_, []) -> false;
|
|
search_running_node(SNode, [Node | Nodes]) ->
|
|
case iolist_to_binary(atom_to_list(Node)) of
|
|
SNode -> Node;
|
|
_ -> search_running_node(SNode, Nodes)
|
|
end.
|
|
|
|
mod_opt_type(iqdisc) -> fun gen_iq_handler:check_type/1;
|
|
mod_opt_type(_) -> [iqdisc].
|