Meter Configuration
- Jenni Wallin
- Felicity Borrelli
- Diksha Sethi
When you double-click the meter processor function, the Meter dialog opens. This dialog consists of three different parts;
The Configuration tab, where you configure the processor
The Inspect tab where you can see details about the meters associated with the meter processor along with their current values, see Meter Inspector
A Preview section which shows what the input and output data looks like and can be used for testing the solution.
When meter processor is added to a stream a unique Meter key is created and is displayed in the Configuration tab in a Meter key field. This key is unique per meter processor, and is one of the parameters used when creating meters using the APIs, see Managing Meters with the API . Next to the field is a 
Note!
If you import a stream with a meter processor that is a duplicate of an existing stream, a new Meter key will be generated to ensure they are unique. The meters attached to meter processors are not imported when importing a stream.
The Configuration tab contains the following settings:
Guiding Rules
The meter processor must have at least one guiding rule configured. You can add additional guiding rules by clicking the 
Each guiding rule contains the following settings.
Setting | Description |
|---|---|
Guiding rule | |
Name | Enter an intuitive name for the guiding rule in this field. |
Condition setting | Select if you want to define customized conditions for the rule or not by selecting either No condition or Custom condition. If you select No condition, nothing more is required, but if you select Custom condition, a new section called Condition n will appear that you can expand and enter any conditions you want to be met for the usage to be metered: Each condition is configured with three settings:
For example: Field: download status The field matching is case-sensitive. The name of the condition will now be converted to show your configuration which will make it easier to see the configured condition even after collapsing it. You can configure additional conditions by clicking on the If the usage data record does not match the condition and is filtered out then it will be evaluated against the next guiding rule, if configured. |
Category to match | Select which category you want to aggregate usage for in this drop-down. The meter processor refers to categories instead of individual meter types which provides you with the possibility to add, remove, or update meter types without having to update the configuration of the meter processor. All existing categories configured in meter types will be displayed, see Creating Meter Types. If the usage data record does not find the meter available in this category then it will be evaluated against the next guiding rule, if configured. |
Group by | |
+Add fields | If you want to get the breakdown of the metered usage based on a specific field or group of fields, click +Add fields and select the fields from the dropdown. If the desired field is not visible in the drop-down, you can use Add Field in the drop-down then click on the + button to add your own. You can add up to 5 groups of fields. For more details on the “Group by” configuration, see Flushing Metered Records |
Other operations | |
+ Add operation | If you want to send additional information along with your metered record to downstream systems you can click +Add operation. This will display a section for defining the operations to be carried out. you can add up to 10 operations in a guiding rule. For details of the output of “other operations” configuration, see Flushing Metered Records Operation
Field If the desired field is not visible in the drop-down, you can use the Add Field in the drop-down then click on the + button to add your own. |
To view all guiding rules together in a table format, click the View all button on the top right of ‘guiding rules
Flush By
The Flush by setting determines when flush happens, that is when the aggregated output data records are sent to downstream systems. You have two options;
Period end - This option is used when you want to aggregate over time, usually in sync with a billing cycle. If you select this option, the meters will be flushed and reset when the current period of the meter has ended. The period end of the meter is determined by the Reset schedule defined for the respective meter type.
Stream execution - This option is commonly used when testing the usage metering solution with integration when you want to output the metered record from the meter processor immediately. If you select this option, all meters will be flushed and reset at the end of stream execution. See Execution of Usage Metering Streams for further information about stream execution considerations. This option is not available for real-time streams.
This setting impacts when the flush is performed and the calculation of the next metering period. For more information see, Meter Reset in Flushing Metered Records and Real-time and batch execution inExecution of Usage Metering Streams.
Preview
Click on the 
You can select to view the data in the following formats:
Input data: Table, tree
Output data: Table, tree
The preview is generated using a fresh state of meters. It does not matter what the value of the meter in the system is, it always takes the meter’s initial state.
Preview functionality works best with a limited set of meters and meter types. A maximum of 200 entries will be shown in the preview. If more entries exist the preview will show a random selection of entries. Only the 10 most recently updated meters will be displayed in the output.
The log tab on output data helps with the debugging of issues that may occur due to incorrect fields or guiding rules. The log tab shows the number of records that will be sent to data correction because they have not matched any meter or because they are missing mandatory input fields.