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
| %% Copyright (c) 2011-2012 Basho Technologies, Inc. All Rights Reserved.
| %%
| %% This file is provided to you 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.
|
|
| -define(DEFAULT_TRUNCATION, 4096).
| -define(DEFAULT_TRACER, lager_default_tracer).
| -define(DEFAULT_SINK, lager_event).
| -define(ERROR_LOGGER_SINK, error_logger_lager_event).
|
| -define(METADATA(Extras), [{severity, info},
| {pid, self()},
| {node, node()},
| {module, ?MODULE},
| {function, ?FUNCTION_NAME},
| {function_arity, ?FUNCTION_ARITY},
| {file, ?FILE},
| {line, ?LINE} | Extras]).
|
| -define(lager_log(Severity, Format, Args, Safety),
| ?lager_log(?DEFAULT_SINK, Severity, ?METADATA(lager:md()), Format, Args,
| ?DEFAULT_TRUNCATION, Safety)).
| -define(lager_log(Severity, Metadata, Format, Args, Safety),
| ?lager_log(?DEFAULT_SINK, Severity, ?METADATA(Metadata++lager:md()), Format, Args,
| ?DEFAULT_TRUNCATION, Safety)).
|
| -define(lager_log(Sink, Severity, Metadata, Format, Args, Size, Safety),
| _ = lager:dispatch_log(Sink, Severity, Metadata, Format, Args, Size, Safety)).
|
| -define(lager_debug(Format, Args), ?lager_log(debug, Format, Args, safe)).
| -define(lager_debug(Metadata, Format, Args), ?lager_log(debug, Metadata, Format, Args, safe)).
|
| -define(lager_info(Format, Args), ?lager_log(info, Format, Args, safe)).
| -define(lager_info(Metadata, Format, Args), ?lager_log(info, Metadata, Format, Args, safe)).
|
| -define(lager_notice(Format, Args), ?lager_log(notice, Format, Args, safe)).
| -define(lager_notice(Metadata, Format, Args), ?lager_log(notice, Metadata, Format, Args, safe)).
|
| -define(lager_warning(Format, Args), ?lager_log(warning, Format, Args, safe)).
| -define(lager_warning(Metadata, Format, Args), ?lager_log(warning, Metadata, Format, Args, safe)).
|
| -define(lager_error(Format, Args), ?lager_log(error, Format, Args, safe)).
| -define(lager_error(Metadata, Format, Args), ?lager_log(error, Metadata, Format, Args, safe)).
|
| -define(lager_critical(Format, Args), ?lager_log(critical, Format, Args, safe)).
| -define(lager_critical(Metadata, Format, Args), ?lager_log(critical, Metadata, Format, Args, safe)).
|
| -define(lager_alert(Format, Args), ?lager_log(alert, Format, Args, safe)).
| -define(lager_alert(Metadata, Format, Args), ?lager_log(alert, Metadata, Format, Args, safe)).
|
| -define(lager_emergency(Format, Args), ?lager_log(emergency, Format, Args, safe)).
| -define(lager_emergency(Metadata, Format, Args), ?lager_log(emergency, Metadata, Format, Args, safe)).
|
| -define(lager_none(Format, Args), ?lager_log(none, Format, Args, safe)).
| -define(lager_none(Metadata, Format, Args), ?lager_log(none, Metadata, Format, Args, safe)).
|
| -define(LEVELS,
| [debug, info, notice, warning, error, critical, alert, emergency, none]).
|
| %% Use of these "functions" means that the argument list will not be
| %% truncated for safety
| -define(LEVELS_UNSAFE,
| [{debug_unsafe, debug}, {info_unsafe, info}, {notice_unsafe, notice}, {warning_unsafe, warning}, {error_unsafe, error}, {critical_unsafe, critical}, {alert_unsafe, alert}, {emergency_unsafe, emergency}]).
|
| -define(DEBUG, 128).
| -define(INFO, 64).
| -define(NOTICE, 32).
| -define(WARNING, 16).
| -define(ERROR, 8).
| -define(CRITICAL, 4).
| -define(ALERT, 2).
| -define(EMERGENCY, 1).
| -define(LOG_NONE, 0).
|
| -define(LEVEL2NUM(Level),
| case Level of
| debug -> ?DEBUG;
| info -> ?INFO;
| notice -> ?NOTICE;
| warning -> ?WARNING;
| error -> ?ERROR;
| critical -> ?CRITICAL;
| alert -> ?ALERT;
| emergency -> ?EMERGENCY
| end).
|
| -define(NUM2LEVEL(Num),
| case Num of
| ?DEBUG -> debug;
| ?INFO -> info;
| ?NOTICE -> notice;
| ?WARNING -> warning;
| ?ERROR -> error;
| ?CRITICAL -> critical;
| ?ALERT -> alert;
| ?EMERGENCY -> emergency
| end).
|
| -define(SHOULD_LOG(Sink, Level),
| (lager_util:level_to_num(Level) band element(1, lager_config:get({Sink, loglevel}, {?LOG_NONE, []}))) /= 0).
|
| -define(SHOULD_LOG(Level),
| (lager_util:level_to_num(Level) band element(1, lager_config:get(loglevel, {?LOG_NONE, []}))) /= 0).
|
| -define(NOTIFY(Level, Pid, Format, Args),
| gen_event:notify(lager_event, {log, lager_msg:new(io_lib:format(Format, Args),
| Level,
| [{pid,Pid},{line,?LINE},{file,?FILE},{module,?MODULE}],
| [])}
| )).
|
| %% FOR INTERNAL USE ONLY
| %% internal non-blocking logging call
| %% there's some special handing for when we try to log (usually errors) while
| %% lager is still starting.
| -ifdef(TEST).
| -define(INT_LOG(Level, Format, Args),
| case ?SHOULD_LOG(Level) of
| true ->
| ?NOTIFY(Level, self(), Format, Args);
| _ ->
| ok
| end).
| -else.
| -define(INT_LOG(Level, Format, Args),
| Self = self(),
| %% do this in a spawn so we don't cause a deadlock calling gen_event:which_handlers
| %% from a gen_event handler
| spawn(fun() ->
| case catch(gen_event:which_handlers(lager_event)) of
| X when X == []; X == {'EXIT', noproc}; X == [lager_backend_throttle] ->
| %% there's no handlers yet or lager isn't running, try again
| %% in half a second.
| timer:sleep(500),
| ?NOTIFY(Level, Self, Format, Args);
| _ ->
| case ?SHOULD_LOG(Level) of
| true ->
| ?NOTIFY(Level, Self, Format, Args);
| _ ->
| ok
| end
| end
| end)).
| -endif.
|
| -record(lager_shaper, {
| id :: any(),
| %% how many messages per second we try to deliver
| hwm = undefined :: 'undefined' | pos_integer(),
| %% how many messages we've received this second
| mps = 0 :: non_neg_integer(),
| %% the current second
| lasttime = os:timestamp() :: erlang:timestamp(),
| %% count of dropped messages this second
| dropped = 0 :: non_neg_integer(),
| %% If true, flush notify messages from msg queue at overload
| flush_queue = true :: boolean(),
| flush_threshold = 0 :: integer(),
| %% timer
| timer = make_ref() :: reference(),
| %% optional filter fun to avoid counting suppressed messages against HWM totals
| filter = fun(_) -> false end :: fun()
| }).
|
| -type lager_shaper() :: #lager_shaper{}.
|
|
