1. Metrics
  2. Total Summer

Metrics

Total Summer

Sums all amounts called on this metric..

Basic usage

Increments the value of stub.metrics.counters.summer.sum_field by 1 starting at 10.

{
metrictype
:
total_summer
params
:
{
category
:
counters
operator
:
addition
amount_field_name
:
sum_field
default_value
:
10

Parameters

metrictype
required
string

Metric type to be used.


params
required
string

This is the object that contains the parameters for the metric.

Show child attributes
amount_field_name
required
string

This is the fieldname to which the data will be written to in stub.metrics.


category
optional
string

This is a grouping of metric within the stub.metrics root.


operator
string

Type of arithmetic to perform.

Options: addition subtraction

Default: addition


default_amount
integer

This is the default value to use if the field is non-existent.

Default: 0


Example

Decrements the value of _ stub.metrics.counters.sum_field_ by 1 starting at 10.

{
metrictype
:
total_summer
params
:
{
category
:
counters
operator
:
subtraction
amount_field_name
:
sum_field
default_value
:
10