Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Insert excerpt
License
License
nameLicensing Information The feature described in this documentation is optional and might not be part of the edition covered by your company's license.
nopaneltrue

Meters are the customer-specific buckets of usage for the different meter types. When a customer opts for a meter type, then the meter need needs to be created using these with the following parameters:

  • Meter Key (for the Meter processor where the usage data is guided)

  • Meter Type ID (for the meter type the usage should be aggregated for)

  • The User ID (for the customer)

Meters can be created, retrieved, updated, and deleted using the API, see API Reference.

Meter The meter inherits these the following properties defined on from the meter type used stated when creating a the meter -:

  • Active From from - Meter The meter is active from the date time defined on in the active Active from field on in the meter type. If active to Active from is before the time of creating the meter creation time then meter is , the meter will be activated as soon as it is created. The time is calculated based on the timezone defined on in the meter type when created by the meter type is created int he user interface.

  • Active To to - Meter The meter is active to the date time defined on in the active Active to field on the meter type. The time is calculated based on the timezone defined on in the meter type when created by the meter type is created in the user interface.

  • Unit - Unit The unit defined on in the meter type is a the unit in which is a unit for the metered record value will be counted.

  • Aggregation type - Meter follows The meter’s usage is aggregated according to the aggregation which is defined on in the meter type.

  • Reset schedule - Meter The meter follows the reset Reset schedule defined in the meter type. The period end of the meter is calculated based on the reset Reset schedule. The timezone defined on in meter type is considered when calculating period start and period end. See meter teset in Flushing of Metered Record , see Flushing Metered Records.
    When the meter is newly first created, the period start is set to when meter is created. It is shown on the time of creating the meter in the selected timezone and it is shown in the Period start field in the Meter Inspector in the selected timezone.

Update of meter supports the update of parameter “deleteOnReset“ which When updating meterr, updating the parameter “deleteOnReset“ is supported. It can be set to either true or false, and false is the default falsevalue. Once If you set it to true, the meter is will be deleted when the current period ends after sending the metered record to downstream functionfunctions.

Note!

Meter A meter can be created anytime dynamically using the API after once the meter type and a stream with meter a Meter processor is have been created.