search

gnocchixyz / gnocchi

Timeseries database
Apache License 2.0
298 stars 84 forks source link

Improve documentation for aggregates API and the `use_history` option #1373

Closed rafaelweingartner closed 4 months ago

rafaelweingartner commented 5 months ago

The use_history option for the aggregates API allows one to retrieve the exact attributes of a resource that were present during a given timestamp for a measurement obtained via the aggregates API. However, this API has a downside, which is the inability to execute "re-aggregations" for now. Therefore, if one needs to execute the "re-aggregation" of computed measures, she/he will need to use the aggregates API with the option use_history as False.

This patch makes that clear for the end users.

pedro-martins commented 5 months ago

It is nice to have this behavior clarified in the docs. I have only this nit suggestion, thanks.

pedro-martins commented 5 months ago

Thanks Rafael, It seems good to me :+1:

rafaelweingartner commented 4 months ago

Hello guys, can we merge this one? Or, do you think that we need some further improvements here?