Skip to content
This repository has been archived by the owner on Jun 20, 2024. It is now read-only.

Add tests and docs for every exposed metric #31

Open
lidel opened this issue Feb 10, 2023 · 2 comments
Open

Add tests and docs for every exposed metric #31

lidel opened this issue Feb 10, 2023 · 2 comments
Milestone

Comments

@lidel
Copy link
Collaborator

lidel commented Feb 10, 2023

To avoid bugs like ipfs/boxo#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 lidel added this to the M0.2: Feb 17 milestone Feb 10, 2023
@lidel lidel changed the title Add tests for every exposed metric Add tests and docs for every exposed metric Feb 10, 2023
@BigLep
Copy link

BigLep commented Feb 10, 2023

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
Copy link
Collaborator

hacdias commented Feb 13, 2023

@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 hacdias removed their assignment May 27, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants