Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To enable Open Telemetry metrics, you must configure an Open Telemetry metrics exporter in uc.properties , otherwise, a noop meter provider is used.

Info

To configure UC with optional metric labels, you can add the following to the uc.properties.

uc.prometheus.metrics.<metric-name>.optional_labels=<comma-delimited-optional-labels>

For example,

uc.prometheus.metrics.uc_history_total.optional_labels=agent_id,task_instance_exit_code
uc.prometheus.metrics.uc_task_instance_duration_seconds.optional_labels=agent_id



Metric Name

Description

Metric Type

Default Labels

Optional LabelsDefault Buckets
1uc_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

2uc_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

3uc_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

4uc_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

5uc_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

6uc_task_instance_duration_secondsTask instance duration in seconds.Histogram
  • cluster_node_id
  • task_type
  • task_type_detailed
  • agent_id
  • task_name
  • security_business_services

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

The values are in seconds and translates to the following:

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

Info

You can customize the buckets by adding the following property to uc.properties.

uc.prometheus.metrics.uc_task_instance_duration_seconds.buckets=1,2.5,5,10,15,30,45,60,150,300,600,900,1800,2700,3600


7uc_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
Info

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

...