/* Copyright 2019 The Knative 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 metrics import ( "context" "fmt" "path" "testing" "knative.dev/pkg/metrics/metricskey" "knative.dev/pkg/metrics/metricstest" "github.com/google/go-cmp/cmp" "go.opencensus.io/resource" "go.opencensus.io/stats" "go.opencensus.io/stats/view" ) type cases struct { name string metricsConfig *metricsConfig measurement stats.Measurement resource resource.Resource } func TestRecordServing(t *testing.T) { measure := stats.Int64("request_count", "Number of reconcile operations", stats.UnitNone) // Increase the measurement value for each test case so that checking // the last value ensures the measurement has been recorded. shouldReportCases := []cases{{ name: "none stackdriver backend", metricsConfig: &metricsConfig{}, measurement: measure.M(1), }, { name: "stackdriver backend with supported metric", metricsConfig: &metricsConfig{ isStackdriverBackend: true, stackdriverMetricTypePrefix: "knative.dev/internal/serving/activator", }, measurement: measure.M(2), }, { name: "stackdriver backend with unsupported metric and allow custom metric", metricsConfig: &metricsConfig{ isStackdriverBackend: true, stackdriverMetricTypePrefix: "knative.dev/unsupported", }, measurement: measure.M(3), }} testRecord(t, measure, shouldReportCases) } func TestRecordEventing(t *testing.T) { measure := stats.Int64("event_count", "Number of event received", stats.UnitNone) // Increase the measurement value for each test case so that checking // the last value ensures the measurement has been recorded. shouldReportCases := []cases{{ name: "none stackdriver backend", metricsConfig: &metricsConfig{}, measurement: measure.M(1), }, { name: "stackdriver backend with supported metric", metricsConfig: &metricsConfig{ isStackdriverBackend: true, stackdriverMetricTypePrefix: "knative.dev/eventing/broker", }, measurement: measure.M(2), }, { name: "stackdriver backend with unsupported metric and allow custom metric", metricsConfig: &metricsConfig{ isStackdriverBackend: true, stackdriverMetricTypePrefix: "knative.dev/unsupported", }, measurement: measure.M(3), }} testRecord(t, measure, shouldReportCases) } func TestRecordBatch(t *testing.T) { ctx := context.Background() measure1 := stats.Int64("count1", "First counter", stats.UnitNone) measure2 := stats.Int64("count2", "Second counter", stats.UnitNone) v := []*view.View{{ Measure: measure1, Aggregation: view.LastValue(), }, { Measure: measure2, Aggregation: view.LastValue(), }} view.Register(v...) t.Cleanup(func() { view.Unregister(v...) }) metricsConfig := &metricsConfig{} measurement1 := measure1.M(1984) measurement2 := measure2.M(42) setCurMetricsConfig(metricsConfig) RecordBatch(ctx, measurement1, measurement2) metricstest.CheckLastValueData(t, measurement1.Measure().Name(), map[string]string{}, 1984) metricstest.CheckLastValueData(t, measurement2.Measure().Name(), map[string]string{}, 42) } func testRecord(t *testing.T, measure *stats.Int64Measure, shouldReportCases []cases) { t.Helper() ctx := context.Background() v := &view.View{ Measure: measure, Aggregation: view.LastValue(), } view.Register(v) defer view.Unregister(v) for _, test := range shouldReportCases { t.Run(test.name, func(t *testing.T) { setCurMetricsConfig(test.metricsConfig) Record(ctx, test.measurement) metricstest.CheckLastValueData(t, test.measurement.Measure().Name(), map[string]string{}, test.measurement.Value()) }) } shouldNotReportCases := []cases{{ // Use a different value for the measurement other than the last one of shouldReportCases name: "stackdriver backend with unsupported metric but not allow custom metric", metricsConfig: &metricsConfig{ isStackdriverBackend: true, stackdriverMetricTypePrefix: "knative.dev/unsupported", recorder: func(ctx context.Context, mss []stats.Measurement, ros ...stats.Options) error { metricType := path.Join("knative.dev/unsupported", mss[0].Measure().Name()) if metricskey.KnativeRevisionMetrics.Has(metricType) || metricskey.KnativeTriggerMetrics.Has(metricType) { ros = append(ros, stats.WithMeasurements(mss[0])) return stats.RecordWithOptions(ctx, ros...) } return nil }, }, measurement: measure.M(5), }, { name: "empty metricsConfig", measurement: measure.M(4), }, { name: "none backend", metricsConfig: &metricsConfig{backendDestination: none}, measurement: measure.M(4), }} for _, test := range shouldNotReportCases { t.Run(test.name, func(t *testing.T) { setCurMetricsConfig(test.metricsConfig) Record(ctx, test.measurement) metricstest.CheckLastValueData(t, test.measurement.Measure().Name(), map[string]string{}, float64(len(shouldReportCases))) // The value is still the last one of shouldReportCases }) } } func TestBucketsNBy10(t *testing.T) { tests := []struct { base float64 n int want []float64 }{{ base: 0.001, n: 5, want: []float64{0.001, 0.01, 0.1, 1, 10}, }, { base: 1, n: 2, want: []float64{1, 10}, }, { base: 0.5, n: 4, want: []float64{0.5, 5, 50, 500}, }} for _, test := range tests { t.Run(fmt.Sprintf("base=%f,n=%d", test.base, test.n), func(t *testing.T) { got := BucketsNBy10(test.base, test.n) if diff := cmp.Diff(got, test.want); diff != "" { t.Errorf("BucketsNBy10 (-want, +got) = %s", diff) } }) } } func TestMeter(t *testing.T) { measure := stats.Int64("request_count", "Number of reconcile operations", stats.UnitNone) // Increase the measurement value for each test case so that checking // the last value ensures the measurement has been recorded. meterTestCases := []cases{{ name: "resource 1", metricsConfig: &metricsConfig{}, measurement: measure.M(1), resource: resource.Resource{Type: "resource 1", Labels: map[string]string{"bar": "foo"}}, }, { name: "resource 2", metricsConfig: &metricsConfig{}, measurement: measure.M(2), resource: resource.Resource{Type: "resource 2", Labels: map[string]string{"bar": "foo", "bar1": "foo1"}}, }} v := &view.View{ Measure: measure, Aggregation: view.LastValue(), } RegisterResourceView(v) t.Cleanup(func() { UnregisterResourceView(v) }) for _, test := range meterTestCases { t.Run(test.name, func(t *testing.T) { ctx := context.Background() ctx = metricskey.WithResource(ctx, test.resource) meter := meterExporterForResource(metricskey.GetResource(ctx)).m setCurMetricsConfig(test.metricsConfig) Record(ctx, test.measurement) metricstest.CheckLastValueDataWithMeter(t, test.measurement.Measure().Name(), map[string]string{}, test.measurement.Value(), meter) }) } }