./ct_report/coverage/mongoose_instrument_exometer.COVER.html

1 -module(mongoose_instrument_exometer).
2
3 -behaviour(mongoose_instrument).
4
5 -define(PREFIXES, {?MODULE, prefixes}).
6
7 -export([config_spec/0, start/0, stop/0, set_up/3, handle_event/4]).
8
9 -include("mongoose.hrl").
10 -include("mongoose_config_spec.hrl").
11
12 -spec config_spec() -> mongoose_config_spec:config_section().
13 config_spec() ->
14 93 #section{items = #{<<"all_metrics_are_global">> => #option{type = boolean}},
15 defaults = #{<<"all_metrics_are_global">> => false}}.
16
17 -spec start() -> ok.
18 start() ->
19 93 AllGlobal = mongoose_config:get_opt([instrumentation, exometer, all_metrics_are_global]),
20 93 Prefixes = [{HostType, make_host_type_prefix(HostType, AllGlobal)}
21 93 || HostType <- ?ALL_HOST_TYPES],
22 93 persistent_term:put(?PREFIXES, maps:from_list(Prefixes)).
23
24 -spec stop() -> ok.
25 stop() ->
26 93 persistent_term:erase(?PREFIXES),
27 93 ok.
28
29 -spec set_up(mongoose_instrument:event_name(), mongoose_instrument:labels(),
30 mongoose_instrument:config()) -> boolean().
31 set_up(EventName, Labels, #{metrics := Metrics}) ->
32 26017 maps:foreach(fun(MetricName, MetricType) ->
33 31615 set_up_metric(EventName, Labels, MetricName, MetricType)
34 end, Metrics),
35 26017 true;
36 set_up(_EventName, _Labels, #{}) ->
37 
:-(
 false.
38
39 -spec handle_event(mongoose_instrument:event_name(), mongoose_instrument:labels(),
40 mongoose_instrument:config(), mongoose_instrument:measurements()) -> ok.
41 handle_event(EventName, Labels, #{metrics := Metrics}, Measurements) ->
42 376685 maps:foreach(fun(MetricName, MetricType) ->
43 602083 handle_metric_event(EventName, Labels, MetricName, MetricType, Measurements)
44 end, Metrics).
45
46 -spec set_up_metric(mongoose_instrument:event_name(), mongoose_instrument:labels(),
47 mongoose_instrument:metric_name(), mongoose_instrument:metric_type()) ->
48 ok.
49 set_up_metric(EventName, Labels, MetricName, MetricType) ->
50 31615 Name = exometer_metric_name(EventName, Labels, MetricName),
51 31615 try exometer:new(Name, MetricType)
52 catch
53 14160 error:exists -> ok = exometer:reset(Name)
54 end.
55
56 -spec handle_metric_event(mongoose_instrument:event_name(), mongoose_instrument:labels(),
57 mongoose_instrument:metric_name(), mongoose_instrument:metric_type(),
58 mongoose_instrument:measurements()) -> ok.
59 handle_metric_event(EventName, Labels, MetricName, MetricType, Measurements) ->
60 602083 case Measurements of
61 #{MetricName := MetricValue} ->
62 600748 Name = exometer_metric_name(EventName, Labels, MetricName),
63 600748 update_metric(Name, MetricType, MetricValue);
64 #{} ->
65 1335 ok
66 end.
67
68 -spec update_metric(exometer:name(), spiral | histogram, integer()) -> ok.
69 update_metric(Name, gauge, Value) when is_integer(Value) ->
70 144 ok = exometer:update(Name, Value);
71 update_metric(Name, spiral, Value) when is_integer(Value), Value >= 0 ->
72 376762 ok = exometer:update(Name, Value);
73 update_metric(Name, histogram, Value) when is_integer(Value) ->
74 223842 ok = exometer:update(Name, Value).
75
76 -spec exometer_metric_name(mongoose_instrument:event_name(), mongoose_instrument:labels(),
77 mongoose_instrument:metric_name()) -> exometer:name().
78 exometer_metric_name(EventName, Labels, MetricName) ->
79 632363 [get_host_type_prefix(Labels), EventName] ++ exometer_labels(Labels) ++ [MetricName].
80
81 %% This logic will need extending if we add more labels
82 exometer_labels(#{function := Function}) ->
83 422238 [Function];
84 exometer_labels(#{}) ->
85 210125 [].
86
87 -spec get_host_type_prefix(mongoose_instrument:labels()) -> mongooseim:host_type_or_global().
88 get_host_type_prefix(#{host_type := HostType}) ->
89 268802 #{HostType := Prefix} = persistent_term:get(?PREFIXES),
90 268802 Prefix;
91 get_host_type_prefix(#{}) ->
92 363561 global.
93
94 -spec make_host_type_prefix(mongooseim:host_type(), boolean()) -> mongooseim:host_type_or_global().
95 make_host_type_prefix(_HostType, true) ->
96 250 global;
97 make_host_type_prefix(HostType, false) ->
98 258 binary:replace(HostType, <<" ">>, <<"_">>, [global]).
Line Hits Source