This repository has been archived by the owner on Jul 31, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 327
Exemplar: Add new record APIs that take exemplar attachments and SpanContext key. #1123
Merged
Merged
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
44a060a
Exemplar: Add SpanContext Attachment key.
songy23 5348178
Exemplar: Add new record APIs that take exemplar attachments.
songy23 06bc010
Use RetrieveData instead of fake exporter to fix race.
songy23 745cd2a
Change map[string]interface to metricdata.Attachments
songy23 b3ae5af
Use nil instead of empty map.
songy23 0d5b2d8
Update to use options for recording attachments.
songy23 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,95 @@ | ||
// Copyright 2019, OpenCensus 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 stats_test | ||
|
||
import ( | ||
"context" | ||
"log" | ||
"reflect" | ||
"testing" | ||
"time" | ||
|
||
"github.com/google/go-cmp/cmp" | ||
"github.com/google/go-cmp/cmp/cmpopts" | ||
|
||
"go.opencensus.io/metric/metricdata" | ||
"go.opencensus.io/stats" | ||
"go.opencensus.io/stats/view" | ||
"go.opencensus.io/tag" | ||
"go.opencensus.io/trace" | ||
) | ||
|
||
var ( | ||
tid = trace.TraceID{1, 2, 3, 4, 5, 6, 7, 8, 1, 2, 4, 8, 16, 32, 64, 128} | ||
sid = trace.SpanID{1, 2, 4, 8, 16, 32, 64, 128} | ||
spanCtx = trace.SpanContext{ | ||
TraceID: tid, | ||
SpanID: sid, | ||
TraceOptions: 1, | ||
} | ||
) | ||
|
||
func TestRecordWithAttachments(t *testing.T) { | ||
k1, _ := tag.NewKey("k1") | ||
k2, _ := tag.NewKey("k2") | ||
distribution := view.Distribution(5, 10) | ||
m := stats.Int64("TestRecordWithAttachments/m1", "", stats.UnitDimensionless) | ||
v := &view.View{ | ||
Name: "test_view", | ||
TagKeys: []tag.Key{k1, k2}, | ||
Measure: m, | ||
Aggregation: distribution, | ||
} | ||
view.SetReportingPeriod(100 * time.Millisecond) | ||
if err := view.Register(v); err != nil { | ||
log.Fatalf("Failed to register views: %v", err) | ||
} | ||
|
||
attachments := map[string]interface{}{metricdata.AttachmentKeySpanContext: spanCtx} | ||
stats.RecordWithAttachments(context.Background(), attachments, m.M(12)) | ||
rows, err := view.RetrieveData("test_view") | ||
if err != nil { | ||
t.Errorf("Failed to retrieve data %v", err) | ||
} | ||
if len(rows) == 0 { | ||
t.Errorf("No data was recorded.") | ||
} | ||
data := rows[0].Data | ||
dis, ok := data.(*view.DistributionData) | ||
if !ok { | ||
t.Errorf("want DistributionData, got %+v", data) | ||
} | ||
wantBuckets := []int64{0, 0, 1} | ||
if !reflect.DeepEqual(dis.CountPerBucket, wantBuckets) { | ||
t.Errorf("want buckets %v, got %v", wantBuckets, dis.CountPerBucket) | ||
} | ||
for i, e := range dis.ExemplarsPerBucket { | ||
// Exemplar slice should be [nil, nil, exemplar] | ||
if i != 2 && e != nil { | ||
t.Errorf("want nil exemplar, got %v", e) | ||
} | ||
if i == 2 { | ||
wantExemplar := &metricdata.Exemplar{Value: 12, Attachments: attachments} | ||
if diff := cmpExemplar(e, wantExemplar); diff != "" { | ||
t.Fatalf("Unexpected Exemplar -got +want: %s", diff) | ||
} | ||
} | ||
} | ||
} | ||
|
||
// Compare exemplars while ignoring exemplar timestamp, since timestamp is non-deterministic. | ||
func cmpExemplar(got, want *metricdata.Exemplar) string { | ||
return cmp.Diff(got, want, cmpopts.IgnoreFields(metricdata.Exemplar{}, "Timestamp"), cmpopts.IgnoreUnexported(metricdata.Exemplar{})) | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it make sense to have RecordWithOptions api instead of withAttachment, withTag, WithAttacmentAndTag?
Similar to what we have in gauges (AddInt64Gauge).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For
Attachments
that makes sense, though I suggest we still keep therecordWithTags
API since it covers most of the use cases and it's easier to use than creatingoptions
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
SG
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated in 0d5b2d8.