opentelemetry-collector/receiver/hostmetricsreceiver/internal/scraper/cpuscraper/cpu_scraper_test.go

128 lines
4.4 KiB
Go

// Copyright The OpenTelemetry Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package cpuscraper
import (
"context"
"errors"
"runtime"
"testing"
"github.com/shirou/gopsutil/cpu"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"go.opentelemetry.io/collector/component/componenttest"
"go.opentelemetry.io/collector/model/pdata"
"go.opentelemetry.io/collector/receiver/hostmetricsreceiver/internal"
"go.opentelemetry.io/collector/receiver/hostmetricsreceiver/internal/metadata"
"go.opentelemetry.io/collector/receiver/scrapererror"
)
func TestScrape(t *testing.T) {
type testCase struct {
name string
bootTimeFunc func() (uint64, error)
timesFunc func(bool) ([]cpu.TimesStat, error)
expectedStartTime pdata.Timestamp
initializationErr string
expectedErr string
}
testCases := []testCase{
{
name: "Standard",
},
{
name: "Validate Start Time",
bootTimeFunc: func() (uint64, error) { return 100, nil },
expectedStartTime: 100 * 1e9,
},
{
name: "Boot Time Error",
bootTimeFunc: func() (uint64, error) { return 0, errors.New("err1") },
initializationErr: "err1",
},
{
name: "Times Error",
timesFunc: func(bool) ([]cpu.TimesStat, error) { return nil, errors.New("err2") },
expectedErr: "err2",
},
}
for _, test := range testCases {
t.Run(test.name, func(t *testing.T) {
scraper := newCPUScraper(context.Background(), &Config{})
if test.bootTimeFunc != nil {
scraper.bootTime = test.bootTimeFunc
}
if test.timesFunc != nil {
scraper.times = test.timesFunc
}
err := scraper.start(context.Background(), componenttest.NewNopHost())
if test.initializationErr != "" {
assert.EqualError(t, err, test.initializationErr)
return
}
require.NoError(t, err, "Failed to initialize cpu scraper: %v", err)
metrics, err := scraper.scrape(context.Background())
if test.expectedErr != "" {
assert.EqualError(t, err, test.expectedErr)
isPartial := scrapererror.IsPartialScrapeError(err)
assert.True(t, isPartial)
if isPartial {
assert.Equal(t, 1, err.(scrapererror.PartialScrapeError).Failed)
}
return
}
require.NoError(t, err, "Failed to scrape metrics: %v", err)
assert.Equal(t, 1, metrics.Len())
assertCPUMetricValid(t, metrics.At(0), metadata.Metrics.SystemCPUTime.New(), test.expectedStartTime)
if runtime.GOOS == "linux" {
assertCPUMetricHasLinuxSpecificStateLabels(t, metrics.At(0))
}
internal.AssertSameTimeStampForAllMetrics(t, metrics)
})
}
}
func assertCPUMetricValid(t *testing.T, metric pdata.Metric, descriptor pdata.Metric, startTime pdata.Timestamp) {
internal.AssertDescriptorEqual(t, descriptor, metric)
if startTime != 0 {
internal.AssertSumMetricStartTimeEquals(t, metric, startTime)
}
assert.GreaterOrEqual(t, metric.Sum().DataPoints().Len(), 4*runtime.NumCPU())
internal.AssertSumMetricLabelExists(t, metric, 0, metadata.Labels.Cpu)
internal.AssertSumMetricLabelHasValue(t, metric, 0, metadata.Labels.CPUState, metadata.LabelCPUState.User)
internal.AssertSumMetricLabelHasValue(t, metric, 1, metadata.Labels.CPUState, metadata.LabelCPUState.System)
internal.AssertSumMetricLabelHasValue(t, metric, 2, metadata.Labels.CPUState, metadata.LabelCPUState.Idle)
internal.AssertSumMetricLabelHasValue(t, metric, 3, metadata.Labels.CPUState, metadata.LabelCPUState.Interrupt)
}
func assertCPUMetricHasLinuxSpecificStateLabels(t *testing.T, metric pdata.Metric) {
internal.AssertSumMetricLabelHasValue(t, metric, 4, metadata.Labels.CPUState, metadata.LabelCPUState.Nice)
internal.AssertSumMetricLabelHasValue(t, metric, 5, metadata.Labels.CPUState, metadata.LabelCPUState.Softirq)
internal.AssertSumMetricLabelHasValue(t, metric, 6, metadata.Labels.CPUState, metadata.LabelCPUState.Steal)
internal.AssertSumMetricLabelHasValue(t, metric, 7, metadata.Labels.CPUState, metadata.LabelCPUState.Wait)
}