...

Source file src/go.opencensus.io/stats/record_test.go

Documentation: go.opencensus.io/stats

     1  // Copyright 2019, OpenCensus Authors
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package stats_test
    16  
    17  import (
    18  	"context"
    19  	"log"
    20  	"reflect"
    21  	"testing"
    22  	"time"
    23  
    24  	"github.com/google/go-cmp/cmp"
    25  	"github.com/google/go-cmp/cmp/cmpopts"
    26  
    27  	"go.opencensus.io/metric/metricdata"
    28  	"go.opencensus.io/stats"
    29  	"go.opencensus.io/stats/view"
    30  	"go.opencensus.io/tag"
    31  	"go.opencensus.io/trace"
    32  )
    33  
    34  var (
    35  	tid     = trace.TraceID{1, 2, 3, 4, 5, 6, 7, 8, 1, 2, 4, 8, 16, 32, 64, 128}
    36  	sid     = trace.SpanID{1, 2, 4, 8, 16, 32, 64, 128}
    37  	spanCtx = trace.SpanContext{
    38  		TraceID:      tid,
    39  		SpanID:       sid,
    40  		TraceOptions: 1,
    41  	}
    42  )
    43  
    44  func TestRecordWithAttachments(t *testing.T) {
    45  	k1 := tag.MustNewKey("k1")
    46  	k2 := tag.MustNewKey("k2")
    47  	distribution := view.Distribution(5, 10)
    48  	m := stats.Int64("TestRecordWithAttachments/m1", "", stats.UnitDimensionless)
    49  	v := &view.View{
    50  		Name:        "test_view",
    51  		TagKeys:     []tag.Key{k1, k2},
    52  		Measure:     m,
    53  		Aggregation: distribution,
    54  	}
    55  	view.SetReportingPeriod(100 * time.Millisecond)
    56  	if err := view.Register(v); err != nil {
    57  		log.Fatalf("Failed to register views: %v", err)
    58  	}
    59  	defer view.Unregister(v)
    60  
    61  	attachments := map[string]interface{}{metricdata.AttachmentKeySpanContext: spanCtx}
    62  	stats.RecordWithOptions(context.Background(), stats.WithAttachments(attachments), stats.WithMeasurements(m.M(12)))
    63  	rows, err := view.RetrieveData("test_view")
    64  	if err != nil {
    65  		t.Errorf("Failed to retrieve data %v", err)
    66  	}
    67  	if len(rows) == 0 {
    68  		t.Errorf("No data was recorded.")
    69  	}
    70  	data := rows[0].Data
    71  	dis, ok := data.(*view.DistributionData)
    72  	if !ok {
    73  		t.Errorf("want DistributionData, got %+v", data)
    74  	}
    75  	wantBuckets := []int64{0, 0, 1}
    76  	if !reflect.DeepEqual(dis.CountPerBucket, wantBuckets) {
    77  		t.Errorf("want buckets %v, got %v", wantBuckets, dis.CountPerBucket)
    78  	}
    79  	for i, e := range dis.ExemplarsPerBucket {
    80  		// Exemplar slice should be [nil, nil, exemplar]
    81  		if i != 2 && e != nil {
    82  			t.Errorf("want nil exemplar, got %v", e)
    83  		}
    84  		if i == 2 {
    85  			wantExemplar := &metricdata.Exemplar{Value: 12, Attachments: attachments}
    86  			if diff := cmpExemplar(e, wantExemplar); diff != "" {
    87  				t.Fatalf("Unexpected Exemplar -got +want: %s", diff)
    88  			}
    89  		}
    90  	}
    91  }
    92  
    93  // Compare exemplars while ignoring exemplar timestamp, since timestamp is non-deterministic.
    94  func cmpExemplar(got, want *metricdata.Exemplar) string {
    95  	return cmp.Diff(got, want, cmpopts.IgnoreFields(metricdata.Exemplar{}, "Timestamp"), cmpopts.IgnoreUnexported(metricdata.Exemplar{}))
    96  }
    97  
    98  func TestRecordWithMeter(t *testing.T) {
    99  	meter := view.NewMeter()
   100  	meter.Start()
   101  	defer meter.Stop()
   102  	k1 := tag.MustNewKey("k1")
   103  	k2 := tag.MustNewKey("k2")
   104  	m1 := stats.Int64("TestResolveOptions/m1", "", stats.UnitDimensionless)
   105  	m2 := stats.Int64("TestResolveOptions/m2", "", stats.UnitDimensionless)
   106  	v := []*view.View{{
   107  		Name:        "test_view",
   108  		TagKeys:     []tag.Key{k1, k2},
   109  		Measure:     m1,
   110  		Aggregation: view.Distribution(5, 10),
   111  	}, {
   112  		Name:        "second_view",
   113  		TagKeys:     []tag.Key{k1},
   114  		Measure:     m2,
   115  		Aggregation: view.Count(),
   116  	}}
   117  	meter.SetReportingPeriod(100 * time.Millisecond)
   118  	if err := meter.Register(v...); err != nil {
   119  		t.Fatalf("Failed to register view: %v", err)
   120  	}
   121  	defer meter.Unregister(v...)
   122  
   123  	attachments := map[string]interface{}{metricdata.AttachmentKeySpanContext: spanCtx}
   124  	ctx, err := tag.New(context.Background(), tag.Insert(k1, "foo"), tag.Insert(k2, "foo"))
   125  	if err != nil {
   126  		t.Fatalf("Failed to set context: %v", err)
   127  	}
   128  	err = stats.RecordWithOptions(ctx,
   129  		stats.WithTags(tag.Upsert(k1, "bar"), tag.Insert(k2, "bar")),
   130  		stats.WithAttachments(attachments),
   131  		stats.WithMeasurements(m1.M(12), m1.M(6), m2.M(5)),
   132  		stats.WithRecorder(meter))
   133  	if err != nil {
   134  		t.Fatalf("Failed to resolve data point: %v", err)
   135  	}
   136  
   137  	rows, err := meter.RetrieveData("test_view")
   138  	if err != nil {
   139  		t.Fatalf("Unable to retrieve data for test_view: %v", err)
   140  	}
   141  	if len(rows) != 1 {
   142  		t.Fatalf("Expected one row, got %d rows: %+v", len(rows), rows)
   143  	}
   144  	if len(rows[0].Tags) != 2 {
   145  		t.Errorf("Wrong number of tags %d: %v", len(rows[0].Tags), rows[0].Tags)
   146  	}
   147  	// k2 was Insert() ed, and shouldn't update the value that was in the supplied context.
   148  	wantTags := []tag.Tag{{Key: k1, Value: "bar"}, {Key: k2, Value: "foo"}}
   149  	for i, tag := range rows[0].Tags {
   150  		if tag.Key != wantTags[i].Key {
   151  			t.Errorf("Incorrect tag %d, want: %q, got: %q", i, wantTags[i].Key, tag.Key)
   152  		}
   153  		if tag.Value != wantTags[i].Value {
   154  			t.Errorf("Incorrect tag for %s, want: %q, got: %v", tag.Key, wantTags[i].Value, tag.Value)
   155  		}
   156  
   157  	}
   158  	wantBuckets := []int64{0, 1, 1}
   159  	gotBuckets := rows[0].Data.(*view.DistributionData)
   160  	if !reflect.DeepEqual(gotBuckets.CountPerBucket, wantBuckets) {
   161  		t.Fatalf("want buckets %v, got %v", wantBuckets, gotBuckets)
   162  	}
   163  	for i, e := range gotBuckets.ExemplarsPerBucket {
   164  		if gotBuckets.CountPerBucket[i] == 0 {
   165  			if e != nil {
   166  				t.Errorf("Unexpected exemplar for bucket")
   167  			}
   168  			continue
   169  		}
   170  		// values from the metrics above
   171  		exemplarValues := []float64{0, 6, 12}
   172  		wantExemplar := &metricdata.Exemplar{Value: exemplarValues[i], Attachments: attachments}
   173  		if diff := cmpExemplar(e, wantExemplar); diff != "" {
   174  			t.Errorf("Bad exemplar for %d: %+v", i, diff)
   175  		}
   176  	}
   177  
   178  	rows2, err := meter.RetrieveData("second_view")
   179  	if err != nil {
   180  		t.Fatalf("Failed to read second_view: %v", err)
   181  	}
   182  	if len(rows2) != 1 {
   183  		t.Fatalf("Expected one row, got %d rows: %v", len(rows2), rows2)
   184  	}
   185  	if len(rows2[0].Tags) != 1 {
   186  		t.Errorf("Expected one tag, got %d tags: %v", len(rows2[0].Tags), rows2[0].Tags)
   187  	}
   188  	wantTags = []tag.Tag{{Key: k1, Value: "bar"}}
   189  	for i, tag := range rows2[0].Tags {
   190  		if wantTags[i].Key != tag.Key {
   191  			t.Errorf("Wrong key for %d, want %q, got %q", i, wantTags[i].Key, tag.Key)
   192  		}
   193  		if wantTags[i].Value != tag.Value {
   194  			t.Errorf("Wrong value for tag %s, want %q got %q", tag.Key, wantTags[i].Value, tag.Value)
   195  		}
   196  	}
   197  	gotCount := rows2[0].Data.(*view.CountData)
   198  	if gotCount.Value != 1 {
   199  		t.Errorf("Wrong count for second_view, want %d, got %d", 1, gotCount.Value)
   200  	}
   201  }
   202  

View as plain text