Liberator Prometheus metrics
This page lists the Prometheus metrics published by Liberator.
Prometheus metrics are not published by default. To enable this feature, see Publishing DataSource metrics in Prometheus format.
This feature requires Liberator 8.0.0 or higher.
Process metrics
Liberator publishes the following metrics on the operating-system process that runs Liberator.
These metrics are only available on RHEL builds of Liberator.
- process_cpu_seconds_total
-
Total user and system CPU time spent in seconds.
Type: Gauge
- process_max_fds
-
The maximum number of file descriptors the process may have open (set by
ulimit
on Linux).Type: Gauge
- process_open_fds
-
Number of file descriptors the process has open.
Type: Gauge
- process_resident_memory_bytes
-
Resident memory size in bytes.
Type: Gauge
- process_start_time_seconds
-
Start time of the process (number of seconds since the start of the Unix epoch).
Type: Gauge
- process_virtual_memory_bytes
-
Virtual memory size in bytes.
Type: Gauge
- process_virtual_memory_max_bytes
-
Maximum amount of virtual memory available in bytes.
Type: Gauge
- rttpd_process_fds
-
Number of file descriptors the process has open.
Type: Gauge
Labels type
File descriptor type. Possible values:
non_socket_fds
,socket_fds
- rttpd_process_uptime_seconds_total
-
Process uptime in seconds.
Type: Counter
- rttpd_process_cputime_seconds_total
-
Process total CPU time in seconds.
Type: Counter
Labels type
CPU time type. Possible values:
user
,system
- rttpd_process_delayed_threads
-
Count of delayed threads that have been delayed for 5 seconds or more. Delayed threads are an indication that the DataSource is under high load or that threads have locked up.
Type: Gauge
- rttpd_process_cpu_usage_percentage
-
Average CPU percentage used by the DataSource process in the period configured by the configuration option
process-usage-period
(default 10 seconds).Type: Gauge
DataSource peer metrics
Liberator publishes the following metrics on connected DataSource peers, where where appname is Liberator’s application name as defined by the application-name
configuration item (defaults to rttpd
).
- rttpd_peer_global_bytes_read
-
[gauge] Total number of bytes read from all peer connections.
- rttpd_peer_global_bytes_read_rate
-
[gauge] The rate data is received (bytes/second) from all peer connections, measured over the sample period defined by
peer-monitor-interval
. - rttpd_peer_global_bytes_written
-
[gauge] Total number of bytes written to peer connections.
- rttpd_peer_global_bytes_written_rate
-
[gauge] The rate data is written (bytes/second) to all peer connections, measured over the sample period defined by
peer-monitor-interval
. - rttpd_peer_global_messages_read
-
[gauge] Total number of messages read from peer connections.
- rttpd_peer_global_messages_read_rate
-
[gauge] The rate messages are received (messages/second) from all peer connections, measured over the sample period defined by
peer-monitor-interval
. - rttpd_peer_global_messages_written
-
[gauge] Total number of messages written to peer connections.
- rttpd_peer_global_messages_written_rate
-
[gauge] The rate messages are written (messages/second) to all peer connections, measured over the sample period defined by
peer-monitor-interval
.
Data service metrics
Liberator publishes the following metrics for each data service, where appname is Liberator’s application name as defined by application-name
(defaults to rttpd
) and servicename
is the name of the data service.
- rttpd_service_servicename_average_response_time
-
[gauge] The average time (milliseconds) taken for the data service to respond to a subscription request, measured over the sample period defined by
peer-monitor-interval
. - rttpd_service_servicename_bytes_read
-
[gauge] Total number of bytes read from the data service.
- rttpd_service_servicename_bytes_read_rate
-
[gauge] The rate at which data is received (bytes/second) from the data service, measured over the sample period defined by
peer-monitor-interval
. - rttpd_service_servicename_bytes_written
-
[gauge] Total number of bytes written to the data service.
- rttpd_service_servicename_bytes_written_rate
-
[gauge] The rate at which data is written (bytes/second) to the data service, measured over the sample period defined by
peer-monitor-interval
. - rttpd_service_servicename_messages_read
-
[gauge] The total number of messages received from the data service.
- rttpd_service_servicename_messages_read_rate
-
[gauge] The rate at which messages are received (messages/second) from the data service, measured over the sample period defined by
peer-monitor-interval
. - rttpd_service_servicename_messages_written
-
[gauge] The total number of messages written to the data service.
- rttpd_service_servicename_messages_written_rate
-
[gauge] The rate at which messages are written (messages/second) to the data service, measured over the sample period defined by
peer-monitor-interval
. - rttpd_service_servicename_response_time
-
[gauge] The time taken (seconds) for the data service to respond to the first subscription request. This value only changes if the object is discarded and requested again.
- rttpd_service_servicename_state
-
[gauge] The state of the data service. It has two possible values:
1
for up,0
for down.
User metrics
Liberator publishes the following metrics for users
- rttpd_user_global_login_fail
-
The total number of failed logins.
Type: Counter
- rttpd_user_global_read_fail
-
The total number of failed reads.
Type: Counter
- rttpd_user_global_write_fail
-
The total number of failed writes.
Type: Counter
- rttpd_user_global_users
-
The total number of live RTTP sessions. Equal to rttpd_session_global_logged_in. Equal to or greater than rttpd_user_global_unique_users, depending on the number of live RTTP sessions per user account.
Type: Gauge
- rttpd_user_global_unique_users
-
The total number of user accounts with one or more live RTTP sessions. Equal to or less than rttpd_user_global_users, depending on the number of live RTTP sessions per user account.
Type: Gauge
RTTP session metrics
Liberator publishes the following metrics for RTTP sessions, where appname is Liberator’s application name as defined by application-name
(defaults to rttpd
).
- rttpd_session_global_bytes_read
-
Total number of bytes Liberator has read from all RTTP sessions.
Type: Gauge
- rttpd_session_global_bytes_read_rate
-
The rate at which Liberator reads data (bytes/second) from all RTTP sessions, measured over the sample period defined by
session-monitoring-interval
.Type: Gauge
- rttpd_session_global_bytes_written
-
Total number of bytes that Liberator has written to all RTTP sessions. This metric is measured before the application of optional protocol compression (see
http-extensions
).Type: Gauge
- rttpd_session_global_bytes_written_rate
-
The rate at which Liberator writes data (bytes/second) to all RTTP sessions, measured over the sample period defined by
session-monitoring-interval
. This metric is measured before the application of optional protocol compression (seehttp-extensions
).Type: Gauge
- rttpd_session_global_bytes_written_actual
-
Total number of bytes Liberator has written to all RTTP sessions. This metric is measured after the application of optional protocol compression (see
http-extensions
).Type: Gauge
- rttpd_session_global_bytes_written_actual_rate
-
The rate at which Liberator writes data (bytes/second) to all RTTP sessions, measured over the sample period defined by
session-monitoring-interval
. This metric is measured after the application of optional protocol compression (seehttp-extensions
).Type: Gauge
- rttpd_session_global_contribs
-
The total number of RTTP contributions received by Liberator across all RTTP sessions.
Type: Gauge
- rttpd_session_global_contribs_rate
-
The rate at which Liberator receives RTTP contributions (contributions/second) across all RTTP sessions, measured over the sample period defined by
session-monitoring-interval
.Type: Gauge
- rttpd_session_global_count
-
The total number of RTTP sessions, including sessions that are not logged in. Compare with rttpd_session_global_logged_in.
Type: Gauge
- rttpd_session_global_discards
-
The total number of objects discarded by Liberator across all RTTP sessions.
Type: Gauge
- rttpd_session_global_discards_rate
-
The rate at which Liberator discards objects (objects/second) across all RTTP sessions.
Type: Gauge
- rttpd_session_global_logged_in
-
The total number of logged in sessions.
Type: Gauge
- rttpd_session_global_requests
-
The total number of subject requests received by Liberator across all RTTP sessions.
Type: Gauge
- rttpd_session_global_requests_rate
-
The rate at which Liberator receives subject requests (subjects/second) across all RTTP sessions, measured over the sample period defined by
session-monitoring-interval
.Type: Gauge
- rttpd_session_global_updates
-
The total number of updates sent by Liberator to all RTTP sessions.
Type: Gauge
- rttpd_session_global_updates_rate
-
The rate at which Liberator sends updates (updates/second) to all RTTP sessions, measured over the sample period defined by
session-monitoring-interval
.Type: Gauge
- rttpd_session_global_duration
-
Cumulative duration of all RTTP sessions. The duration of an RTTP session is added to this total when the session is removed.
Type: Gauge
See also: