aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/github.com/uber/jaeger-client-go/internal/baggage/remote/options.go
blob: 745729319ff0034fb64a52bc407c9d1604fba577 (plain) (blame)
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
// Copyright (c) 2017 Uber Technologies, Inc.
//
// 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 remote

import (
    "time"

    "github.com/uber/jaeger-client-go"
)

const (
    defaultMaxValueLength  = 2048
    defaultRefreshInterval = time.Minute
    defaultHostPort        = "localhost:5778"
)

// Option is a function that sets some option on the RestrictionManager
type Option func(options *options)

// Options is a factory for all available options
var Options options

type options struct {
    denyBaggageOnInitializationFailure bool
    metrics                            *jaeger.Metrics
    logger                             jaeger.Logger
    hostPort                           string
    refreshInterval                    time.Duration
}

// DenyBaggageOnInitializationFailure creates an Option that determines the startup failure mode of RestrictionManager.
// If DenyBaggageOnInitializationFailure is true, RestrictionManager will not allow any baggage to be written until baggage
// restrictions have been retrieved from agent.
// If DenyBaggageOnInitializationFailure is false, RestrictionManager will allow any baggage to be written until baggage
// restrictions have been retrieved from agent.
func (options) DenyBaggageOnInitializationFailure(b bool) Option {
    return func(o *options) {
        o.denyBaggageOnInitializationFailure = b
    }
}

// Metrics creates an Option that initializes Metrics on the RestrictionManager, which is used to emit statistics.
func (options) Metrics(m *jaeger.Metrics) Option {
    return func(o *options) {
        o.metrics = m
    }
}

// Logger creates an Option that sets the logger used by the RestrictionManager.
func (options) Logger(logger jaeger.Logger) Option {
    return func(o *options) {
        o.logger = logger
    }
}

// HostPort creates an Option that sets the hostPort of the local agent that contains the baggage restrictions.
func (options) HostPort(hostPort string) Option {
    return func(o *options) {
        o.hostPort = hostPort
    }
}

// RefreshInterval creates an Option that sets how often the RestrictionManager will poll local agent for
// the baggage restrictions.
func (options) RefreshInterval(refreshInterval time.Duration) Option {
    return func(o *options) {
        o.refreshInterval = refreshInterval
    }
}

func applyOptions(o ...Option) options {
    opts := options{}
    for _, option := range o {
        option(&opts)
    }
    if opts.metrics == nil {
        opts.metrics = jaeger.NewNullMetrics()
    }
    if opts.logger == nil {
        opts.logger = jaeger.NullLogger
    }
    if opts.hostPort == "" {
        opts.hostPort = defaultHostPort
    }
    if opts.refreshInterval == 0 {
        opts.refreshInterval = defaultRefreshInterval
    }
    return opts
}