chore: support statsd

apps/emqx_statsd/.gitignore

@@ -0,0 +1,19 @@
+.rebar3
+_*
+.eunit
+*.o
+*.beam
+*.plt
+*.swp
+*.swo
+.erlang.cookie
+ebin
+log
+erl_crash.dump
+.rebar
+logs
+_build
+.idea
+*.iml
+rebar3.crashdump
+*~

apps/emqx_statsd/LICENSE

@@ -0,0 +1,191 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2021, DDDHuang <904897578@qq.com>.
+
+   Licensed 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.
+

apps/emqx_statsd/README.md

@@ -0,0 +1,9 @@
+emqx_statsd
+=====
+
+An OTP application
+
+Build
+-----
+
+    $ rebar3 compile

apps/emqx_statsd/etc/emqx_statsd.conf

@@ -0,0 +1,42 @@
+##--------------------------------------------------------------------
+ ## Statsd for EMQ X
+ ##--------------------------------------------------------------------
+
+ ## The statsd server host
+ ## 
+ ## Default: "127.0.0.1"
+ statsd.host = "127.0.0.1"
+
+ ## The statsd server port
+ ## 
+ ## Default: "127.0.0.1"
+ statsd.port = 8125
+
+ ## statsd prefix
+ ##
+ ## Default: emqx
+ # statsd.prefix = emqx
+
+ ## statsd tag key
+ ##
+ # statsd.tag.1.key = from
+
+ ## statsd tag value
+ ##
+ # statsd.tag.1.value = emqx
+
+ ## statsd batch_size
+ ## 
+ ## Default: 10
+ statsd.batch_size = 10
+
+ ## statsd sample time interval
+ ## 
+ ## Default: 10s
+ statsd.sample_time_interval = 10s
+
+ ## statsd flush time interval
+ ## 
+ ## Default: 10s
+ statsd.flush_time_interval = 10s
+ 

apps/emqx_statsd/include/emqx_statsd.hrl

@@ -0,0 +1,9 @@
+-define(APP, emqx_statsd).
+
+-define(DEFAULT_HOST, {127, 0, 0, 1}).
+-define(DEFAULT_PORT, 8125).
+-define(DEFAULT_PREFIX, undefined).
+-define(DEFAULT_TAGS, []).
+-define(DEFAULT_BATCH_SIZE, 10).
+-define(DEFAULT_SAMPLE_TIME_INTERVAL, 10000).
+-define(DEFAULT_FLUSH_TIME_INTERVAL, 10000).

apps/emqx_statsd/priv/emqx_statsd.schema

@@ -0,0 +1,53 @@
+%% emqx_statsd config
+
+ {mapping, "statsd.host", "emqx_statsd.host", [
+   {default, "127.0.0.1"},
+   {datatype, string}
+ ]}.
+
+ {mapping, "statsd.port", "emqx_statsd.port", [
+   {default, 8125},
+   {datatype, integer}
+ ]}.
+
+ {mapping, "statsd.prefix", "emqx_statsd.prefix", [
+   {datatype, string}
+ ]}.
+
+ {mapping, "statsd.tag.$id.key", "emqx_statsd.tag", [
+   {datatype, string}
+ ]}.
+
+ {mapping, "statsd.tag.$id.value", "emqx_statsd.tag", [
+   {datatype, string}
+ ]}.
+
+ {mapping, "statsd.batch_size", "emqx_statsd.batch_size", [
+   {default, 10},
+   {datatype, integer}
+ ]}.
+
+ {mapping, "statsd.sample_time_interval", "emqx_statsd.sample_time_interval", [
+   {default, "2s"},
+   {datatype, {duration, ms}}
+ ]}.
+
+ {mapping, "statsd.flush_time_interval", "emqx_statsd.flush_time_interval", [
+   {default, "10s"},
+   {datatype, {duration, ms}}
+ ]}.
+
+ {translation, "emqx_stasd.host", fun(Conf) ->
+   {ok, IPAddress} = inet:parse_address(cuttlefish:conf_get("statsd.host", Conf, "127.0.0.1")),
+   IPAddress
+ end}.
+
+ {translation, "emqx_statsd.tag", fun(Conf) ->
+   Tags = cuttlefish_variable:filter_by_prefix("statsd.tag", Conf),
+   lists:foldl(
+     fun({["statsd", "tag", Id, "key"], Key}, AccIn) ->
+         [{Key, cuttlefish:conf_get("statsd." ++ Id ++ ".value", Conf)} | AccIn];
+        (_, AccIn) ->
+         AccIn
+     end, [], Tags)
+ end}.

apps/emqx_statsd/rebar.config

@@ -0,0 +1,7 @@
+{erl_opts, [debug_info]}.
+{deps, [{estatsd, {git, "https://github.com/emqx/estatsd", {tag, "0.1.0"}}}]}.
+
+{shell, [
+  % {config, "config/sys.config"},
+    {apps, [emqx_statsd]}
+]}.

apps/emqx_statsd/src/emqx_statsd.app.src

@@ -0,0 +1,16 @@
+{application, emqx_statsd,
+ [{description, "An OTP application"},
+  {vsn, "0.1.0"},
+  {registered, []},
+  {mod, {emqx_statsd_app, []}},
+  {applications,
+   [kernel,
+    stdlib,
+    estatsd
+   ]},
+  {env,[]},
+  {modules, []},
+
+  {licenses, ["Apache 2.0"]},
+  {links, []}
+ ]}.

apps/emqx_statsd/src/emqx_statsd.erl

@@ -0,0 +1,101 @@
+%%--------------------------------------------------------------------
+ %% Copyright (c) 2021 EMQ Technologies Co., Ltd. All Rights Reserved.
+ %%
+ %% Licensed 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.
+ %%--------------------------------------------------------------------
+
+ -module(emqx_statsd).
+
+ -behaviour(gen_server).
+
+ -ifdef(TEST).
+ -compile(export_all).
+ -compile(nowarn_export_all).
+ -endif.
+
+ -include_lib("emqx/include/logger.hrl").
+
+ %% Interface
+ -export([start_link/1]).
+
+ %% Internal Exports
+ -export([ init/1
+         , handle_call/3
+         , handle_cast/2
+         , handle_info/2
+         , code_change/3
+         , terminate/2
+         ]).
+
+ -record(state, {
+           timer                :: reference(),
+           sample_time_interval :: pos_integer(),
+           flush_time_interval  :: pos_integer(),
+           estatsd_pid          :: pid()
+         }).
+
+ start_link(Opts) ->
+     gen_server:start_link({local, ?MODULE}, ?MODULE, [Opts], []).
+
+ init([Opts]) ->
+     SampleTimeInterval = proplists:get_value(sample_time_interval, Opts),
+     FlushTimeInterval = proplists:get_value(flush_time_interval, Opts),
+     Ref = erlang:start_timer(SampleTimeInterval, self(), sample_timeout),
+     Pid = proplists:get_value(estatsd_pid, Opts),
+     {ok, #state{timer = Ref,
+                 sample_time_interval = SampleTimeInterval,
+                 flush_time_interval = FlushTimeInterval,
+                 estatsd_pid = Pid}}.
+
+ handle_call(_Req, _From, State) ->
+     {noreply, State}.
+
+ handle_cast(_Msg, State) ->
+     {noreply, State}.
+
+ handle_info({timeout, Ref, sample_timeout}, State = #state{sample_time_interval = SampleTimeInterval,
+                                                            flush_time_interval = FlushTimeInterval,
+                                                            estatsd_pid = Pid,
+                                                            timer = Ref}) ->
+     ?LOG(debug, "emqx statsd submit"),
+     Metrics = emqx_metrics:all() ++ emqx_stats:getstats() ++ emqx_vm_data(),
+     SampleRate = SampleTimeInterval / FlushTimeInterval,
+     StatsdMetrics = [{gauge, trans_metrics_name(Name), Value, SampleRate, []} || {Name, Value} <- Metrics],
+     estatsd:submit(Pid, StatsdMetrics),
+     {noreply, State#state{timer = erlang:start_timer(SampleTimeInterval, self(), sample_timeout)}};
+
+ handle_info(_Msg, State) ->
+     {noreply, State}.
+
+ code_change(_OldVsn, State, _Extra) ->
+     {ok, State}.
+
+ terminate(_Reason, _State) ->
+     ok.
+
+ %%------------------------------------------------------------------------------
+ %% Internale function
+ %%------------------------------------------------------------------------------
+ trans_metrics_name(Name) ->
+     Name0 = atom_to_binary(Name, utf8),
+     binary_to_atom(<<"emqx.", Name0/binary>>, utf8).
+
+ emqx_vm_data() ->
+     Idle = case cpu_sup:util([detailed]) of
+                {_, 0, 0, _} -> 0; %% Not support for Windows
+                {_Num, _Use, IdleList, _} -> proplists:get_value(idle, IdleList, 0)
+            end,
+     RunQueue = erlang:statistics(run_queue),
+     [{run_queue, RunQueue},
+      {cpu_idle, Idle},
+      {cpu_use, 100 - Idle}] ++ emqx_vm:mem_info().

apps/emqx_statsd/src/emqx_statsd_app.erl

@@ -0,0 +1,38 @@
+%%--------------------------------------------------------------------
+ %% Copyright (c) 2021 EMQ Technologies Co., Ltd. All Rights Reserved.
+ %%
+ %% Licensed 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.
+ %%--------------------------------------------------------------------
+
+ -module(emqx_statsd_app).
+
+ -behaviour(application).
+
+-include_lib("emqx/include/logger.hrl").
+
+ -emqx_plugin(?MODULE).
+
+ -export([ start/2
+         , stop/1
+         ]).
+
+start(_StartType, _StartArgs) ->
+    {ok, Sup} = emqx_statsd_sup:start_link(),
+    emqx_statsd_sup:start_statsd(),
+    ?LOG(info, "emqx statsd start: successfully"),
+    {ok, Sup}.
+
+ stop(_) ->
+    emqx_statsd_sup:stop_statsd(),
+    ?LOG(info, "emqx statsd stop: successfully"),
+    ok.

apps/emqx_statsd/src/emqx_statsd_sup.erl

@@ -0,0 +1,60 @@
+%%%-------------------------------------------------------------------
+%% @doc emqx_statsd top level supervisor.
+%% @end
+%%%-------------------------------------------------------------------
+
+-module(emqx_statsd_sup).
+
+-behaviour(supervisor).
+
+-include("emqx_statsd.hrl").
+
+-export([start_link/0]).
+
+-export([start_statsd/0, stop_statsd/0]).
+
+-export([init/1]).
+
+ start_link() ->
+     supervisor:start_link({local, ?MODULE}, ?MODULE, []).
+
+ init([]) ->
+    {ok, { {one_for_one, 10, 100}, []} }.
+
+start_statsd() ->
+    {ok, Pid} = supervisor:start_child(?MODULE, estatsd_child_spec()),
+    {ok, _Pid1} = supervisor:start_child(?MODULE, emqx_statsd_child_spec(Pid)).
+
+stop_statsd() ->
+    supervisor:terminate_child(emqx_statsd_sup, emqx_statsd),
+    supervisor:terminate_child(emqx_statsd_sup, estatsd).
+%%==============================================================================================
+%% internal
+estatsd_child_spec() ->
+    #{id       => estatsd
+    , start    => {estatsd, start_link, [estatsd_options()]}
+    , restart  => permanent
+    , shutdown => 5000
+    , type     => worker
+    , modules  => [estatsd]}.
+
+estatsd_options() ->
+    Host = application:get_env(?APP, host, ?DEFAULT_HOST),
+    Port = application:get_env(?APP, port, ?DEFAULT_PORT),
+    Prefix = application:get_env(?APP, prefix, ?DEFAULT_PREFIX),
+    Tags = application:get_env(?APP, tags, ?DEFAULT_TAGS),
+    BatchSize = application:get_env(?APP, batch_size, ?DEFAULT_BATCH_SIZE),
+    [{host, Host}, {port, Port}, {prefix, Prefix}, {tags, Tags}, {batch_size, BatchSize}].
+
+emqx_statsd_child_spec(Pid) ->
+    #{id       => emqx_statsd
+    , start    => {emqx_statsd, start_link, [emqx_statsd_options(Pid)]}
+    , restart  => permanent
+    , shutdown => 5000
+    , type     => worker
+    , modules  => [emqx_statsd]}.
+
+emqx_statsd_options(Pid) ->
+    SampleTimeInterval = application:get_env(?APP, sample_time_interval, ?DEFAULT_SAMPLE_TIME_INTERVAL),
+    FlushTimeInterval = application:get_env(?APP, flush_time_interval, ?DEFAULT_FLUSH_TIME_INTERVAL),
+    [{estatsd_pid, Pid}, {sample_time_interval, SampleTimeInterval}, {flush_time_interval, FlushTimeInterval}].

rebar.config.erl

@@ -286,6 +286,7 @@ relx_plugin_apps(ReleaseType) ->
     , emqx_recon
     , emqx_rule_engine
     , emqx_sasl
+    , emqx_statsd
     ]
     ++ [emqx_telemetry || not is_enterprise()]
     ++ relx_plugin_apps_per_rel(ReleaseType)