feat(mgmt): add credit consumption chart endpoint

[jvallesm]

Because

• Instill Cloud needs to display the credit consumption of an owner as a chart.

This commit

• Adds the contract for the chart information. In pipeline metrics the total
  count is served by a different endpoint. For now, we only want to sum amounts
  by time slot so a single endpoint fits our use case.

Info

Rough example of the returned data (without the total sum):

Result: _result
Table: keys: [_time]
                    _time:time                  amount:float
------------------------------  ----------------------------
2024-06-10T18:15:00.000000000Z                         20.85
Table: keys: [_time]
                    _time:time                  amount:float
------------------------------  ----------------------------
2024-06-10T18:20:00.000000000Z                         20.45
Table: keys: [_time]
                    _time:time                  amount:float
------------------------------  ----------------------------
2024-06-10T18:25:00.000000000Z                          58.5
Table: keys: [_time]
                    _time:time                  amount:float
------------------------------  ----------------------------
2024-06-10T18:30:00.000000000Z                          45.6
Table: keys: [_time]
                    _time:time                  amount:float
------------------------------  ----------------------------
2024-06-10T18:40:00.000000000Z                         15.75

[linear]

INS-4207 Collect credit usage metrics

[donch1989]

Hi @EiffelFly
Do you think we should use id or uid here? Since most of our APIs use id in the path, I'm not sure if using uid will make it harder for the Console to integrate.

[jvallesm]

I actually added this field in the record to have some sort of ownership as part of its data, but in fact the frontend shouldn't need to use it. I agree that in public endpoints the owner ID is more readable and straightforward, but in the request frontend can use owner_name.

[EiffelFly]

@donch1989 @jvallesm I would suggest we use id like users/summerbud since that is the essence of resource oriented API design and console is quite happy with that since all the endpoint have unified behavior

[donch1989]

Got it.
I have a related question about this. If we don't include owner_name in the filter, what will it return?

[jvallesm]

I would suggest we use id like users/summerbud

🤝 I guess exposing UIDs unnecessarily isn't great, I'll adjust the contract.

I have a related question about this. If we don't include owner_name in the filter, what will it return?

It'd aggregate credit over all owners. We don't have a use case for that and it is a resource-consuming operation so I'd make that filter mandatory. But, then, I guess it makes more sense as an explicit endpoint param. In the pipeline chart this is part of the filter but I think the same strategy applies.

[EiffelFly]

I left some comment 👍

[EiffelFly]

@donch1989 @jvallesm I would suggest we use id like users/summerbud since that is the essence of resource oriented API design and console is quite happy with that since all the endpoint have unified behavior

[donch1989]

LGTM

[jvallesm]

@donch1989 @EiffelFly one last change. The transpiler in mgmt-backend produced only an empty expression, even if I copied the filter from the existing dashboard endpoints. In order to make it and, given that all the designs we're handling right now only filter by start and end date, I removed the filter param

[jvallesm]

Sample request (window is reduced to showcase different time slots):

$ curl 'https://localhost:8084/v1beta/metrics/credit/charts?owner=users/juan&start=2024-06-13T06:00:00Z&stop=2024-06-13T08:00:00Z&aggregation_window=10m' \
-H 'Instill-User-Uid: xxx-055d163d2425' -H 'Instill-Auth-Type: user' \
-H 'Content-Type: application/json' | jq
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   174  100   174    0     0   4221      0 --:--:-- --:--:-- --:--:--  4243
{
  "credit_consumption_chart_records": [
    {
      "credit_owner": "users/juan",
      "time_buckets": [
        "2024-06-13T07:50:00Z",
        "2024-06-13T08:00:00Z"
      ],
      "amount": [
        24.7,
        40.75
      ]
    }
  ],
  "total_amount": 65.45
}