search

open-services / open-registry

Community Owned JavaScript Registry
https://open-registry.dev
MIT License
266 stars 8 forks source link

Metrics page #6

Open victorb opened 5 years ago

victorb commented 5 years ago

Part of being a Open Service is having all the useful metrics also be public. Metrics we currently have is bunch of data about the JVM + metadata/tarball requests (cached vs non-cached)

kbariotis commented 5 years ago

Hi @victorb, this is a great project, thank you for taking the time to do it.

Haven't had the chance to setup this project locally so a couple of questions on this to see how I can help. How are you thinking about tackling this issue?

I could setup another page on the existing website, trying to fetch data from Prometheus and showing them in some nice metrics using a third-party metrics library.

Thank you

victorb commented 5 years ago

Hi @victorb, this is a great project, thank you for taking the time to do it.

Thanks, makes me very happy to hear! :)

I saw that you are using Prometheus. Are these metrics stored there?

Yes, currently prometheus is used everywhere, even for the finances, the idea being that we can have one dashboard in Grafana that is public that gives a overview of everything from the finances, infrastructure or application-specific metrics.

Should we setup a basic website that would fetch them from Prometheus?

I think we can use a Grafana Dashboard for the main view. What would be nice and is planned, is to fetch data from Prometheus and show is on the website. I was planning to include it in the first version of the website, but didn't have time. You can see the commented HTML where the metrics/finances are supposed to be here: https://github.com/open-services/open-registry-website/blob/master/index.html#L248-L345

I saw you have setup a website on the gh-pages. I don't see how this is being built so I guess you are managing it manually. Have you thought about moving to a framework? Is this a good time to talk about it?

So the gh-pages you see here in open-services/open-registry is the documentation available over at https://docs.open-registry.dev. It's built with mkdocs already.

The configuration for the docs config is here: https://github.com/open-services/open-registry/blob/master/mkdocs.yml And the actual documents are here: https://github.com/open-services/open-registry/tree/master/docs

The main website has a different repository: https://github.com/open-services/open-registry-website

Regarding the landing page (https://open-registry.dev) it's currently very simple and hopefully we can keep it so. There is no framework and works without JS, which would be nice to keep it like that. Unless there is a sudden jump in complexity compared to now, I'd like to avoid any frameworks.

If you feel up for it, I added a issue in the website repository about working towards showing the finance metrics there. Take a look and let me know what you think: https://github.com/open-services/open-registry-website/issues/1