add exometer_report:get_intervals/1

doc/exometer_report.md

@@ -342,7 +342,7 @@ time_ms() = pos_integer()
 ## Function Index ##
 
 
-<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#add_reporter-2">add_reporter/2</a></td><td>Add a reporter.</td></tr><tr><td valign="top"><a href="#call_reporter-2">call_reporter/2</a></td><td>Send a custom (synchronous) call to <code>Reporter</code>.</td></tr><tr><td valign="top"><a href="#cast_reporter-2">cast_reporter/2</a></td><td>Send a custom (asynchronous) cast to <code>Reporter</code>.</td></tr><tr><td valign="top"><a href="#delete_interval-2">delete_interval/2</a></td><td>Delete a named interval.</td></tr><tr><td valign="top"><a href="#disable_me-2">disable_me/2</a></td><td>Used by a reporter to disable itself.</td></tr><tr><td valign="top"><a href="#disable_reporter-1">disable_reporter/1</a></td><td>Disable <code>Reporter</code>.</td></tr><tr><td valign="top"><a href="#enable_reporter-1">enable_reporter/1</a></td><td>Enable <code>Reporter</code>.</td></tr><tr><td valign="top"><a href="#list_metrics-0">list_metrics/0</a></td><td>Equivalent to <a href="#list_metrics-1"><tt>list_metrics([])</tt></a>.</td></tr><tr><td valign="top"><a href="#list_metrics-1">list_metrics/1</a></td><td>List all metrics matching <code>Path</code>, together with subscription status.</td></tr><tr><td valign="top"><a href="#list_reporters-0">list_reporters/0</a></td><td>List the name and pid of each known reporter.</td></tr><tr><td valign="top"><a href="#list_subscriptions-1">list_subscriptions/1</a></td><td>List all subscriptions for <code>Reporter</code>.</td></tr><tr><td valign="top"><a href="#new_entry-1">new_entry/1</a></td><td>Called by exometer whenever a new entry is created.</td></tr><tr><td valign="top"><a href="#remove_reporter-1">remove_reporter/1</a></td><td>Remove reporter and all its subscriptions.</td></tr><tr><td valign="top"><a href="#remove_reporter-2">remove_reporter/2</a></td><td>Remove <code>Reporter</code> (non-blocking call).</td></tr><tr><td valign="top"><a href="#restart_intervals-1">restart_intervals/1</a></td><td>Restart all named intervals, respecting specified delays.</td></tr><tr><td valign="top"><a href="#set_interval-3">set_interval/3</a></td><td>Specify a named interval.</td></tr><tr><td valign="top"><a href="#setopts-3">setopts/3</a></td><td>Called by exometer when options of a metric entry are changed.</td></tr><tr><td valign="top"><a href="#start_link-0">start_link/0</a></td><td>Starts the server
+<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#add_reporter-2">add_reporter/2</a></td><td>Add a reporter.</td></tr><tr><td valign="top"><a href="#call_reporter-2">call_reporter/2</a></td><td>Send a custom (synchronous) call to <code>Reporter</code>.</td></tr><tr><td valign="top"><a href="#cast_reporter-2">cast_reporter/2</a></td><td>Send a custom (asynchronous) cast to <code>Reporter</code>.</td></tr><tr><td valign="top"><a href="#delete_interval-2">delete_interval/2</a></td><td>Delete a named interval.</td></tr><tr><td valign="top"><a href="#disable_me-2">disable_me/2</a></td><td>Used by a reporter to disable itself.</td></tr><tr><td valign="top"><a href="#disable_reporter-1">disable_reporter/1</a></td><td>Disable <code>Reporter</code>.</td></tr><tr><td valign="top"><a href="#enable_reporter-1">enable_reporter/1</a></td><td>Enable <code>Reporter</code>.</td></tr><tr><td valign="top"><a href="#get_intervals-1">get_intervals/1</a></td><td>List the named intervals for <code>Reporter</code>.</td></tr><tr><td valign="top"><a href="#list_metrics-0">list_metrics/0</a></td><td>Equivalent to <a href="#list_metrics-1"><tt>list_metrics([])</tt></a>.</td></tr><tr><td valign="top"><a href="#list_metrics-1">list_metrics/1</a></td><td>List all metrics matching <code>Path</code>, together with subscription status.</td></tr><tr><td valign="top"><a href="#list_reporters-0">list_reporters/0</a></td><td>List the name and pid of each known reporter.</td></tr><tr><td valign="top"><a href="#list_subscriptions-1">list_subscriptions/1</a></td><td>List all subscriptions for <code>Reporter</code>.</td></tr><tr><td valign="top"><a href="#new_entry-1">new_entry/1</a></td><td>Called by exometer whenever a new entry is created.</td></tr><tr><td valign="top"><a href="#remove_reporter-1">remove_reporter/1</a></td><td>Remove reporter and all its subscriptions.</td></tr><tr><td valign="top"><a href="#remove_reporter-2">remove_reporter/2</a></td><td>Remove <code>Reporter</code> (non-blocking call).</td></tr><tr><td valign="top"><a href="#restart_intervals-1">restart_intervals/1</a></td><td>Restart all named intervals, respecting specified delays.</td></tr><tr><td valign="top"><a href="#set_interval-3">set_interval/3</a></td><td>Specify a named interval.</td></tr><tr><td valign="top"><a href="#setopts-3">setopts/3</a></td><td>Called by exometer when options of a metric entry are changed.</td></tr><tr><td valign="top"><a href="#start_link-0">start_link/0</a></td><td>Starts the server
 --------------------------------------------------------------------.</td></tr><tr><td valign="top"><a href="#start_reporters-0">start_reporters/0</a></td><td></td></tr><tr><td valign="top"><a href="#subscribe-4">subscribe/4</a></td><td>Equivalent to <a href="#subscribe-5"><tt>subscribe(Reporter, Metric, DataPoint, Interval, [])</tt></a>.</td></tr><tr><td valign="top"><a href="#subscribe-5">subscribe/5</a></td><td>Add a subscription to an existing reporter.</td></tr><tr><td valign="top"><a href="#terminate_reporter-1">terminate_reporter/1</a></td><td></td></tr><tr><td valign="top"><a href="#unsubscribe-3">unsubscribe/3</a></td><td>Equivalent to <a href="#unsubscribe-4"><tt>unsubscribe(Reporter, Metric, DataPoint, [])</tt></a>.</td></tr><tr><td valign="top"><a href="#unsubscribe-4">unsubscribe/4</a></td><td>Removes a subscription.</td></tr><tr><td valign="top"><a href="#unsubscribe_all-2">unsubscribe_all/2</a></td><td>Removes all subscriptions related to Metric in Reporter.</td></tr></table>
 
 
@@ -491,6 +491,17 @@ a restart.
 
 
 If the reporter was already enabled, nothing is changed.
+<a name="get_intervals-1"></a>
+
+### get_intervals/1 ###
+
+
+<pre><code>
+get_intervals(Reporter::<a href="#type-reporter_name">reporter_name()</a>) -&gt; [{atom(), [{time, pos_integer()} | {delay, pos_integer()} | {timer_ref, reference()}]}]
+</code></pre>
+<br />
+
+List the named intervals for `Reporter`.
 <a name="list_metrics-0"></a>
 
 ### list_metrics/0 ###

src/exometer_report.erl

@@ -160,6 +160,7 @@
     set_interval/3,
     delete_interval/2,
     restart_intervals/1,
+    get_intervals/1,
     remove_reporter/1, remove_reporter/2,
     terminate_reporter/1,
     enable_reporter/1,
@@ -458,6 +459,14 @@ delete_interval(Reporter, Name) ->
 restart_intervals(Reporter) ->
     call({restart_intervals, Reporter}).
 
+-spec get_intervals(reporter_name()) ->
+			   [{atom(), [{time, pos_integer()}
+				      | {delay, pos_integer()}
+				      | {timer_ref, reference()}]}].
+%% @doc List the named intervals for `Reporter'.
+get_intervals(Reporter) ->
+    call({get_intervals, Reporter}).
+
 
 -spec enable_reporter(reporter_name()) -> ok | {error, any()}.
 %% @doc Enable `Reporter'.
@@ -628,14 +637,15 @@ make_reporter_recs([{R, Opts}|T]) ->
                module = get_module(R, Opts),
 	       status = proplists:get_value(status, Opts, enabled),
                opts = Opts,
-	       intervals = get_intervals(Opts)}|make_reporter_recs(T)];
+	       intervals = get_interval_opts(Opts)}|make_reporter_recs(T)];
 make_reporter_recs([]) ->
     [].
 
 get_module(R, Opts) ->
     proplists:get_value(module, Opts, R).
 
-get_intervals(Opts) ->
+-spec get_interval_opts([named_interval() | any()]) -> [#interval{}].
+get_interval_opts(Opts) ->
     case lists:keyfind(intervals, 1, Opts) of
 	false -> [];
 	{_, Is} ->
@@ -878,6 +888,20 @@ handle_call({restart_intervals, Reporter}, _, #st{} = St) ->
 	[] ->
 	    {reply, {error, not_found}, St}
     end;
+handle_call({get_intervals, Reporter}, _, #st{} = St) ->
+    case ets:lookup(?EXOMETER_REPORTERS, Reporter) of
+	[#reporter{intervals = Ints}] ->
+	    Info =
+		[{Name, [{time, T},
+			 {delay, D},
+			 {timer_ref, TR}]} || #interval{name = Name,
+							time = T,
+							delay = D,
+							t_ref = TR} <- Ints],
+	    {reply, Info, St};
+	[] ->
+	    {reply, {error, not_found}, St}
+    end;
 handle_call({setopts, Metric, Options, Status}, _, #st{}=St) ->
     [erlang:send(Pid, {exometer_setopts, Metric, Options, Status})
      || Pid <- reporter_pids()],