Skip to content

Commit

Permalink
Added tests for node cpu metrics being reported as double cpu units w…
Browse files Browse the repository at this point in the history 
…ith the feature gate enabled
  • Loading branch information
@jvoravong
jvoravong committed Mar 8, 2022
1 parent 4ca4ef3 commit 903c883
Show file tree
Hide file tree
Showing 2 changed files with 144 additions and 12 deletions.
78 changes: 72 additions & 6 deletions receiver/k8sclusterreceiver/internal/collection/nodes_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import (

metricspb "github.com/census-instrumentation/opencensus-proto/gen-go/metrics/v1"
"github.com/stretchr/testify/require"
"go.opentelemetry.io/collector/service/featuregate"
"go.uber.org/zap"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/resource"
Expand All @@ -28,7 +29,9 @@ import (
"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/k8sclusterreceiver/internal/testutils"
)

func TestNodeMetrics(t *testing.T) {
func TestNodeMetricsReportCPUMetricsAsInt(t *testing.T) {
// disable the feature gate
featuregate.Apply(map[string]bool{reportCPUMetricsAsDoubleFeatureGateID: false})
n := newNode("1")

actualResourceMetrics := getMetricsForNode(n, []string{"Ready", "MemoryPressure"}, []string{"cpu", "memory", "ephemeral-storage", "storage"}, zap.NewNop())
Expand All @@ -44,24 +47,87 @@ func TestNodeMetrics(t *testing.T) {
},
)

testutils.AssertMetrics(t, actualResourceMetrics[0].metrics[0], "k8s.node.condition_ready",
testutils.AssertMetricsInt(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.AssertMetricsInt(t, actualResourceMetrics[0].metrics[1], "k8s.node.condition_memory_pressure",
metricspb.MetricDescriptor_GAUGE_INT64, 0)

testutils.AssertMetrics(t, actualResourceMetrics[0].metrics[2], "k8s.node.allocatable_cpu",
testutils.AssertMetricsInt(t, actualResourceMetrics[0].metrics[2], "k8s.node.allocatable_cpu",
metricspb.MetricDescriptor_GAUGE_INT64, 123)

testutils.AssertMetrics(t, actualResourceMetrics[0].metrics[3], "k8s.node.allocatable_memory",
testutils.AssertMetricsInt(t, actualResourceMetrics[0].metrics[3], "k8s.node.allocatable_memory",
metricspb.MetricDescriptor_GAUGE_INT64, 456)

testutils.AssertMetrics(t, actualResourceMetrics[0].metrics[4], "k8s.node.allocatable_ephemeral_storage",
testutils.AssertMetricsInt(t, actualResourceMetrics[0].metrics[4], "k8s.node.allocatable_ephemeral_storage",
metricspb.MetricDescriptor_GAUGE_INT64, 1234)
}

func TestNodeMetricsReportCPUMetricsAsDouble(t *testing.T) {
// enable the feature gate
featuregate.Apply(map[string]bool{reportCPUMetricsAsDoubleFeatureGateID: true})
n := newNode("1")

actualResourceMetrics := getMetricsForNode(n, []string{"Ready", "MemoryPressure"}, []string{"cpu", "memory", "ephemeral-storage", "storage"}, zap.NewNop())

require.Equal(t, 1, len(actualResourceMetrics))

require.Equal(t, 5, len(actualResourceMetrics[0].metrics))
testutils.AssertResource(t, actualResourceMetrics[0].resource, k8sType,
map[string]string{
"k8s.node.uid": "test-node-1-uid",
"k8s.node.name": "test-node-1",
"k8s.cluster.name": "test-cluster",
},
)

testutils.AssertMetricsInt(t, actualResourceMetrics[0].metrics[0], "k8s.node.condition_ready",
metricspb.MetricDescriptor_GAUGE_INT64, 1)

testutils.AssertMetricsInt(t, actualResourceMetrics[0].metrics[1], "k8s.node.condition_memory_pressure",
metricspb.MetricDescriptor_GAUGE_INT64, 0)

testutils.AssertMetricsDouble(t, actualResourceMetrics[0].metrics[2], "k8s.node.allocatable_cpu",
metricspb.MetricDescriptor_GAUGE_DOUBLE, 3.14)

testutils.AssertMetricsInt(t, actualResourceMetrics[0].metrics[3], "k8s.node.allocatable_memory",
metricspb.MetricDescriptor_GAUGE_INT64, 456)

testutils.AssertMetricsInt(t, actualResourceMetrics[0].metrics[4], "k8s.node.allocatable_ephemeral_storage",
metricspb.MetricDescriptor_GAUGE_INT64, 1234)
}

func newNode(id string) *corev1.Node {
if featuregate.IsEnabled(reportCPUMetricsAsDoubleFeatureGateID) {
return &corev1.Node{
ObjectMeta: v1.ObjectMeta{
Name: "test-node-" + id,
UID: types.UID("test-node-" + id + "-uid"),
ClusterName: "test-cluster",
Labels: map[string]string{
"foo": "bar",
"foo1": "",
},
},
Status: corev1.NodeStatus{
Conditions: []corev1.NodeCondition{
{
Type: corev1.NodeReady,
Status: corev1.ConditionTrue,
},
{
Status: corev1.ConditionFalse,
Type: corev1.NodeMemoryPressure,
},
},
Allocatable: corev1.ResourceList{
corev1.ResourceCPU: *resource.NewMilliQuantity(3140, resource.DecimalSI),
corev1.ResourceMemory: *resource.NewQuantity(456, resource.DecimalSI),
corev1.ResourceEphemeralStorage: *resource.NewQuantity(1234, resource.DecimalSI),
},
},
}
}
return &corev1.Node{
ObjectMeta: v1.ObjectMeta{
Name: "test-node-" + id,
Expand Down
78 changes: 72 additions & 6 deletions receiver/k8sclusterreceiver/internal/collection/pods_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (
metricspb "github.com/census-instrumentation/opencensus-proto/gen-go/metrics/v1"
resourcepb "github.com/census-instrumentation/opencensus-proto/gen-go/resource/v1"
"github.com/stretchr/testify/require"
"go.opentelemetry.io/collector/service/featuregate"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"go.uber.org/zap/zaptest/observer"
Expand All @@ -34,7 +35,10 @@ import (
"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/k8sclusterreceiver/internal/testutils"
)

func TestPodAndContainerMetrics(t *testing.T) {
func TestPodAndContainerMetricsReportCPUMetricsAsInt(t *testing.T) {
// disable the feature gate
featuregate.Apply(map[string]bool{reportCPUMetricsAsDoubleFeatureGateID: false})

pod := newPodWithContainer(
"1",
podSpecWithContainer("container-name"),
Expand All @@ -60,7 +64,7 @@ func TestPodAndContainerMetrics(t *testing.T) {
},
)

testutils.AssertMetrics(t, rm.Metrics[0], "k8s.pod.phase",
testutils.AssertMetricsInt(t, rm.Metrics[0], "k8s.pod.phase",
metricspb.MetricDescriptor_GAUGE_INT64, 3)

rm = rms[1]
Expand All @@ -80,19 +84,81 @@ func TestPodAndContainerMetrics(t *testing.T) {
},
)

testutils.AssertMetrics(t, rm.Metrics[0], "k8s.container.restarts",
testutils.AssertMetricsInt(t, rm.Metrics[0], "k8s.container.restarts",
metricspb.MetricDescriptor_GAUGE_INT64, 3)

testutils.AssertMetrics(t, rm.Metrics[1], "k8s.container.ready",
testutils.AssertMetricsInt(t, rm.Metrics[1], "k8s.container.ready",
metricspb.MetricDescriptor_GAUGE_INT64, 1)

testutils.AssertMetrics(t, rm.Metrics[2], "k8s.container.cpu_request",
testutils.AssertMetricsInt(t, rm.Metrics[2], "k8s.container.cpu_request",
metricspb.MetricDescriptor_GAUGE_INT64, 10000)

testutils.AssertMetrics(t, rm.Metrics[3], "k8s.container.cpu_limit",
testutils.AssertMetricsInt(t, rm.Metrics[3], "k8s.container.cpu_limit",
metricspb.MetricDescriptor_GAUGE_INT64, 20000)
}

func TestPodAndContainerMetricsReportCPUMetricsAsDouble(t *testing.T) {
// enable the feature gate
featuregate.Apply(map[string]bool{reportCPUMetricsAsDoubleFeatureGateID: true})

pod := newPodWithContainer(
"1",
podSpecWithContainer("container-name"),
podStatusWithContainer("container-name", containerIDWithPreifx("container-id")),
)
dc := NewDataCollector(zap.NewNop(), []string{}, []string{})

dc.SyncMetrics(pod)
actualResourceMetrics := dc.metricsStore.metricsCache

rms := actualResourceMetrics["test-pod-1-uid"]
require.NotNil(t, rms)

rm := rms[0]
require.Equal(t, 1, len(rm.Metrics))
testutils.AssertResource(t, rm.Resource, k8sType,
map[string]string{
"k8s.pod.uid": "test-pod-1-uid",
"k8s.pod.name": "test-pod-1",
"k8s.node.name": "test-node",
"k8s.namespace.name": "test-namespace",
"k8s.cluster.name": "test-cluster",
},
)

testutils.AssertMetricsInt(t, rm.Metrics[0], "k8s.pod.phase",
metricspb.MetricDescriptor_GAUGE_INT64, 3)

rm = rms[1]

require.Equal(t, 4, len(rm.Metrics))
testutils.AssertResource(t, rm.Resource, "container",
map[string]string{
"container.id": "container-id",
"k8s.container.name": "container-name",
"container.image.name": "container-image-name",
"container.image.tag": "latest",
"k8s.pod.uid": "test-pod-1-uid",
"k8s.pod.name": "test-pod-1",
"k8s.node.name": "test-node",
"k8s.namespace.name": "test-namespace",
"k8s.cluster.name": "test-cluster",
},
)

testutils.AssertMetricsInt(t, rm.Metrics[0], "k8s.container.restarts",
metricspb.MetricDescriptor_GAUGE_INT64, 3)

testutils.AssertMetricsInt(t, rm.Metrics[1], "k8s.container.ready",
metricspb.MetricDescriptor_GAUGE_INT64, 1)

testutils.AssertMetricsDouble(t, rm.Metrics[2], "k8s.container.cpu_request",
metricspb.MetricDescriptor_GAUGE_DOUBLE, 10.0)

testutils.AssertMetricsDouble(t, rm.Metrics[3], "k8s.container.cpu_limit",
metricspb.MetricDescriptor_GAUGE_DOUBLE, 20.0)
}

func newPodWithContainer(id string, spec *corev1.PodSpec, status *corev1.PodStatus) *corev1.Pod {
return &corev1.Pod{
ObjectMeta: v1.ObjectMeta{
Expand Down

0 comments on commit 903c883

Please sign in to comment.