Provided Metrics

As part of the Opentelemetry integration in 7.5.0.0, several components publish metrics, offering valuable insights into the performance and resource utilization. The following table outlines the metrics.

Metrics Compliance

The process.* metrics are compliant with the Opentelemetry semantic conventions.

Shared Metrics

Metric Name	Metric Type	Labels	Description	Published By
`process.cpu.time`	Counter	`state` (value will either by `system` or `user`)	Total CPU seconds broken down by different states.	UAG OMS
`process.memory.usage`	UpDownCounter	N/A	The amount of physical memory in use.	UAG OMS
`process.memory.virtual`	UpDownCounter	N/A	The amount of committed virtual memory.	UAG OMS
`process.open_file_descriptors`	UpDownCounter	N/A	Number of file descriptors in use by the process.	UAG OMS

OMS Metrics

Metric Name	Metric Type	Labels	Description
`ua.active.connections`	UpDownCounter	N/A	Number of active OMS client connections. Can go up or down.

UAG Metrics

Metric Name	Metric Type	Labels	Description
`ua.num.jobs`	Counter	N/A	The total number of jobs launched by UAG. The value is incremented when UAG is able to successfully launch the job. The job itself may end up in Start Failure status, but the counter will still be incremented.

Resource Attributes

In addition to the labels specified in the table above, additional resource attributes are set, which are shown in the table below.

Resource Attribute Name	Comments	Set By
`service.name`	User configurable using the `otel_service_name` option for UAG and OMS, and `otel_uip_service_name` for Universal Extensions.	OMS UAG Universal Extensions
`service.version`	Not configurable. Automatically set according to the UAG and OMS version. For Universal Extensions, value is set to the Extension version defined in `extension.yml`	UAG OMS Universal Extensions
`service.namespace`	Not configurable. Always `Stonebranch.UAC`	UAG OMS Universal Extensions
`service.port`	Only set for OMS – the service port used by UAG and Controller to connect to OMS.	OMS
`service.instance.id`	Value will be: `<hostname>:<brokerport>` For instance, if the hostname is `sbus44` and broker is running on port `7887` then the value will be `sbus44:7887`. This value is unique enough to distinguish multiple instances of UAG and OMS.	UAG OMS Universal Extensions
`host.name`	Not configurable.	UAG OMS Universal Extensions
`os.name`	Not configurable.	UAG OMS Universal Extensions
`os.version`	Not configurable.	UAG OMS Universal Extensions
`process.owner`	Not configurable.	UAG OMS Universal Extensions
`process.pid`	Not configurable.	UAG OMS Universal Extensions
`process.executable.path`	Not configurable.	Universal Extensions
`process.runtime.version`	Not configurable.	Universal Extensions
`agent.id`	Set to the Agent netname.	UAG Universal Extensions
`task.name`	The name of the launched task.	Universal Extensions
`security.business.services`	Comma-separated string specifying the business services the task is part of.	Universal Extensions

By default, the attributes listed above will not be added to the final, exported metrics (to avoid high-cardinality issues). The Opentelemetry Collector must be configured to copy the resource attributes as normal labels. The snippet below shows how to use the Opentelemetry Collector Transform Processor to do this:

config.yaml

processors:
    transform:
    metric_statements:
        - context: datapoint
          statements:
          # Only business_services is added in this example
          - set(attributes["security.business.services"], resource.attributes["security.business.services"])
          
service:
  pipelines:
    metrics:
      receivers: [otlp, opencensus]
      processors: [transform, batch]
      exporters: [prometheus]