1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 2012. All Rights Reserved.
%%
%% The contents of this file are subject to the Erlang Public License,
%% Version 1.1, (the "License"); you may not use this file except in
%% compliance with the License. You should have received a copy of the
%% Erlang Public License along with this software. If not, it can be
%% retrieved online at http://www.erlang.org/.
%%
%% Software distributed under the License is distributed on an "AS IS"
%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
%% the License for the specific language governing rights and limitations
%% under the License.
%%
%% %CopyrightEnd%
%%
-module(ct_conn_log_h).
%%%
%%% A handler that can be connected to the error_logger event
%%% handler. Writes all ct connection events. See comments in
%%% cth_conn_log for more information.
%%%
-include("ct_util.hrl").
-export([init/1,
handle_event/2, handle_call/2, handle_info/2,
terminate/2]).
-record(state, {group_leader,logs=[]}).
-define(WIDTH,80).
%%%-----------------------------------------------------------------
%%% Callbacks
init({GL,Logs}) ->
open_files(Logs,#state{group_leader=GL}).
open_files([{ConnMod,{LogType,Logs}}|T],State) ->
case do_open_files(Logs,[]) of
{ok,Fds} ->
open_files(T,State#state{logs=[{ConnMod,{LogType,Fds}} |
State#state.logs]});
Error ->
Error
end;
open_files([],State) ->
{ok,State}.
do_open_files([{Tag,File}|Logs],Acc) ->
case file:open(File, [write]) of
{ok,Fd} ->
do_open_files(Logs,[{Tag,Fd}|Acc]);
{error,Reason} ->
{error,{could_not_open_log,File,Reason}}
end;
do_open_files([],Acc) ->
{ok,lists:reverse(Acc)}.
handle_event({_Type, GL, _Msg}, State) when node(GL) /= node() ->
{ok, State};
handle_event({_Type,_GL,{Pid,{ct_connection,Action,ConnName},Report}},State) ->
%% NOTE: if the format of this event is changed
%% ({ct_connection,Action,ConnName}) then remember to change
%% test_server_h:report_receiver as well!!!
Info = conn_info(Pid,#conn_log{name=ConnName,action=Action}),
write_report(now(),Info,Report,State),
{ok, State};
handle_event({_Type,_GL,{Pid,Info=#conn_log{},Report}},State) ->
%% NOTE: if the format of this event is changed
%% (Info=#conn_log{}) then remember to change
%% test_server_h:report_receiver as well!!!
write_report(now(),conn_info(Pid,Info),Report,State),
{ok, State};
handle_event({error_report,_,{Pid,_,[{ct_connection,ConnName}|R]}},State) ->
%% Error reports from connection
write_error(now(),conn_info(Pid,#conn_log{name=ConnName}),R,State),
{ok, State};
handle_event(_, State) ->
{ok, State}.
handle_info(_, State) ->
{ok, State}.
handle_call(_Query, State) ->
{ok, {error, bad_query}, State}.
terminate(_,#state{logs=Logs}) ->
[file:close(Fd) || {_,{_,Fds}} <- Logs, {_,Fd} <- Fds],
ok.
%%%-----------------------------------------------------------------
%%% Writing reports
write_report(Time,#conn_log{module=ConnMod}=Info,Data,State) ->
{LogType,Fd} = get_log(Info,State),
io:format(Fd,"~n~s~s~s",[format_head(ConnMod,LogType,Time),
format_title(LogType,Info),
format_data(ConnMod,LogType,Data)]).
write_error(Time,#conn_log{module=ConnMod}=Info,Report,State) ->
case get_log(Info,State) of
{html,_} ->
%% The error will anyway be written in the html log by the
%% sasl error handler, so don't write it again.
ok;
{LogType,Fd} ->
io:format(Fd,"~n~s~s~s",[format_head(ConnMod,LogType,Time," ERROR"),
format_title(LogType,Info),
format_error(LogType,Report)])
end.
get_log(Info,State) ->
case proplists:get_value(Info#conn_log.module,State#state.logs) of
{html,_} ->
{html,State#state.group_leader};
{LogType,Fds} ->
{LogType,get_fd(Info,Fds)};
undefined ->
{html,State#state.group_leader}
end.
get_fd(#conn_log{name=undefined},Fds) ->
proplists:get_value(default,Fds);
get_fd(#conn_log{name=ConnName},Fds) ->
case proplists:get_value(ConnName,Fds) of
undefined ->
proplists:get_value(default,Fds);
Fd ->
Fd
end.
%%%-----------------------------------------------------------------
%%% Formatting
format_head(ConnMod,LogType,Time) ->
format_head(ConnMod,LogType,Time,"").
format_head(ConnMod,raw,Time,Text) ->
io_lib:format("~n~p, ~p~s, ",[now_to_time(Time),ConnMod,Text]);
format_head(ConnMod,_,Time,Text) ->
Head = pad_char_end(?WIDTH,pretty_head(now_to_time(Time),ConnMod,Text),$=),
io_lib:format("~n~s",[Head]).
format_title(raw,#conn_log{client=Client}=Info) ->
io_lib:format("Client ~p ~s ~s",[Client,actionstr(Info),serverstr(Info)]);
format_title(_,Info) ->
Title = pad_char_end(?WIDTH,pretty_title(Info),$=),
io_lib:format("~n~s", [Title]).
format_data(_,_,NoData) when NoData == ""; NoData == <<>> ->
"";
format_data(ConnMod,LogType,Data) ->
ConnMod:format_data(LogType,Data).
format_error(raw,Report) ->
io_lib:format("~n~p~n",[Report]);
format_error(pretty,Report) ->
[io_lib:format("~n ~p: ~p",[K,V]) || {K,V} <- Report].
%%%-----------------------------------------------------------------
%%% Helpers
conn_info(LoggingProc, #conn_log{client=undefined} = ConnInfo) ->
conn_info(ConnInfo#conn_log{client=LoggingProc});
conn_info(_, ConnInfo) ->
conn_info(ConnInfo).
conn_info(#conn_log{client=Client, module=undefined} = ConnInfo) ->
case ets:lookup(ct_connections,Client) of
[#conn{address=Address,callback=Callback}] ->
ConnInfo#conn_log{address=Address,module=Callback};
[] ->
ConnInfo
end;
conn_info(ConnInfo) ->
ConnInfo.
now_to_time({_,_,MicroS}=Now) ->
{calendar:now_to_local_time(Now),MicroS}.
pretty_head({{{Y,Mo,D},{H,Mi,S}},MicroS},ConnMod,Text0) ->
Text = string:to_upper(atom_to_list(ConnMod) ++ Text0),
io_lib:format("= ~s ==== ~s-~s-~p::~s:~s:~s,~s ",
[Text,t(D),month(Mo),Y,t(H),t(Mi),t(S),
micro2milli(MicroS)]).
pretty_title(#conn_log{client=Client}=Info) ->
io_lib:format("= Client ~p ~s Server ~s ",
[Client,actionstr(Info),serverstr(Info)]).
actionstr(#conn_log{action=send}) -> "----->";
actionstr(#conn_log{action=recv}) -> "<-----";
actionstr(#conn_log{action=open}) -> "opened session to";
actionstr(#conn_log{action=close}) -> "closed session to";
actionstr(_) -> "<---->".
serverstr(#conn_log{name=undefined,address=Address}) ->
io_lib:format("~p",[Address]);
serverstr(#conn_log{name=Alias,address=Address}) ->
io_lib:format("~p(~p)",[Alias,Address]).
month(1) -> "Jan";
month(2) -> "Feb";
month(3) -> "Mar";
month(4) -> "Apr";
month(5) -> "May";
month(6) -> "Jun";
month(7) -> "Jul";
month(8) -> "Aug";
month(9) -> "Sep";
month(10) -> "Oct";
month(11) -> "Nov";
month(12) -> "Dec".
micro2milli(X) ->
pad0(3,integer_to_list(X div 1000)).
t(X) ->
pad0(2,integer_to_list(X)).
pad0(N,Str) ->
M = length(Str),
lists:duplicate(N-M,$0) ++ Str.
pad_char_end(N,Str,Char) ->
case length(lists:flatten(Str)) of
M when M<N -> Str ++ lists:duplicate(N-M,Char);
_ -> Str
end.
|
