Provided Metrics
As part of the Opentelemetry integration in 7.6.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 |
| Total CPU seconds broken down by different states. |
|
process.memory.usage | UpDownCounter | N/A | The amount of physical memory in use. |
|
process.memory.virtual | UpDownCounter | N/A | The amount of committed virtual memory. |
|
process.open_file_descriptors | UpDownCounter | N/A | Number of file descriptors in use by the process. |
|
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 |
|
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 |
|
service.namespace | Not configurable. Always |
|
service.port | Only set for OMS – the service port used by UAG and Controller to connect to OMS. |
|
service.instance.id | Value will be: For instance, if the hostname is |
|
host.name | Not configurable. |
|
os.name | Not configurable. |
|
os.version | Not configurable. |
|
process.owner | Not configurable. |
|
process.pid | Not configurable. |
|
process.executable.path | Not configurable. |
|
process.runtime.version | Not configurable. |
|
agent.id | Set to the Agent netname. |
|
task.name | The name of the launched task. |
|
security.business.services | Comma-separated string specifying the business services the task is part of. |
|
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: