Enable per limit metrics

[alexsnaps]

This builds on the changes in #112 - which lets a RateLimit have a name.

Add the telemetry field to the LimitadorSpec, which currently has two valid options: basic (what it's been so far) and exhaustive, which will result in starting the Limitador server process with the --limit-name-in-labels option, resulting in the two metrics, limited_calls & authorized_calls, to include the limit's name field as label - providing better metrics about what Limit is limiting or allow traffic through.

[codecov-commenter]

Codecov Report

Merging #113 (5645e70) into main (bb16f15) will decrease coverage by 0.21%.
The diff coverage is 0.00%.

@@            Coverage Diff             @@
##             main     #113      +/-   ##
==========================================
- Coverage   68.80%   68.59%   -0.21%     
==========================================
  Files          14       14              
  Lines         984      987       +3     
==========================================
  Hits          677      677              
- Misses        267      269       +2     
- Partials       40       41       +1     

Flag	Coverage Δ
integration	66.06% <ø> (ø)
unit	69.87% <0.00%> (-0.33%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
api/v1alpha1 (u)	100.00% <ø> (ø)
pkg/helpers (u)	∅ <ø> (∅)
pkg/log (u)	31.81% <ø> (ø)
pkg/reconcilers (u)	44.19% <ø> (ø)
pkg/limitador (u)	87.68% <0.00%> (-0.78%)	⬇️
controllers (i)	66.06% <ø> (ø)

Files	Coverage Δ
api/v1alpha1/limitador_types.go	100.00% <ø> (ø)
pkg/limitador/deployment_options.go	92.10% <0.00%> (-7.90%)	⬇️

[eguzki]

Verification Steps ✔️

dev setup

make local-setup

Deploy the limitador CR without

k apply -f - <<EOF
---
apiVersion: limitador.kuadrant.io/v1alpha1
kind: Limitador
metadata:
  name: limitador-sample
spec:
  limits:
    - conditions: ["get_toy == 'yes'"]
      max_value: 2
      namespace: toystore-app
      seconds: 30
      variables: []
      name: "toy_get_route"
EOF

Check deployment is correct

kubectl wait --timeout=300s --for=condition=Ready limitador limitador-sample

Should return

limitador.limitador.kuadrant.io/limitador-sample condition met

Check command line

kubectl get deployment/limitador-sample  -o yaml | yq '.spec.template.spec.containers[0].command'

should look like this

- limitador-server
- /home/limitador/etc/limitador-config.yaml
- memory

Let's add the telemetry field

k apply -f - <<EOF
---
apiVersion: limitador.kuadrant.io/v1alpha1
kind: Limitador
metadata:
  name: limitador-sample
spec:
  telemetry: exhaustive
  limits:
    - conditions: ["get_toy == 'yes'"]
      max_value: 2
      namespace: toystore-app
      seconds: 30
      variables: []
      name: "toy_get_route"
EOF

Check command line

kubectl get deployment/limitador-sample  -o yaml | yq '.spec.template.spec.containers[0].command'

should look like this

- limitador-server
- --limit-name-in-labels
- /home/limitador/etc/limitador-config.yaml
- memory

Whether that new command line arg --limit-name-in-labels includes or not the limit's name field as label is out of scope of the operator.

[eguzki]

Telemetry is maybe too generic name, not very meaningful for the very specific task that is doing: "adding limit names as label in the metrics". Or you are planning to add more command line args like --limit-name-in-labels when the value of the telemtry is exhaustive??

[alexsnaps]

Or you are planning to add more command line args like --limit-name-in-labels when the value of the telemtry is exhaustive??

Yes, or… let's say I did want that to be generic to not tie it to any implementation, as we'll probably iterate over this. Hence the enum as well, so we can add values. e.g. to support better tracing

[eguzki]

Code wise it is correct

[alexsnaps]

Rebased and ready for merge/releasing