Skip to content
This repository was archived by the owner on Oct 3, 2023. It is now read-only.

Commit 4f48d9a

Browse files
author
Bogdan Drutu
authored
Fix typos and allow Measurement to use only the Measure name. (#61)
* Fix typos and allow Measurement to use only the Measure name. * Fix some comments.
1 parent 6e91b23 commit 4f48d9a

2 files changed

Lines changed: 5 additions & 4 deletions

File tree

stats/DataAggregation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ within the library.
3131
* `columns`: an array of tag keys. These values associated with tags of this name form the basis
3232
by which individual stats will be aggregated (one aggregation per unique tag value). If none are
3333
provided, then all data is recorded in a single aggregation.
34-
* `aggregation`: `Distribution`, `Count`, `Sum`, `Mean`.
34+
* `aggregation`: `Distribution`, `Count`, `Sum`, `LastValue`, `Max`.
3535

3636
Implementations SHOULD define a View data type, constructed from the parameters above. Views MAY
3737
have getters for retrieving all of the information used in View definition. Once created, View

stats/Record.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ A Measure describes a value with the following metadata:
1313
* `name`: a string by which the measure will be referred to, e.g. "rpc_server_latency", or
1414
"vm_cpu_cycles". Names MUST be unique within the library. It is recommended to use names
1515
compatible with the intended end usage, e.g, use host/path pattern.
16-
* `description`: a string describes the measure, e.g. "RPC latency in seconds", "Virtual cycles
16+
* `description`: a string describing the measure, e.g. "RPC latency in seconds", "Virtual cycles
1717
executed on VM".
1818
* `unit`: a string describing the unit used for the `Measure`. Follows the format described by
1919
[Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html).
@@ -33,12 +33,13 @@ References to Measures in the system MAY be obtained from querying of registered
3333
functionality is required to decouple the recording of the data from the exporting of the data.
3434

3535
For languages that do not allow private properties/metadata and if they are needed implementations
36-
MAY define a `MeasureDescription` data type which contains all the read-only fields from the
36+
MAY define a `MeasureDescription` data type which contains all the read-only fields from the
3737
`Measure` definition such as: `name`, `description`, `unit` and `type`.
3838

3939
## Measurement
4040
A `Measurement` is defined from the following:
41-
* `Measure`: the `Measure` to which this `value` is applied.
41+
* `Measure`: the `Measure` to which this `value` is applied. Some implementations may use the
42+
measure name instead of the `Measure`.
4243
* `value`: recorded value, MUST have the appropriate type to match the `Measure` definition.
4344

4445
Implementations MAY define a `MeasurementMap` which describes a set of data points to be collected

0 commit comments

Comments
 (0)