3.8.6. /management/metricsΒΆ

Note

Added in EHRbase version 0.15.0

The metrics service provides multiple useful data on the usage of EHRbase since startup of the service. These could be for example the number of requests that have been served to clients and also information on the response types and errors.

You can get an overview on all supported metrics that can be served with this endpoint via GET to the path /management/metrics. This will return a list in JSON format with all possible values for more detailed metrics that have to be requested in a separate request.

Example output:

../../../_images/management_metrics_example_response.png

You can use the values from this list in a further request as the sub-path of metrics and you will get the detailed metric for that point.

As an example you can use the path http.server.reqests to get information on all serves http requests as shown below:

../../../_images/management_metric_http_example_response.png

This example shows also a list of available tags. If you see a list you can filter and aggregate the resuklts by using query paramerters on the same metric.

In our example we can also apply a filter for all unauthorized request by adding the tag like this: /management/metrics/http.server.requests?tag=status:401 which could look like this:

../../../_images/management_metric_http_tag_example_response.png

You can find more information on using tags on metrics in the official documentation.