search

ipfs-inactive / bifrost-gateway

Experimental gateway with delegated backend. No longer maintained, consider migrating to https://github.com/ipfs/rainbow/
Other
41 stars 20 forks source link

Add tests and docs for every exposed metric #31

Open lidel opened 1 year ago

lidel commented 1 year ago

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)

BigLep commented 1 year ago

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".

hacdias commented 1 year ago

@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.