Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .chloggen/add_openshift_semconv.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Use this changelog template to create an entry for release notes.
#
# If your change doesn't affect end users you should instead start
# your pull request title with [chore] or use the "Skip Changelog" label.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: enhancement

# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
component: openshift

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Adds metrics for openshift's clusterquota

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
# The values here must be integers.
issues: [2078]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ body:
- area:oci
- area:onc-rpc
- area:openai
- area:openshift
- area:opentracing
- area:os
- area:otel
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/change_proposal.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ body:
- area:oci
- area:onc-rpc
- area:openai
- area:openshift
- area:opentracing
- area:os
- area:otel
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/new-conventions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ body:
- area:oci
- area:onc-rpc
- area:openai
- area:openshift
- area:opentracing
- area:os
- area:otel
Expand Down
20 changes: 20 additions & 0 deletions docs/non-normative/k8s-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ and one for disabling the old schema called `semconv.k8s.disableLegacy`. Then:
- [K8s ReplicationController resource](#k8s-replicationcontroller-resource)
- [K8s Container metrics](#k8s-container-metrics)
- [K8s ResourceQuota metrics](#k8s-resourcequota-metrics)
- [OpenShift ClusterResourceQuota metrics](#openshift-clusterresourcequota-metrics)
- [K8s Node condition metrics](#k8s-node-condition-metrics)
- [K8s Filesystem metrics](#k8s-filesystem-metrics)
- [K8s Pod Volume metrics](#k8s-pod-volume-metrics)
Expand Down Expand Up @@ -363,6 +364,25 @@ These metrics were completely re-designed. The changes are the following:

<!-- prettier-ignore-end -->

### OpenShift ClusterResourceQuota metrics

The OpenShift ClusterResourceQuota metrics implemented by the Collector and specifically the
[k8scluster](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.115.0/receiver/k8sclusterreceiver/documentation.md)
receiver were introduced as semantic conventions in
[github.com/open-telemetry/semantic-conventions/pull/2779](https://github.com/open-telemetry/semantic-conventions/pull/2779).

These metrics were completely re-designed. The changes are the following:

<!-- prettier-ignore-start -->

| Old (Collector) ![changed](https://img.shields.io/badge/changed-orange?style=flat) | New |
|------------------------------------------------------------------------------------|-------------------------------------|
| `openshift.clusterquota.hard_limit` | `openshift.clusterquota.{resource}.hard` |
| `openshift.clusterquota.used` | `openshift.clusterquota.{resource}.used` |
| `{resource}` attribute | Split in different metrics per type |

<!-- prettier-ignore-end -->

### K8s Node condition metrics

The K8s Node condition metrics implemented by the Collector and specifically the
Expand Down
1 change: 1 addition & 0 deletions docs/registry/attributes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ Currently, the following namespaces exist:
- [OCI](oci.md)
- [ONC RPC](onc-rpc.md)
- [OpenAI](openai.md)
- [Openshift](openshift.md)
- [OpenTracing](opentracing.md)
- [OS](os.md)
- [OTel](otel.md)
Expand Down
13 changes: 13 additions & 0 deletions docs/registry/attributes/openshift.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/attribute_namespace.md.j2 -->

# Openshift

## Openshift Attributes

OpenShift resource attributes.

| Attribute | Type | Description | Examples | Stability |
|---|---|---|---|---|
| <a id="openshift-clusterquota-name" href="#openshift-clusterquota-name">`openshift.clusterquota.name`</a> | string | The name of the cluster quota. | `opentelemetry` | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="openshift-clusterquota-uid" href="#openshift-clusterquota-uid">`openshift.clusterquota.uid`</a> | string | The UID of the cluster quota. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` | ![Development](https://img.shields.io/badge/-development-blue) |
2 changes: 2 additions & 0 deletions docs/registry/entities/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ Currently, the following namespaces exist:
| | [k8s.replicationcontroller](k8s.md#k8s-replicationcontroller) | ![Development](https://img.shields.io/badge/-development-blue) |
| | [k8s.resourcequota](k8s.md#k8s-resourcequota) | ![Development](https://img.shields.io/badge/-development-blue) |
| | [k8s.statefulset](k8s.md#k8s-statefulset) | ![Development](https://img.shields.io/badge/-development-blue) |
| Openshift | | |
| | [openshift.clusterquota](openshift.md#openshift-clusterquota) | ![Development](https://img.shields.io/badge/-development-blue) |
| OS | | |
| | [os](os.md#os) | ![Development](https://img.shields.io/badge/-development-blue) |
| OTel | | |
Expand Down
29 changes: 29 additions & 0 deletions docs/registry/entities/openshift.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/entity_namespace.md.j2 -->
<!-- markdownlint-capture -->
<!-- markdownlint-disable -->

# Openshift

## Openshift Clusterquota

**Status:** ![Development](https://img.shields.io/badge/-development-blue)

**type:** `openshift.clusterquota`

**Description:** An OpenShift [ClusterResourceQuota](https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1#clusterresourcequota-quota-openshift-io-v1) object.

**Identifying Attributes:**

| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|---|---|---|---|---|---|
| [`openshift.clusterquota.uid`](/docs/registry/attributes/openshift.md) | string | The UID of the cluster quota. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |

**Descriptive Attributes:**

| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|---|---|---|---|---|---|
| [`openshift.clusterquota.name`](/docs/registry/attributes/openshift.md) | string | The name of the cluster quota. | `opentelemetry` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |


<!-- markdownlint-restore -->
26 changes: 26 additions & 0 deletions docs/resource/k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -593,6 +593,32 @@ A ResourceQuota provides constraints that limit aggregate resource consumption p
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

## ClusterResourceQuota

<!-- semconv entity.openshift.clusterquota -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 -->
<!-- prettier-ignore-start -->
<!-- markdownlint-capture -->
<!-- markdownlint-disable -->


**Status:** ![Development](https://img.shields.io/badge/-development-blue)

**type:** `openshift.clusterquota`

**Description:** An OpenShift [ClusterResourceQuota](https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1#clusterresourcequota-quota-openshift-io-v1) object.

| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|---|---|---|---|---|---|
| [`openshift.clusterquota.name`](/docs/registry/attributes/openshift.md) | string | The name of the cluster quota. | `opentelemetry` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
| [`openshift.clusterquota.uid`](/docs/registry/attributes/openshift.md) | string | The UID of the cluster quota. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status

## Kubernetes specific guidelines
Expand Down
Loading
Loading