[receiver/k8s_cluster] Define entities and relationships in metadata.yaml

.chloggen/k8scluster-entities-relationships.yaml

@@ -0,0 +1,22 @@
+# 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. receiver/filelog)
+component: receiver/k8s_cluster
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Define entities and relationships for Kubernetes resources in metadata.yaml.
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [41080]
+
+# 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: [user]

receiver/k8sclusterreceiver/documentation.md

@@ -519,3 +519,202 @@ The number of load balancer ingress points (external IPs/hostnames) assigned to
 | openshift.clusterquota.uid | The k8s ClusterResourceQuota uid. | Any Str | true |
 | os.description | The os description used by Kubernetes Node. | Any Str | false |
 | os.type | The os type used by Kubernetes Node. | Any Str | false |
+
+## Entities
+
+The following entities are defined for this component:
+
+### k8s.namespace
+
+A Kubernetes namespace
+
+**Stability:** Development
+
+**Identifying Attributes:**
+- `k8s.namespace.uid`
+
+**Descriptive Attributes:**
+- `k8s.namespace.name`
+
+### k8s.node
+
+A Kubernetes node
+
+**Stability:** Development
+
+**Identifying Attributes:**
+- `k8s.node.uid`
+
+**Descriptive Attributes:**
+- `k8s.node.name`
+- `k8s.kubelet.version`
+- `container.runtime`
+- `container.runtime.version`
+- `os.description`
+- `os.type`
+
+### k8s.deployment
+
+A Kubernetes deployment
+
+**Stability:** Development
+
+**Identifying Attributes:**
+- `k8s.deployment.uid`
+
+**Descriptive Attributes:**
+- `k8s.deployment.name`
+
+### k8s.replicaset
+
+A Kubernetes replicaset
+
+**Stability:** Development
+
+**Identifying Attributes:**
+- `k8s.replicaset.uid`
+
+**Descriptive Attributes:**
+- `k8s.replicaset.name`
+
+### k8s.statefulset
+
+A Kubernetes statefulset
+
+**Stability:** Development
+
+**Identifying Attributes:**
+- `k8s.statefulset.uid`
+
+**Descriptive Attributes:**
+- `k8s.statefulset.name`
+
+### k8s.daemonset
+
+A Kubernetes daemonset
+
+**Stability:** Development
+
+**Identifying Attributes:**
+- `k8s.daemonset.uid`
+
+**Descriptive Attributes:**
+- `k8s.daemonset.name`
+
+### k8s.cronjob
+
+A Kubernetes cronjob
+
+**Stability:** Development
+
+**Identifying Attributes:**
+- `k8s.cronjob.uid`
+
+**Descriptive Attributes:**
+- `k8s.cronjob.name`
+
+### k8s.job
+
+A Kubernetes job
+
+**Stability:** Development
+
+**Identifying Attributes:**
+- `k8s.job.uid`
+
+**Descriptive Attributes:**
+- `k8s.job.name`
+
+### k8s.pod
+
+A Kubernetes pod
+
+**Stability:** Development
+
+**Identifying Attributes:**
+- `k8s.pod.uid`
+
+**Descriptive Attributes:**
+- `k8s.pod.name`
+- `k8s.pod.qos_class`
+
+### k8s.container
+
+A Kubernetes container
+
+**Stability:** Development
+
+**Identifying Attributes:**
+- `container.id`
+
+**Descriptive Attributes:**
+- `k8s.container.name`
+- `container.image.name`
+- `container.image.tag`
+- `k8s.container.status.last_terminated_reason`
+
+### k8s.replicationcontroller
+
+A Kubernetes replication controller
+
+**Stability:** Development
+
+**Identifying Attributes:**
+- `k8s.replicationcontroller.uid`
+
+**Descriptive Attributes:**
+- `k8s.replicationcontroller.name`
+
+### k8s.resourcequota
+
+A Kubernetes resource quota
+
+**Stability:** Development
+
+**Identifying Attributes:**
+- `k8s.resourcequota.uid`
+
+**Descriptive Attributes:**
+- `k8s.resourcequota.name`
+
+### k8s.service
+
+A Kubernetes service
+
+**Stability:** Development
+
+**Identifying Attributes:**
+- `k8s.service.uid`
+
+**Descriptive Attributes:**
+- `k8s.service.name`
+- `k8s.service.type`
+- `k8s.service.publish_not_ready_addresses`
+- `k8s.service.traffic_distribution`
+
+### k8s.hpa
+
+A Kubernetes horizontal pod autoscaler
+
+**Stability:** Development
+
+**Identifying Attributes:**
+- `k8s.hpa.uid`
+
+**Descriptive Attributes:**
+- `k8s.hpa.name`
+- `k8s.hpa.scaletargetref.apiversion`
+- `k8s.hpa.scaletargetref.kind`
+- `k8s.hpa.scaletargetref.name`
+
+### openshift.clusterquota
+
+An OpenShift cluster resource quota
+
+**Stability:** Development
+
+**Identifying Attributes:**
+- `openshift.clusterquota.uid`
+
+**Descriptive Attributes:**
+- `openshift.clusterquota.name`

receiver/k8sclusterreceiver/go.mod

@@ -9,6 +9,7 @@ require (
 	github.com/open-telemetry/opentelemetry-collector-contrib/extension/k8sleaderelector v0.146.0
 	github.com/open-telemetry/opentelemetry-collector-contrib/internal/common v0.146.0
 	github.com/open-telemetry/opentelemetry-collector-contrib/internal/k8sconfig v0.146.0
+	github.com/open-telemetry/opentelemetry-collector-contrib/internal/k8sleaderelectortest v0.146.0
 	github.com/open-telemetry/opentelemetry-collector-contrib/internal/sharedcomponent v0.146.0
 	github.com/open-telemetry/opentelemetry-collector-contrib/pkg/experimentalmetricmetadata v0.146.0
 	github.com/open-telemetry/opentelemetry-collector-contrib/pkg/golden v0.146.0
@@ -27,6 +28,7 @@ require (
 	go.opentelemetry.io/collector/consumer/consumertest v0.146.1
 	go.opentelemetry.io/collector/filter v0.146.1
 	go.opentelemetry.io/collector/pdata v1.52.0
+	go.opentelemetry.io/collector/pdata/xpdata v0.146.1
 	go.opentelemetry.io/collector/pipeline v1.52.0
 	go.opentelemetry.io/collector/receiver v1.52.0
 	go.opentelemetry.io/collector/receiver/otlpreceiver v0.146.1
@@ -40,8 +42,6 @@ require (
 	k8s.io/client-go v0.35.1
 )
 
-require github.com/open-telemetry/opentelemetry-collector-contrib/internal/k8sleaderelectortest v0.146.0
-
 require (
 	github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1 // indirect
 	github.com/Microsoft/go-winio v0.6.1 // indirect