@@ -106,7 +106,7 @@ See table below to find out how to create `URI` for each backend:
106106### Sending metric
107107
108108```cpp
109- send(Metric&& metric)
109+ send(Metric&& metric, [DerivedMetricMode mode] )
110110```
111111Where metric constructor receives following parameters:
112112 - ` T value `
@@ -118,6 +118,8 @@ For example:
118118monitoring->send ({10, "myMetricInt"});
119119```
120120
121+ Regarding `DerivedMetricMode` see [Calculating derived metrics](#calculating-derived-metrics).
122+
121123### Customized metrics
122124Two additional methods can be chained the to `send(Metric&& metric)` in order to __insert custom tags__ or __set custom timestamp__:
123125 + `addTags(std::vector<Tag>&& tags)`
@@ -179,9 +181,10 @@ Metrics consist of 4 parameters: name, value, timestamp and tags.
179181+ process name
180182
181183### Calculating derived metrics
182- The module can calculate derived metrics. To do so, use ` addDerivedMetric(std::string name, DerivedMetricMode mode) ` with one of two available modes:
183- + ` DerivedMetricMode::RATE ` - rate between two following metrics;
184- + ` DerivedMetricMode::AVERAGE ` - average value of all metrics stored in cache;
184+ The module can calculate derived metrics. To do so, use optional ` DerivedMetricMode mode ` parameter of ` send ` method:
185+ + ` DerivedMetricMode::NONE ` - no action,
186+ + ` DerivedMetricMode::RATE ` - rate between two following metrics,
187+ + ` DerivedMetricMode::AVERAGE ` - average value of all metrics stored in cache.
185188
186189Derived metrics are generated each time as new value is passed to the module. Their names are suffixed with derived mode name.
187190
0 commit comments