[receiver/k8s_cluster] Move statefulset metrics to use pdata (open-te…

…lemetry#23420)
observIQ · Jul 6, 2023 · 50c065a · 50c065a
1 parent 32d714c
commit 50c065a
Show file tree

Hide file tree

Showing 12 changed files with 935 additions and 104 deletions.
diff --git a/.chloggen/switchk8sss.yaml b/.chloggen/switchk8sss.yaml
@@ -0,0 +1,11 @@
+# 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: Switch k8s.ss metrics to use pdata.
+
+# One or more tracking issues related to the change
+issues: [23420]
diff --git a/receiver/k8sclusterreceiver/internal/collection/collector.go b/receiver/k8sclusterreceiver/internal/collection/collector.go
@@ -120,7 +120,7 @@ func (dc *DataCollector) SyncMetrics(obj interface{}) {
 	case *appsv1.DaemonSet:
 		md = ocsToMetrics(demonset.GetMetrics(o))
 	case *appsv1.StatefulSet:
-		md = ocsToMetrics(statefulset.GetMetrics(o))
+		md = statefulset.GetMetrics(dc.settings, o)
 	case *batchv1.Job:
 		md = ocsToMetrics(jobs.GetMetrics(o))
 	case *batchv1.CronJob:

diff --git a/receiver/k8sclusterreceiver/internal/statefulset/doc.go b/receiver/k8sclusterreceiver/internal/statefulset/doc.go
@@ -0,0 +1,6 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+//go:generate mdatagen metadata.yaml
+
+package statefulset // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/k8sclusterreceiver/internal/statefulset"
diff --git a/receiver/k8sclusterreceiver/internal/statefulset/documentation.md b/receiver/k8sclusterreceiver/internal/statefulset/documentation.md
@@ -0,0 +1,54 @@
+[comment]: <> (Code generated by mdatagen. DO NOT EDIT.)
+
+# k8s/statefulset
+
+## Default Metrics
+
+The following metrics are emitted by default. Each of them can be disabled by applying the following configuration:
+
+```yaml
+metrics:
+  <metric_name>:
+    enabled: false
+```
+
+### k8s.statefulset.current_pods
+
+The number of pods created by the StatefulSet controller from the StatefulSet version
+
+| Unit | Metric Type | Value Type |
+| ---- | ----------- | ---------- |
+| 1 | Gauge | Int |
+
+### k8s.statefulset.desired_pods
+
+Number of desired pods in the stateful set (the `spec.replicas` field)
+
+| Unit | Metric Type | Value Type |
+| ---- | ----------- | ---------- |
+| 1 | Gauge | Int |
+
+### k8s.statefulset.ready_pods
+
+Number of pods created by the stateful set that have the `Ready` condition
+
+| Unit | Metric Type | Value Type |
+| ---- | ----------- | ---------- |
+| 1 | Gauge | Int |
+
+### k8s.statefulset.updated_pods
+
+Number of pods created by the StatefulSet controller from the StatefulSet version
+
+| Unit | Metric Type | Value Type |
+| ---- | ----------- | ---------- |
+| 1 | Gauge | Int |
+
+## Resource Attributes
+
+| Name | Description | Values | Enabled |
+| ---- | ----------- | ------ | ------- |
+| k8s.namespace.name | The name of the namespace that the pod is running in. | Any Str | true |
+| k8s.statefulset.name | The k8s statefulset name. | Any Str | true |
+| k8s.statefulset.uid | The k8s statefulset uid. | Any Str | true |
+| opencensus.resourcetype | The OpenCensus resource type. | Any Str | true |
diff --git a/receiver/k8sclusterreceiver/internal/statefulset/internal/metadata/generated_config.go b/receiver/k8sclusterreceiver/internal/statefulset/internal/metadata/generated_config.go
diff --git a/receiver/k8sclusterreceiver/internal/statefulset/internal/metadata/generated_config_test.go b/receiver/k8sclusterreceiver/internal/statefulset/internal/metadata/generated_config_test.go