ipfs / ipfs-docs

📚IPFS documentation platform
https://docs.ipfs.tech
300 stars 413 forks source link

Explain what the Prometheus API is, and add some examples. #682

Closed autonome closed 1 year ago

autonome commented 3 years ago

Implemented originally here: https://github.com/ipfs/go-ipfs/pull/1422

Also something newer here: https://github.com/ipfs/go-metrics-prometheus

autonome commented 3 years ago

Some cluster + Prometheus docs, maybe relevant:

https://cluster.ipfs.io/documentation/guides/opencensus/

https://simpleaswater.com/tracing-and-monitoring-ipfs-cluster/

AlexxNica commented 3 years ago

I think I can get this one. Do you have more info for the bounty (numbers, tasks)?

johnnymatthews commented 3 years ago

I'm not really sure why I threw the bounty tag on here, I usually have the tasks fleshed out before I do that. Ah well, here we are. I'm gonna take the bounty tag off for now while I find out what exactly we need to document. I'm assuming it's along the lines of:

  1. What Prometheus is/does.
  2. How to use it.

Once I've got a task list ready to go I'll tag you again @AlexxNica and you can see if you wanna tackle it. Sound good?

AlexxNica commented 3 years ago

@johnnymatthews Perfect! Thank you! 🙌