@@ -7,20 +7,20 @@ import { StallTrackingInstrumentation } from './stalltracking';
7
7
import { BeforeNavigate } from './types' ;
8
8
export interface NativescriptTracingOptions extends RequestInstrumentationOptions {
9
9
/**
10
- * The time to wait in ms until the transaction will be finished. The transaction will use the end timestamp of
11
- * the last finished span as the endtime for the transaction.
12
- * Time is in ms.
13
- *
14
- * Default: 1000
15
- */
10
+ * The time to wait in ms until the transaction will be finished. The transaction will use the end timestamp of
11
+ * the last finished span as the endtime for the transaction.
12
+ * Time is in ms.
13
+ *
14
+ * Default: 1000
15
+ */
16
16
idleTimeout : number ;
17
17
/**
18
- * The maximum duration of a transaction before it will be marked as "deadline_exceeded".
19
- * If you never want to mark a transaction set it to 0.
20
- * Time is in seconds.
21
- *
22
- * Default: 600
23
- */
18
+ * The maximum duration of a transaction before it will be marked as "deadline_exceeded".
19
+ * If you never want to mark a transaction set it to 0.
20
+ * Time is in seconds.
21
+ *
22
+ * Default: 600
23
+ */
24
24
maxTransactionDuration : number ;
25
25
/**
26
26
* The time to wait in ms until the transaction will be finished. The transaction will use the end timestamp of
@@ -40,40 +40,40 @@ export interface NativescriptTracingOptions extends RequestInstrumentationOption
40
40
*/
41
41
finalTimeoutMs : number ;
42
42
/**
43
- * The routing instrumentation to be used with the tracing integration.
44
- * There is no routing instrumentation if nothing is passed.
45
- */
43
+ * The routing instrumentation to be used with the tracing integration.
44
+ * There is no routing instrumentation if nothing is passed.
45
+ */
46
46
routingInstrumentation ?: RoutingInstrumentationInstance ;
47
47
/**
48
- * Does not sample transactions that are from routes that have been seen any more and don't have any spans.
49
- * This removes a lot of the clutter as most back navigation transactions are now ignored.
50
- *
51
- * Default: true
52
- */
48
+ * Does not sample transactions that are from routes that have been seen any more and don't have any spans.
49
+ * This removes a lot of the clutter as most back navigation transactions are now ignored.
50
+ *
51
+ * Default: true
52
+ */
53
53
ignoreEmptyBackNavigationTransactions : boolean ;
54
54
/**
55
- * beforeNavigate is called before a navigation transaction is created and allows users to modify transaction
56
- * context data, or drop the transaction entirely (by setting `sampled = false` in the context).
57
- *
58
- * @param context: The context data which will be passed to `startTransaction` by default
59
- *
60
- * @returns A (potentially) modified context object, with `sampled = false` if the transaction should be dropped.
61
- */
55
+ * beforeNavigate is called before a navigation transaction is created and allows users to modify transaction
56
+ * context data, or drop the transaction entirely (by setting `sampled = false` in the context).
57
+ *
58
+ * @param context: The context data which will be passed to `startTransaction` by default
59
+ *
60
+ * @returns A (potentially) modified context object, with `sampled = false` if the transaction should be dropped.
61
+ */
62
62
beforeNavigate : BeforeNavigate ;
63
63
/**
64
- * Track the app start time by adding measurements to the first route transaction. If there is no routing instrumentation
65
- * an app start transaction will be started.
66
- *
67
- * Default: true
68
- */
64
+ * Track the app start time by adding measurements to the first route transaction. If there is no routing instrumentation
65
+ * an app start transaction will be started.
66
+ *
67
+ * Default: true
68
+ */
69
69
enableAppStartTracking : boolean ;
70
70
/**
71
- * Track slow/frozen frames from the native layer and adds them as measurements to all transactions.
72
- */
71
+ * Track slow/frozen frames from the native layer and adds them as measurements to all transactions.
72
+ */
73
73
enableNativeFramesTracking : boolean ;
74
74
/**
75
- * Track when and how long the JS event loop stalls for. Adds stalls as measurements to all transactions.
76
- */
75
+ * Track when and how long the JS event loop stalls for. Adds stalls as measurements to all transactions.
76
+ */
77
77
enableStallTracking : boolean ;
78
78
/**
79
79
* Trace User Interaction events like touch and gestures.
@@ -85,12 +85,12 @@ export interface NativescriptTracingOptions extends RequestInstrumentationOption
85
85
*/
86
86
export declare class NativescriptTracing implements Integration {
87
87
/**
88
- * @inheritDoc
89
- */
88
+ * @inheritDoc
89
+ */
90
90
static id : string ;
91
91
/**
92
- * @inheritDoc
93
- */
92
+ * @inheritDoc
93
+ */
94
94
name : string ;
95
95
/** NativescriptTracing options */
96
96
options : NativescriptTracingOptions ;
@@ -107,58 +107,58 @@ export declare class NativescriptTracing implements Integration {
107
107
private _currentViewName ;
108
108
constructor ( options ?: Partial < NativescriptTracingOptions > ) ;
109
109
/**
110
- * Registers routing and request instrumentation.
111
- */
110
+ * Registers routing and request instrumentation.
111
+ */
112
112
setupOnce ( addGlobalEventProcessor : ( callback : EventProcessor ) => void , getCurrentHub : ( ) => Hub ) : void ;
113
113
/**
114
- * To be called on a transaction start. Can have async methods
115
- */
114
+ * To be called on a transaction start. Can have async methods
115
+ */
116
116
onTransactionStart ( transaction : Transaction ) : void ;
117
117
/**
118
- * To be called on a transaction finish. Cannot have async methods.
119
- */
118
+ * To be called on a transaction finish. Cannot have async methods.
119
+ */
120
120
onTransactionFinish ( transaction : Transaction , endTimestamp ?: number ) : void ;
121
121
/**
122
- * Called by the NativescriptProfiler component on first component mount.
123
- */
122
+ * Called by the NativescriptProfiler component on first component mount.
123
+ */
124
124
onAppStartFinish ( endTimestamp : number ) : void ;
125
125
/**
126
- * Starts a new transaction for a user interaction.
127
- * @param userInteractionId Consists of `op` representation UI Event and `elementId` unique element identifier on current screen.
128
- */
126
+ * Starts a new transaction for a user interaction.
127
+ * @param userInteractionId Consists of `op` representation UI Event and `elementId` unique element identifier on current screen.
128
+ */
129
129
startUserInteractionTransaction ( userInteractionId : {
130
130
elementId : string | undefined ;
131
131
op : string ;
132
132
} ) : TransactionType | undefined ;
133
133
/**
134
- * Sets the current view name into the app context.
135
- * @param event Le event.
136
- */
134
+ * Sets the current view name into the app context.
135
+ * @param event Le event.
136
+ */
137
137
private _getCurrentViewEventProcessor ;
138
138
/**
139
- * Returns the App Start Duration in Milliseconds. Also returns undefined if not able do
140
- * define the duration.
141
- */
139
+ * Returns the App Start Duration in Milliseconds. Also returns undefined if not able do
140
+ * define the duration.
141
+ */
142
142
private _getAppStartDurationMilliseconds ;
143
143
/**
144
- * Instruments the app start measurements on the first route transaction.
145
- * Starts a route transaction if there isn't routing instrumentation.
146
- */
144
+ * Instruments the app start measurements on the first route transaction.
145
+ * Starts a route transaction if there isn't routing instrumentation.
146
+ */
147
147
private _instrumentAppStart ;
148
148
/**
149
- * Adds app start measurements and starts a child span on a transaction.
150
- */
149
+ * Adds app start measurements and starts a child span on a transaction.
150
+ */
151
151
private _addAppStartData ;
152
152
/** To be called when the route changes, but BEFORE the components of the new route mount. */
153
153
private _onRouteWillChange ;
154
154
/**
155
- * Creates a breadcrumb and sets the current route as a tag.
156
- */
155
+ * Creates a breadcrumb and sets the current route as a tag.
156
+ */
157
157
private _onConfirmRoute ;
158
158
/** Create routing idle transaction. */
159
159
private _createRouteTransaction ;
160
160
/**
161
- * Start app state aware idle transaction on the scope.
162
- */
161
+ * Start app state aware idle transaction on the scope.
162
+ */
163
163
private _startIdleTransaction ;
164
164
}
0 commit comments