Prometheus integration about wakapi HOT 6 CLOSED

https://prometheus.io/docs/instrumenting/writing_exporters/

from wakapi.

Export metrics:

• Number of users
• Number of active users
• Number of recorded heartbeats
• Total sum of recorded minutes of coding time
• Total sum of recorded minutes per OS ?
• Total sum of recorded minutes per editor ?
• Total sum of recorded minutes per language ?

Q: I'm not too experienced with Prometheus. Does anyone know, if its a good practice to export metrics like the last three from above? Obviously, exporting a metrics for every tracked project is infeasible, as the amount of projects can easily be several hundreds or thousands. OSs, editors and languages could, in theory, also be an infinite set each, however, in practice, it will probably be a manageable finite number.

from wakapi.

Moreover, this would have to be done on a per-user basis.

• Option 1: Parameterize /metrics endpoint with an ?apiKey= argument, so that metrics are always only scraped for a specific given user
• Option 2: Include the user name as a metrics label. This way, any user could track any other user's statistics, which seems to be a bad idea.

from wakapi.

Option 1 would go well with Wakatime's convention to have /current/ in the URL path reference the currently logged in user.

wakatime_exporter implements option 1 and exports separate labels for every project, editor, etc.

from wakapi.

May also be realized as a standalone exporter, just like wakatime_exporter. In fact, when implementing #44 and #45, wakatime_exporter could be used as is.

from wakapi.

I decided not to implement an own Prometheus exporter for now, but instead rely on wakatime_exporter as an additional, standalone tool.

from wakapi.