Event Mapping
ADVANCED TOPIC
This section is not necessary for out-of-the-box basic usage of the Octane platform. We recommend going through the other guides first before reading this section.
A single event may be measured by multiple meters. Event names allow a single event to be measured by multiple meters. If an event name is not set, the event name will default to the meter name. If an event name is set, you should not set the meter name.
When creating a meter, you can set its event name and Octane will use it to identify associated measurements. Multiple meters can map to the same event name, and this is the intended use case. Each meter can have it's own aggregation, be priced on separately, and have their own Metered Component.
If you are using labels to measure different independent streams, all meters that map to the same event name must have the same label keys defined. Any measurements sent with the event name will be multiplexed to each of the meters and have the same labels sent in the event-level measurement.
Your system could have an event calledĀ applicant_exam, and have two meters that are mapped to this event:
- An active_applicants continuous meter with a TIME_WEIGHTED_SUM aggregation measuring the current number of applicants.
- An exam_count discrete meter with a SUM aggregation measuring the number of exams taken.
Now, instead of having to send a measurement to each meter, you could simply send one measurement with theĀ event_nameĀ set toĀ applicant_exam:
Octane will multiplex this measurement to both theĀ active_applicantsĀ andĀ exam_countĀ meters. Each meter will apply their own aggregation and have their own usage. Additionally, as stated above, each meter can have their own price scheme.
ļ»æ