Initial code drop
Project: http://git-wip-us.apache.org/repos/asf/couchdb-couch-stats/repo Commit: http://git-wip-us.apache.org/repos/asf/couchdb-couch-stats/commit/b4543ab7 Tree: http://git-wip-us.apache.org/repos/asf/couchdb-couch-stats/tree/b4543ab7 Diff: http://git-wip-us.apache.org/repos/asf/couchdb-couch-stats/diff/b4543ab7 Branch: refs/heads/master Commit: b4543ab773c823db09873944be9d42e98283c999 Parents: 48481c7 Author: Benjamin Anderson <b...@banjiewen.net> Authored: Tue Jan 14 16:22:54 2014 -0800 Committer: Robert Newson <rnew...@apache.org> Committed: Tue Aug 19 14:48:27 2014 +0100 ---------------------------------------------------------------------- .gitignore | 6 + LICENSE | 201 +++++++++++++++++++++++++++++++ priv/sample_descriptions.cfg | 15 +++ rebar.config | 4 + src/couch_stats.app.src | 10 ++ src/couch_stats.erl | 97 +++++++++++++++ src/couch_stats_app.erl | 11 ++ src/couch_stats_process_tracker.erl | 58 +++++++++ src/couch_stats_stats_collector.erl | 117 ++++++++++++++++++ src/couch_stats_sup.erl | 23 ++++ 10 files changed, 542 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/couchdb-couch-stats/blob/b4543ab7/.gitignore ---------------------------------------------------------------------- diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..093e7e0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +*~ +*.beam +deps +ebin +doc +.project http://git-wip-us.apache.org/repos/asf/couchdb-couch-stats/blob/b4543ab7/LICENSE ---------------------------------------------------------------------- diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..11069ed --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + 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 + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +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. http://git-wip-us.apache.org/repos/asf/couchdb-couch-stats/blob/b4543ab7/priv/sample_descriptions.cfg ---------------------------------------------------------------------- diff --git a/priv/sample_descriptions.cfg b/priv/sample_descriptions.cfg new file mode 100644 index 0000000..1947ad4 --- /dev/null +++ b/priv/sample_descriptions.cfg @@ -0,0 +1,15 @@ +%% -*- mode: erlang -*- + +%% Example stat descriptions. +{[couch_stats, sample_counter], [ + {type, counter}, + {desc, <<"counters counted by couch_stats">>} +]}. +{[couch_stats, sample_histogram], [ + {type, histogram}, + {desc, <<"histograms histogrammed by couch_stats">>} +]}. +{[couch_stats, sample_gauge], [ + {type, gauge}, + {desc, <<"gauges gauged by couch_stats">>} +]}. http://git-wip-us.apache.org/repos/asf/couchdb-couch-stats/blob/b4543ab7/rebar.config ---------------------------------------------------------------------- diff --git a/rebar.config b/rebar.config new file mode 100644 index 0000000..46f1ef1 --- /dev/null +++ b/rebar.config @@ -0,0 +1,4 @@ +{deps, [ + {folsom, ".*", {git, "https://github.com/boundary/folsom.git";, + {tag, "0.8.0"}}} +]}. http://git-wip-us.apache.org/repos/asf/couchdb-couch-stats/blob/b4543ab7/src/couch_stats.app.src ---------------------------------------------------------------------- diff --git a/src/couch_stats.app.src b/src/couch_stats.app.src new file mode 100644 index 0000000..4f94d46 --- /dev/null +++ b/src/couch_stats.app.src @@ -0,0 +1,10 @@ +{application, couch_stats, [ + {description, "Simple statistics collection"}, + {vsn, git}, + {registered, [couch_stats_stats_collector, couch_stats_process_tracker]}, + {applications, [kernel, stdlib, folsom]}, + {mod, {couch_stats_app, []}}, + {env, [ + {collection_interval, 10} + ]} +]}. http://git-wip-us.apache.org/repos/asf/couchdb-couch-stats/blob/b4543ab7/src/couch_stats.erl ---------------------------------------------------------------------- diff --git a/src/couch_stats.erl b/src/couch_stats.erl new file mode 100644 index 0000000..f4d753a --- /dev/null +++ b/src/couch_stats.erl @@ -0,0 +1,97 @@ +-module(couch_stats). + +-export([ + start/0, + stop/0, + fetch/0, + sample/1, + new/2, + delete/1, + list/0, + increment_counter/1, + increment_counter/2, + decrement_counter/1, + decrement_counter/2, + update_histogram/2, + update_gauge/2 +]). + +-type response() :: ok | {error, unknown_metric}. +-type stat() :: {any(), [{atom(), any()}]}. + +start() -> + application:start(couch_stats). + +stop() -> + application:stop(couch_stats). + +fetch() -> + couch_stats_stats_collector:fetch(). + +-spec sample(any()) -> stat(). +sample(Name) -> + [{Name, Info}] = folsom_metrics:get_metric_info(Name), + sample_type(Name, proplists:get_value(type, Info)). + +-spec new(atom(), any()) -> ok | {error, metric_exists | unsupported_type}. +new(counter, Name) -> + case folsom_metrics:new_counter(Name) of + ok -> ok; + {error, Name, metric_exists} -> {error, metric_exists} + end; +new(histogram, Name) -> + {ok, Time} = application:get_env(couch_stats, collection_interval), + case folsom_metrics:new_histogram(Name, slide_uniform, {Time, 1024}) of + ok -> ok; + {error, Name, metric_exists} -> {error, metric_exists} + end; +new(gauge, Name) -> + case folsom_metrics:new_gauge(Name) of + ok -> ok; + {error, Name, metric_exists} -> {error, metric_exists} + end; +new(_, _) -> + {error, unsupported_type}. + +delete(Name) -> + folsom_metrics:delete_metric(Name). + +list() -> + folsom_metrics:get_metrics_info(). + +-spec increment_counter(any()) -> response(). +increment_counter(Name) -> + notify(Name, {inc, 1}). + +-spec increment_counter(any(), pos_integer()) -> response(). +increment_counter(Name, Value) -> + notify(Name, {inc, Value}). + +-spec decrement_counter(any()) -> response(). +decrement_counter(Name) -> + notify(Name, {dec, 1}). + +-spec decrement_counter(any(), pos_integer()) -> response(). +decrement_counter(Name, Value) -> + notify(Name, {dec, Value}). + +-spec update_histogram(any(), number()) -> response(). +update_histogram(Name, Value) -> + notify(Name, Value). + +-spec update_gauge(any(), number()) -> response(). +update_gauge(Name, Value) -> + notify(Name, Value). + +-spec notify(any(), any()) -> response(). +notify(Name, Op) -> + case folsom_metrics:notify(Name, Op) of + ok -> ok; + _ -> {error, unknown_metric} + end. + +-spec sample_type(any(), atom()) -> stat(). +sample_type(Name, histogram) -> + folsom_metrics:get_histogram_statistics(Name); +sample_type(Name, _) -> + folsom_metrics:get_metric_value(Name). http://git-wip-us.apache.org/repos/asf/couchdb-couch-stats/blob/b4543ab7/src/couch_stats_app.erl ---------------------------------------------------------------------- diff --git a/src/couch_stats_app.erl b/src/couch_stats_app.erl new file mode 100644 index 0000000..e9f7836 --- /dev/null +++ b/src/couch_stats_app.erl @@ -0,0 +1,11 @@ +-module(couch_stats_app). + +-behaviour(application). + +-export([start/2, stop/1]). + +start(_StartType, _StartArgs) -> + couch_stats_sup:start_link(). + +stop(_State) -> + ok. http://git-wip-us.apache.org/repos/asf/couchdb-couch-stats/blob/b4543ab7/src/couch_stats_process_tracker.erl ---------------------------------------------------------------------- diff --git a/src/couch_stats_process_tracker.erl b/src/couch_stats_process_tracker.erl new file mode 100644 index 0000000..bead7c1 --- /dev/null +++ b/src/couch_stats_process_tracker.erl @@ -0,0 +1,58 @@ +-module(couch_stats_process_tracker). +-behaviour(gen_server). + +-export([ + track/1, + track/2 +]). + +-export([ + start_link/0, + init/1, + handle_call/3, + handle_cast/2, + handle_info/2, + code_change/3, + terminate/2 +]). + +-record(st, { + tracked +}). + +-spec track(any()) -> ok. +track(Name) -> + track(self(), Name). + +-spec track(pid(), any()) -> ok. +track(Name, Pid) -> + gen_server:cast(?MODULE, {track, Name, Pid}). + +start_link() -> + gen_server:start_link({local, ?MODULE}, ?MODULE, [], []). + +init([]) -> + {ok, #st{tracked = dict:new()}}. + +handle_call(Msg, _From, State) -> + {stop, {unknown_call, Msg}, error, State}. + +handle_cast({track, Pid, Name}, #st{tracked=Tracked}=State) -> + couch_stats:increment_counter(Name), + Ref = erlang:monitor(process, Pid), + {noreply, State#st{tracked=dict:store(Ref, Name, Tracked)}}; +handle_cast(Msg, State) -> + {stop, {unknown_cast, Msg}, State}. + +handle_info({'DOWN', Ref, _, _, _}, #st{tracked=Tracked}=State) -> + Name = dict:fetch(Ref, Tracked), + couch_stats:decrement_counter(Name), + {noreply, State#st{tracked=dict:erase(Ref, Tracked)}}; +handle_info(Msg, State) -> + {stop, {unknown_info, Msg}, State}. + +terminate(_Reason, _State) -> + ok. + +code_change(_OldVsn, State, _Extra) -> + {ok, State}. http://git-wip-us.apache.org/repos/asf/couchdb-couch-stats/blob/b4543ab7/src/couch_stats_stats_collector.erl ---------------------------------------------------------------------- diff --git a/src/couch_stats_stats_collector.erl b/src/couch_stats_stats_collector.erl new file mode 100644 index 0000000..3176cf5 --- /dev/null +++ b/src/couch_stats_stats_collector.erl @@ -0,0 +1,117 @@ +-module(couch_stats_stats_collector). + +-behaviour(gen_server). + +-export([ + fetch/0 +]). + +-export([ + start_link/0, + init/1, + handle_call/3, + handle_cast/2, + handle_info/2, + code_change/3, + terminate/2 +]). + +-record(st, { + descriptions, + stats, + collect_timer, + reload_timer +}). + +fetch() -> + {ok, Stats} = gen_server:call(?MODULE, fetch), + Stats. + +start_link() -> + gen_server:start_link({local, ?MODULE}, ?MODULE, [], []). + +init([]) -> + {ok, Descs} = reload_metrics(), + Interval = case application:get_env(couch_stats, collection_interval) of + {ok, I} -> I * 1000 + end, + {ok, CT} = timer:send_interval(Interval, self(), collect), + {ok, RT} = timer:send_interval(600000, self(), reload), + {ok, #st{descriptions=Descs, stats=[], collect_timer=CT, reload_timer=RT}}. + +handle_call(fetch, _from, #st{stats = Stats}=State) -> + {reply, {ok, Stats}, State}; +handle_call(Msg, _From, State) -> + {stop, {unknown_call, Msg}, error, State}. + +handle_cast(Msg, State) -> + {stop, {unknown_cast, Msg}, State}. + +handle_info(collect, #st{descriptions=Descriptions}=State) -> + Stats = lists:map( + fun({Name, Props}) -> + {Name, [{value, couch_stats:sample(Name)}|Props]} + end, + Descriptions + ), + {noreply, State#st{stats=Stats}}; +handle_info(reload, State) -> + {ok, Descriptions} = reload_metrics(), + {noreply, State#st{descriptions=Descriptions}}; +handle_info(Msg, State) -> + {stop, {unknown_info, Msg}, State}. + +terminate(_Reason, _State) -> + ok. + +code_change(_OldVsn, State, _Extra) -> + {ok, State}. + +reload_metrics() -> + Existing = couch_stats:list(), + Current = load_metrics_for_applications(), + ToDelete = lists:foldl( + fun({_, {Name, [{type, Type}, _]}}, Acc) -> + E = {Name, [{type, Type}]}, + case sets:is_element(E, Acc) of + true -> + sets:del_element(E, Acc); + false -> + couch_stats:new(Type, Name), + Acc + end + end, + sets:from_list(Existing), + Current + ), + lists:foreach( + fun({Name, _}) -> couch_stats:delete(Name) end, + sets:to_list(ToDelete) + ), + {ok, Current}. + +load_metrics_for_applications() -> + Apps = [element(1, A) || A <- application:which_applications()], + lists:foldl( + fun(AppName, Acc) -> + case load_metrics_for_application(AppName) of + error -> Acc; + Descriptions -> [{AppName, Descriptions}|Acc] + end + end, + [], + Apps + ). + +load_metrics_for_application(AppName) -> + case code:priv_dir(AppName) of + {error, _Error} -> + error; + Dir -> + case file:consult(Dir ++ "/stat_descriptions.cfg") of + {ok, Descriptions} -> + Descriptions; + {error, _Error} -> + error + end + end. http://git-wip-us.apache.org/repos/asf/couchdb-couch-stats/blob/b4543ab7/src/couch_stats_sup.erl ---------------------------------------------------------------------- diff --git a/src/couch_stats_sup.erl b/src/couch_stats_sup.erl new file mode 100644 index 0000000..0b296d4 --- /dev/null +++ b/src/couch_stats_sup.erl @@ -0,0 +1,23 @@ +-module(couch_stats_sup). + +-behaviour(supervisor). + +-export([ + start_link/0, + init/1 +]). + +-define(CHILD(I, Type), {I, {I, start_link, []}, permanent, 5000, Type, [I]}). + +start_link() -> + supervisor:start_link({local, ?MODULE}, ?MODULE, []). + + +init([]) -> + {ok, { + {one_for_one, 5, 10}, [ + ?CHILD(couch_stats_stats_collector, worker), + ?CHILD(couch_stats_process_tracker, worker) + ] + }}. +
