forked from go-kit/kit
/
endpoint_options.go
74 lines (61 loc) · 2.4 KB
/
endpoint_options.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
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
}
}