Add oc_sampler_period_or_count (#129)

Author: deadtrickster

doc/README.md

@@ -178,6 +178,8 @@ $ rebar3 protobuf compile
 
 
 <table width="100%" border="0" summary="list of modules">
+<tr><td><a href="oc_producer.md" class="module">oc_producer</a></td></tr>
+<tr><td><a href="oc_producer_registry.md" class="module">oc_producer_registry</a></td></tr>
 <tr><td><a href="oc_reporter.md" class="module">oc_reporter</a></td></tr>
 <tr><td><a href="oc_reporter_noop.md" class="module">oc_reporter_noop</a></td></tr>
 <tr><td><a href="oc_reporter_sequential.md" class="module">oc_reporter_sequential</a></td></tr>
@@ -187,7 +189,9 @@ $ rebar3 protobuf compile
 <tr><td><a href="oc_sampler_always.md" class="module">oc_sampler_always</a></td></tr>
 <tr><td><a href="oc_sampler_impl.md" class="module">oc_sampler_impl</a></td></tr>
 <tr><td><a href="oc_sampler_never.md" class="module">oc_sampler_never</a></td></tr>
+<tr><td><a href="oc_sampler_period_or_count.md" class="module">oc_sampler_period_or_count</a></td></tr>
 <tr><td><a href="oc_sampler_probability.md" class="module">oc_sampler_probability</a></td></tr>
+<tr><td><a href="oc_self_producer.md" class="module">oc_self_producer</a></td></tr>
 <tr><td><a href="oc_server.md" class="module">oc_server</a></td></tr>
 <tr><td><a href="oc_span.md" class="module">oc_span</a></td></tr>
 <tr><td><a href="oc_span_ctx_binary.md" class="module">oc_span_ctx_binary</a></td></tr>

doc/edoc-info

@@ -1,10 +1,11 @@
 %% encoding: UTF-8
 {application,opencensus}.
-{modules,[oc_reporter,oc_reporter_noop,oc_reporter_sequential,
-          oc_reporter_stdout,oc_reporter_zipkin,oc_sampler,oc_sampler_always,
-          oc_sampler_impl,oc_sampler_never,oc_sampler_probability,oc_server,
-          oc_span,oc_span_ctx_binary,oc_span_ctx_header,oc_span_sweeper,
-          oc_span_transform,oc_stat,oc_stat_aggregation,
+{modules,[oc_producer,oc_producer_registry,oc_reporter,oc_reporter_noop,
+          oc_reporter_sequential,oc_reporter_stdout,oc_reporter_zipkin,
+          oc_sampler,oc_sampler_always,oc_sampler_impl,oc_sampler_never,
+          oc_sampler_period_or_count,oc_sampler_probability,oc_self_producer,
+          oc_server,oc_span,oc_span_ctx_binary,oc_span_ctx_header,
+          oc_span_sweeper,oc_span_transform,oc_stat,oc_stat_aggregation,
           oc_stat_aggregation_count,oc_stat_aggregation_distribution,
           oc_stat_aggregation_latest,oc_stat_aggregation_sum,oc_stat_config,
           oc_stat_exporter,oc_stat_exporter_stdout,oc_stat_measure,

doc/oc_producer.md

@@ -0,0 +1,22 @@
+
+
+# Module oc_producer #
+* [Description](#description)
+
+Producer is a source of metrics.
+
+__This module defines the `oc_producer` behaviour.__<br /> Required callback functions: `read/2`.
+
+<a name="description"></a>
+
+## Description ##
+
+Callbacks:
+
+- `read(Registry, Callback) -> ok` - called by exporters.
+Read should call `Callback` with the current values of all metrics
+supported by this metric provider.
+The metrics should be unique for each combination of name and resource.
+
+- `cleanup(Registry) -> ok` - optional.
+Called when producer removed from `Registry`

doc/oc_producer_registry.md

@@ -0,0 +1,82 @@
+
+
+# Module oc_producer_registry #
+* [Description](#description)
+* [Function Index](#index)
+* [Function Details](#functions)
+
+Registry maintains a set of metric producers for exporting.
+
+<a name="description"></a>
+
+## Description ##
+Most users will rely on the DefaultRegistry.<a name="index"></a>
+
+## Function Index ##
+
+
+<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#add_producer-1">add_producer/1</a></td><td></td></tr><tr><td valign="top"><a href="#add_producer-2">add_producer/2</a></td><td>
+Adds <code>Producer</code> to the <code>Registry</code>.</td></tr><tr><td valign="top"><a href="#read_all-1">read_all/1</a></td><td>Equivalent to <a href="#read_all-1"><tt>read_all(default)</tt></a>.</td></tr><tr><td valign="top"><a href="#read_all-2">read_all/2</a></td><td>
+Calls <code>Callback</code> for each metric produced by the metric producers in the <code>Registry</code>.</td></tr><tr><td valign="top"><a href="#read_to_list-0">read_to_list/0</a></td><td></td></tr><tr><td valign="top"><a href="#read_to_list-1">read_to_list/1</a></td><td></td></tr><tr><td valign="top"><a href="#remove_producer-1">remove_producer/1</a></td><td>Equivalent to <a href="#remove_producer-2"><tt>remove_producer(default, Producer)</tt></a>.</td></tr><tr><td valign="top"><a href="#remove_producer-2">remove_producer/2</a></td><td></td></tr></table>
+
+
+<a name="functions"></a>
+
+## Function Details ##
+
+<a name="add_producer-1"></a>
+
+### add_producer/1 ###
+
+`add_producer(Producer) -> any()`
+
+<a name="add_producer-2"></a>
+
+### add_producer/2 ###
+
+`add_producer(Registry, Producer) -> any()`
+
+Adds `Producer` to the `Registry`.
+
+<a name="read_all-1"></a>
+
+### read_all/1 ###
+
+`read_all(Callback) -> any()`
+
+Equivalent to [`read_all(default)`](#read_all-1).
+
+<a name="read_all-2"></a>
+
+### read_all/2 ###
+
+`read_all(Registry, Callback) -> any()`
+
+Calls `Callback` for each metric produced by the metric producers in the `Registry`.
+
+<a name="read_to_list-0"></a>
+
+### read_to_list/0 ###
+
+`read_to_list() -> any()`
+
+<a name="read_to_list-1"></a>
+
+### read_to_list/1 ###
+
+`read_to_list(Registry) -> any()`
+
+<a name="remove_producer-1"></a>
+
+### remove_producer/1 ###
+
+`remove_producer(Producer) -> any()`
+
+Equivalent to [`remove_producer(default, Producer)`](#remove_producer-2).
+
+<a name="remove_producer-2"></a>
+
+### remove_producer/2 ###
+
+`remove_producer(Registry, Producer) -> any()`
+

doc/oc_sampler_period_or_count.md

@@ -0,0 +1,36 @@
+
+
+# Module oc_sampler_period_or_count #
+* [Description](#description)
+* [Function Index](#index)
+* [Function Details](#functions)
+
+This sampler makes sure you will have at least 1 sample during `period`
+or `1/count` samples otherwise.
+
+__Behaviours:__ [`oc_sampler`](oc_sampler.md).
+
+<a name="index"></a>
+
+## Function Index ##
+
+
+<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#init-1">init/1</a></td><td></td></tr><tr><td valign="top"><a href="#should_sample-4">should_sample/4</a></td><td></td></tr></table>
+
+
+<a name="functions"></a>
+
+## Function Details ##
+
+<a name="init-1"></a>
+
+### init/1 ###
+
+`init(Opts) -> any()`
+
+<a name="should_sample-4"></a>
+
+### should_sample/4 ###
+
+`should_sample(TraceId, X2, X3, X4) -> any()`
+

doc/oc_self_producer.md

@@ -0,0 +1,27 @@
+
+
+# Module oc_self_producer #
+* [Description](#description)
+* [Function Index](#index)
+* [Function Details](#functions)
+
+Produces metrics for internal state like spans queue size, views count, etc.
+
+<a name="index"></a>
+
+## Function Index ##
+
+
+<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#read-2">read/2</a></td><td></td></tr></table>
+
+
+<a name="functions"></a>
+
+## Function Details ##
+
+<a name="read-2"></a>
+
+### read/2 ###
+
+`read(Registry, Callback) -> any()`
+

doc/oc_span_sweeper.md

@@ -11,7 +11,7 @@ __Behaviours:__ [`gen_statem`](gen_statem.md).
 ## Function Index ##
 
 
-<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#callback_mode-0">callback_mode/0</a></td><td></td></tr><tr><td valign="top"><a href="#code_change-4">code_change/4</a></td><td></td></tr><tr><td valign="top"><a href="#handle_event-4">handle_event/4</a></td><td></td></tr><tr><td valign="top"><a href="#init-1">init/1</a></td><td></td></tr><tr><td valign="top"><a href="#start_link-0">start_link/0</a></td><td></td></tr><tr><td valign="top"><a href="#terminate-3">terminate/3</a></td><td></td></tr></table>
+<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#callback_mode-0">callback_mode/0</a></td><td></td></tr><tr><td valign="top"><a href="#code_change-4">code_change/4</a></td><td></td></tr><tr><td valign="top"><a href="#handle_event-4">handle_event/4</a></td><td></td></tr><tr><td valign="top"><a href="#init-1">init/1</a></td><td></td></tr><tr><td valign="top"><a href="#start_link-0">start_link/0</a></td><td></td></tr><tr><td valign="top"><a href="#storage_size-0">storage_size/0</a></td><td></td></tr><tr><td valign="top"><a href="#terminate-3">terminate/3</a></td><td></td></tr></table>
 
 
 <a name="functions"></a>
@@ -48,6 +48,12 @@ __Behaviours:__ [`gen_statem`](gen_statem.md).
 
 `start_link() -> any()`
 
+<a name="storage_size-0"></a>
+
+### storage_size/0 ###
+
+`storage_size() -> any()`
+
 <a name="terminate-3"></a>
 
 ### terminate/3 ###

elvis.config

@@ -29,6 +29,7 @@
         rules => [{elvis_style, god_modules, #{ignore => [egithub]}},
                   {elvis_style, dont_repeat_yourself, #{min_complexity => 30}},
                   {elvis_style, line_length, #{limit => 120}},
+                  {elvis_style, no_if_expression, disable},
                   %% be a bit more lax on naming for tests
                   {elvis_style, variable_naming_convention, #{regex => "^_{0,2}([A-Z][0-9a-zA-Z]*)$"}},
                   {elvis_style, state_record_and_type, disable}],

rebar.config

@@ -11,6 +11,9 @@
 {project_plugins, [covertool,
                    {rebar3_gpb_plugin, "~> 2.6.1"},
                    rebar3_lint]}.
+
+{plugins, [rebar3_proper]}.
+
 {gpb_opts, [
   {i, "priv/opencensus-proto/src/opencensus/proto/trace"},
   {module_name_suffix, "_pb"},
@@ -28,7 +31,8 @@
 
 {profiles, [
   {test, [{erl_opts, [nowarn_export_all]},
-          {deps, [{meck, "0.8.11"}]}]},
+          {deps, [{meck, "0.8.11"},
+                  {proper, "1.3.0"}]}]},
   {docs, [{deps, [{edown, "0.8.1"}]},
           {edoc_opts,
            [{doclet, edown_doclet},

src/oc_producer.erl

@@ -1,15 +1,21 @@
 %% @doc
 %% Producer is a source of metrics.
+%%
+%% Callbacks:
+%%
+%% - `read(Registry, Callback) -> ok' - called by exporters.
+%% Read should call `Callback' with the current values of all metrics
+%% supported by this metric provider.
+%% The metrics should be unique for each combination of name and resource.
+%%
+%% - `cleanup(Registry) -> ok' - optional.
+%% Called when producer removed from `Registry'
+%%
 %% @end
 -module(oc_producer).
 
 -include("oc_metrics.hrl").
 
-%% @doc
-%% Read should call `Callback' with the current values of all metrics
-%% supported by this metric provider.
-%% The metrics should be unique for each combination of name and resource.
-%% @end
 -callback read(Registry, Callback) -> ok when
       Registry :: oc_producer_registry:registry(),
       Callback :: metric_callback().