knative.dev/pkg@v0.0.0-20260602142205-ac97e43f6622/observability/metrics/k8s/tools_test.go (about)

     1  /*
     2  Copyright 2025 The Knative Authors
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package k8s
    18  
    19  import (
    20  	"context"
    21  	"net/url"
    22  	"testing"
    23  	"time"
    24  
    25  	"knative.dev/pkg/observability/semconv"
    26  
    27  	"go.opentelemetry.io/otel"
    28  	"go.opentelemetry.io/otel/attribute"
    29  	sdkmetric "go.opentelemetry.io/otel/sdk/metric"
    30  	"go.opentelemetry.io/otel/sdk/metric/metricdata"
    31  	"knative.dev/pkg/observability/metrics/metricstest"
    32  )
    33  
    34  func TestNewClientMetricsProvider(t *testing.T) {
    35  	r := sdkmetric.NewManualReader()
    36  	provider := sdkmetric.NewMeterProvider(sdkmetric.WithReader(r))
    37  	p, err := NewClientMetricProvider(WithMeterProvider(provider))
    38  	if err != nil {
    39  		t.Fatal("unexpected error", err)
    40  	}
    41  
    42  	if p == nil {
    43  		t.Fatal("provider returned was nil")
    44  	}
    45  }
    46  
    47  func TestNewClientMetricsProviderGlobal(t *testing.T) {
    48  	r := sdkmetric.NewManualReader()
    49  	provider := sdkmetric.NewMeterProvider(sdkmetric.WithReader(r))
    50  	otel.SetMeterProvider(provider)
    51  	p, err := NewClientMetricProvider()
    52  	if err != nil {
    53  		t.Fatal("unexpected error", err)
    54  	}
    55  
    56  	if p == nil {
    57  		t.Fatal("provider returned was nil")
    58  	}
    59  }
    60  
    61  func TestLatencyMetric(t *testing.T) {
    62  	r := sdkmetric.NewManualReader()
    63  	provider := sdkmetric.NewMeterProvider(sdkmetric.WithReader(r))
    64  	p, err := NewClientMetricProvider(WithMeterProvider(provider))
    65  	if err != nil {
    66  		t.Fatal("unexpected error", err)
    67  	}
    68  
    69  	m := p.RequestLatencyMetric()
    70  	if m == nil {
    71  		t.Fatal("unexpected nil latency metric")
    72  	}
    73  
    74  	u, err := url.Parse("https://example.com/path")
    75  	if err != nil {
    76  		t.Fatal(err)
    77  	}
    78  
    79  	m.Observe(context.Background(), "GET", *u, time.Second)
    80  
    81  	bucketCounts := [15]uint64{}
    82  	bucketCounts[9] = 1
    83  
    84  	metricstest.AssertMetrics(t, r,
    85  		metricstest.MetricsEqual(
    86  			scopeName,
    87  			metricdata.Metrics{
    88  				Name:        "http.client.request.duration",
    89  				Unit:        "s",
    90  				Description: "Duration of HTTP client requests.",
    91  				Data: metricdata.Histogram[float64]{
    92  					Temporality: metricdata.CumulativeTemporality,
    93  					DataPoints: []metricdata.HistogramDataPoint[float64]{{
    94  						Bounds:       latencyBounds,
    95  						Count:        1,
    96  						Sum:          1,
    97  						BucketCounts: bucketCounts[:],
    98  						Min:          metricdata.NewExtrema[float64](1),
    99  						Max:          metricdata.NewExtrema[float64](1),
   100  						Attributes: attribute.NewSet(
   101  							semconv.ServerAddressKey.String("example.com"),
   102  							semconv.ServerPortKey.Int(443),
   103  							semconv.HTTPRequestMethodKey.String("GET"),
   104  							semconv.URLSchemeKey.String("https"),
   105  							semconv.URLTemplateKey.String("/path"),
   106  						),
   107  					}},
   108  				},
   109  			},
   110  		),
   111  	)
   112  }
   113  
   114  func TestResultMetric(t *testing.T) {
   115  	r := sdkmetric.NewManualReader()
   116  	provider := sdkmetric.NewMeterProvider(sdkmetric.WithReader(r))
   117  	p, err := NewClientMetricProvider(WithMeterProvider(provider))
   118  	if err != nil {
   119  		t.Fatal("unexpected error", err)
   120  	}
   121  
   122  	m := p.RequestResultMetric()
   123  	if m == nil {
   124  		t.Fatal("unexpected nil result metric")
   125  	}
   126  
   127  	m.Increment(context.Background(), "200", "GET", "example.com")
   128  
   129  	metricstest.AssertMetrics(t, r,
   130  		metricstest.MetricsEqual(
   131  			scopeName,
   132  			metricdata.Metrics{
   133  				Name:        resultMetricName,
   134  				Unit:        "{item}",
   135  				Description: resultMetricDescription,
   136  				Data: metricdata.Sum[int64]{
   137  					IsMonotonic: true,
   138  					Temporality: metricdata.CumulativeTemporality,
   139  					DataPoints: []metricdata.DataPoint[int64]{{
   140  						Attributes: attribute.NewSet(
   141  							semconv.ServerAddressKey.String("example.com"),
   142  							semconv.HTTPRequestMethodKey.String("GET"),
   143  							semconv.HTTPResponseStatusCodeKey.Int(200),
   144  						),
   145  						Value: 1,
   146  					}},
   147  				},
   148  			},
   149  		),
   150  	)
   151  }