Performance Metrics#
The application server collects and reports performance metrics for collection by the Prometheus monitoring toolkit. Counters are prepared and updated within the backend. Scrapers can fetch the current data via a simple HTTP GET request. The response is in plain text and contains self-descriptive information. The Metrics-resource is available only on the maintenance server-port.
Example request and response:
# curl -s -v http://localhost:8083/metrics
* Trying ::1...
* TCP_NODELAY set
* Expire in 150000 ms for 3 (transfer 0x55f8f7168fb0)
* Expire in 200 ms for 4 (transfer 0x55f8f7168fb0)
* Connected to localhost (::1) port 8083 (#0)
> GET /metrics HTTP/1.1
> Host: localhost:8083
> User-Agent: curl/7.64.0
> Accept: */*
>
< HTTP/1.1 200 OK
< Content-Type: text/plain;charset=utf-8;version=0.0.4
< Transfer-Encoding: chunked
<
# HELP jvm_threads_current Current thread count of a JVM
# TYPE jvm_threads_current gauge
jvm_threads_current 80.0
# HELP jvm_threads_daemon Daemon thread count of a JVM
# TYPE jvm_threads_daemon gauge
jvm_threads_daemon 66.0
# HELP jvm_threads_peak Peak thread count of a JVM
# TYPE jvm_threads_peak gauge
jvm_threads_peak 97.0
# HELP jvm_threads_started_total Started thread count of a JVM
# TYPE jvm_threads_started_total counter
jvm_threads_started_total 161.0
# HELP jvm_threads_deadlocked Cycles of JVM-threads that are in deadlock waiting to acquire object monitors or ownable synchronizers
# TYPE jvm_threads_deadlocked gauge
jvm_threads_deadlocked 0.0
# HELP jvm_threads_deadlocked_monitor Cycles of JVM-threads that are in deadlock waiting to acquire object monitors
# TYPE jvm_threads_deadlocked_monitor gauge
jvm_threads_deadlocked_monitor 0.0
# HELP jvm_threads_state Current count of threads by state
# TYPE jvm_threads_state gauge
jvm_threads_state{state="NEW",} 0.0
jvm_threads_state{state="TERMINATED",} 0.0
jvm_threads_state{state="RUNNABLE",} 17.0
jvm_threads_state{state="BLOCKED",} 0.0
jvm_threads_state{state="TIMED_WAITING",} 26.0
jvm_threads_state{state="WAITING",} 37.0
HTTP endpoint#
The Metrics-resource is available only on the maintenance server-port. By default, the following URL should be used:
http://localhost:8083/metrics
JVM metrics#
The backend reports information about the JVM performance and resource utilization.
References:
- https://github.com/prometheus/client_java#included-collectors
- https://github.com/prometheus/client_java/tree/master/simpleclient_hotspot
Spaces metrics#
The backend collects and reports number of events triggered by users as well as key values used in KPI reporting.
Note: Some values are reported individual to the application server. Other values are calculated from the database; querying multiple application servers will always return the same results.
| Metric | Type | Purpose | Scope |
|---|---|---|---|
| spaces_requests_total | Counter | Number of successful requests by users, since appserver start. Label type differentiates between types of requests. |
Per appserver |
| spaces_metadata_total | Gauge | Total number of metadata objects. Includes objects in trash and orphans. | Cluster-wide |
| spaces_metadata_size_total | Gauge | Total size of all metadata objects in Bytes. Includes objects in trash and orphans. | Cluster-wide |
| spaces_organizations_withActiveSpace_total | Gauge | Total number of organizations with at least one actively used space. | Cluster-wide |
| spaces_collaborators_total | Gauge | Total number of collaborators. | Cluster-wide |
| spaces_collaborators_new_14d_weekly_total | Gauge | Total number of collaborators created during 7d starting 14d ago. | Cluster-wide |
| spaces_collaborators_new_14d_active_weekly_total | Gauge | Total number of collaborators created during 7d starting 14d ago that were active during the last 7d. | Cluster-wide |
| spaces_collaborators_new_180d_weekly_total | Gauge | Total number of collaborators created more than 180d ago. | Cluster-wide |
| spaces_collaborators_new_180d_active_weekly_total | Gauge | Total number of collaborators created more than 180d ago that were active during the last 7d. | Cluster-wide |
| spaces_persons_total | Gauge | Total number of persons. | Cluster-wide |
| spaces_persons_new_14d_weekly_total | Gauge | Total number of persons created during 7d starting 14d ago. | Cluster-wide |
| spaces_persons_new_14d_active_weekly_total | Gauge | Total number of persons created during 7d starting 14d ago that were active during the last 7d. | Cluster-wide |
| spaces_persons_new_14d_invitation_weekly_total | Gauge | Total number of persons created during 7d starting 14d ago that issued an invitation during the last 7d. | Cluster-wide |
| spaces_persons_new_14d_newSpace_weekly_total | Gauge | Total number of persons created during 7d starting 14d ago that created a new space during the last 7d. | Cluster-wide |
| spaces_persons_new_180d_weekly_total | Gauge | Total number of persons created more than 180d ago. | Cluster-wide |
| spaces_persons_new_180d_active_weekly_total | Gauge | Total number of persons created more than 180d ago that were active during the last 7d. | Cluster-wide |