Metrics

Open Klant produces application metrics (using Open Telemetry).

Note

The exact metric names that show up may be transformed, e.g. Prometheus replaces periods with underscores, and processing pipelines may add prefixes or suffixes.

Important

Some metrics are defined as “global scope”.

These metrics are typically derived from application state introspection, e.g. by performing database (read) queries to aggregate some information. Usually those correspond to an Asynchronous Gauge.

Multiple replicas and/or instances of the same service will produce the same values of the metrics. You need to apply some kind of aggregation to de-duplicate these values. The attribute scope="global" acts as a marker for these type of metrics.

With PromQL for example, you can use avg on the assumption that all values will be equal, so the average will also be identical:

avg by (type) (otel_openklant_auth_user_count{scope="global"})

Generic

http.server.duration: Captures how long each HTTP request took, in ms. The metric produces histogram data.
http.server.request.duration (not active): The future replacement of http.server.duration, in seconds. Currently not enabled, but the code is in the Open Telemetry SDK instrumentation already and could possibly be opted-in to.

Application specific

Accounts

openklant.auth.user_count

Reports the number of users in the database. This is a global metric, you must take care in de-duplicating results. Additional attributes are:

scope - fixed, set to global to enable de-duplication.
type - the user type. all, staff or superuser.

Sample PromQL query:

max by (type) (last_over_time(
  otel_openklant_auth_user_count{scope="global"}
  [1m]
))

openklant.auth.login_failures

A counter incremented every time a user login fails (typically because of invalid credentials). Does not include the second factor, if enabled. Additional attributes:

http_target - the request path where the login failure occurred, if this happened in a request context.

openklant.auth.user_lockouts

A counter incremented every time a user is locked out because they reached the maximum number of failed attempts. Additional attributes:

http_target - the request path where the login failure occurred, if this happened in a request context.
username - username of the user trying to log in.

openklant.auth.logins

Counter incrementing on every successful login by a user. Additional attributes:

http_target - the request path where the login failure occurred, if this happened in a request context.
username - username of the user trying to log in.

openklant.auth.logouts

Counter incrementing every time a user logs out. Additional attributes:

username - username of the user who logged out.

Klantcontacten

openklant.klantcontact.creates: Reports the number of klantcontacten created via the API.
openklant.klantcontact.updates: Reports the number of klantcontacten updated via the API.
openklant.klantcontact.deletes: Reports the number of klantcontacten deleted via the API.

The klantcontacten metrics show how many entities are created, updated, or deleted via the API, helping to monitor load and the most frequent operations, and allow for various aggregations on the data.

Sample PromQL query:

sum by (otel_scope_name) (otel_openklant_klantcontact_updates_total)

Betrokkenen

openklant.betrokkene.creates: Reports the number of betrokkenen created via the API.
openklant.betrokkene.updates: Reports the number of betrokkenen updated via the API.
openklant.betrokkene.deletes: Reports the number of betrokkenen deleted via the API.

The betrokkenen metrics show how many entities are created, updated, or deleted via the API, helping to monitor load and the most frequent operations, and allow for various aggregations on the data.

Sample PromQL query:

sum by (otel_scope_name) (otel_openklant_betrokkene_updates_total)

Partijen

openklant.partij.creates: Reports the number of partijen created via the API.
openklant.partij.updates: Reports the number of partijen updated via the API.
openklant.partij.deletes: Reports the number of partijen deleted via the API.

The partijen metrics show how many entities are created, updated, or deleted via the API, helping to monitor load and the most frequent operations, and allow for various aggregations on the data.

Sample PromQL query:

sum by (otel_scope_name) (otel_openklant_partij_updates_total)

Actoren

openklant.actor.creates: Reports the number of actoren created via the API.
openklant.actor.updates: Reports the number of actoren updated via the API.
openklant.actor.deletes: Reports the number of actoren deleted via the API.

The actoren metrics show how many entities are created, updated, or deleted via the API, helping to monitor load and the most frequent operations, and allow for various aggregations on the data.

Sample PromQL query:

sum by (otel_scope_name) (otel_openklant_actor_updates_total)

Digitale Adressen

openklant.digitaal_adres.creates: Reports the number of digitale adressen created via the API.
openklant.digitaal_adres.updates: Reports the number of digitale adressen updated via the API.
openklant.digitaal_adres.deletes: Reports the number of digitale adressen deleted via the API.

The digitale adressen metrics show how many entities are created, updated, or deleted via the API, helping to monitor load and the most frequent operations, and allow for various aggregations on the data.

Sample PromQL query:

sum by (otel_scope_name) (otel_openklant_digitaal_adres_updates_total)

Interne Taken

openklant.interne_taak.creates: Reports the number of interne taken created via the API.
openklant.interne_taak.updates: Reports the number of interne taken updated via the API.
openklant.interne_taak.deletes: Reports the number of interne taken deleted via the API.

The interne taken metrics show how many entities are created, updated, or deleted via the API, helping to monitor load and the most frequent operations, and allow for various aggregations on the data.

Sample PromQL query:

sum by (otel_scope_name) (otel_openklant_interne_taak_updates_total)