1 -module(beam_stats_consumer_statsd).
3 -include("include/beam_stats.hrl").
5 -behaviour(beam_stats_consumer).
18 %% Tests (to be run by CT):
20 [ ct_test__beam_stats_to_bins/1
21 , ct_test__memory_component_to_statsd_msg/1
22 , ct_test__statsd_msg_add_name_prefix/1
23 , ct_test__statsd_msg_to_bin/1
24 , ct_test__node_id_to_bin/1
28 {consumption_interval , non_neg_integer()}
29 | {dst_host , inet:ip_address() | inet:hostname()}
30 | {dst_port , inet:port_number()}
31 | {src_port , inet:port_number()}
34 -define(DEFAULT_DST_HOST, "localhost").
35 -define(DEFAULT_DST_PORT, 8125).
36 -define(DEFAULT_SRC_PORT, 8124).
38 -type metric_type() ::
39 % TODO: Add other metric types
44 , value :: non_neg_integer()
45 , type :: metric_type()
52 { sock :: hope_option:t(gen_udp:socket())
53 , dst_host :: inet:ip_address() | inet:hostname()
54 , dst_port :: inet:port_number()
55 , src_port :: inet:port_number()
61 -define(PATH_PREFIX, "beam_stats").
63 %% ============================================================================
64 %% Consumer implementation
65 %% ============================================================================
67 -spec init([option()]) ->
68 {non_neg_integer(), state()}.
70 ConsumptionInterval = hope_kv_list:get(Options, consumption_interval, 60000),
71 DstHost = hope_kv_list:get(Options, dst_host, ?DEFAULT_DST_HOST),
72 DstPort = hope_kv_list:get(Options, dst_port, ?DEFAULT_DST_PORT),
73 SrcPort = hope_kv_list:get(Options, src_port, ?DEFAULT_SRC_PORT),
80 {ConsumptionInterval, State}.
82 -spec consume(beam_stats_consumer:queue(), state()) ->
84 consume(Q, #state{}=State1) ->
85 Payload = beam_stats_queue_to_binary(Q),
86 State2 = try_to_connect_if_no_socket(State1),
87 try_to_send(State2, Payload).
89 -spec terminate(state()) ->
91 terminate(#state{sock=SockOpt}) ->
92 ok = hope_option:iter(SockOpt, fun gen_udp:close/1),
95 %% ============================================================================
97 %% ============================================================================
99 -spec try_to_send(state(), binary()) ->
101 try_to_send(#state{sock=none}=State, _) ->
102 io:format("error: socket closed~n"),
103 % TODO: Maybe schedule retry?
107 { sock = {some, Sock}
113 case gen_udp:send(Sock, DstHost, DstPort, Payload)
116 ; {error, _}=Error ->
117 io:format("error: gen_udp:send/4 failed: ~p~n", [Error]),
118 % TODO: Do something with unsent messages?
119 ok = gen_udp:close(Sock),
120 State#state{sock=none}
123 -spec try_to_connect_if_no_socket(state()) ->
125 try_to_connect_if_no_socket(#state{sock={some, _}}=State) ->
127 try_to_connect_if_no_socket(#state{sock=none, src_port=SrcPort}=State) ->
128 case gen_udp:open(SrcPort)
130 State#state{sock = {some, Sock}}
131 ; {error, _}=Error ->
132 io:format("error: gen_udp:open/1 failed: ~p~n", [Error]),
133 State#state{sock = none}
136 %% ============================================================================
138 %% ============================================================================
140 -spec beam_stats_queue_to_binary(beam_stats_consumer:queue()) ->
142 beam_stats_queue_to_binary(Q) ->
143 iolist_to_binary([beam_stats_to_bins(B) || B <- queue:to_list(Q)]).
145 -spec beam_stats_to_bins(beam_stats:t()) ->
147 beam_stats_to_bins(#beam_stats
152 NodeIDBin = node_id_to_bin(NodeID),
153 Msgs1 = memory_to_msgs(Memory),
154 Msgs2 = [statsd_msg_add_name_prefix(M, NodeIDBin) || M <- Msgs1],
155 [statsd_msg_to_bin(M) || M <- Msgs2].
157 -spec memory_to_msgs([{atom(), non_neg_integer()}]) ->
159 memory_to_msgs(Memory) ->
160 [memory_component_to_statsd_msg(MC) || MC <- Memory].
162 -spec memory_component_to_statsd_msg({atom(), non_neg_integer()}) ->
164 memory_component_to_statsd_msg({MemType, MemSize}) when MemSize >= 0 ->
166 { name = atom_to_binary(MemType, latin1)
171 -spec statsd_msg_add_name_prefix(statsd_msg(), binary()) ->
173 statsd_msg_add_name_prefix(#statsd_msg{name=Name1}=Msg, <<NodeID/binary>>) ->
174 Prefix = <<?PATH_PREFIX, ".", NodeID/binary, ".">>,
175 Name2 = <<Prefix/binary, Name1/binary>>,
176 Msg#statsd_msg{name=Name2}.
178 -spec statsd_msg_to_bin(statsd_msg()) ->
182 { name = <<Name/binary>>
184 , type = Type = gauge
187 TypeBin = metric_type_to_bin(Type),
188 ValueBin = integer_to_binary(Value),
197 -spec metric_type_to_bin(metric_type()) ->
199 metric_type_to_bin(gauge) ->
202 -spec node_id_to_bin(node()) ->
204 node_id_to_bin(NodeID) ->
205 NodeIDBin = atom_to_binary(NodeID, utf8),
206 re:replace(NodeIDBin, "[\@\.]", "_", [global, {return, binary}]).
208 %% ============================================================================
210 %% ============================================================================
212 ct_test__beam_stats_to_bins(_Cfg) ->
213 BEAMStats = #beam_stats{node_id = 'node@host.local', memory = [{foo,1}]},
214 [<<?PATH_PREFIX, ".node_host_local.foo:1|g\n">>] =
215 beam_stats_to_bins(BEAMStats).
217 ct_test__memory_component_to_statsd_msg(_Cfg) ->
218 #statsd_msg{name = <<"foo">>, value = 1, type = gauge} =
219 memory_component_to_statsd_msg({foo, 1}).
221 ct_test__statsd_msg_add_name_prefix(_Cfg) ->
222 Msg1 = #statsd_msg{name = <<"foo">>, value = 1, type = gauge},
223 Msg2 = statsd_msg_add_name_prefix(Msg1, <<"bar">>),
224 <<?PATH_PREFIX,".bar.foo">> = Msg2#statsd_msg.name.
226 ct_test__statsd_msg_to_bin(_Cfg) ->
227 Msg = #statsd_msg{name = <<"foo">>, value = 1, type = gauge},
228 <<"foo:1|g\n">> = statsd_msg_to_bin(Msg).
230 ct_test__node_id_to_bin(_Cfg) ->
231 <<"foo_bar_local">> = node_id_to_bin('foo@bar.local').