-
Notifications
You must be signed in to change notification settings - Fork 27
/
options_client.go
201 lines (179 loc) · 6.56 KB
/
options_client.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
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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
// Copyright 2023 StreamNative, 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 oxia
import (
"crypto/tls"
"time"
"github.com/google/uuid"
"github.com/pkg/errors"
"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/metric"
"go.opentelemetry.io/otel/metric/noop"
"go.uber.org/multierr"
"github.com/streamnative/oxia/common"
)
const (
DefaultBatchLinger = 5 * time.Millisecond
DefaultMaxRequestsPerBatch = 1000
DefaultMaxBatchSize = 128 * 1024
DefaultRequestTimeout = 30 * time.Second
DefaultSessionTimeout = 15 * time.Second
DefaultNamespace = common.DefaultNamespace
)
var (
ErrInvalidOptionBatchLinger = errors.New("BatchLinger must be greater than or equal to zero")
ErrInvalidOptionMaxRequestsPerBatch = errors.New("MaxRequestsPerBatch must be greater than zero")
ErrInvalidOptionMaxBatchSize = errors.New("MaxBatchSize must be greater than zero")
ErrInvalidOptionRequestTimeout = errors.New("RequestTimeout must be greater than zero")
ErrInvalidOptionSessionTimeout = errors.New("SessionTimeout must be greater than zero")
ErrInvalidOptionIdentity = errors.New("Identity must be non-empty")
ErrInvalidOptionNamespace = errors.New("Namespace cannot be empty")
ErrInvalidOptionTLS = errors.New("Tls cannot be empty")
)
// clientOptions contains options for the Oxia client.
type clientOptions struct {
serviceAddress string
namespace string
batchLinger time.Duration
maxRequestsPerBatch int
maxBatchSize int
requestTimeout time.Duration
meterProvider metric.MeterProvider
sessionTimeout time.Duration
identity string
tls *tls.Config
}
func defaultIdentity() string {
return uuid.NewString()
}
// RequestTimeout defines how long the client will wait for responses before cancelling the request and failing
// the request.
func (o clientOptions) RequestTimeout() time.Duration {
return o.requestTimeout
}
// ClientOption is an interface for applying Oxia client options.
type ClientOption interface {
// apply is used to set a ClientOption value of a clientOptions.
apply(option clientOptions) (clientOptions, error)
}
func newClientOptions(serviceAddress string, opts ...ClientOption) (clientOptions, error) {
options := clientOptions{
serviceAddress: serviceAddress,
namespace: common.DefaultNamespace,
batchLinger: DefaultBatchLinger,
maxRequestsPerBatch: DefaultMaxRequestsPerBatch,
maxBatchSize: DefaultMaxBatchSize,
requestTimeout: DefaultRequestTimeout,
meterProvider: noop.NewMeterProvider(),
sessionTimeout: DefaultSessionTimeout,
identity: defaultIdentity(),
}
var errs error
var err error
for _, o := range opts {
options, err = o.apply(options)
if err != nil {
errs = multierr.Append(errs, err)
}
}
return options, errs
}
type clientOptionFunc func(clientOptions) (clientOptions, error)
func (f clientOptionFunc) apply(c clientOptions) (clientOptions, error) {
return f(c)
}
// WithNamespace set the Oxia namespace to be used for this client.
// If not set, the client will be using the `default` namespace.
func WithNamespace(namespace string) ClientOption {
return clientOptionFunc(func(options clientOptions) (clientOptions, error) {
if namespace == "" {
return options, ErrInvalidOptionNamespace
}
options.namespace = namespace
return options, nil
})
}
// WithBatchLinger defines how long the batcher will wait before sending a batched request. The value must be greater
// than or equal to zero. A value of zero will disable linger, effectively disabling batching.
func WithBatchLinger(batchLinger time.Duration) ClientOption {
return clientOptionFunc(func(options clientOptions) (clientOptions, error) {
if batchLinger < 0 {
return options, ErrInvalidOptionBatchLinger
}
options.batchLinger = batchLinger
return options, nil
})
}
// WithMaxRequestsPerBatch defines how many individual requests a batch can contain before the batched request is sent.
// The value must be greater than zero. A value of one will effectively disable batching.
func WithMaxRequestsPerBatch(maxRequestsPerBatch int) ClientOption {
return clientOptionFunc(func(options clientOptions) (clientOptions, error) {
if maxRequestsPerBatch <= 0 {
return options, ErrInvalidOptionMaxRequestsPerBatch
}
options.maxRequestsPerBatch = maxRequestsPerBatch
return options, nil
})
}
func WithRequestTimeout(requestTimeout time.Duration) ClientOption {
return clientOptionFunc(func(options clientOptions) (clientOptions, error) {
if requestTimeout <= 0 {
return options, ErrInvalidOptionRequestTimeout
}
options.requestTimeout = requestTimeout
return options, nil
})
}
func WithMeterProvider(meterProvider metric.MeterProvider) ClientOption {
return clientOptionFunc(func(options clientOptions) (clientOptions, error) {
if meterProvider == nil {
options.meterProvider = noop.NewMeterProvider()
} else {
options.meterProvider = meterProvider
}
return options, nil
})
}
// WithGlobalMeterProvider instructs the Oxia client to use the global OpenTelemetry MeterProvider.
func WithGlobalMeterProvider() ClientOption {
return WithMeterProvider(otel.GetMeterProvider())
}
// WithSessionTimeout specifies the session timeout to.
func WithSessionTimeout(sessionTimeout time.Duration) ClientOption {
return clientOptionFunc(func(options clientOptions) (clientOptions, error) {
if sessionTimeout <= 0 {
return options, ErrInvalidOptionSessionTimeout
}
options.sessionTimeout = sessionTimeout
return options, nil
})
}
func WithIdentity(identity string) ClientOption {
return clientOptionFunc(func(options clientOptions) (clientOptions, error) {
if identity == "" {
return options, ErrInvalidOptionIdentity
}
options.identity = identity
return options, nil
})
}
func WithTLS(tlsConf *tls.Config) ClientOption {
return clientOptionFunc(func(options clientOptions) (clientOptions, error) {
if tlsConf == nil {
return options, ErrInvalidOptionTLS
}
options.tls = tlsConf
return options, nil
})
}