Skip to content
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.

Sign up for GitHub

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

Jump to bottom

otelgin: add routeName argument to SpanNameFormatter function #5741

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

otelgin: add routeName argument to SpanNameFormatter function #5741

wants to merge 8 commits into from

Conversation

NeoCN
Copy link
Contributor

@NeoCN NeoCN commented Jun 6, 2024 •
edited
Loading

For Gin framework, the route name can only be get by using FullPath() function in gin.Context, the original SpanNameFormatter only has the http.Request argument that can not get the right route name if route parameters used.

This PR add routeName argument to SpanNameFormatter function, align with SpanNameFormatter in otelmux.

@NeoCN NeoCN requested a review from hanyuancheung as a code owner June 6, 2024 04:57
@NeoCN NeoCN requested a review from a team June 6, 2024 04:57
dmathieu
dmathieu reviewed Jun 6, 2024
View reviewed changes
Copy link
Member

@dmathieu dmathieu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We had #4280 which didn't get traction, but did the same thing, using *gin.Context instead of a new argument.
Are there any other information from the gin context we may want to use in span name formatter?

CHANGELOG.md Outdated Show resolved Hide resolved
@NeoCN @dmathieu
Update CHANGELOG.md
bd5f50c 
Co-authored-by: Damien Mathieu <[email protected]>
@NeoCN
Copy link
Contributor Author

NeoCN commented Jun 6, 2024

@dmathieu Currently no other info needed from the gin.Context. Honestly, using gin.Context will be more flexible as lots of things can be got from the context. Do we need the flexibility ?

@codecov Codecov
Copy link

codecov bot commented Jun 6, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.6%. Comparing base (0a25107) to head (1fd7392).

Additional details and impacted files

Impacted file tree graph

@@          Coverage Diff          @@
##            main   #5741   +/-   ##
=====================================
  Coverage   66.6%   66.6%           
=====================================
  Files        192     192           
  Lines      15525   15525           
=====================================
+ Hits       10351   10354    +3     
+ Misses      4883    4881    -2     
+ Partials     291     290    -1
Files with missing lines Coverage Δ
...ation/github.com/gin-gonic/gin/otelgin/gintrace.go 84.0% <100.0%> (ø)
...ntation/github.com/gin-gonic/gin/otelgin/option.go 100.0% <100.0%> (ø)

... and 1 file with indirect coverage changes

@NeoCN NeoCN requested a review from dmathieu June 7, 2024 05:47
@dmathieu
Copy link
Member

Ping @hanyuancheung

@NeoCN
Copy link
Contributor Author

NeoCN commented Jun 17, 2024

@dmathieu @hanyuancheung Any suggestions for this PR?

@NeoCN
Copy link
Contributor Author

NeoCN commented Jul 10, 2024

@hanyuancheung Any suggestions? Or any principles to follow?

@NeoCN NeoCN requested a review from a team as a code owner October 21, 2024 09:35
@NeoCN
Copy link
Contributor Author

NeoCN commented Oct 21, 2024 •
edited
Loading

@dmathieu @hanyuancheung Do you have any suggestions for this PR? Or should I change to add new function like WithSpanNameGinFormatter ?

@dmathieu
Copy link
Member

otelgin is now deprecated due to a lack of owner: #6190
While we would be happy to get a new owner for this package, I'm not sure introducing breaking changes at this stage makes sense.
If you're interested in stepping up to own this package, I'd recommend starting with smaller, more trivial changes.

flc1125
flc1125 suggested changes Nov 26, 2024
View reviewed changes
instrumentation/github.com/gin-gonic/gin/otelgin/option.go
// name. By default, the route name (path template or regexp) is used. The route
// name is provided so you can use it in the span name without needing to
// duplicate the logic for extracting it from the request.
func WithSpanNameFormatter(f func(routeName string, r *http.Request) string) Option {
return optionFunc(func(c *config) {
c.SpanNameFormatter = f
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion to add:

if f != nil {
	....
}

instrumentation/github.com/gin-gonic/gin/otelgin/gintrace.go
@@ -75,7 +75,7 @@ func Middleware(service string, opts ...Option) gin.HandlerFunc {
if cfg.SpanNameFormatter == nil {
spanName = c.FullPath()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It can be considered to adjust to the form of: method path.

@flc1125
Copy link
Member

flc1125 commented Nov 26, 2024

I feel that this PR can be reconsidered for evaluation. Currently, it seems that otelgin is becoming active.

@flc1125 flc1125 mentioned this pull request Nov 27, 2024
Closed
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@flc1125 flc1125 flc1125 requested changes

@hanyuancheung hanyuancheung Awaiting requested review from hanyuancheung

@dmathieu dmathieu Awaiting requested review from dmathieu

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@NeoCN @dmathieu @flc1125