[receiver/k8sclusterreceiver] add HierarchicalResourceQuota

.chloggen/add-hrq-k8sclusterreceiver.yaml

@@ -0,0 +1,28 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: k8sclusterreceiver
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Add hnc.x-k8s.io/v1alpha2 HierarchicalResourceQuota as a target for metrics collection (Optional)
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [29555]
+
+# (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:
+
+# If your change doesn't affect end users or the exported elements of any package,
+# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: []
+

cmd/configschema/go.mod

@@ -709,6 +709,7 @@ require (
 	k8s.io/kubelet v0.28.4 // indirect
 	k8s.io/utils v0.0.0-20230711102312-30195339c3c7 // indirect
 	sigs.k8s.io/controller-runtime v0.16.3 // indirect
+	sigs.k8s.io/hierarchical-namespaces v1.1.0 // indirect
 	sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
 	sigs.k8s.io/structured-merge-diff/v4 v4.3.0 // indirect
 	sigs.k8s.io/yaml v1.3.0 // indirect

cmd/otelcontribcol/go.mod

@@ -719,6 +719,7 @@ require (
 	k8s.io/kubelet v0.28.4 // indirect
 	k8s.io/utils v0.0.0-20230711102312-30195339c3c7 // indirect
 	sigs.k8s.io/controller-runtime v0.16.3 // indirect
+	sigs.k8s.io/hierarchical-namespaces v1.1.0 // indirect
 	sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
 	sigs.k8s.io/structured-merge-diff/v4 v4.3.0 // indirect
 	sigs.k8s.io/yaml v1.3.0 // indirect

go.mod

@@ -708,6 +708,7 @@ require (
 	k8s.io/kubelet v0.28.4 // indirect
 	k8s.io/utils v0.0.0-20230711102312-30195339c3c7 // indirect
 	sigs.k8s.io/controller-runtime v0.16.3 // indirect
+	sigs.k8s.io/hierarchical-namespaces v1.1.0 // indirect
 	sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
 	sigs.k8s.io/structured-merge-diff/v4 v4.3.0 // indirect
 	sigs.k8s.io/yaml v1.3.0 // indirect

receiver/k8sclusterreceiver/README.md

@@ -342,3 +342,35 @@ Add the following rules to your ClusterRole:
   - watch
 ```
 
+### HierarchicalResourceQuota
+
+You can enable [HierarchicalResourceQuota](https://github.com/kubernetes-sigs/hierarchical-namespaces) support to collect aggregate quota restrictions as metrics.
+
+Example:
+
+```yaml
+  k8s_cluster:
+    resource_attributes:
+      k8s.hierarchicalresourcequota.name:
+        enabled: true
+      k8s.hierarchicalresourcequota.uid:
+        enabled: true
+    metrics:
+      k8s.hierarchical_resource_quota.hard_limit:
+        enabled: true
+      k8s.hierarchical_resource_quota.used:
+        enabled: true
+```
+
+Add the following rules to your ClusterRole:
+
+```yaml
+- apiGroups:
+    - hnc.x-k8s.io
+  resources:
+    - hierarchicalresourcequotas
+  verbs:
+    - get
+    - list
+    - watch
+```

receiver/k8sclusterreceiver/documentation.md

@@ -396,6 +396,34 @@ metrics:
     enabled: true
 ```
 
+### k8s.hierarchical_resource_quota.hard_limit
+
+The upper limit for a particular resource in a specific namespace. Will only be sent if a quota is specified. CPU requests/limits will be sent as millicores
+
+| Unit | Metric Type | Value Type |
+| ---- | ----------- | ---------- |
+| {resource} | Gauge | Int |
+
+#### Attributes
+
+| Name | Description | Values |
+| ---- | ----------- | ------ |
+| resource | the name of the resource on which the quota is applied | Any Str |
+
+### k8s.hierarchical_resource_quota.used
+
+The usage for a particular resource in a specific namespace. Will only be sent if a quota is specified. CPU requests/limits will be sent as millicores
+
+| Unit | Metric Type | Value Type |
+| ---- | ----------- | ---------- |
+| {resource} | Gauge | Int |
+
+#### Attributes
+
+| Name | Description | Values |
+| ---- | ----------- | ------ |
+| resource | the name of the resource on which the quota is applied | Any Str |
+
 ### k8s.node.condition
 
 The condition of a particular Node.
@@ -432,6 +460,8 @@ Current status reason of the pod (1 - Evicted, 2 - NodeAffinity, 3 - NodeLost, 4
 | k8s.daemonset.uid | The k8s daemonset uid. | Any Str | true |
 | k8s.deployment.name | The name of the Deployment. | Any Str | true |
 | k8s.deployment.uid | The UID of the Deployment. | Any Str | true |
+| k8s.hierarchicalresourcequota.name | The k8s HierarchicalresourceQuota name. | Any Str | false |
+| k8s.hierarchicalresourcequota.uid | The k8s HierarchicalResourceQuota uid. | Any Str | false |
 | k8s.hpa.name | The k8s hpa name. | Any Str | true |
 | k8s.hpa.uid | The k8s hpa uid. | Any Str | true |
 | k8s.job.name | The k8s pod name. | Any Str | true |

receiver/k8sclusterreceiver/factory_test.go

@@ -16,6 +16,9 @@ import (
 	"go.opentelemetry.io/collector/component/componenttest"
 	"go.opentelemetry.io/collector/consumer/consumertest"
 	"go.opentelemetry.io/collector/receiver/receivertest"
+	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/client-go/dynamic"
+	fakeDynamic "k8s.io/client-go/dynamic/fake"
 	"k8s.io/client-go/kubernetes"
 	"k8s.io/client-go/kubernetes/fake"
 
@@ -93,6 +96,9 @@ func newTestReceiver(t *testing.T, cfg *Config) *kubernetesReceiver {
 	rcvr.resourceWatcher.makeClient = func(_ k8sconfig.APIConfig) (kubernetes.Interface, error) {
 		return fake.NewSimpleClientset(), nil
 	}
+	rcvr.resourceWatcher.makeDynamicClient = func(_ k8sconfig.APIConfig) (dynamic.Interface, error) {
+		return fakeDynamic.NewSimpleDynamicClient(runtime.NewScheme()), nil
+	}
 	rcvr.resourceWatcher.makeOpenShiftQuotaClient = func(_ k8sconfig.APIConfig) (quotaclientset.Interface, error) {
 		return fakeQuota.NewSimpleClientset(), nil
 	}

receiver/k8sclusterreceiver/go.mod

@@ -30,6 +30,7 @@ require (
 	k8s.io/api v0.28.4
 	k8s.io/apimachinery v0.28.4
 	k8s.io/client-go v0.28.4
+	sigs.k8s.io/hierarchical-namespaces v1.1.0
 )
 
 require (
@@ -128,6 +129,7 @@ require (
 	k8s.io/klog/v2 v2.100.1 // indirect
 	k8s.io/kube-openapi v0.0.0-20230717233707-2695361300d9 // indirect
 	k8s.io/utils v0.0.0-20230406110748-d93618cff8a2 // indirect
+	sigs.k8s.io/controller-runtime v0.11.0 // indirect
 	sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
 	sigs.k8s.io/structured-merge-diff/v4 v4.2.3 // indirect
 	sigs.k8s.io/yaml v1.3.0 // indirect

receiver/k8sclusterreceiver/internal/collection/collector.go

@@ -10,16 +10,19 @@ import (
 	"go.opentelemetry.io/collector/pdata/pcommon"
 	"go.opentelemetry.io/collector/pdata/pmetric"
 	"go.opentelemetry.io/collector/receiver"
+	"go.uber.org/zap"
 	appsv1 "k8s.io/api/apps/v1"
 	autoscalingv2 "k8s.io/api/autoscaling/v2"
 	batchv1 "k8s.io/api/batch/v1"
 	corev1 "k8s.io/api/core/v1"
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/k8sclusterreceiver/internal/clusterresourcequota"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/k8sclusterreceiver/internal/cronjob"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/k8sclusterreceiver/internal/demonset"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/k8sclusterreceiver/internal/deployment"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/k8sclusterreceiver/internal/gvk"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/k8sclusterreceiver/internal/hierarchicalresourcequota"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/k8sclusterreceiver/internal/hpa"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/k8sclusterreceiver/internal/jobs"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/k8sclusterreceiver/internal/metadata"
@@ -104,6 +107,14 @@ func (dc *DataCollector) CollectMetricData(currentTime time.Time) pmetric.Metric
 	dc.metadataStore.ForEach(gvk.ClusterResourceQuota, func(o any) {
 		clusterresourcequota.RecordMetrics(dc.metricsBuilder, o.(*quotav1.ClusterResourceQuota), ts)
 	})
+	dc.metadataStore.ForEach(gvk.HierarchicalResourceQuota, func(o any) {
+		hrq, err := hierarchicalresourcequota.Parse(o.(*unstructured.Unstructured))
+		if err != nil {
+			dc.settings.Logger.Error("failed to parse hierarchicalresourcequota object", zap.Error(err))
+		} else {
+			hierarchicalresourcequota.RecordMetrics(dc.metricsBuilder, hrq, ts)
+		}
+	})
 
 	m := dc.metricsBuilder.Emit()
 	customRMs.MoveAndAppendTo(m.ResourceMetrics())

receiver/k8sclusterreceiver/internal/gvk/gvk.go

@@ -7,18 +7,19 @@ import "k8s.io/apimachinery/pkg/runtime/schema"
 
 // Kubernetes group version kinds
 var (
-	Pod                     = schema.GroupVersionKind{Group: "", Version: "v1", Kind: "Pod"}
-	Node                    = schema.GroupVersionKind{Group: "", Version: "v1", Kind: "Node"}
-	Namespace               = schema.GroupVersionKind{Group: "", Version: "v1", Kind: "Namespace"}
-	ReplicationController   = schema.GroupVersionKind{Group: "", Version: "v1", Kind: "ReplicationController"}
-	ResourceQuota           = schema.GroupVersionKind{Group: "", Version: "v1", Kind: "ResourceQuota"}
-	Service                 = schema.GroupVersionKind{Group: "", Version: "v1", Kind: "Service"}
-	DaemonSet               = schema.GroupVersionKind{Group: "apps", Version: "v1", Kind: "DaemonSet"}
-	Deployment              = schema.GroupVersionKind{Group: "apps", Version: "v1", Kind: "Deployment"}
-	ReplicaSet              = schema.GroupVersionKind{Group: "apps", Version: "v1", Kind: "ReplicaSet"}
-	StatefulSet             = schema.GroupVersionKind{Group: "apps", Version: "v1", Kind: "StatefulSet"}
-	Job                     = schema.GroupVersionKind{Group: "batch", Version: "v1", Kind: "Job"}
-	CronJob                 = schema.GroupVersionKind{Group: "batch", Version: "v1", Kind: "CronJob"}
-	HorizontalPodAutoscaler = schema.GroupVersionKind{Group: "autoscaling", Version: "v2", Kind: "HorizontalPodAutoscaler"}
-	ClusterResourceQuota    = schema.GroupVersionKind{Group: "quota", Version: "v1", Kind: "ClusterResourceQuota"}
+	Pod                       = schema.GroupVersionKind{Group: "", Version: "v1", Kind: "Pod"}
+	Node                      = schema.GroupVersionKind{Group: "", Version: "v1", Kind: "Node"}
+	Namespace                 = schema.GroupVersionKind{Group: "", Version: "v1", Kind: "Namespace"}
+	ReplicationController     = schema.GroupVersionKind{Group: "", Version: "v1", Kind: "ReplicationController"}
+	ResourceQuota             = schema.GroupVersionKind{Group: "", Version: "v1", Kind: "ResourceQuota"}
+	Service                   = schema.GroupVersionKind{Group: "", Version: "v1", Kind: "Service"}
+	DaemonSet                 = schema.GroupVersionKind{Group: "apps", Version: "v1", Kind: "DaemonSet"}
+	Deployment                = schema.GroupVersionKind{Group: "apps", Version: "v1", Kind: "Deployment"}
+	ReplicaSet                = schema.GroupVersionKind{Group: "apps", Version: "v1", Kind: "ReplicaSet"}
+	StatefulSet               = schema.GroupVersionKind{Group: "apps", Version: "v1", Kind: "StatefulSet"}
+	Job                       = schema.GroupVersionKind{Group: "batch", Version: "v1", Kind: "Job"}
+	CronJob                   = schema.GroupVersionKind{Group: "batch", Version: "v1", Kind: "CronJob"}
+	HorizontalPodAutoscaler   = schema.GroupVersionKind{Group: "autoscaling", Version: "v2", Kind: "HorizontalPodAutoscaler"}
+	ClusterResourceQuota      = schema.GroupVersionKind{Group: "quota", Version: "v1", Kind: "ClusterResourceQuota"}
+	HierarchicalResourceQuota = schema.GroupVersionKind{Group: "hnc.x-k8s.io", Version: "v1alpha2", Kind: "HierarchicalResourceQuota"}
 )

receiver/k8sclusterreceiver/internal/gvr/gvr.go

@@ -0,0 +1,11 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package gvr // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/k8sclusterreceiver/internal/gvr"
+
+import "k8s.io/apimachinery/pkg/runtime/schema"
+
+// Kubernetes group version resources
+var (
+	HierarchicalResourceQuota = schema.GroupVersionResource{Group: "hnc.x-k8s.io", Version: "v1alpha2", Resource: "hierarchicalresourcequotas"}
+)