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.

rttpd_peer_bytes_read_total

Total number of bytes read across all peer connections.

Type: Counter

Labels

remote_label

the label of the DataSource peer

rttpd_peer_bytes_written_total

Total number of bytes written across all peer connections.

Type: Counter

Labels

remote_label

the label of the DataSource peer

rttpd_peer_messages_read_total

Total number of messages read across all peer connections.

Type: Counter

Labels

remote_label

the label of the DataSource peer

message_type

the type of DataSource message. Possible values: status, update

rttpd_peer_messages_written_total

Total number of messages written across all peer connections.

Type: Counter

Labels

remote_label

the label of the DataSource peer

message_type

the type of DataSource message. Possible values: request, discard

rttpd_peer_pingpong_time_milliseconds

Average of the last ten heartbeat round-trip times.

Type: Gauge

Labels

remote_label

the label of the DataSource peer

Data service metrics

Liberator publishes the following metrics for each data service.

rttpd_data_service_messages_read_total

The total number of messages read from a data service.

Type: Counter

Labels

service_name

the data-service name

message_type

the type of message received. Possible values: update, map, nodata

rttpd_data_service_bytes_read_total

The total number of bytes read from a data service.

Type: Counter

Labels

service_name

the data-service name

rttpd_data_service_bytes_written_total

The total number of bytes written to a data service (contributions).

Type: Counter

Labels

service_name

the data-service name

rttpd_data_service_state

The state of a labelled data service. It has two possible values: 1 for up, 0 for down.

Type: Gauge

Labels

service_name

the data-service name

rttpd_data_service_subscriptions

The number of open subscriptions associated with a data service.

Type: Gauge

Labels

service_name

the data-service name

rttpd_data_service_response_time_milliseconds

The time taken for data services to respond to the first subscription request.

Type: Histogram

Labels

le

the upper-bound of a histogram bucket. Possible values: 1.0, 10.0, 20.0, 30.0, 50.0, 100.0, 200.0, 300.0, 500.0, 1000.0, +Inf

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

User session metrics

The following user metrics are available since Liberator 8.0.3.

The bytes read and written metrics and the updates metric will only appear if session-monitoring-interval is configured to a value > 0.
rttpd_user_bytes_written_total

The total number of bytes written to this user’s sessions.

Type: Counter

Labels

username

the user’s name

user_session_name

the unique user name for the session

rttpd_user_bytes_read_total

The total number of bytes read by this user’s sessions.

Type: Counter

Labels

username

the user’s name

user_session_name

the unique user name for the session

rttpd_user_updates_total

The total number updates sent by the session to the user.

Type: Counter

Labels

username

the user’s name

user_session_name

the unique user name for the session

rttpd_user_reconnections_total

The total number session reconnections for the user.

Type: Counter

Labels

username

the user’s name

user_session_name

the unique user name for the session

rttpd_user_update_latency_milliseconds

The update latency for the user’s session.

Type: Counter

Labels

username

the user’s name

user_session_name

the unique user name for the session

rttpd_user_noop_latency_milliseconds

The NOOP latency for the user’s session.

Type: Counter

Labels

username

the user’s name

user_session_name

the unique user name for the session

RTTP session metrics

Liberator publishes the following metrics for RTTP sessions:

rttpd_session_global_bytes_read

Total number of bytes Liberator has read from all RTTP sessions.

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_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_contribs

The total number of RTTP contributions received by Liberator across all RTTP sessions.

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_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_updates

The total number of updates sent by Liberator to all RTTP sessions.

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: