bifrost-gateway icon indicating copy to clipboard operation
bifrost-gateway copied to clipboard

Add tests and docs for every exposed metric

Open lidel opened this issue 2 years ago • 2 comments

To avoid bugs like https://github.com/ipfs/go-libipfs/issues/162 we need to have regression test for every gateway metric fro go-libipfs.

We should also have ./docs/METRICS.md which explains what is exposed and why (reuse notes from https://www.notion.so/pl-strflt/Rhea-Project-Metrics-55f08f7b33564dc59926d63c282ab564 for now, we can refine it later)

lidel avatar Feb 10 '23 15:02 lidel

Yes, definitely agreed on needing to have our metrics documented.

One area I often see get missed is around latency metrics. Please be clear on "when is the stopwatch started" and "when is the stopwatch ended".

BigLep avatar Feb 10 '23 23:02 BigLep

@lidel perhaps this tests (and docs) would be better to live in go-libipfs instead, with the gateway code itself? I will investigate how to add tests for the metrics.

hacdias avatar Feb 13 '23 15:02 hacdias