Semantic conventions for OpenShift metrics
Status: Development
OpenShift metrics
This document describes instruments and attributes for common OpenShift specific metrics in OpenTelemetry. These metrics are collected from OpenShift’s, well-defined API.
Metrics in openshift. instruments SHOULD be attached to an OpenShift Resource
and therefore inherit its attributes, like openshift.clusterquota.name and openshift.clusterquota.uid.
ClusterResourceQuota metrics
Description: ClusterResourceQuota level metrics captured under the namespace openshift.clusterquota.
Metric: openshift.clusterquota.cpu.limit.hard
This metric is recommended.
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
|---|---|---|---|---|---|
openshift.clusterquota.cpu.limit.hard | UpDownCounter | {cpu} | The enforced hard limit of the resource across all projects. [1] |  | openshift.clusterquota |
[1]: This metric is retrieved from the Status.Total.Hard field of the
K8s ResourceQuotaStatus
of the
ClusterResourceQuota.
Metric: openshift.clusterquota.cpu.limit.used
This metric is recommended.
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
|---|---|---|---|---|---|
openshift.clusterquota.cpu.limit.used | UpDownCounter | {cpu} | The current observed total usage of the resource across all projects. [1] | | openshift.clusterquota |
[1]: This metric is retrieved from the Status.Total.Used field of the
K8s ResourceQuotaStatus
of the
ClusterResourceQuota.
Metric: openshift.clusterquota.cpu.request.hard
This metric is recommended.
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
|---|---|---|---|---|---|
openshift.clusterquota.cpu.request.hard | UpDownCounter | {cpu} | The enforced hard limit of the resource across all projects. [1] | | openshift.clusterquota |
[1]: This metric is retrieved from the Status.Total.Hard field of the
K8s ResourceQuotaStatus
of the
ClusterResourceQuota.
Metric: openshift.clusterquota.cpu.request.used
This metric is recommended.
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
|---|---|---|---|---|---|
openshift.clusterquota.cpu.request.used | UpDownCounter | {cpu} | The current observed total usage of the resource across all projects. [1] | | openshift.clusterquota |
[1]: This metric is retrieved from the Status.Total.Used field of the
K8s ResourceQuotaStatus
of the
ClusterResourceQuota.
Metric: openshift.clusterquota.memory.limit.hard
This metric is recommended.
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
|---|---|---|---|---|---|
openshift.clusterquota.memory.limit.hard | UpDownCounter | By | The enforced hard limit of the resource across all projects. [1] | | openshift.clusterquota |
[1]: This metric is retrieved from the Status.Total.Hard field of the
K8s ResourceQuotaStatus
of the
ClusterResourceQuota.
Metric: openshift.clusterquota.memory.limit.used
This metric is recommended.
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
|---|---|---|---|---|---|
openshift.clusterquota.memory.limit.used | UpDownCounter | By | The current observed total usage of the resource across all projects. [1] | | openshift.clusterquota |
[1]: This metric is retrieved from the Status.Total.Used field of the
K8s ResourceQuotaStatus
of the
ClusterResourceQuota.
Metric: openshift.clusterquota.memory.request.hard
This metric is recommended.
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
|---|---|---|---|---|---|
openshift.clusterquota.memory.request.hard | UpDownCounter | By | The enforced hard limit of the resource across all projects. [1] | | openshift.clusterquota |
[1]: This metric is retrieved from the Status.Total.Hard field of the
K8s ResourceQuotaStatus
of the
ClusterResourceQuota.
Metric: openshift.clusterquota.memory.request.used
This metric is recommended.
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
|---|---|---|---|---|---|
openshift.clusterquota.memory.request.used | UpDownCounter | By | The current observed total usage of the resource across all projects. [1] | | openshift.clusterquota |
[1]: This metric is retrieved from the Status.Total.Used field of the
K8s ResourceQuotaStatus
of the
ClusterResourceQuota.
Metric: openshift.clusterquota.hugepage_count.request.hard
This metric is recommended.
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
|---|---|---|---|---|---|
openshift.clusterquota.hugepage_count.request.hard | UpDownCounter | {hugepage} | The enforced hard limit of the resource across all projects. [1] | | openshift.clusterquota |
[1]: This metric is retrieved from the Status.Total.Hard field of the
K8s ResourceQuotaStatus
of the
ClusterResourceQuota.
Attributes:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
k8s.hugepage.size | | Required | string | The size (identifier) of the K8s huge page. | 2Mi |
Metric: openshift.clusterquota.hugepage_count.request.used
This metric is recommended.
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
|---|---|---|---|---|---|
openshift.clusterquota.hugepage_count.request.used | UpDownCounter | {hugepage} | The current observed total usage of the resource across all projects. [1] | | openshift.clusterquota |
[1]: This metric is retrieved from the Status.Total.Used field of the
K8s ResourceQuotaStatus
of the
ClusterResourceQuota.
Attributes:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
k8s.hugepage.size | | Required | string | The size (identifier) of the K8s huge page. | 2Mi |
Metric: openshift.clusterquota.storage.request.hard
This metric is recommended.
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
|---|---|---|---|---|---|
openshift.clusterquota.storage.request.hard | UpDownCounter | By | The enforced hard limit of the resource across all projects. [1] | | openshift.clusterquota |
[1]: This metric is retrieved from the Status.Total.Hard field of the
K8s ResourceQuotaStatus
of the
ClusterResourceQuota.
The k8s.storageclass.name should be required when a resource quota is defined for a specific
storage class.
Attributes:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
k8s.storageclass.name | | Conditionally Required [1] | string | The name of K8s StorageClass object. | gold.storageclass.storage.k8s.io |
[1] k8s.storageclass.name: The k8s.storageclass.name should be required when a resource quota is defined for a specific
storage class.
Metric: openshift.clusterquota.storage.request.used
This metric is recommended.
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
|---|---|---|---|---|---|
openshift.clusterquota.storage.request.used | UpDownCounter | By | The current observed total usage of the resource across all projects. [1] | | openshift.clusterquota |
[1]: This metric is retrieved from the Status.Total.Used field of the
K8s ResourceQuotaStatus
of the
ClusterResourceQuota.
The k8s.storageclass.name should be required when a resource quota is defined for a specific
storage class.
Attributes:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
k8s.storageclass.name | | Conditionally Required [1] | string | The name of K8s StorageClass object. | gold.storageclass.storage.k8s.io |
[1] k8s.storageclass.name: The k8s.storageclass.name should be required when a resource quota is defined for a specific
storage class.
Metric: openshift.clusterquota.persistentvolumeclaim_count.hard
This metric is recommended.
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
|---|---|---|---|---|---|
openshift.clusterquota.persistentvolumeclaim_count.hard | UpDownCounter | {persistentvolumeclaim} | The enforced hard limit of the resource across all projects. [1] | |
[1]: This metric is retrieved from the Status.Total.Hard field of the
K8s ResourceQuotaStatus
of the
ClusterResourceQuota.
The k8s.storageclass.name should be required when a resource quota is defined for a specific
storage class.
Attributes:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
k8s.storageclass.name | | Conditionally Required [1] | string | The name of K8s StorageClass object. | gold.storageclass.storage.k8s.io |
[1] k8s.storageclass.name: The k8s.storageclass.name should be required when a resource quota is defined for a specific
storage class.
Metric: openshift.clusterquota.persistentvolumeclaim_count.used
This metric is recommended.
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
|---|---|---|---|---|---|
openshift.clusterquota.persistentvolumeclaim_count.used | UpDownCounter | {persistentvolumeclaim} | The current observed total usage of the resource across all projects. [1] | |
[1]: This metric is retrieved from the Status.Total.Used field of the
K8s ResourceQuotaStatus
of the
ClusterResourceQuota.
The k8s.storageclass.name should be required when a resource quota is defined for a specific
storage class.
Attributes:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
k8s.storageclass.name | | Conditionally Required [1] | string | The name of K8s StorageClass object. | gold.storageclass.storage.k8s.io |
[1] k8s.storageclass.name: The k8s.storageclass.name should be required when a resource quota is defined for a specific
storage class.
Metric: openshift.clusterquota.ephemeral_storage.request.hard
This metric is recommended.
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
|---|---|---|---|---|---|
openshift.clusterquota.ephemeral_storage.request.hard | UpDownCounter | By | The enforced hard limit of the resource across all projects. [1] | | openshift.clusterquota |
[1]: This metric is retrieved from the Status.Total.Hard field of the
K8s ResourceQuotaStatus
of the
ClusterResourceQuota.
Metric: openshift.clusterquota.ephemeral_storage.request.used
This metric is recommended.
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
|---|---|---|---|---|---|
openshift.clusterquota.ephemeral_storage.request.used | UpDownCounter | By | The current observed total usage of the resource across all projects. [1] | | openshift.clusterquota |
[1]: This metric is retrieved from the Status.Total.Used field of the
K8s ResourceQuotaStatus
of the
ClusterResourceQuota.
Metric: openshift.clusterquota.ephemeral_storage.limit.hard
This metric is recommended.
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
|---|---|---|---|---|---|
openshift.clusterquota.ephemeral_storage.limit.hard | UpDownCounter | By | The enforced hard limit of the resource across all projects. [1] | | openshift.clusterquota |
[1]: This metric is retrieved from the Status.Total.Hard field of the
K8s ResourceQuotaStatus
of the
ClusterResourceQuota.
Metric: openshift.clusterquota.ephemeral_storage.limit.used
This metric is recommended.
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
|---|---|---|---|---|---|
openshift.clusterquota.ephemeral_storage.limit.used | UpDownCounter | By | The current observed total usage of the resource across all projects. [1] | | openshift.clusterquota |
[1]: This metric is retrieved from the Status.Total.Used field of the
K8s ResourceQuotaStatus
of the
ClusterResourceQuota.
Metric: openshift.clusterquota.object_count.hard
This metric is recommended.
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
|---|---|---|---|---|---|
openshift.clusterquota.object_count.hard | UpDownCounter | {object} | The enforced hard limit of the resource across all projects. [1] | | openshift.clusterquota |
[1]: This metric is retrieved from the Status.Total.Hard field of the
K8s ResourceQuotaStatus
of the
ClusterResourceQuota.
Attributes:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
k8s.resourcequota.resource_name | | Required | string | The name of the K8s resource a resource quota defines. [1] | count/replicationcontrollers |
[1] k8s.resourcequota.resource_name: The value for this attribute can be either the full count/<resource>[.<group>] string (e.g., count/deployments.apps, count/pods), or, for certain core Kubernetes resources, just the resource name (e.g., pods, services, configmaps). Both forms are supported by Kubernetes for object count quotas. See Kubernetes Resource Quotas documentation for more details.
Metric: openshift.clusterquota.object_count.used
This metric is recommended.
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
|---|---|---|---|---|---|
openshift.clusterquota.object_count.used | UpDownCounter | {object} | The current observed total usage of the resource across all projects. [1] | | openshift.clusterquota |
[1]: This metric is retrieved from the Status.Total.Used field of the
K8s ResourceQuotaStatus
of the
ClusterResourceQuota.
Attributes:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
k8s.resourcequota.resource_name | | Required | string | The name of the K8s resource a resource quota defines. [1] | count/replicationcontrollers |
[1] k8s.resourcequota.resource_name: The value for this attribute can be either the full count/<resource>[.<group>] string (e.g., count/deployments.apps, count/pods), or, for certain core Kubernetes resources, just the resource name (e.g., pods, services, configmaps). Both forms are supported by Kubernetes for object count quotas. See Kubernetes Resource Quotas documentation for more details.
Feedback
Was this page helpful?
Thank you. Your feedback is appreciated!
Please let us know how we can improve this page. Your feedback is appreciated!