UNPKG

@zendesk/retrace

Version:

define and capture Product Operation Traces along with computed metrics with an optional friendly React beacon API

github.com/zendesk/retrace

zendesk/retrace

134 lines (124 loc) • 3.74 kB
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
import type { SpanMatcherFn } from './matchSpan' import type { SpanAndAnnotation } from './spanAnnotationTypes' import type { OnEnterStatePayload } from './Trace' import type { DraftTraceContext, RelationSchemasBase, TraceDefinitionModifications, } from './types' // Types for debugging/monitoring events export interface AddSpanToRecordingEvent< SelectedRelationNameT extends keyof RelationSchemasT, RelationSchemasT extends RelationSchemasBase<RelationSchemasT>, VariantsT extends string, > { spanAndAnnotation: SpanAndAnnotation<RelationSchemasT> traceContext: DraftTraceContext< SelectedRelationNameT, RelationSchemasT, VariantsT > } export interface DefinitionModifiedEvent< SelectedRelationNameT extends keyof RelationSchemasT, RelationSchemasT extends RelationSchemasBase<RelationSchemasT>, VariantsT extends string, > { modifications: TraceDefinitionModifications< SelectedRelationNameT, RelationSchemasT, VariantsT > traceContext: DraftTraceContext< SelectedRelationNameT, RelationSchemasT, VariantsT > } export interface TraceStartEvent< SelectedRelationNameT extends keyof RelationSchemasT, RelationSchemasT extends RelationSchemasBase<RelationSchemasT>, VariantsT extends string, > { traceContext: DraftTraceContext< SelectedRelationNameT, RelationSchemasT, VariantsT > } export interface StateTransitionEvent< SelectedRelationNameT extends keyof RelationSchemasT, RelationSchemasT extends RelationSchemasBase<RelationSchemasT>, VariantsT extends string, > { traceContext: DraftTraceContext< SelectedRelationNameT, RelationSchemasT, VariantsT > stateTransition: OnEnterStatePayload<RelationSchemasT> } export interface RequiredSpanSeenEvent< SelectedRelationNameT extends keyof RelationSchemasT, RelationSchemasT extends RelationSchemasBase<RelationSchemasT>, VariantsT extends string, > { traceContext: DraftTraceContext< SelectedRelationNameT, RelationSchemasT, VariantsT > spanAndAnnotation: SpanAndAnnotation<RelationSchemasT> matcher: SpanMatcherFn<SelectedRelationNameT, RelationSchemasT, VariantsT> } export type AllPossibleTraceStartEvents< RelationSchemasT extends RelationSchemasBase<RelationSchemasT>, > = { [SelectedRelationNameT in keyof RelationSchemasT]: TraceStartEvent< SelectedRelationNameT, RelationSchemasT, string > }[keyof RelationSchemasT] export type AllPossibleStateTransitionEvents< RelationSchemasT extends RelationSchemasBase<RelationSchemasT>, > = { [SelectedRelationNameT in keyof RelationSchemasT]: StateTransitionEvent< SelectedRelationNameT, RelationSchemasT, string > }[keyof RelationSchemasT] export type AllPossibleRequiredSpanSeenEvents< RelationSchemasT extends RelationSchemasBase<RelationSchemasT>, > = { [SelectedRelationNameT in keyof RelationSchemasT]: RequiredSpanSeenEvent< SelectedRelationNameT, RelationSchemasT, string > }[keyof RelationSchemasT] export type AllPossibleAddSpanToRecordingEvents< RelationSchemasT extends RelationSchemasBase<RelationSchemasT>, > = { [SelectedRelationNameT in keyof RelationSchemasT]: AddSpanToRecordingEvent< SelectedRelationNameT, RelationSchemasT, string > }[keyof RelationSchemasT] export type AllPossibleDefinitionModifiedEvents< RelationSchemasT extends RelationSchemasBase<RelationSchemasT>, > = { [SelectedRelationNameT in keyof RelationSchemasT]: DefinitionModifiedEvent< SelectedRelationNameT, RelationSchemasT, string > }[keyof RelationSchemasT] export type DebugEventType = | 'trace-start' | 'state-transition' | 'required-span-seen' | 'add-span-to-recording' | 'definition-modified'