Docs for /debug/metrics/prometheus

[ianzhang1988]

Checklist

• [X] I am reporting a documentation issue in this repo, not https://docs.ipfs.tech.
• [X] I have searched on the issue tracker for my issue.

Location

No response

Description

Hi, I could not find any detailed explanation about the promethueus output. Some of them are rather unclear to me. Cloud you add some doc for this?

[welcome[bot]]

Thank you for submitting your first issue to this repository! A maintainer will be here shortly to triage and review. In the meantime, please double-check that you have provided all the necessary information to make this process easy! Any information that can help save additional round trips is useful! We currently aim to give initial feedback within two business days. If this does not happen, feel free to leave a comment. Please keep an eye on how this issue will be labeled, as labels give an overview of priorities, assignments and additional actions requested by the maintainers:

• "Priority" labels will show how urgent this is for the team.
• "Status" labels will show if this is ready to be worked on, blocked, or in progress.
• "Need" labels will indicate if additional input or analysis is required.

Finally, remember to use https://discuss.ipfs.io if you just need general support.

[Jorropo]

@ianzhang1988 this is the standart prometheus endpoint, you can see things here for example: https://prometheus.io/docs/guides/go-application/ But I do agree we should have an example on how to use it somewhere.

[ianzhang1988]

@Jorropo Thanks for your reply. I should point out that what I am confused about are the meaing of some "items" from the output. For example flatfs_datastore_get_latency_seconds_bucket, Is the latency here from DHT search or from network or even something else.

[lidel]

If anyone wants to pick this up, the work here is to improve description fields of existing metrics, so they are exported along the values. Please do not waste time writing things down in Markdown, as such documents will get out of date (unless you are willing to write automation that exports strings from code).

[papiche]

I discovered that ipfs is publishing a prometheus probe http://localhost:5001/debug/metrics/prometheus

looking for help to use it...