-
Notifications
You must be signed in to change notification settings - Fork 98
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Allow custom display name format for spans (#45) #48
Merged
james-bebbington
merged 6 commits into
GoogleCloudPlatform:master
from
stevencl1013:display-name-formatter
Jun 30, 2020
Merged
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
0ba19c7
allow users to use their own display name format for spans
stevencl1013 92f163a
add test for custom span display name format
stevencl1013 680ab22
make separate function to generate displayName
stevencl1013 44456f2
Merge branch 'master' into display-name-formatter
stevencl1013 d3e76d7
update test to use bundler+syncer instead of batcher
stevencl1013 ee614e7
take out some nesting in generateDisplayName function
stevencl1013 File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
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
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 | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -60,25 +60,33 @@ const ( | |||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||
var userAgent = fmt.Sprintf("opentelemetry-go %s; cloudtrace-exporter %s", opentelemetry.Version(), version) | ||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||
func protoFromSpanData(s *export.SpanData, projectID string) *tracepb.Span { | ||||||||||||||||||||||||||||||||||||||
func generateDisplayName(s *export.SpanData, format DisplayNameFormatter) (displayName string) { | ||||||||||||||||||||||||||||||||||||||
if format == nil { | ||||||||||||||||||||||||||||||||||||||
switch s.SpanKind { | ||||||||||||||||||||||||||||||||||||||
// TODO(ymotongpoo): add cases for "Send" and "Recv". | ||||||||||||||||||||||||||||||||||||||
default: | ||||||||||||||||||||||||||||||||||||||
displayName = fmt.Sprintf("Span.%s-%s", s.SpanKind, s.Name) | ||||||||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||||||||
} else { | ||||||||||||||||||||||||||||||||||||||
displayName = format(s) | ||||||||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It's always a little easier to read code if you minimize nesting imo:
Suggested change
|
||||||||||||||||||||||||||||||||||||||
return | ||||||||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||
func protoFromSpanData(s *export.SpanData, projectID string, format DisplayNameFormatter) *tracepb.Span { | ||||||||||||||||||||||||||||||||||||||
if s == nil { | ||||||||||||||||||||||||||||||||||||||
return nil | ||||||||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||
traceIDString := s.SpanContext.TraceID.String() | ||||||||||||||||||||||||||||||||||||||
spanIDString := s.SpanContext.SpanID.String() | ||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||
name := s.Name | ||||||||||||||||||||||||||||||||||||||
switch s.SpanKind { | ||||||||||||||||||||||||||||||||||||||
// TODO(ymotongpoo): add cases for "Send" and "Recv". | ||||||||||||||||||||||||||||||||||||||
default: | ||||||||||||||||||||||||||||||||||||||
name = fmt.Sprintf("Span.%s-%s", s.SpanKind, name) | ||||||||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||||||||
displayName := generateDisplayName(s, format) | ||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||
sp := &tracepb.Span{ | ||||||||||||||||||||||||||||||||||||||
Name: "projects/" + projectID + "/traces/" + traceIDString + "/spans/" + spanIDString, | ||||||||||||||||||||||||||||||||||||||
SpanId: spanIDString, | ||||||||||||||||||||||||||||||||||||||
DisplayName: trunc(name, 128), | ||||||||||||||||||||||||||||||||||||||
DisplayName: trunc(displayName, 128), | ||||||||||||||||||||||||||||||||||||||
StartTime: timestampProto(s.StartTime), | ||||||||||||||||||||||||||||||||||||||
EndTime: timestampProto(s.EndTime), | ||||||||||||||||||||||||||||||||||||||
SameProcessAsParentSpan: &wrapperspb.BoolValue{Value: !s.HasRemoteParent}, | ||||||||||||||||||||||||||||||||||||||
|
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.
Sleeping for a block amount of time in tests in never ideal. To make this signficiantly more robust, and faster, a better alternative to this is to do something like
I wouldn't bother changing this now though. After you add the
NewPipeline
method that returns a flush function (see the Jaeger exporter), you can avoid the sleep here entirely.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.
ok, sounds good. I'll leave this for now, and when I create the
NewPipeline
method, I plan to update this test and others to use the pipeline and flush function as appropriate.