Usage Limits & Alerts
Label limits are a feature of a metered component in a price plan that allows you to receive a webhook event when a certain amount of usage on a metered component is reached.
Field Name | Description | Type | Required |
labels | A collection of rules that define the type of usage you'd like to alert on | Dict[String, String]* | Yes |
limit | The threshold at which the webhook will be triggered | Integer | Yes |
These (key, value) pairs correspond to labels emitted by a given metered component. For example, if the primary label of a metered component is Bugatti, then a price plan label limit might have [(Bugatti, Veyron)] for the labels field and 10 for the limit. In this case, the webhook would be triggered when Octane receives the 10th (Bugatti, Veyron) pair from the metered components attached to the price plan.
The (Bugatti, Veyron) example above is an example of a Specific limit in the drop down here:
In contrast to Veyron in the example above, Octane supports three other label limit types
Any: if this type is used, you will receive a webhook event when any number of occurrences of the given key is triggered. Building off the example above, if you have an “any” limit on Bugatti, and put 10 as the limit, you will receive a webhook event when Octane receives 10 events for any Bugatti. This type is not currently exposed in the UI. Only in the api.
Each: if this type is used, you will receive a webhook event for each possible value the metered component can emit. Building off the initial example, if you enter (Bugatti, each) for a given label limit, and put 10 as the limit, you will receive one webhook event for each 10th Bugatti hit (e.g., one webhook event on the 10th (Bugatti, Veyron), another for the 10th (Bugatti Chiron), etc..)
Overall: As the name implies, this label limit type in the drop down above just tracks usage of the overall metered component selected.