...
| Insert excerpt | ||||||||
|---|---|---|---|---|---|---|---|---|
|
The process of sending data from the Meter processor to downstream systems is known as ‘flushing a record’. The flushed record is in JSON format and it will be sent for each meter associated with the Meter processor.
Irrespective Regardless of whether the meter being was updated or not during the last metering period, the meter is will always be flushed when it’s its period ends. Meters are not will only be flushed after the Active Toto date time has been passed for the meter type linked except Meters which has passed if they have been updated during the current metering period.
A usage audit is generated when the input data is sent out from the Meter processor.
The metered record can be viewed in JSON format in the Meter Inspector
...
These The following fields are included in the fields which are record sent to downstream systems in JSON format:
Field | Purpose |
|---|---|
id | The unique ID of the meter. |
userId | Unique The unique ID of the user the meter belongs to, for example an email address, user name, or MSISDN number. |
meterTypeId | The unique ID of the meter type that the meter aggregate aggregates usage for. |
meterTypeName | Name The name of the meter type this meter is created using. |
timezone | The timezone that should be applied for reset time. Defined on in the meter type of for this meter. |
meterKey | The meter key for the Meter processor aggregating the usage for the meter. |
value | The current value of the meter, updated based on the guiding rules and aggregation type defined on in the meter type. |
unit | Unit The unit in which this meter is measuringmeasures usage. Defined on in the meter type of for this meter. |
createdAt | The UTC timestamp of for when the meter was created. |
updatedAt | The UTC timestamp of for when the meter was last updated. |
periodStart | The UTC timestamp from for when the metering period has started. This is calculated based on when the last period has ended. |
periodEnd | The UTC timestamp for when the metering period has ended. This is calculated based on the reset schedule. |
groups | Granular A granular breakdown of the aggregated values, grouped by the guiding rules defined in the Meter Configuration. Each group is represented by an array containing the parameters |
carryFirst | First The first occurrence of one or many more fields that should be carried over from the usage record. Configured This is configured in other Other operations in the Meter Configuration. |
carryLast | Last The last occurrence of one or many more fields that should be carried over from the usage record. Configured This is configured in other Other operations in the Meter Configuration. |
deleteOnReset | If this is set to true, the meter will be deleted when the ongoing metering period ends. Can This can be updated using the update Meter meter API. |
meterMetaData | Additional This is additional meta information related to the usage ingestion example, datetime when the first and last record matched this meter. |
...
| Info | ||
|---|---|---|
Example - Metered Output Record
|
Meter Reset
When a flush happens, the values of the meters are also reset to their initial value , for example, a value is set to 0, or groups are removed etc, to empty the bucket. At the same time, meters are prepared for the next metering period and Period start and Period end is are updated based on when the flush happen happens and the Reset schedule.
If the meters are flushed by Period end in the Meter Processor , then the new period Period start is set to when the when last period has ended, and period the Period end is calculated based on the Reset schedule of the respective meter type. Example, meter type has reset schedule everyday at midnight -
| Info |
|---|
Example - Meter Type has Reset Schedule every day at Midnight Ongoing period: Period start - |
...
Jan 1 00:00 |
...
Period end |
...
- Jan 2 00:00 |
...
...
Scenario 1: A stream runs on |
...
Jan |
...
2 at 02:00 |
...
. The new period is: Period start |
...
- Jan 2 00:00 |
...
Period end |
...
- Jan 3 00:00 |
...
...
Scenario 2: Astream does not run |
...
on Jan 2 at 00:00, but runs on |
...
Jan 3 at 02:00 |
...
. The new period is: Period start |
...
- Jan 2 00:00 and Period end |
...
- Jan 4 00:00. |
...
This happens because before |
...
the incoming usage data is processed, the stream scans for meters whose |
...
periods have ended and |
...
flushes them. In scenario 2 where the stream runs on |
...
Jan 3, the usage data from |
...
Jan |
...
2 after midnight is included in the new period, and usage data up |
...
until Jan 2 at midnight is already aggregated in the metered and flushed record. |
If the meters are flushed by Stream execution in the Meter Processor , the period Period end of the flushed metered record is set to the time of the flush. The new Period start of the meter in the stream is also set to the time of the flush, and the Period end is calculated using the meter type Reset schedule.
Period start and Period end for a meter can be checked using a in the Meter Inspector.