k8sclusterreceiver: Standardize metric names (#1119)

- Replace "/" with "." in metric names - daemon_set -> daemonset, stateful_set -> statefulset, replica_set -> replicaset to match conventions - k8s/container/<resource_type>/<request | limit> -> k8s.container.<resource_type>_<request | limit>
asuresh4 · Sep 28, 2020 · cd5dacb · cd5dacb
1 parent 92f2dca
commit cd5dacb
Show file tree

Hide file tree

Showing 24 changed files with 103 additions and 65 deletions.
diff --git a/receiver/k8sclusterreceiver/README.md b/receiver/k8sclusterreceiver/README.md
@@ -44,7 +44,7 @@ with detailed sample configurations [here](./testdata/config.yaml).
 ### node_conditions_to_report
 
 For example, with the config below the receiver will emit two metrics
-`kubernetes/node/condition_ready` and `kubernetes/node/condition_memory_pressure`, one
+`k8s.node.condition_ready` and `k8s.node.condition_memory_pressure`, one
 for each condition in the config. The value will be `1` if the `ConditionStatus` for the
 corresponding `Condition` is `True`, `0` if it is `False` and -1 if it is `Unknown`.
 

diff --git a/receiver/k8sclusterreceiver/collection/containers.go b/receiver/k8sclusterreceiver/collection/containers.go
@@ -37,7 +37,7 @@ const (
 )
 
 var containerRestartMetric = &metricspb.MetricDescriptor{
- Name: "k8s/container/restarts",
+ Name: "k8s.container.restarts",
  Description: "How many times the container has restarted in the recent past. " +
  "This value is pulled directly from the K8s API and the value can go indefinitely high" +
  " and be reset to 0 at any time depending on how your kubelet is configured to prune" +
@@ -50,7 +50,7 @@ var containerRestartMetric = &metricspb.MetricDescriptor{
 }
 
 var containerReadyMetric = &metricspb.MetricDescriptor{
- Name: "k8s/container/ready",
+ Name: "k8s.container.ready",
  Description: "Whether a container has passed its readiness probe (0 for no, 1 for yes)",
  Type: metricspb.MetricDescriptor_GAUGE_INT64,
 }
@@ -114,7 +114,7 @@ func getSpecMetricsForContainer(c corev1.Container) []*metricspb.Metric {
  metrics = append(metrics,
  &metricspb.Metric{
  MetricDescriptor: &metricspb.MetricDescriptor{
- Name: fmt.Sprintf("k8s/container/%s/%s", k, t.typ),
+ Name: fmt.Sprintf("k8s.container.%s_%s", k, t.typ),
  Description: t.description,
  Type: metricspb.MetricDescriptor_GAUGE_INT64,
  },

diff --git a/receiver/k8sclusterreceiver/collection/cronjobs.go b/receiver/k8sclusterreceiver/collection/cronjobs.go
@@ -30,7 +30,7 @@ const (
 )
 
 var activeJobs = &metricspb.MetricDescriptor{
- Name: "k8s/cronjob/active_jobs",
+ Name: "k8s.cronjob.active_jobs",
  Description: "The number of actively running jobs for a cronjob",
  Unit: "1",
  Type: metricspb.MetricDescriptor_GAUGE_INT64,

diff --git a/receiver/k8sclusterreceiver/collection/cronjobs_test.go b/receiver/k8sclusterreceiver/collection/cronjobs_test.go
@@ -44,7 +44,7 @@ func TestCronJobMetrics(t *testing.T) {
  },
  )
 
- testutils.AssertMetrics(t, actualResourceMetrics[0].metrics[0], "k8s/cronjob/active_jobs",
+ testutils.AssertMetrics(t, actualResourceMetrics[0].metrics[0], "k8s.cronjob.active_jobs",
  metricspb.MetricDescriptor_GAUGE_INT64, 2)
 }
 

diff --git a/receiver/k8sclusterreceiver/collection/daemonsets.go b/receiver/k8sclusterreceiver/collection/daemonsets.go
@@ -24,28 +24,28 @@ import (
 )
 
 var daemonSetCurrentScheduledMetric = &metricspb.MetricDescriptor{
- Name: "k8s/daemon_set/current_scheduled_nodes",
+ Name: "k8s.daemonset.current_scheduled_nodes",
  Description: "Number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod",
  Unit: "1",
  Type: metricspb.MetricDescriptor_GAUGE_INT64,
 }
 
 var daemonSetDesiredScheduledMetric = &metricspb.MetricDescriptor{
- Name: "k8s/daemon_set/desired_scheduled_nodes",
+ Name: "k8s.daemonset.desired_scheduled_nodes",
  Description: "Number of nodes that should be running the daemon pod (including nodes currently running the daemon pod)",
  Unit: "1",
  Type: metricspb.MetricDescriptor_GAUGE_INT64,
 }
 
 var daemonSetMisScheduledMetric = &metricspb.MetricDescriptor{
- Name: "k8s/daemon_set/misscheduled_nodes",
+ Name: "k8s.daemonset.misscheduled_nodes",
  Description: "Number of nodes that are running the daemon pod, but are not supposed to run the daemon pod",
  Unit: "1",
  Type: metricspb.MetricDescriptor_GAUGE_INT64,
 }
 
 var daemonSetReadyMetric = &metricspb.MetricDescriptor{
- Name: "k8s/daemon_set/ready_nodes",
+ Name: "k8s.daemonset.ready_nodes",
  Description: "Number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready",
  Unit: "1",
  Type: metricspb.MetricDescriptor_GAUGE_INT64,

diff --git a/receiver/k8sclusterreceiver/collection/daemonsets_test.go b/receiver/k8sclusterreceiver/collection/daemonsets_test.go
@@ -44,16 +44,16 @@ func TestDaemonsetMetrics(t *testing.T) {
  },
  )
 
- testutils.AssertMetrics(t, rm.metrics[0], "k8s/daemon_set/current_scheduled_nodes",
+ testutils.AssertMetrics(t, rm.metrics[0], "k8s.daemonset.current_scheduled_nodes",
  metricspb.MetricDescriptor_GAUGE_INT64, 3)
 
- testutils.AssertMetrics(t, rm.metrics[1], "k8s/daemon_set/desired_scheduled_nodes",
+ testutils.AssertMetrics(t, rm.metrics[1], "k8s.daemonset.desired_scheduled_nodes",
  metricspb.MetricDescriptor_GAUGE_INT64, 5)
 
- testutils.AssertMetrics(t, rm.metrics[2], "k8s/daemon_set/misscheduled_nodes",
+ testutils.AssertMetrics(t, rm.metrics[2], "k8s.daemonset.misscheduled_nodes",
  metricspb.MetricDescriptor_GAUGE_INT64, 1)
 
- testutils.AssertMetrics(t, rm.metrics[3], "k8s/daemon_set/ready_nodes",
+ testutils.AssertMetrics(t, rm.metrics[3], "k8s.daemonset.ready_nodes",
  metricspb.MetricDescriptor_GAUGE_INT64, 2)
 }
 

diff --git a/receiver/k8sclusterreceiver/collection/deployments_test.go b/receiver/k8sclusterreceiver/collection/deployments_test.go
@@ -44,10 +44,10 @@ func TestDeploymentMetrics(t *testing.T) {
  },
  )
 
- testutils.AssertMetrics(t, rm.metrics[0], "k8s/deployment/desired",
+ testutils.AssertMetrics(t, rm.metrics[0], "k8s.deployment.desired",
  metricspb.MetricDescriptor_GAUGE_INT64, 10)
 
- testutils.AssertMetrics(t, rm.metrics[1], "k8s/deployment/available",
+ testutils.AssertMetrics(t, rm.metrics[1], "k8s.deployment.available",
  metricspb.MetricDescriptor_GAUGE_INT64, 3)
 }
 

diff --git a/receiver/k8sclusterreceiver/collection/hpa.go b/receiver/k8sclusterreceiver/collection/hpa.go
@@ -24,28 +24,28 @@ import (
 )
 
 var hpaMaxReplicasMetric = &metricspb.MetricDescriptor{
- Name: "k8s/hpa/max_replicas",
+ Name: "k8s.hpa.max_replicas",
  Description: "Maximum number of replicas to which the autoscaler can scale up",
  Unit: "1",
  Type: metricspb.MetricDescriptor_GAUGE_INT64,
 }
 
 var hpaMinReplicasMetric = &metricspb.MetricDescriptor{
- Name: "k8s/hpa/min_replicas",
+ Name: "k8s.hpa.min_replicas",
  Description: "Minimum number of replicas to which the autoscaler can scale down",
  Unit: "1",
  Type: metricspb.MetricDescriptor_GAUGE_INT64,
 }
 
 var hpaCurrentReplicasMetric = &metricspb.MetricDescriptor{
- Name: "k8s/hpa/current_replicas",
+ Name: "k8s.hpa.current_replicas",
  Description: "Current number of pod replicas managed by this autoscaler",
  Unit: "1",
  Type: metricspb.MetricDescriptor_GAUGE_INT64,
 }
 
 var hpaDesiredReplicasMetric = &metricspb.MetricDescriptor{
- Name: "k8s/hpa/desired_replicas",
+ Name: "k8s.hpa.desired_replicas",
  Description: "Desired number of pod replicas managed by this autoscaler",
  Unit: "1",
  Type: metricspb.MetricDescriptor_GAUGE_INT64,

diff --git a/receiver/k8sclusterreceiver/collection/hpa_test.go b/receiver/k8sclusterreceiver/collection/hpa_test.go
@@ -44,16 +44,16 @@ func TestHPAMetrics(t *testing.T) {
  },
  )
 
- testutils.AssertMetrics(t, rm.metrics[0], "k8s/hpa/max_replicas",
+ testutils.AssertMetrics(t, rm.metrics[0], "k8s.hpa.max_replicas",
  metricspb.MetricDescriptor_GAUGE_INT64, 10)
 
- testutils.AssertMetrics(t, rm.metrics[1], "k8s/hpa/min_replicas",
+ testutils.AssertMetrics(t, rm.metrics[1], "k8s.hpa.min_replicas",
  metricspb.MetricDescriptor_GAUGE_INT64, 2)
 
- testutils.AssertMetrics(t, rm.metrics[2], "k8s/hpa/current_replicas",
+ testutils.AssertMetrics(t, rm.metrics[2], "k8s.hpa.current_replicas",
  metricspb.MetricDescriptor_GAUGE_INT64, 5)
 
- testutils.AssertMetrics(t, rm.metrics[3], "k8s/hpa/desired_replicas",
+ testutils.AssertMetrics(t, rm.metrics[3], "k8s.hpa.desired_replicas",
  metricspb.MetricDescriptor_GAUGE_INT64, 7)
 }
 

diff --git a/receiver/k8sclusterreceiver/collection/jobs.go b/receiver/k8sclusterreceiver/collection/jobs.go
@@ -24,35 +24,35 @@ import (
 )
 
 var podsActiveMetric = &metricspb.MetricDescriptor{
- Name: "k8s/job/active_pods",
+ Name: "k8s.job.active_pods",
  Description: "The number of actively running pods for a job",
  Unit: "1",
  Type: metricspb.MetricDescriptor_GAUGE_INT64,
 }
 
 var podsDesiredCompletedMetric = &metricspb.MetricDescriptor{
- Name: "k8s/job/desired_successful_pods",
+ Name: "k8s.job.desired_successful_pods",
  Description: "The desired number of successfully finished pods the job should be run with",
  Unit: "1",
  Type: metricspb.MetricDescriptor_GAUGE_INT64,
 }
 
 var podsFailedMetric = &metricspb.MetricDescriptor{
- Name: "k8s/job/failed_pods",
+ Name: "k8s.job.failed_pods",
  Description: "The number of pods which reached phase Failed for a job",
  Unit: "1",
  Type: metricspb.MetricDescriptor_GAUGE_INT64,
 }
 
 var podsMaxParallelMetric = &metricspb.MetricDescriptor{
- Name: "k8s/job/max_parallel_pods",
+ Name: "k8s.job.max_parallel_pods",
  Description: "The max desired number of pods the job should run at any given time",
  Unit: "1",
  Type: metricspb.MetricDescriptor_GAUGE_INT64,
 }
 
 var podsSuccessfulMetric = &metricspb.MetricDescriptor{
- Name: "k8s/job/successful_pods",
+ Name: "k8s.job.successful_pods",
  Description: "The number of pods which reached phase Succeeded for a job",
  Unit: "1",
  Type: metricspb.MetricDescriptor_GAUGE_INT64,

diff --git a/receiver/k8sclusterreceiver/collection/jobs_test.go b/receiver/k8sclusterreceiver/collection/jobs_test.go
@@ -43,19 +43,19 @@ func TestJobMetrics(t *testing.T) {
  },
  )
 
- testutils.AssertMetrics(t, actualResourceMetrics[0].metrics[0], "k8s/job/active_pods",
+ testutils.AssertMetrics(t, actualResourceMetrics[0].metrics[0], "k8s.job.active_pods",
  metricspb.MetricDescriptor_GAUGE_INT64, 2)
 
- testutils.AssertMetrics(t, actualResourceMetrics[0].metrics[1], "k8s/job/desired_successful_pods",
+ testutils.AssertMetrics(t, actualResourceMetrics[0].metrics[1], "k8s.job.desired_successful_pods",
  metricspb.MetricDescriptor_GAUGE_INT64, 10)
 
- testutils.AssertMetrics(t, actualResourceMetrics[0].metrics[2], "k8s/job/failed_pods",
+ testutils.AssertMetrics(t, actualResourceMetrics[0].metrics[2], "k8s.job.failed_pods",
  metricspb.MetricDescriptor_GAUGE_INT64, 0)
 
- testutils.AssertMetrics(t, actualResourceMetrics[0].metrics[3], "k8s/job/max_parallel_pods",
+ testutils.AssertMetrics(t, actualResourceMetrics[0].metrics[3], "k8s.job.max_parallel_pods",
  metricspb.MetricDescriptor_GAUGE_INT64, 2)
 
- testutils.AssertMetrics(t, actualResourceMetrics[0].metrics[4], "k8s/job/successful_pods",
+ testutils.AssertMetrics(t, actualResourceMetrics[0].metrics[4], "k8s.job.successful_pods",
  metricspb.MetricDescriptor_GAUGE_INT64, 3)
 }
 

diff --git a/receiver/k8sclusterreceiver/collection/namespaces.go b/receiver/k8sclusterreceiver/collection/namespaces.go
@@ -27,7 +27,7 @@ func getMetricsForNamespace(ns *corev1.Namespace) []*resourceMetrics {
  metrics := []*metricspb.Metric{
  {
  MetricDescriptor: &metricspb.MetricDescriptor{
- Name: "k8s/namespace/phase",
+ Name: "k8s.namespace.phase",
  Description: "The current phase of namespaces (1 for active and 0 for terminating)",
  Type: metricspb.MetricDescriptor_GAUGE_INT64,
  },

diff --git a/receiver/k8sclusterreceiver/collection/namespaces_test.go b/receiver/k8sclusterreceiver/collection/namespaces_test.go
@@ -42,7 +42,7 @@ func TestNamespaceMetrics(t *testing.T) {
  },
  )
 
- testutils.AssertMetrics(t, actualResourceMetrics[0].metrics[0], "k8s/namespace/phase",
+ testutils.AssertMetrics(t, actualResourceMetrics[0].metrics[0], "k8s.namespace.phase",
  metricspb.MetricDescriptor_GAUGE_INT64, 0)
 }
 

diff --git a/receiver/k8sclusterreceiver/collection/nodes.go b/receiver/k8sclusterreceiver/collection/nodes.go
@@ -61,7 +61,7 @@ func getMetricsForNode(node *corev1.Node, nodeConditionTypesToReport []string) [
 }
 
 func getNodeConditionMetric(nodeConditionTypeValue string) string {
- return fmt.Sprintf("k8s/node/condition_%s", strcase.ToSnake(nodeConditionTypeValue))
+ return fmt.Sprintf("k8s.node.condition_%s", strcase.ToSnake(nodeConditionTypeValue))
 }
 
 func getResourceForNode(node *corev1.Node) *resourcepb.Resource {

diff --git a/receiver/k8sclusterreceiver/collection/nodes_test.go b/receiver/k8sclusterreceiver/collection/nodes_test.go
@@ -42,10 +42,10 @@ func TestNodeMetrics(t *testing.T) {
  },
  )
 
- testutils.AssertMetrics(t, actualResourceMetrics[0].metrics[0], "k8s/node/condition_ready",
+ testutils.AssertMetrics(t, actualResourceMetrics[0].metrics[0], "k8s.node.condition_ready",
  metricspb.MetricDescriptor_GAUGE_INT64, 1)
 
- testutils.AssertMetrics(t, actualResourceMetrics[0].metrics[1], "k8s/node/condition_memory_pressure",
+ testutils.AssertMetrics(t, actualResourceMetrics[0].metrics[1], "k8s.node.condition_memory_pressure",
  metricspb.MetricDescriptor_GAUGE_INT64, 0)
 }
 
@@ -83,15 +83,15 @@ func TestGetNodeConditionMetric(t *testing.T) {
  }{
  {"Metric for Node condition Ready",
  "Ready",
- "k8s/node/condition_ready",
+ "k8s.node.condition_ready",
  },
  {"Metric for Node condition MemoryPressure",
  "MemoryPressure",
- "k8s/node/condition_memory_pressure",
+ "k8s.node.condition_memory_pressure",
  },
  {"Metric for Node condition DiskPressure",
  "DiskPressure",
- "k8s/node/condition_disk_pressure",
+ "k8s.node.condition_disk_pressure",
  },
  }
 

diff --git a/receiver/k8sclusterreceiver/collection/pods.go b/receiver/k8sclusterreceiver/collection/pods.go
@@ -39,7 +39,7 @@ const (
 )
 
 var podPhaseMetric = &metricspb.MetricDescriptor{
- Name: "k8s/pod/phase",
+ Name: "k8s.pod.phase",
  Description: "Current phase of the pod (1 - Pending, 2 - Running, 3 - Succeeded, 4 - Failed, 5 - Unknown)",
  Type: metricspb.MetricDescriptor_GAUGE_INT64,
 }

diff --git a/receiver/k8sclusterreceiver/collection/pods_test.go b/receiver/k8sclusterreceiver/collection/pods_test.go
@@ -60,7 +60,7 @@ func TestPodAndContainerMetrics(t *testing.T) {
  },
  )
 
- testutils.AssertMetrics(t, rm.Metrics[0], "k8s/pod/phase",
+ testutils.AssertMetrics(t, rm.Metrics[0], "k8s.pod.phase",
  metricspb.MetricDescriptor_GAUGE_INT64, 3)
 
  rm = rms[1]
@@ -79,16 +79,16 @@ func TestPodAndContainerMetrics(t *testing.T) {
  },
  )
 
- testutils.AssertMetrics(t, rm.Metrics[0], "k8s/container/restarts",
+ testutils.AssertMetrics(t, rm.Metrics[0], "k8s.container.restarts",
  metricspb.MetricDescriptor_GAUGE_INT64, 3)
 
- testutils.AssertMetrics(t, rm.Metrics[1], "k8s/container/ready",
+ testutils.AssertMetrics(t, rm.Metrics[1], "k8s.container.ready",
  metricspb.MetricDescriptor_GAUGE_INT64, 1)
 
- testutils.AssertMetrics(t, rm.Metrics[2], "k8s/container/cpu/request",
+ testutils.AssertMetrics(t, rm.Metrics[2], "k8s.container.cpu_request",
  metricspb.MetricDescriptor_GAUGE_INT64, 10000)
 
- testutils.AssertMetrics(t, rm.Metrics[3], "k8s/container/cpu/limit",
+ testutils.AssertMetrics(t, rm.Metrics[3], "k8s.container.cpu_limit",
  metricspb.MetricDescriptor_GAUGE_INT64, 20000)
 }
 

diff --git a/receiver/k8sclusterreceiver/collection/replica.go b/receiver/k8sclusterreceiver/collection/replica.go
@@ -26,7 +26,7 @@ func getReplicaMetrics(resource string, desired, available int32) []*metricspb.M
  return []*metricspb.Metric{
  {
  MetricDescriptor: &metricspb.MetricDescriptor{
- Name: fmt.Sprintf("k8s/%s/desired", resource),
+ Name: fmt.Sprintf("k8s.%s.desired", resource),
  Description: fmt.Sprintf("Number of desired pods in this %s", resource),
  Type: metricspb.MetricDescriptor_GAUGE_INT64,
  Unit: "1",
@@ -35,7 +35,7 @@ func getReplicaMetrics(resource string, desired, available int32) []*metricspb.M
  },
  {
  MetricDescriptor: &metricspb.MetricDescriptor{
- Name: fmt.Sprintf("k8s/%s/available", resource),
+ Name: fmt.Sprintf("k8s.%s.available", resource),
  Description: fmt.Sprintf("Total number of available pods (ready for at least minReadySeconds) targeted by this %s", resource),
  Type: metricspb.MetricDescriptor_GAUGE_INT64,
  Unit: "1",

diff --git a/receiver/k8sclusterreceiver/collection/replicasets.go b/receiver/k8sclusterreceiver/collection/replicasets.go
@@ -29,7 +29,7 @@ func getMetricsForReplicaSet(rs *appsv1.ReplicaSet) []*resourceMetrics {
  {
  resource: getResourceForReplicaSet(rs),
  metrics: getReplicaMetrics(
- "replica_set",
+ "replicaset",
  *rs.Spec.Replicas,
  rs.Status.AvailableReplicas,
  ),