ExTeal
v0.27.0

View Source ExTeal.Metric.Value behaviour (ExTeal v0.27.0)

Value Metrics display a single value and it's change compared to a previous interval of time. For example, a value metric might display the total number of blog posts created in the last thirty days, versus the previous thirty days.

Once generated, a value metric module has two functions that can be customized, a calculate/1 and a ranges/0 function.

Additionally there are modifier functions that change the behavior and display of the metric.

Summary

Types

multi_result()
result()
valid_result()

Callbacks

calculate(t)

Functions

aggregate(metric_module, request, queryable, aggregate_type, field)
between_current(query, atom, options)
query_for(current, metric, request, queryable, aggregate_type, field)

Types

Link to this type

multi_result()

View Source 
@type multi_result() :: [%{label: String.t(), data: result()}]
Link to this type

result()

View Source 
@type result() :: %{current: term(), previous: term()}
Link to this type

valid_result()

View Source 
@type valid_result() :: result() | [multi_result()]

Callbacks

Link to this callback

calculate(t)

View Source 
@callback calculate(ExTeal.Metric.Request.t()) :: valid_result()

Functions

Link to this function

aggregate(metric_module, request, queryable, aggregate_type, field)

View Source 
@spec aggregate(
  module(),
  ExTeal.Metric.Request.t(),
  Ecto.Queryable.t(),
  atom(),
  atom()
) :: map()
Link to this function

between_current(query, atom, options)

View Source
Link to this function

query_for(current, metric, request, queryable, aggregate_type, field)

View Source 
@spec query_for(
  atom(),
  module(),
  ExTeal.Metric.Request.t(),
  Ecto.Queryable.t(),
  atom(),
  atom()
) ::
  integer() | float()