/
Monitoring Web Services
Monitoring Web Services
- Stonebranch (Deactivated)
Owned by Stonebranch (Deactivated)
Overview
Universal Controller supports the following RESTful-based web service for Monitoring operations:
- Universal Controller Metrics (Prometheus)
Formatting specifications for each web service, including details about parameter requirements, are provided.
Universal Controller Metrics (Prometheus)
The Universal Controller Metrics API requires the ops_admin role or the ops_service role.
Description |
|
|---|---|
URI |
http://host_name/uc/resources/metrics |
HTTP Method |
GET |
Description |
Scrape the Universal Controller metrics as Prometheus text. |
Example URI |
|
Authentication |
HTTP Basic |
Consumes Content-Type |
n/a |
Produces Content-Type |
text/plain; version=0.0.4 |
Example Responses |
|
Metrics
The following metric details will be collected and will be scraped by Prometheus, an open-source systems monitoring and alerting toolkit.
- Universal Controller Task Instance Activity and History Metric Exports
- Standard Metric Exports (CPU Time Spent and Memory Usage)
- JVM Class Loading
- JVM Memory Pools Metric Exports
- JVM Memory Allocation Metric Exports
- JVM Buffer Pools Metric Exports
- JVM Garbage Collector Exports
- JVM Thread Metric Exports
- JVM Class Loading Metric Exports
- JVM Version Info Exports
- Universal Controller Build Info Metric Exports
- Universal Controller Database Connection Pool Metric Exports
- OMS Server Metrics
- License Detail Metrics
See Universal Controller Provided Metrics for a full list of metrics.
Metrics Data Example
# HELP uc_history_total Total number of task instances that completed with an end status of In Doubt, Start Failure, Confirmation Required, Cancelled, Failed, Skipped, Finished, or Success.
# TYPE uc_history_total counter
uc_history_total{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Email",task_type_detailed="Email",task_instance_status="Success",} 1.0
uc_history_total{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Universal Command",task_type_detailed="Universal Command",task_instance_status="Success",} 2.0
uc_history_total{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="SQL",task_type_detailed="SQL",task_instance_status="Success",} 1.0
uc_history_total{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Application Control",task_type_detailed="Application Control",task_instance_status="Finished",} 1.0
uc_history_total{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Remote File Monitor",task_type_detailed="Remote File Monitor",task_instance_status="Success",} 1.0
uc_history_total{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Workflow",task_type_detailed="Workflow",task_instance_status="Success",} 2.0
uc_history_total{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Stored Procedure",task_type_detailed="Stored Procedure",task_instance_status="Success",} 1.0
uc_history_total{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Task Monitor",task_type_detailed="Task Monitor",task_instance_status="Success",} 1.0
uc_history_total{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Variable Monitor",task_type_detailed="Variable Monitor",task_instance_status="Success",} 1.0
uc_history_total{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Manual",task_type_detailed="Manual",task_instance_status="Success",} 1.0
uc_history_total{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Linux/Unix",task_type_detailed="Linux/Unix",task_instance_status="Success",} 1.0
uc_history_total{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="File Transfer",task_type_detailed="File Transfer",task_instance_status="Success",} 1.0
uc_history_total{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="System Monitor",task_type_detailed="System Monitor",task_instance_status="Success",} 1.0
uc_history_total{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="z/OS",task_type_detailed="z/OS",task_instance_status="Skipped",} 1.0
uc_history_total{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Universal",task_type_detailed="License Generator - 7.5",task_instance_status="Success",} 1.0
uc_history_total{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Application Control",task_type_detailed="Application Control",task_instance_status="Failed",} 1.0
uc_history_total{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Agent File Monitor",task_type_detailed="Agent File Monitor",task_instance_status="Success",} 1.0
uc_history_total{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Windows",task_type_detailed="Windows",task_instance_status="Skipped",} 1.0
uc_history_total{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="SAP",task_type_detailed="SAP",task_instance_status="Success",} 1.0
uc_history_total{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Timer",task_type_detailed="Timer",task_instance_status="Success",} 2.0
uc_history_total{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="z/OS",task_type_detailed="z/OS",task_instance_status="Success",} 101.0
# HELP uc_task_instance_late_start_total Total number of task instances that started late.
# TYPE uc_task_instance_late_start_total counter
# HELP jvm_classes_currently_loaded The number of classes that are currently loaded in the JVM
# TYPE jvm_classes_currently_loaded gauge
jvm_classes_currently_loaded 17606.0
# HELP jvm_classes_loaded_total The total number of classes that have been loaded since the JVM has started execution
# TYPE jvm_classes_loaded_total counter
jvm_classes_loaded_total 18951.0
# HELP jvm_classes_unloaded_total The total number of classes that have been unloaded since the JVM has started execution
# TYPE jvm_classes_unloaded_total counter
jvm_classes_unloaded_total 1345.0
# HELP jvm_info VM version info
# TYPE jvm_info gauge
jvm_info{runtime="OpenJDK Runtime Environment",vendor="Ubuntu",version="11.0.17+8-post-Ubuntu-1ubuntu220.04",} 1.0
# HELP uc_task_instance_early_finish_total Total number of task instances that finished early.
# TYPE uc_task_instance_early_finish_total counter
# HELP uc_task_instance_duration_seconds Task instance duration in seconds.
# TYPE uc_task_instance_duration_seconds histogram
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="File Transfer",task_type_detailed="File Transfer",le="1.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="File Transfer",task_type_detailed="File Transfer",le="2.5",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="File Transfer",task_type_detailed="File Transfer",le="5.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="File Transfer",task_type_detailed="File Transfer",le="10.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="File Transfer",task_type_detailed="File Transfer",le="15.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="File Transfer",task_type_detailed="File Transfer",le="30.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="File Transfer",task_type_detailed="File Transfer",le="45.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="File Transfer",task_type_detailed="File Transfer",le="60.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="File Transfer",task_type_detailed="File Transfer",le="150.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="File Transfer",task_type_detailed="File Transfer",le="300.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="File Transfer",task_type_detailed="File Transfer",le="600.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="File Transfer",task_type_detailed="File Transfer",le="900.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="File Transfer",task_type_detailed="File Transfer",le="1800.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="File Transfer",task_type_detailed="File Transfer",le="2700.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="File Transfer",task_type_detailed="File Transfer",le="3600.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="File Transfer",task_type_detailed="File Transfer",le="+Inf",} 1.0
uc_task_instance_duration_seconds_count{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="File Transfer",task_type_detailed="File Transfer",} 1.0
uc_task_instance_duration_seconds_sum{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="File Transfer",task_type_detailed="File Transfer",} 0.13
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Linux/Unix",task_type_detailed="Linux/Unix",le="1.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Linux/Unix",task_type_detailed="Linux/Unix",le="2.5",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Linux/Unix",task_type_detailed="Linux/Unix",le="5.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Linux/Unix",task_type_detailed="Linux/Unix",le="10.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Linux/Unix",task_type_detailed="Linux/Unix",le="15.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Linux/Unix",task_type_detailed="Linux/Unix",le="30.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Linux/Unix",task_type_detailed="Linux/Unix",le="45.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Linux/Unix",task_type_detailed="Linux/Unix",le="60.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Linux/Unix",task_type_detailed="Linux/Unix",le="150.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Linux/Unix",task_type_detailed="Linux/Unix",le="300.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Linux/Unix",task_type_detailed="Linux/Unix",le="600.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Linux/Unix",task_type_detailed="Linux/Unix",le="900.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Linux/Unix",task_type_detailed="Linux/Unix",le="1800.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Linux/Unix",task_type_detailed="Linux/Unix",le="2700.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Linux/Unix",task_type_detailed="Linux/Unix",le="3600.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Linux/Unix",task_type_detailed="Linux/Unix",le="+Inf",} 1.0
uc_task_instance_duration_seconds_count{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Linux/Unix",task_type_detailed="Linux/Unix",} 1.0
uc_task_instance_duration_seconds_sum{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Linux/Unix",task_type_detailed="Linux/Unix",} 0.036
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="System Monitor",task_type_detailed="System Monitor",le="1.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="System Monitor",task_type_detailed="System Monitor",le="2.5",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="System Monitor",task_type_detailed="System Monitor",le="5.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="System Monitor",task_type_detailed="System Monitor",le="10.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="System Monitor",task_type_detailed="System Monitor",le="15.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="System Monitor",task_type_detailed="System Monitor",le="30.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="System Monitor",task_type_detailed="System Monitor",le="45.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="System Monitor",task_type_detailed="System Monitor",le="60.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="System Monitor",task_type_detailed="System Monitor",le="150.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="System Monitor",task_type_detailed="System Monitor",le="300.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="System Monitor",task_type_detailed="System Monitor",le="600.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="System Monitor",task_type_detailed="System Monitor",le="900.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="System Monitor",task_type_detailed="System Monitor",le="1800.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="System Monitor",task_type_detailed="System Monitor",le="2700.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="System Monitor",task_type_detailed="System Monitor",le="3600.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="System Monitor",task_type_detailed="System Monitor",le="+Inf",} 1.0
uc_task_instance_duration_seconds_count{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="System Monitor",task_type_detailed="System Monitor",} 1.0
uc_task_instance_duration_seconds_sum{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="System Monitor",task_type_detailed="System Monitor",} 0.012
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Email",task_type_detailed="Email",le="1.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Email",task_type_detailed="Email",le="2.5",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Email",task_type_detailed="Email",le="5.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Email",task_type_detailed="Email",le="10.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Email",task_type_detailed="Email",le="15.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Email",task_type_detailed="Email",le="30.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Email",task_type_detailed="Email",le="45.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Email",task_type_detailed="Email",le="60.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Email",task_type_detailed="Email",le="150.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Email",task_type_detailed="Email",le="300.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Email",task_type_detailed="Email",le="600.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Email",task_type_detailed="Email",le="900.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Email",task_type_detailed="Email",le="1800.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Email",task_type_detailed="Email",le="2700.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Email",task_type_detailed="Email",le="3600.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Email",task_type_detailed="Email",le="+Inf",} 1.0
uc_task_instance_duration_seconds_count{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Email",task_type_detailed="Email",} 1.0
uc_task_instance_duration_seconds_sum{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="Email",task_type_detailed="Email",} 0.091
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="SAP",task_type_detailed="SAP",le="1.0",} 0.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="SAP",task_type_detailed="SAP",le="2.5",} 0.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="SAP",task_type_detailed="SAP",le="5.0",} 0.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="SAP",task_type_detailed="SAP",le="10.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="SAP",task_type_detailed="SAP",le="15.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="SAP",task_type_detailed="SAP",le="30.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="SAP",task_type_detailed="SAP",le="45.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="SAP",task_type_detailed="SAP",le="60.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="SAP",task_type_detailed="SAP",le="150.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="SAP",task_type_detailed="SAP",le="300.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="SAP",task_type_detailed="SAP",le="600.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="SAP",task_type_detailed="SAP",le="900.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="SAP",task_type_detailed="SAP",le="1800.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="SAP",task_type_detailed="SAP",le="2700.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="SAP",task_type_detailed="SAP",le="3600.0",} 1.0
uc_task_instance_duration_seconds_bucket{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="SAP",task_type_detailed="SAP",le="+Inf",} 1.0
uc_task_instance_duration_seconds_count{cluster_node_id="qa-opswise6:8080-qa_opswise6",task_type="SAP",task_type_detailed="SAP",} 1.0
uc_task_instance_duratio