Universal Controller - Provided Metrics


Introduction

System metrics are scraped through our Prometheus Metrics Web Service endpoint.

 For configuring and exporting user-defined Universal Event metrics, click here.

Universal Controller Task Instance Activity and History Metric Exports

For configuring UC with optional metric labels, click here.

Metric Name

Description

Metric Type

Default Labels

Optional Labels
uc_history_totalTotal number of task instances that completed with an end status of In Doubt, Start Failure, Confirmation Required, Cancelled, Failed, Skipped, Finished, or Success.Counter
  • cluster_node_id
  • task_type
  • task_type_detailed
  • task_instance_status
  • agent_id
  • task_name
  • security_business_services
  • task_instance_exit_code
uc_task_instance_launch_totalTotal number of task instances launched.Counter
  • cluster_node_id
  • task_type
  • task_type_detailed
  • agent_id
  • task_name
  • security_business_services
uc_task_instance_late_start_total

Total number of task instances that started late.

Counter
  • cluster_node_id
  • task_type
  • task_type_detailed
  • agent_id
  • task_name
  • security_business_services
uc_task_instance_late_finish_totalTotal number of task instances that finished late.Counter
  • cluster_node_id
  • task_type
  • task_type_detailed
  • agent_id
  • task_name
  • security_business_services
uc_task_instance_early_finish_totalTotal number of task instances that finished early.Counter
  • cluster_node_id
  • task_type
  • task_type_detailed
  • agent_id
  • task_name
  • security_business_services
uc_task_instance_duration_seconds

Task instance duration in seconds.

The default buckets, defined in seconds, are as follows.

1, 2.5, 5, 10, 15, 30, 45, 60, 150, 300, 600, 900, 1800, 2700, 3600

This translates to the following.

1s, 2.5s, 5s, 10s, 15s, 30s, 45s, 60s, 2.5m, 5m, 10m, 15m, 30m, 45m, 1hr

To customize the buckets, you can configure the uc.properties property uc.prometheus.metrics.uc_task_instance_duration_seconds.buckets.
Histogram
  • cluster_node_id
  • task_type
  • task_type_detailed
  • agent_id
  • task_name
  • security_business_services
uc_universal_event_totalTotal number of Universal Events published by Universal Event Templates and Universal Template Event Templates.Counter
  • cluster_node_id
  • universal_event_name
  • universal_template_name
  • universal_extension_name

The universal_template_name and universal_extension_name label values are non-empty for published local Universal Events (defined by a Universal Template Event Template) and empty for published global Universal Events (defined by a Universal Event Template).

  • agent_id
  • task_name
  • security_business_services

Standard Metric Exports (CPU Time Spent and Memory Usage)

Metric Name

Description

Metric Type

process_cpu_seconds_total

Total user and system CPU time spent in seconds.

Counter

process_start_time_seconds

Start time of the process since unix epoch in seconds.

Gauge

process_open_fds

Number of open file descriptors.

Gauge

process_max_fds

Maximum number of open file descriptors.

Gauge

process_virtual_memory_bytes

Virtual memory size in bytes.

Gauge

process_resident_memory_bytes

Resident memory size in bytes.

Gauge

JVM Class Loading 

JVM Memory Pools Metric Exports

Metric Name

Description

Metric Type

jvm_memory_objects_pending_finalization

The number of objects waiting in the finalizer queue.

Gauge

jvm_memory_bytes_used

Used bytes of a given JVM memory area.

Gauge

jvm_memory_pool_bytes_used

Used bytes of a given JVM memory pool.

Gauge

jvm_memory_bytes_committed

Committed (bytes) of a given JVM memory area.

Gauge

jvm_memory_bytes_max

Max (bytes) of a given JVM memory area.

Gauge

jvm_memory_bytes_init

Initial bytes of a given JVM memory area.

Gauge

JVM Memory Allocation Metric Exports

Metric Name

Description

Metric Type

jvm_memory_pool_allocated_bytes_total

Total bytes allocated in a given JVM memory pool. Only updated after GC, not continuously.

Counter

JVM Buffer Pools Metric Exports

Metric Name

Description

Metric Type

jvm_buffer_pool_used_bytes

Used bytes of a given JVM buffer pool.

Gauge

jvm_buffer_pool_capacity_bytes

Bytes capacity of a given JVM buffer pool.

Gauge

jvm_buffer_pool_used_buffers

Used buffers of a given JVM buffer pool.

Gauge

JVM Garbage Collector Exports

Metric Name

Description

Metric Type

jvm_gc_collection_seconds

Time spent in a given JVM garbage collector in seconds.

Summary

JVM Thread Metric Exports

Metric Name

Description

Metric Type

jvm_threads_current

Current thread count of a JVM.

Gauge

jvm_threads_daemon

Daemon thread count of a JVM.

Gauge

jvm_threads_peak

Peak thread count of a JVM.

Gauge

jvm_threads_started_total

Started thread count of a JVM.

Counter

jvm_threads_deadlocked

Cycles of JVM-threads that are in deadlock waiting to acquire object monitors or ownable synchronizers.

Gauge

jvm_threads_deadlocked_monitor

Cycles of JVM-threads that are in deadlock waiting to acquire object monitors.

Gauge

jvm_threads_state

Current count of threads by state.

Gauge

JVM Class Loading Metric Exports

Metric Name

Description

Metric Type

jvm_classes_currently_loaded

The number of classes that are currently loaded in the JVM.

Gauge

jvm_classes_loaded_total

The total number of classes that have been loaded since the JVM has started execution.

Counter

jvm_classes_unloaded_total

The total number of classes that have been unloaded since the JVM has started execution.

Counter

JVM Version Info Exports

Metric Name

Description

Metric Type

jvm_info

VM version info.

Gauge

Universal Controller Build Info Metric Exports

Metric Name

Description

Metric Type

Default Labels

uc_build_info

Universal Controller build information.

Gauge

  • build

  • build_date

  • release

Universal Controller Database Connection Pool Metric Exports

Metric Name

Description

Metric Type

Default Labels

uc_database_connection_pool_active

Number of connections currently borrowed from this pool.

Gauge
  • pool
  • db_type

uc_database_connection_pool_idle

Returns the number of connections currently idle in this pool.

Gauge
  • pool
  • db_type

uc_database_connection_pool_idle_min

Returns the target for the minimum number of idle connections to maintain in the pool.

Gauge
  • pool
  • db_type

uc_database_connection_pool_idle_max

Returns the cap on the number of idle connections in the pool.

Gauge
  • pool
  • db_type

uc_database_connection_pool_total

Returns the total number of connections currently borrowed and currently idle in this pool.

Gauge
  • pool
  • db_type

uc_database_connection_pool_max

Returns the maximum number of connections that can be allocated by the pool (currently borrowed and currently idle) at a given time.

Gauge
  • pool
  • db_type

OMS Server Metrics

Metric Name

Description

Metric Type

Default Labels

uc_oms_server_last_connected_time_seconds

OMS Server last connected time specified as the number of seconds since the Unix epoch, namely January 1, 1970, 00:00:00 GMT.

Gauge
  • server_address

  • last_connected

uc_oms_server_session_status

OMS Server session status. (0=None, 1=Impaired, 2=Operational, -1=Unknown)

Gauge
  • server_address

  • last_connected

License Detail Metrics

Metric Name

Description

Metric Type

Default Labels

uc_license_agents_distributed_used

Returns the number of distributed agents used.

Gauge
  • environment

  • customer
  • expiry_date

uc_license_agents_distributed_max

Returns the number of distributed agents allowed.

Gauge
  • environment

  • customer
  • expiry_date

uc_license_agents_zos_used

Returns the number of Zos agents used.

Gauge
  • environment

  • customer
  • expiry_date

uc_license_agents_zos_max

Returns the number of Zos agents allowed.

Gauge
  • environment

  • customer
  • expiry_date

uc_license_cluster_nodes_used

Returns the number of cluster nodes used.

Gauge
  • environment

  • customer
  • expiry_date

uc_license_cluster_nodes_max

Returns the number of cluster nodes allowed.

Gauge
  • environment

  • customer
  • expiry_date

uc_license_monthly_executions_used

Returns the number of monthly task executions used.

Gauge
  • environment

  • customer
  • expiry_date

uc_license_monthly_executions_max

Returns the number of monthly task executions allowed.

Gauge
  • environment

  • customer
  • expiry_date

uc_license_task_definitions_used

Returns the number of task definitions used.

Gauge
  • environment

  • customer
  • expiry_date

uc_license_task_definitions_max

Returns the number of task definitions allowed.

Gauge
  • environment

  • customer
  • expiry_date