/
faultdetect_config.go
409 lines (374 loc) · 14.1 KB
/
faultdetect_config.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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
/**
* Tencent is pleased to support the open source community by making Polaris available.
*
* Copyright (C) 2019 THL A29 Limited, a Tencent company. All rights reserved.
*
* Licensed under the BSD 3-Clause License (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://opensource.org/licenses/BSD-3-Clause
*
* 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 service
import (
"context"
"encoding/json"
"fmt"
"time"
"github.com/golang/protobuf/jsonpb"
"github.com/golang/protobuf/ptypes/wrappers"
apifault "github.com/polarismesh/specification/source/go/api/v1/fault_tolerance"
apimodel "github.com/polarismesh/specification/source/go/api/v1/model"
apiservice "github.com/polarismesh/specification/source/go/api/v1/service_manage"
api "github.com/polarismesh/polaris/common/api/v1"
"github.com/polarismesh/polaris/common/model"
commonstore "github.com/polarismesh/polaris/common/store"
commontime "github.com/polarismesh/polaris/common/time"
"github.com/polarismesh/polaris/common/utils"
)
func checkBatchFaultDetectRules(req []*apifault.FaultDetectRule) *apiservice.BatchWriteResponse {
if len(req) == 0 {
return api.NewBatchWriteResponse(apimodel.Code_EmptyRequest)
}
if len(req) > MaxBatchSize {
return api.NewBatchWriteResponse(apimodel.Code_BatchSizeOverLimit)
}
return nil
}
// CreateFaultDetectRules Create a FaultDetect rule
func (s *Server) CreateFaultDetectRules(
ctx context.Context, request []*apifault.FaultDetectRule) *apiservice.BatchWriteResponse {
if checkErr := checkBatchFaultDetectRules(request); checkErr != nil {
return checkErr
}
responses := api.NewBatchWriteResponse(apimodel.Code_ExecuteSuccess)
for _, cbRule := range request {
response := s.createFaultDetectRule(ctx, cbRule)
api.Collect(responses, response)
}
return api.FormatBatchWriteResponse(responses)
}
// DeleteFaultDetectRules Delete current Fault Detect rules
func (s *Server) DeleteFaultDetectRules(
ctx context.Context, request []*apifault.FaultDetectRule) *apiservice.BatchWriteResponse {
if checkErr := checkBatchFaultDetectRules(request); checkErr != nil {
return checkErr
}
responses := api.NewBatchWriteResponse(apimodel.Code_ExecuteSuccess)
for _, cbRule := range request {
response := s.deleteFaultDetectRule(ctx, cbRule)
api.Collect(responses, response)
}
return api.FormatBatchWriteResponse(responses)
}
// UpdateFaultDetectRules Modify the FaultDetect rule
func (s *Server) UpdateFaultDetectRules(
ctx context.Context, request []*apifault.FaultDetectRule) *apiservice.BatchWriteResponse {
if checkErr := checkBatchFaultDetectRules(request); checkErr != nil {
return checkErr
}
responses := api.NewBatchWriteResponse(apimodel.Code_ExecuteSuccess)
for _, cbRule := range request {
response := s.updateFaultDetectRule(ctx, cbRule)
api.Collect(responses, response)
}
return api.FormatBatchWriteResponse(responses)
}
func checkFaultDetectRuleParams(
req *apifault.FaultDetectRule, idRequired bool, nameRequired bool) *apiservice.Response {
if req == nil {
return api.NewResponse(apimodel.Code_EmptyRequest)
}
if resp := checkFaultDetectRuleParamsDbLen(req); nil != resp {
return resp
}
if nameRequired && len(req.GetName()) == 0 {
return api.NewResponse(apimodel.Code_InvalidCircuitBreakerName)
}
if idRequired && len(req.GetId()) == 0 {
return api.NewResponse(apimodel.Code_InvalidCircuitBreakerID)
}
return nil
}
func checkFaultDetectRuleParamsDbLen(req *apifault.FaultDetectRule) *apiservice.Response {
if err := utils.CheckDbRawStrFieldLen(req.GetTargetService().GetService(), MaxDbServiceNameLength); err != nil {
return api.NewResponse(apimodel.Code_InvalidServiceName)
}
if err := utils.CheckDbRawStrFieldLen(
req.GetTargetService().GetNamespace(), MaxDbServiceNamespaceLength); err != nil {
return api.NewResponse(apimodel.Code_InvalidNamespaceName)
}
if err := utils.CheckDbRawStrFieldLen(req.GetName(), MaxRuleName); err != nil {
return api.NewResponse(apimodel.Code_InvalidRateLimitName)
}
if err := utils.CheckDbRawStrFieldLen(req.GetNamespace(), MaxDbServiceNamespaceLength); err != nil {
return api.NewResponse(apimodel.Code_InvalidNamespaceName)
}
if err := utils.CheckDbRawStrFieldLen(req.GetDescription(), MaxCommentLength); err != nil {
return api.NewResponse(apimodel.Code_InvalidServiceComment)
}
return nil
}
func faultDetectRuleRecordEntry(ctx context.Context, req *apifault.FaultDetectRule, md *model.FaultDetectRule,
opt model.OperationType) *model.RecordEntry {
marshaler := jsonpb.Marshaler{}
detail, _ := marshaler.MarshalToString(req)
entry := &model.RecordEntry{
ResourceType: model.RFaultDetectRule,
ResourceName: fmt.Sprintf("%s(%s)", md.Name, md.ID),
Namespace: req.GetNamespace(),
OperationType: opt,
Operator: utils.ParseOperator(ctx),
Detail: detail,
HappenTime: time.Now(),
}
return entry
}
// createFaultDetectRule Create a FaultDetect rule
func (s *Server) createFaultDetectRule(ctx context.Context, request *apifault.FaultDetectRule) *apiservice.Response {
requestID := utils.ParseRequestID(ctx)
if resp := checkFaultDetectRuleParams(request, false, true); resp != nil {
return resp
}
data, err := api2FaultDetectRule(request)
if err != nil {
log.Error(err.Error(), utils.ZapRequestID(requestID))
return api.NewResponse(apimodel.Code_ParseException)
}
exists, err := s.storage.HasFaultDetectRuleByName(data.Name, data.Namespace)
if err != nil {
log.Error(err.Error(), utils.ZapRequestID(requestID))
return api.NewResponseWithMsg(commonstore.StoreCode2APICode(err), err.Error())
}
if exists {
return api.NewResponse(apimodel.Code_FaultDetectRuleExisted)
}
data.ID = utils.NewUUID()
// 存储层操作
if err := s.storage.CreateFaultDetectRule(data); err != nil {
log.Error(err.Error(), utils.ZapRequestID(requestID))
return api.NewResponseWithMsg(commonstore.StoreCode2APICode(err), err.Error())
}
msg := fmt.Sprintf("create fault detect rule: id=%v, name=%v, namespace=%v",
data.ID, request.GetName(), request.GetNamespace())
log.Info(msg, utils.ZapRequestID(requestID))
s.RecordHistory(ctx, faultDetectRuleRecordEntry(ctx, request, data, model.OCreate))
request.Id = data.ID
return api.NewAnyDataResponse(apimodel.Code_ExecuteSuccess, request)
}
// updateFaultDetectRule Update a FaultDetect rule
func (s *Server) updateFaultDetectRule(ctx context.Context, request *apifault.FaultDetectRule) *apiservice.Response {
requestID := utils.ParseRequestID(ctx)
if resp := checkFaultDetectRuleParams(request, true, true); resp != nil {
return resp
}
resp := s.checkFaultDetectRuleExists(request.GetId(), requestID)
if resp != nil {
return resp
}
fdRuleId := &apifault.FaultDetectRule{Id: request.GetId()}
fdRule, err := api2FaultDetectRule(request)
if err != nil {
log.Error(err.Error(), utils.ZapRequestID(requestID))
return api.NewAnyDataResponse(apimodel.Code_ParseException, fdRuleId)
}
fdRule.ID = request.GetId()
exists, err := s.storage.HasFaultDetectRuleByNameExcludeId(fdRule.Name, fdRule.Namespace, fdRule.ID)
if err != nil {
log.Error(err.Error(), utils.ZapRequestID(requestID))
return api.NewResponseWithMsg(commonstore.StoreCode2APICode(err), err.Error())
}
if exists {
return api.NewAnyDataResponse(apimodel.Code_FaultDetectRuleExisted, fdRuleId)
}
if err := s.storage.UpdateFaultDetectRule(fdRule); err != nil {
log.Error(err.Error(), utils.ZapRequestID(requestID))
return storeError2AnyResponse(err, fdRuleId)
}
msg := fmt.Sprintf("update fault detect rule: id=%v, name=%v, namespace=%v",
request.GetId(), request.GetName(), request.GetNamespace())
log.Info(msg, utils.ZapRequestID(requestID))
s.RecordHistory(ctx, faultDetectRuleRecordEntry(ctx, request, fdRule, model.OUpdate))
return api.NewAnyDataResponse(apimodel.Code_ExecuteSuccess, fdRuleId)
}
// deleteFaultDetectRule Delete a FaultDetect rule
func (s *Server) deleteFaultDetectRule(ctx context.Context, request *apifault.FaultDetectRule) *apiservice.Response {
requestID := utils.ParseRequestID(ctx)
if resp := checkFaultDetectRuleParams(request, true, false); resp != nil {
return resp
}
resp := s.checkFaultDetectRuleExists(request.GetId(), requestID)
if resp != nil {
if resp.GetCode().GetValue() == uint32(apimodel.Code_NotFoundResource) {
resp.Code = &wrappers.UInt32Value{Value: uint32(apimodel.Code_ExecuteSuccess)}
}
return resp
}
cbRuleId := &apifault.FaultDetectRule{Id: request.GetId()}
err := s.storage.DeleteFaultDetectRule(request.GetId())
if err != nil {
log.Error(err.Error(), utils.ZapRequestID(requestID))
return api.NewAnyDataResponse(apimodel.Code_ParseException, cbRuleId)
}
msg := fmt.Sprintf("delete fault detect rule: id=%v, name=%v, namespace=%v",
request.GetId(), request.GetName(), request.GetNamespace())
log.Info(msg, utils.ZapRequestID(requestID))
cbRule := &model.FaultDetectRule{ID: request.GetId(), Name: request.GetName(), Namespace: request.GetNamespace()}
s.RecordHistory(ctx, faultDetectRuleRecordEntry(ctx, request, cbRule, model.ODelete))
return api.NewAnyDataResponse(apimodel.Code_ExecuteSuccess, cbRuleId)
}
func (s *Server) checkFaultDetectRuleExists(id, requestID string) *apiservice.Response {
exists, err := s.storage.HasFaultDetectRule(id)
if err != nil {
log.Error(err.Error(), utils.ZapRequestID(requestID))
return api.NewResponse(commonstore.StoreCode2APICode(err))
}
if !exists {
return api.NewResponse(apimodel.Code_NotFoundResource)
}
return nil
}
var (
// FaultDetectRuleFilters filter fault detect rule query parameters
FaultDetectRuleFilters = map[string]bool{
"brief": true,
"offset": true,
"limit": true,
"id": true,
"name": true,
"namespace": true,
"service": true,
"serviceNamespace": true,
"dstService": true,
"dstNamespace": true,
"dstMethod": true,
"description": true,
}
)
func (s *Server) GetFaultDetectRules(ctx context.Context, query map[string]string) *apiservice.BatchQueryResponse {
for key := range query {
if _, ok := FaultDetectRuleFilters[key]; !ok {
log.Errorf("params %s is not allowed in querying fault detect rule", key)
return api.NewBatchQueryResponse(apimodel.Code_InvalidParameter)
}
}
offset, limit, err := utils.ParseOffsetAndLimit(query)
if err != nil {
return api.NewBatchQueryResponse(apimodel.Code_InvalidParameter)
}
total, cbRules, err := s.storage.GetFaultDetectRules(query, offset, limit)
if err != nil {
log.Errorf("get fault detect rules store err: %s", err.Error())
return api.NewBatchQueryResponse(commonstore.StoreCode2APICode(err))
}
out := api.NewBatchQueryResponse(apimodel.Code_ExecuteSuccess)
out.Amount = utils.NewUInt32Value(total)
out.Size = utils.NewUInt32Value(uint32(len(cbRules)))
for _, cbRule := range cbRules {
cbRuleProto, err := faultDetectRule2api(cbRule)
if nil != err {
log.Errorf("marshal circuitbreaker rule fail: %v", err)
continue
}
if nil == cbRuleProto {
continue
}
err = api.AddAnyDataIntoBatchQuery(out, cbRuleProto)
if nil != err {
log.Errorf("add circuitbreaker rule as any data fail: %v", err)
continue
}
}
return out
}
func marshalFaultDetectRule(req *apifault.FaultDetectRule) (string, error) {
r := &apifault.FaultDetectRule{
TargetService: req.TargetService,
Interval: req.Interval,
Timeout: req.Timeout,
Port: req.Port,
Protocol: req.Protocol,
HttpConfig: req.HttpConfig,
TcpConfig: req.TcpConfig,
UdpConfig: req.UdpConfig,
}
rule, err := json.Marshal(r)
if err != nil {
return "", err
}
return string(rule), nil
}
// api2FaultDetectRule 把API参数转化为内部数据结构
func api2FaultDetectRule(req *apifault.FaultDetectRule) (*model.FaultDetectRule, error) {
rule, err := marshalFaultDetectRule(req)
if err != nil {
return nil, err
}
out := &model.FaultDetectRule{
Name: req.GetName(),
Namespace: req.GetNamespace(),
Description: req.GetDescription(),
DstService: req.GetTargetService().GetService(),
DstNamespace: req.GetTargetService().GetNamespace(),
DstMethod: req.GetTargetService().GetMethod().GetValue().GetValue(),
Rule: rule,
Revision: utils.NewUUID(),
}
if out.Namespace == "" {
out.Namespace = DefaultNamespace
}
return out, nil
}
func faultDetectRule2api(fdRule *model.FaultDetectRule) (*apifault.FaultDetectRule, error) {
if fdRule == nil {
return nil, nil
}
fdRule.Proto = &apifault.FaultDetectRule{}
if len(fdRule.Rule) > 0 {
if err := json.Unmarshal([]byte(fdRule.Rule), fdRule.Proto); err != nil {
return nil, err
}
} else {
// brief search, to display the services in list result
fdRule.Proto.TargetService = &apifault.FaultDetectRule_DestinationService{
Service: fdRule.DstService,
Namespace: fdRule.DstNamespace,
Method: &apimodel.MatchString{Value: &wrappers.StringValue{Value: fdRule.DstMethod}},
}
}
fdRule.Proto.Id = fdRule.ID
fdRule.Proto.Name = fdRule.Name
fdRule.Proto.Namespace = fdRule.Namespace
fdRule.Proto.Description = fdRule.Description
fdRule.Proto.Revision = fdRule.Revision
fdRule.Proto.Ctime = commontime.Time2String(fdRule.CreateTime)
fdRule.Proto.Mtime = commontime.Time2String(fdRule.ModifyTime)
return fdRule.Proto, nil
}
// faultDetectRule2ClientAPI 把内部数据结构转化为客户端API参数
func faultDetectRule2ClientAPI(req *model.ServiceWithFaultDetectRules) (*apifault.FaultDetector, error) {
if req == nil {
return nil, nil
}
out := &apifault.FaultDetector{}
out.Revision = req.Revision
out.Rules = make([]*apifault.FaultDetectRule, 0, req.CountFaultDetectRules())
var iterateErr error
req.IterateFaultDetectRules(func(rule *model.FaultDetectRule) {
cbRule, err := faultDetectRule2api(rule)
if err != nil {
iterateErr = err
return
}
out.Rules = append(out.Rules, cbRule)
})
if nil != iterateErr {
return nil, iterateErr
}
return out, nil
}