rcrowley / go-metrics

Go port of Coda Hale's Metrics library
Other
3.46k stars 494 forks source link

Improve documentation #279

Closed AkashSarda closed 3 years ago

AkashSarda commented 3 years ago

Hi,

I am very new to an organisation and I am tasked with publishing the metrics. Your documentation is not good enough to understand. I am still trying to understand though. How do I expose the api to Prometheus? And what is a Registry, what does it do? I guess a description worth two or three lines can be good enough for the users.