feat(#8426): API express internals + endpoint monitoring via Prometheus #8354
Conversation
kennsippell
changed the title
api/src/routing.js
Outdated
| @@ -111,6 +112,16 @@ app.postJsonOrCsv = (path, callback) => handleJsonOrCsvRequest('post', path, cal | |||
| app.postJson = (path, callback) => handleJsonRequest('post', path, callback); | |||
| app.putJson = (path, callback) => handleJsonRequest('put', path, callback); | |||
|
|
|||
| app.use(prometheusMiddleware({ | |||
| metricsPath: '/api_prometheus_metrics', | |||
There was a problem hiding this comment.
not sure where to put this. somewhere under /api/?
There was a problem hiding this comment.
We've usually followed this format /api/v1/<thing>
There was a problem hiding this comment.
I suppose this won't export any PHI. If it's possible to export any URL, I think we're at risk of exposing PHI.
There was a problem hiding this comment.
I have moved to /api/vi/prometheus_metrics.
Can you elaborate on the risk of exposing PHI? I want to make sure I'm clear about your concerns. The intended beahvior here is to only export the Express routes, not URLs.
There was a problem hiding this comment.
Cool, you're correct, there no immediate concern for PHI being exposed through this API at this moment. However, we should still be vigilant whenever we update it.
garethbowen
changed the title
Yep over here: It will be broken by the recent metricPrefix change, but I'll fix that shortly. |
|
Tested with local CHT, grafana, prometheus. API-side looks good. |
|
So awesome to see this merged! Nice work all. |
Description
Adds new endpoint
/api_prometheus_metricsexposing details of what's happening within CHT API Express Server via Prometheus.Conversation in medic/cht-watchdog#60, but I'm installing from a private branch here to work around PayU/prometheus-api-metrics#112 and PayU/prometheus-api-metrics#114.
This exposes:
Works with these dashboards
medic/cht-watchdog#60
#8426
Code review checklist
Compose URLs
If Build CI hasn't passed, these may 404:
License
The software is provided under AGPL-3.0. Contributions to this project are accepted under the same license.