-
Notifications
You must be signed in to change notification settings - Fork 13
/
logeventbuilder.go
660 lines (574 loc) · 17.2 KB
/
logeventbuilder.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
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
package transaction
import (
"errors"
"reflect"
"time"
"github.com/Axway/agent-sdk/pkg/agent"
"github.com/Axway/agent-sdk/pkg/traceability/redaction"
"github.com/Axway/agent-sdk/pkg/transaction/models"
"github.com/Axway/agent-sdk/pkg/util"
)
const defaultAPICDeployment = "prod"
// IsValid - Validator for TxEventStatus
func (s TxEventStatus) IsValid() error {
switch s {
case TxEventStatusPass, TxEventStatusFail:
return nil
}
return errors.New("invalid transaction event status")
}
// IsValid - Validator for TxSummaryStatus
func (s TxSummaryStatus) IsValid() error {
switch s {
case TxSummaryStatusSuccess, TxSummaryStatusFailure, TxSummaryStatusException, TxSummaryStatusUnknown:
return nil
}
return errors.New("invalid transaction summary status")
}
// EventBuilder - Interface to build the log event of type transaction event
type EventBuilder interface {
SetTimestamp(timestamp int64) EventBuilder
SetTransactionID(transactionID string) EventBuilder
SetAPICDeployment(apicDeployment string) EventBuilder
SetEnvironmentName(environmentName string) EventBuilder
SetEnvironmentID(environmentID string) EventBuilder
SetTenantID(tenantID string) EventBuilder
SetTrcbltPartitionID(trcbltPartitionID string) EventBuilder
SetTargetPath(targetPath string) EventBuilder
SetResourcePath(resourcePath string) EventBuilder
SetID(id string) EventBuilder
SetParentID(parentID string) EventBuilder
SetSource(source string) EventBuilder
SetDestination(destination string) EventBuilder
SetDuration(duration int) EventBuilder
SetDirection(direction string) EventBuilder
SetStatus(status TxEventStatus) EventBuilder
SetProtocolDetail(protocolDetail interface{}) EventBuilder
SetRedactionConfig(config redaction.Redactions) EventBuilder
Build() (*LogEvent, error)
}
type transactionEventBuilder struct {
EventBuilder
err error
cfgTenantID string
cfgAPICDeployment string
cfgEnvironmentName string
cfgEnvironmentID string
logEvent *LogEvent
redactionConfig redaction.Redactions
}
// SummaryBuilder - Interface to build the log event of type transaction summary
type SummaryBuilder interface {
SetTimestamp(timestamp int64) SummaryBuilder
SetTransactionID(transactionID string) SummaryBuilder
SetAPICDeployment(apicDeployment string) SummaryBuilder
SetEnvironmentName(environmentName string) SummaryBuilder
SetEnvironmentID(environmentID string) SummaryBuilder
SetTenantID(tenantID string) SummaryBuilder
SetTrcbltPartitionID(trcbltPartitionID string) SummaryBuilder
SetTargetPath(targetPath string) SummaryBuilder
SetResourcePath(resourcePath string) SummaryBuilder
SetStatus(status TxSummaryStatus, statusDetail string) SummaryBuilder
SetDuration(duration int) SummaryBuilder
SetApplication(appID, appName string) SummaryBuilder
SetProduct(id, name, version string) SummaryBuilder
SetTeam(teamID string) SummaryBuilder
SetProxy(proxyID, proxyName string, proxyRevision int) SummaryBuilder
SetProxyWithStage(proxyID, proxyName, proxyStage string, proxyRevision int) SummaryBuilder
SetProxyWithStageVersion(proxyID, proxyName, proxyStage, proxyVersion string, proxyRevision int) SummaryBuilder
SetRunTime(runtimeID, runtimeName string) SummaryBuilder
SetEntryPoint(entryPointType, method, path, host string) SummaryBuilder
SetIsInMetricEvent(isInMetricEvent bool) SummaryBuilder
SetRedactionConfig(config redaction.Redactions) SummaryBuilder
Build() (*LogEvent, error)
}
type transactionSummaryBuilder struct {
SummaryBuilder
err error
cfgTenantID string
cfgAPICDeployment string
cfgEnvironmentName string
cfgEnvironmentID string
logEvent *LogEvent
redactionConfig redaction.Redactions
}
// NewTransactionEventBuilder - Creates a new log event builder
func NewTransactionEventBuilder() EventBuilder {
txEventBuilder := &transactionEventBuilder{
logEvent: &LogEvent{
Version: "1.0",
Stamp: time.Now().Unix(),
Type: TypeTransactionEvent,
TransactionEvent: &Event{},
TransactionSummary: nil,
APICDeployment: defaultAPICDeployment,
},
}
cfg := agent.GetCentralConfig()
// Check interface and value are not nil
if cfg != nil && !reflect.ValueOf(cfg).IsNil() {
txEventBuilder.logEvent.TenantID = cfg.GetTenantID()
txEventBuilder.logEvent.EnvironmentName = cfg.GetEnvironmentName()
txEventBuilder.logEvent.EnvironmentID = cfg.GetEnvironmentID()
txEventBuilder.logEvent.APICDeployment = cfg.GetAPICDeployment()
}
return txEventBuilder
}
// NewTransactionSummaryBuilder - Creates a new log event builder
func NewTransactionSummaryBuilder() SummaryBuilder {
txSummaryBuilder := &transactionSummaryBuilder{
logEvent: &LogEvent{
Version: "1.0",
Stamp: time.Now().Unix(),
Type: TypeTransactionSummary,
TransactionEvent: nil,
TransactionSummary: &Summary{},
APICDeployment: defaultAPICDeployment,
},
}
cfg := agent.GetCentralConfig()
// Check interface and value are not nil
if cfg != nil && !reflect.ValueOf(cfg).IsNil() {
txSummaryBuilder.logEvent.TenantID = cfg.GetTenantID()
txSummaryBuilder.logEvent.EnvironmentName = cfg.GetEnvironmentName()
txSummaryBuilder.logEvent.EnvironmentID = cfg.GetEnvironmentID()
txSummaryBuilder.logEvent.APICDeployment = cfg.GetAPICDeployment()
txSummaryBuilder.logEvent.TransactionSummary.IsInMetricEvent =
cfg.GetUsageReportingConfig().CanPublishMetric()
}
return txSummaryBuilder
}
func (b *transactionEventBuilder) SetTimestamp(timestamp int64) EventBuilder {
if b.err != nil {
return b
}
b.logEvent.Stamp = timestamp
return b
}
func (b *transactionEventBuilder) SetTransactionID(transactionID string) EventBuilder {
if b.err != nil {
return b
}
b.logEvent.TransactionID = transactionID
return b
}
func (b *transactionEventBuilder) SetAPICDeployment(apicDeployment string) EventBuilder {
if b.err != nil {
return b
}
b.logEvent.APICDeployment = apicDeployment
return b
}
func (b *transactionEventBuilder) SetEnvironmentName(environmentName string) EventBuilder {
if b.err != nil {
return b
}
b.logEvent.EnvironmentName = environmentName
return b
}
func (b *transactionEventBuilder) SetEnvironmentID(environmentID string) EventBuilder {
if b.err != nil {
return b
}
b.logEvent.EnvironmentID = environmentID
return b
}
func (b *transactionEventBuilder) SetTenantID(tenantID string) EventBuilder {
if b.err != nil {
return b
}
b.logEvent.TenantID = tenantID
return b
}
func (b *transactionEventBuilder) SetTrcbltPartitionID(trcbltPartitionID string) EventBuilder {
if b.err != nil {
return b
}
b.logEvent.TrcbltPartitionID = trcbltPartitionID
return b
}
func (b *transactionEventBuilder) SetTargetPath(targetPath string) EventBuilder {
if b.err != nil {
return b
}
b.logEvent.TargetPath = targetPath
return b
}
func (b *transactionEventBuilder) SetResourcePath(resourcePath string) EventBuilder {
if b.err != nil {
return b
}
b.logEvent.ResourcePath = resourcePath
return b
}
func (b *transactionEventBuilder) SetID(id string) EventBuilder {
if b.err != nil {
return b
}
b.logEvent.TransactionEvent.ID = id
return b
}
func (b *transactionEventBuilder) SetParentID(parentID string) EventBuilder {
if b.err != nil {
return b
}
b.logEvent.TransactionEvent.ParentID = parentID
return b
}
func (b *transactionEventBuilder) SetSource(source string) EventBuilder {
if b.err != nil {
return b
}
b.logEvent.TransactionEvent.Source = source
return b
}
func (b *transactionEventBuilder) SetDestination(destination string) EventBuilder {
if b.err != nil {
return b
}
b.logEvent.TransactionEvent.Destination = destination
return b
}
func (b *transactionEventBuilder) SetDuration(duration int) EventBuilder {
if b.err != nil {
return b
}
b.logEvent.TransactionEvent.Duration = duration
return b
}
func (b *transactionEventBuilder) SetDirection(direction string) EventBuilder {
if b.err != nil {
return b
}
b.logEvent.TransactionEvent.Direction = direction
return b
}
func (b *transactionEventBuilder) SetStatus(status TxEventStatus) EventBuilder {
if b.err != nil {
return b
}
err := status.IsValid()
if err != nil {
b.err = err
return b
}
b.logEvent.TransactionEvent.Status = string(status)
return b
}
func (b *transactionEventBuilder) SetProtocolDetail(protocolDetail interface{}) EventBuilder {
if b.err != nil {
return b
}
_, ok := protocolDetail.(*Protocol)
if !ok {
_, ok = protocolDetail.(*JMSProtocol)
}
if ok {
b.logEvent.TransactionEvent.Protocol = protocolDetail
} else {
b.err = errors.New("unsupported protocol type")
}
return b
}
func (b *transactionEventBuilder) SetRedactionConfig(config redaction.Redactions) EventBuilder {
if b.err != nil {
return b
}
b.redactionConfig = config
return b
}
func (b *transactionEventBuilder) Build() (*LogEvent, error) {
if b.err != nil {
return nil, b.err
}
// Set Target Path
if b.redactionConfig == nil {
b.logEvent.TargetPath, _ = redaction.URIRedaction(b.logEvent.TargetPath)
} else {
b.logEvent.TargetPath, _ = b.redactionConfig.URIRedaction(b.logEvent.TargetPath)
}
//Set Resource Path
if b.redactionConfig == nil {
b.logEvent.ResourcePath, _ = redaction.URIRedaction(b.logEvent.ResourcePath)
} else {
b.logEvent.ResourcePath, _ = b.redactionConfig.URIRedaction(b.logEvent.ResourcePath)
}
if b.logEvent.TrcbltPartitionID == "" {
b.logEvent.TrcbltPartitionID = b.logEvent.TenantID
}
err := b.validateLogEvent()
if err != nil {
return nil, err
}
return b.logEvent, nil
}
func (b *transactionEventBuilder) validateLogEvent() error {
if agent.GetCentralConfig() == nil {
return nil
}
if util.IsNotTest() && agent.GetCentralConfig().GetUsageReportingConfig().IsOfflineMode() {
// Do not need this information in offline mode
return nil
}
if b.logEvent.TenantID == "" {
return errors.New("tenant ID property not set in transaction event")
}
if b.logEvent.EnvironmentID == "" {
return errors.New("environment ID property are not set in transaction event")
}
if b.logEvent.TransactionEvent.ID == "" {
return errors.New("id property not set in transaction event")
}
if b.logEvent.TransactionEvent.Direction == "" {
return errors.New("direction property not set in transaction event")
}
if b.logEvent.TransactionEvent.Status == "" {
return errors.New("status property not set in transaction event")
}
if b.logEvent.TransactionEvent.Protocol == nil {
return errors.New("protocol details not set in transaction event")
}
return nil
}
func (b *transactionSummaryBuilder) SetTimestamp(timestamp int64) SummaryBuilder {
if b.err != nil {
return b
}
b.logEvent.Stamp = timestamp
return b
}
func (b *transactionSummaryBuilder) SetTransactionID(transactionID string) SummaryBuilder {
if b.err != nil {
return b
}
b.logEvent.TransactionID = transactionID
return b
}
func (b *transactionSummaryBuilder) SetAPICDeployment(apicDeployment string) SummaryBuilder {
if b.err != nil {
return b
}
b.logEvent.APICDeployment = apicDeployment
return b
}
func (b *transactionSummaryBuilder) SetEnvironmentName(environmentName string) SummaryBuilder {
if b.err != nil {
return b
}
b.logEvent.EnvironmentName = environmentName
return b
}
func (b *transactionSummaryBuilder) SetEnvironmentID(environmentID string) SummaryBuilder {
if b.err != nil {
return b
}
b.logEvent.EnvironmentID = environmentID
return b
}
func (b *transactionSummaryBuilder) SetTenantID(tenantID string) SummaryBuilder {
if b.err != nil {
return b
}
b.logEvent.TenantID = tenantID
return b
}
func (b *transactionSummaryBuilder) SetTrcbltPartitionID(trcbltPartitionID string) SummaryBuilder {
if b.err != nil {
return b
}
b.logEvent.TrcbltPartitionID = trcbltPartitionID
return b
}
func (b *transactionSummaryBuilder) SetTargetPath(targetPath string) SummaryBuilder {
if b.err != nil {
return b
}
b.logEvent.TargetPath = targetPath
return b
}
func (b *transactionSummaryBuilder) SetResourcePath(resourcePath string) SummaryBuilder {
if b.err != nil {
return b
}
b.logEvent.ResourcePath = resourcePath
return b
}
func (b *transactionSummaryBuilder) SetStatus(status TxSummaryStatus, statusDetail string) SummaryBuilder {
if b.err != nil {
return b
}
err := status.IsValid()
if err != nil {
b.err = err
return b
}
b.logEvent.TransactionSummary.Status = string(status)
b.logEvent.TransactionSummary.StatusDetail = statusDetail
return b
}
func (b *transactionSummaryBuilder) SetDuration(duration int) SummaryBuilder {
if b.err != nil {
return b
}
b.logEvent.TransactionSummary.Duration = duration
return b
}
func (b *transactionSummaryBuilder) SetApplication(appID, appName string) SummaryBuilder {
if b.err != nil {
return b
}
b.logEvent.TransactionSummary.Application = &Application{
ID: appID,
Name: appName,
}
return b
}
// Currently, no one is setting Product for transaction summary builder, but leaving function signature as is for now
func (b *transactionSummaryBuilder) SetProduct(id, name, versionID string) SummaryBuilder {
if b.err != nil {
return b
}
b.logEvent.TransactionSummary.Product = &models.Product{
ID: id,
Name: name,
VersionID: versionID,
}
return b
}
func (b *transactionSummaryBuilder) SetTeam(teamID string) SummaryBuilder {
if b.err != nil {
return b
}
b.logEvent.TransactionSummary.Team = &Team{
ID: teamID,
}
return b
}
func (b *transactionSummaryBuilder) SetProxy(proxyID, proxyName string, proxyRevision int) SummaryBuilder {
return b.SetProxyWithStage(proxyID, proxyName, "", proxyRevision)
}
func (b *transactionSummaryBuilder) SetProxyWithStage(proxyID, proxyName, proxyStage string, proxyRevision int) SummaryBuilder {
return b.SetProxyWithStageVersion(proxyID, proxyName, proxyStage, "", proxyRevision)
}
func (b *transactionSummaryBuilder) SetProxyWithStageVersion(proxyID, proxyName, proxyStage, proxyVersion string, proxyRevision int) SummaryBuilder {
if b.err != nil {
return b
}
if proxyID == "" {
proxyID = "unknown"
}
b.logEvent.TransactionSummary.Proxy = &Proxy{
ID: proxyID,
Revision: proxyRevision,
Name: proxyName,
Stage: proxyStage,
Version: proxyVersion,
}
return b
}
func (b *transactionSummaryBuilder) SetRunTime(runtimeID, runtimeName string) SummaryBuilder {
if b.err != nil {
return b
}
b.logEvent.TransactionSummary.Runtime = &Runtime{
ID: runtimeID,
Name: runtimeName,
}
return b
}
func (b *transactionSummaryBuilder) SetEntryPoint(entryPointType, method, path, host string) SummaryBuilder {
if b.err != nil {
return b
}
b.logEvent.TransactionSummary.EntryPoint = &EntryPoint{
Type: entryPointType,
Method: method,
Path: path,
Host: host,
}
return b
}
func (b *transactionSummaryBuilder) SetIsInMetricEvent(isInMetricEvent bool) SummaryBuilder {
if b.err != nil {
return b
}
b.logEvent.TransactionSummary.IsInMetricEvent = isInMetricEvent
return b
}
func (b *transactionSummaryBuilder) SetRedactionConfig(config redaction.Redactions) SummaryBuilder {
if b.err != nil {
return b
}
b.redactionConfig = config
return b
}
func (b *transactionSummaryBuilder) Build() (*LogEvent, error) {
if b.err != nil {
return nil, b.err
}
// Set Target Path
if b.redactionConfig == nil {
b.logEvent.TargetPath, b.err = redaction.URIRedaction(b.logEvent.TargetPath)
} else {
b.logEvent.TargetPath, b.err = b.redactionConfig.URIRedaction(b.logEvent.TargetPath)
}
if b.err != nil {
return nil, b.err
}
//Set Resource Path
if b.redactionConfig == nil {
b.logEvent.ResourcePath, b.err = redaction.URIRedaction(b.logEvent.ResourcePath)
} else {
b.logEvent.ResourcePath, b.err = b.redactionConfig.URIRedaction(b.logEvent.ResourcePath)
}
if b.err != nil {
return nil, b.err
}
// Set redacted path in EntryPoint
if b.logEvent.TransactionSummary.EntryPoint == nil {
return nil, errors.New("transaction entry point details are not set in transaction summary event")
}
if b.redactionConfig == nil {
b.logEvent.TransactionSummary.EntryPoint.Path, b.err = redaction.URIRedaction(b.logEvent.TransactionSummary.EntryPoint.Path)
} else {
b.logEvent.TransactionSummary.EntryPoint.Path, b.err = b.redactionConfig.URIRedaction(b.logEvent.TransactionSummary.EntryPoint.Path)
}
if b.err != nil {
return nil, b.err
}
if b.logEvent.TrcbltPartitionID == "" {
b.logEvent.TrcbltPartitionID = b.logEvent.TenantID
}
if b.logEvent.TransactionSummary.Proxy == nil {
b.logEvent.TransactionSummary.Proxy = &Proxy{
ID: "unknown",
}
}
err := b.validateLogEvent()
if err != nil {
return nil, err
}
return b.logEvent, b.err
}
func (b *transactionSummaryBuilder) validateLogEvent() error {
if agent.GetCentralConfig() == nil {
return nil
}
if util.IsNotTest() && agent.GetCentralConfig().GetUsageReportingConfig().IsOfflineMode() {
// Do not need this information in offline mode
return nil
}
if b.logEvent.TenantID == "" {
return errors.New("tenant ID property not set in transaction summary event")
}
if b.logEvent.EnvironmentID == "" {
return errors.New("environment ID property are not set in transaction summary event")
}
if b.logEvent.TransactionSummary.Status == "" {
return errors.New("status property not set in transaction summary event")
}
if b.logEvent.TransactionSummary.Product != nil && b.logEvent.TransactionSummary.Product.ID == "" {
return errors.New("product ID property not set in transaction summary event")
}
return nil
}