Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1072 from alebabai/feature-tracing-opentracing
tracing.opentracing endpoint middleware options
- Loading branch information
Showing
5 changed files
with
494 additions
and
64 deletions.
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 |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| package opentracing | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/opentracing/opentracing-go" | ||
| ) | ||
|
|
||
| // EndpointOptions holds the options for tracing an endpoint | ||
| type EndpointOptions struct { | ||
| // IgnoreBusinessError if set to true will not treat a business error | ||
| // identified through the endpoint.Failer interface as a span error. | ||
| IgnoreBusinessError bool | ||
|
|
||
| // GetOperationName is an optional function that can set the span operation name based on the existing one | ||
| // for the endpoint and information in the context. | ||
| // | ||
| // If the function is nil, or the returned name is empty, the existing name for the endpoint is used. | ||
| GetOperationName func(ctx context.Context, name string) string | ||
|
|
||
| // Tags holds the default tags which will be set on span | ||
| // creation by our Endpoint middleware. | ||
| Tags opentracing.Tags | ||
|
|
||
| // GetTags is an optional function that can extract tags | ||
| // from the context and add them to the span. | ||
| GetTags func(ctx context.Context) opentracing.Tags | ||
| } | ||
|
|
||
| // EndpointOption allows for functional options to endpoint tracing middleware. | ||
| type EndpointOption func(*EndpointOptions) | ||
|
|
||
| // WithOptions sets all configuration options at once by use of the EndpointOptions struct. | ||
| func WithOptions(options EndpointOptions) EndpointOption { | ||
| return func(o *EndpointOptions) { | ||
| *o = options | ||
| } | ||
| } | ||
|
|
||
| // WithIgnoreBusinessError if set to true will not treat a business error | ||
| // identified through the endpoint.Failer interface as a span error. | ||
| func WithIgnoreBusinessError(ignoreBusinessError bool) EndpointOption { | ||
| return func(o *EndpointOptions) { | ||
| o.IgnoreBusinessError = ignoreBusinessError | ||
| } | ||
| } | ||
|
|
||
| // WithOperationNameFunc allows to set function that can set the span operation name based on the existing one | ||
| // for the endpoint and information in the context. | ||
| func WithOperationNameFunc(getOperationName func(ctx context.Context, name string) string) EndpointOption { | ||
| return func(o *EndpointOptions) { | ||
| o.GetOperationName = getOperationName | ||
| } | ||
| } | ||
|
|
||
| // WithTags adds default tags for the spans created by the Endpoint tracer. | ||
| func WithTags(tags opentracing.Tags) EndpointOption { | ||
| return func(o *EndpointOptions) { | ||
| if o.Tags == nil { | ||
| o.Tags = make(opentracing.Tags) | ||
| } | ||
|
|
||
| for key, value := range tags { | ||
| o.Tags[key] = value | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // WithTagsFunc set the func to extracts additional tags from the context. | ||
| func WithTagsFunc(getTags func(ctx context.Context) opentracing.Tags) EndpointOption { | ||
| return func(o *EndpointOptions) { | ||
| o.GetTags = getTags | ||
| } | ||
| } |
Oops, something went wrong.