Add a rate_applies_when field to Policy Rules#688
Add a rate_applies_when field to Policy Rules#688schnuerle merged 3 commits intoopenmobilityfoundation:devfrom
Conversation
The rate_applies_when field allows people constructing policy rules with attached rates to specify when the rate is applicable: is when something is within the rule bounds or when it is outside of them? The rate_applies_when when field may take on the values in_bounds and out_of_bounds.
|
Per our working group meeting could you add some example updates to this PR to show how minimum and maximum would work? |
|
Another note from the meeting, when updating the schema, remember to update the files in the schema templates folder too. That's what's used to generate the schema files. |
As a bonus also includes an inclusive_maximum example.
|
I've added an example in d49ae26 and updated the schema template in f38cc96. One question I had was whether I needed to add |
@avatarneil @marie-x could you weigh in on this question so we can finish this PR for the release? |
|
I don't think we need to add it. The new (as of 1.2) rate policy examples use the default |
|
I would argue that if anything the existing rate examples are using |
|
Looks ready to approve. I'm a little concerned that removing 'once' as an option completely, replacing it with 'once_on_unmatch' and 'once_on_match' may break some people's implementations if they are looking at 'once', but it would more likely just not have their code find these new options, which I think is ok as it's not breaking their processing. This change will be in the release notes and schema for 1.2 which should be adequate. |
3 participants
Explain pull request
This is implementing my proposal from #666. The
rate_applies_whenfield allows people constructing policy rules with attached rates to specify when the rate is applicable: is it when something is within the rule bounds or when it is outside of them? Therate_applies_whenwhen field may take on the valuesin_boundsandout_of_bounds. It is used in conjunction with the ruleminimumandmaximumfields. It defaults toout_of_bounds.I also used this PR to bring the Policy JSON schema and an example policy up-to-date following the merger of #658.
Is this a breaking change
This field is optional so it doesn't break in that sense, but having a defined notion of when rates apply could change the interpretation of existing policies.
Impacted Spec
policyAdditional context
The MDS policy spec does not currently specify when rates apply. In #658 @avatarneil argued that they apply when an event falls outside the rule bounds, but in the
raterule examples in the example policies the rates are applying to events/counts within the rule bounds. With the merger of #658 we now have example rules that are not consistent in their interpretation of when rates apply. (The example rate policies do not specifyminimumormaximumfields, so the are implicitly 0 and infinity, respectively, though perhaps it could be argued thatminimumandmaximumare not applicable to rate type rules.)See also my proposal in #666.