この記事は英語の原文を日本語に翻訳したものです。原文: https://opentelemetry.io/docs/specs/semconv/system/openshift-metrics/

翻訳元: open-telemetry/semantic-conventions v1.44.0（コミット e10a930）

OpenShiftメトリクスに関するセマンティック規約

ステータス: Development

OpenShiftメトリクス

この文書では、OpenTelemetryにおける一般的なOpenShift固有のメトリクスのInstrumentと属性について説明します。これらのメトリクスは、OpenShiftの明確に定義されたAPIから収集されます。

openshift.名前空間のInstrumentによるメトリクスは、OpenShift Resourceに関連付けるべきであり（SHOULD）、それによってopenshift.clusterquota.nameやopenshift.clusterquota.uidなどのその属性を引き継ぎます。

ClusterResourceQuotaメトリクス

Description: 名前空間openshift.clusterquotaの下で取得される、ClusterResourceQuotaレベルのメトリクス。

メトリクス: openshift.clusterquota.cpu.limit.hard

このメトリクスは推奨です。

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
openshift.clusterquota.cpu.limit.hard	UpDownCounter	{cpu}	すべてのプロジェクトにわたって強制される、リソースのハード上限。[1]		openshift.clusterquota

[1]: このメトリクスは、ClusterResourceQuotaの K8s ResourceQuotaStatusの Status.Total.Hardフィールドから取得されます。

メトリクス: openshift.clusterquota.cpu.limit.used

このメトリクスは推奨です。

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
openshift.clusterquota.cpu.limit.used	UpDownCounter	{cpu}	すべてのプロジェクトにわたる、現在観測されているリソースの合計使用量。[1]		openshift.clusterquota

[1]: このメトリクスは、ClusterResourceQuotaの K8s ResourceQuotaStatusの Status.Total.Usedフィールドから取得されます。

メトリクス: openshift.clusterquota.cpu.request.hard

このメトリクスは推奨です。

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
openshift.clusterquota.cpu.request.hard	UpDownCounter	{cpu}	すべてのプロジェクトにわたって強制される、リソースのハード上限。[1]		openshift.clusterquota

[1]: このメトリクスは、ClusterResourceQuotaの K8s ResourceQuotaStatusの Status.Total.Hardフィールドから取得されます。

メトリクス: openshift.clusterquota.cpu.request.used

このメトリクスは推奨です。

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
openshift.clusterquota.cpu.request.used	UpDownCounter	{cpu}	すべてのプロジェクトにわたる、現在観測されているリソースの合計使用量。[1]		openshift.clusterquota

[1]: このメトリクスは、ClusterResourceQuotaの K8s ResourceQuotaStatusの Status.Total.Usedフィールドから取得されます。

メトリクス: openshift.clusterquota.memory.limit.hard

このメトリクスは推奨です。

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
openshift.clusterquota.memory.limit.hard	UpDownCounter	By	すべてのプロジェクトにわたって強制される、リソースのハード上限。[1]		openshift.clusterquota

[1]: このメトリクスは、ClusterResourceQuotaの K8s ResourceQuotaStatusの Status.Total.Hardフィールドから取得されます。

メトリクス: openshift.clusterquota.memory.limit.used

このメトリクスは推奨です。

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
openshift.clusterquota.memory.limit.used	UpDownCounter	By	すべてのプロジェクトにわたる、現在観測されているリソースの合計使用量。[1]		openshift.clusterquota

[1]: このメトリクスは、ClusterResourceQuotaの K8s ResourceQuotaStatusの Status.Total.Usedフィールドから取得されます。

メトリクス: openshift.clusterquota.memory.request.hard

このメトリクスは推奨です。

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
openshift.clusterquota.memory.request.hard	UpDownCounter	By	すべてのプロジェクトにわたって強制される、リソースのハード上限。[1]		openshift.clusterquota

[1]: このメトリクスは、ClusterResourceQuotaの K8s ResourceQuotaStatusの Status.Total.Hardフィールドから取得されます。

メトリクス: openshift.clusterquota.memory.request.used

このメトリクスは推奨です。

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
openshift.clusterquota.memory.request.used	UpDownCounter	By	すべてのプロジェクトにわたる、現在観測されているリソースの合計使用量。[1]		openshift.clusterquota

[1]: このメトリクスは、ClusterResourceQuotaの K8s ResourceQuotaStatusの Status.Total.Usedフィールドから取得されます。

メトリクス: openshift.clusterquota.hugepage_count.request.hard

このメトリクスは推奨です。

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
openshift.clusterquota.hugepage_count.request.hard	UpDownCounter	{hugepage}	すべてのプロジェクトにわたって強制される、リソースのハード上限。[1]		openshift.clusterquota

[1]: このメトリクスは、ClusterResourceQuotaの K8s ResourceQuotaStatusの Status.Total.Hardフィールドから取得されます。

Attributes:

Key	Stability	Requirement Level	Value Type	Description	Example Values
k8s.hugepage.size		Required	string	K8sのhuge pageのサイズ（識別子）。	2Mi

メトリクス: openshift.clusterquota.hugepage_count.request.used

このメトリクスは推奨です。

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
openshift.clusterquota.hugepage_count.request.used	UpDownCounter	{hugepage}	すべてのプロジェクトにわたる、現在観測されているリソースの合計使用量。[1]		openshift.clusterquota

[1]: このメトリクスは、ClusterResourceQuotaの K8s ResourceQuotaStatusの Status.Total.Usedフィールドから取得されます。

Attributes:

Key	Stability	Requirement Level	Value Type	Description	Example Values
k8s.hugepage.size		Required	string	K8sのhuge pageのサイズ（識別子）。	2Mi

メトリクス: openshift.clusterquota.storage.request.hard

このメトリクスは推奨です。

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
openshift.clusterquota.storage.request.hard	UpDownCounter	By	すべてのプロジェクトにわたって強制される、リソースのハード上限。[1]		openshift.clusterquota

[1]: このメトリクスは、ClusterResourceQuotaの K8s ResourceQuotaStatusの Status.Total.Hardフィールドから取得されます。

リソースクォータが特定のストレージクラスに対して定義されている場合、k8s.storageclass.nameは必須にすべきです。

Attributes:

Key	Stability	Requirement Level	Value Type	Description	Example Values
k8s.storageclass.name		Conditionally Required [1]	string	K8sのStorageClassオブジェクトの名前。	gold.storageclass.storage.k8s.io

[1] k8s.storageclass.name: リソースクォータが特定のストレージクラスに対して定義されている場合、k8s.storageclass.nameは必須にすべきです。

メトリクス: openshift.clusterquota.storage.request.used

このメトリクスは推奨です。

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
openshift.clusterquota.storage.request.used	UpDownCounter	By	すべてのプロジェクトにわたる、現在観測されているリソースの合計使用量。[1]		openshift.clusterquota

[1]: このメトリクスは、ClusterResourceQuotaの K8s ResourceQuotaStatusの Status.Total.Usedフィールドから取得されます。

リソースクォータが特定のストレージクラスに対して定義されている場合、k8s.storageclass.nameは必須にすべきです。

Attributes:

Key	Stability	Requirement Level	Value Type	Description	Example Values
k8s.storageclass.name		Conditionally Required [1]	string	K8sのStorageClassオブジェクトの名前。	gold.storageclass.storage.k8s.io

[1] k8s.storageclass.name: リソースクォータが特定のストレージクラスに対して定義されている場合、k8s.storageclass.nameは必須にすべきです。

メトリクス: openshift.clusterquota.persistentvolumeclaim_count.hard

このメトリクスは推奨です。

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
openshift.clusterquota.persistentvolumeclaim_count.hard	UpDownCounter	{persistentvolumeclaim}	すべてのプロジェクトにわたって強制される、リソースのハード上限。[1]

[1]: このメトリクスは、ClusterResourceQuotaの K8s ResourceQuotaStatusの Status.Total.Hardフィールドから取得されます。

リソースクォータが特定のストレージクラスに対して定義されている場合、k8s.storageclass.nameは必須にすべきです。

Attributes:

Key	Stability	Requirement Level	Value Type	Description	Example Values
k8s.storageclass.name		Conditionally Required [1]	string	K8sのStorageClassオブジェクトの名前。	gold.storageclass.storage.k8s.io

[1] k8s.storageclass.name: リソースクォータが特定のストレージクラスに対して定義されている場合、k8s.storageclass.nameは必須にすべきです。

メトリクス: openshift.clusterquota.persistentvolumeclaim_count.used

このメトリクスは推奨です。

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
openshift.clusterquota.persistentvolumeclaim_count.used	UpDownCounter	{persistentvolumeclaim}	すべてのプロジェクトにわたる、現在観測されているリソースの合計使用量。[1]

[1]: このメトリクスは、ClusterResourceQuotaの K8s ResourceQuotaStatusの Status.Total.Usedフィールドから取得されます。

リソースクォータが特定のストレージクラスに対して定義されている場合、k8s.storageclass.nameは必須にすべきです。

Attributes:

Key	Stability	Requirement Level	Value Type	Description	Example Values
k8s.storageclass.name		Conditionally Required [1]	string	K8sのStorageClassオブジェクトの名前。	gold.storageclass.storage.k8s.io

[1] k8s.storageclass.name: リソースクォータが特定のストレージクラスに対して定義されている場合、k8s.storageclass.nameは必須にすべきです。

メトリクス: openshift.clusterquota.ephemeral_storage.request.hard

このメトリクスは推奨です。

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
openshift.clusterquota.ephemeral_storage.request.hard	UpDownCounter	By	すべてのプロジェクトにわたって強制される、リソースのハード上限。[1]		openshift.clusterquota

[1]: このメトリクスは、ClusterResourceQuotaの K8s ResourceQuotaStatusの Status.Total.Hardフィールドから取得されます。

メトリクス: openshift.clusterquota.ephemeral_storage.request.used

このメトリクスは推奨です。

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
openshift.clusterquota.ephemeral_storage.request.used	UpDownCounter	By	すべてのプロジェクトにわたる、現在観測されているリソースの合計使用量。[1]		openshift.clusterquota

[1]: このメトリクスは、ClusterResourceQuotaの K8s ResourceQuotaStatusの Status.Total.Usedフィールドから取得されます。

メトリクス: openshift.clusterquota.ephemeral_storage.limit.hard

このメトリクスは推奨です。

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
openshift.clusterquota.ephemeral_storage.limit.hard	UpDownCounter	By	すべてのプロジェクトにわたって強制される、リソースのハード上限。[1]		openshift.clusterquota

[1]: このメトリクスは、ClusterResourceQuotaの K8s ResourceQuotaStatusの Status.Total.Hardフィールドから取得されます。

メトリクス: openshift.clusterquota.ephemeral_storage.limit.used

このメトリクスは推奨です。

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
openshift.clusterquota.ephemeral_storage.limit.used	UpDownCounter	By	すべてのプロジェクトにわたる、現在観測されているリソースの合計使用量。[1]		openshift.clusterquota

[1]: このメトリクスは、ClusterResourceQuotaの K8s ResourceQuotaStatusの Status.Total.Usedフィールドから取得されます。

メトリクス: openshift.clusterquota.object_count.hard

このメトリクスは推奨です。

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
openshift.clusterquota.object_count.hard	UpDownCounter	{object}	すべてのプロジェクトにわたって強制される、リソースのハード上限。[1]		openshift.clusterquota

[1]: このメトリクスは、ClusterResourceQuotaの K8s ResourceQuotaStatusの Status.Total.Hardフィールドから取得されます。

Attributes:

Key	Stability	Requirement Level	Value Type	Description	Example Values
k8s.resourcequota.resource_name		Required	string	リソースクォータが定義するK8sリソースの名前。[1]	count/replicationcontrollers

[1] k8s.resourcequota.resource_name: この属性の値は、完全なcount/<resource>[.<group>]形式の文字列（例: count/deployments.apps、count/pods）、または一部のコアKubernetesリソースについてはリソース名のみ（例: pods、services、configmaps）のいずれかです。オブジェクト数のクォータについては、Kubernetesは両方の形式をサポートします。詳細はKubernetes Resource Quotasのドキュメントを参照してください。

メトリクス: openshift.clusterquota.object_count.used

このメトリクスは推奨です。

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
openshift.clusterquota.object_count.used	UpDownCounter	{object}	すべてのプロジェクトにわたる、現在観測されているリソースの合計使用量。[1]		openshift.clusterquota

[1]: このメトリクスは、ClusterResourceQuotaの K8s ResourceQuotaStatusの Status.Total.Usedフィールドから取得されます。

Attributes:

Key	Stability	Requirement Level	Value Type	Description	Example Values
k8s.resourcequota.resource_name		Required	string	リソースクォータが定義するK8sリソースの名前。[1]	count/replicationcontrollers

[1] k8s.resourcequota.resource_name: この属性の値は、完全なcount/<resource>[.<group>]形式の文字列（例: count/deployments.apps、count/pods）、または一部のコアKubernetesリソースについてはリソース名のみ（例: pods、services、configmaps）のいずれかです。オブジェクト数のクォータについては、Kubernetesは両方の形式をサポートします。詳細はKubernetes Resource Quotasのドキュメントを参照してください。