-
Notifications
You must be signed in to change notification settings - Fork 8
Expand file tree
/
Copy pathrum.d.ts
More file actions
2525 lines (2525 loc) · 78.3 KB
/
Copy pathrum.d.ts
File metadata and controls
2525 lines (2525 loc) · 78.3 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
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
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* DO NOT MODIFY IT BY HAND. Run `yarn generate` instead.
*/
/**
* Schema of all properties of a RUM event
*/
export type RumEvent = RumActionEvent | RumTransitionEvent | RumErrorEvent | RumLongTaskEvent | RumResourceEvent | RumViewEvent | RumViewUpdateEvent | RumVitalEvent;
/**
* Schema of all properties of an Action event
*/
export type RumActionEvent = CommonProperties & ViewContainerSchema & {
/**
* RUM event type
*/
readonly type: 'action';
/**
* Action properties
*/
readonly action: {
/**
* Type of the action
*/
readonly type: 'custom' | 'click' | 'tap' | 'scroll' | 'swipe' | 'application_start' | 'back';
/**
* UUID of the action
*/
readonly id?: string;
/**
* Duration in ns to the action is considered loaded
*/
readonly loading_time?: number;
/**
* Action target properties
*/
readonly target?: {
/**
* Target name
*/
name: string;
[k: string]: unknown;
};
/**
* Action frustration properties
*/
readonly frustration?: {
/**
* Action frustration types
*/
readonly type: ('rage_click' | 'dead_click' | 'error_click' | 'rage_tap' | 'error_tap')[];
[k: string]: unknown;
};
/**
* Properties of the errors of the action
*/
readonly error?: {
/**
* Number of errors that occurred on the action
*/
readonly count: number;
[k: string]: unknown;
};
/**
* Properties of the crashes of the action
*/
readonly crash?: {
/**
* Number of crashes that occurred on the action
*/
readonly count: number;
[k: string]: unknown;
};
/**
* Properties of the long tasks of the action
*/
readonly long_task?: {
/**
* Number of long tasks that occurred on the action
*/
readonly count: number;
[k: string]: unknown;
};
/**
* Properties of the resources of the action
*/
readonly resource?: {
/**
* Number of resources that occurred on the action
*/
readonly count: number;
[k: string]: unknown;
};
[k: string]: unknown;
};
/**
* View properties
*/
readonly view: {
/**
* Is the action starting in the foreground (focus in browser)
*/
readonly in_foreground?: boolean;
[k: string]: unknown;
};
/**
* Internal properties
*/
_dd?: {
/**
* Action properties
*/
readonly action?: {
/**
* Action position properties
*/
readonly position?: {
/**
* X coordinate relative to the target element of the action (in pixels)
*/
readonly x: number;
/**
* Y coordinate relative to the target element of the action (in pixels)
*/
readonly y: number;
[k: string]: unknown;
};
/**
* Target properties
*/
target?: {
/**
* CSS selector path of the target element
*/
readonly selector?: string;
/**
* Selector data based on the click event composed path
*/
readonly composed_path_selector?: string;
/**
* Width of the target element (in pixels)
*/
readonly width?: number;
/**
* Height of the target element (in pixels)
*/
readonly height?: number;
/**
* Mobile-only: a globally unique and stable identifier for this UI element, computed as the hash of the element's path. Used to correlate actions with mobile session replay wireframes.
*/
readonly permanent_id?: string;
[k: string]: unknown;
};
/**
* The strategy of how the auto click action name is computed
*/
name_source?: 'custom_attribute' | 'mask_placeholder' | 'standard_attribute' | 'text_content' | 'mask_disallowed' | 'blank';
[k: string]: unknown;
};
[k: string]: unknown;
};
[k: string]: unknown;
};
/**
* Schema of all properties of an Transition event
*/
export type RumTransitionEvent = CommonProperties & {
/**
* RUM event type
*/
readonly type: 'transition';
readonly view: {
[k: string]: unknown;
};
/**
* Stream properties
*/
readonly stream: {
/**
* UUID of the stream
*/
readonly id: string;
[k: string]: unknown;
};
/**
* Transition properties
*/
readonly transition: {
/**
* Type of the transition
*/
readonly type: string;
/**
* UUID of the transition
*/
readonly id?: string;
/**
* The player's current timestamp in milliseconds
*/
readonly timestamp?: number;
/**
* Buffer starvation duration, the amount of time spent rebuffering in milliseconds
*/
readonly buffer_starvation_duration?: number;
/**
* Media start delay, the amount of time spent loading before playing in milliseconds
*/
readonly media_start_delay?: number;
/**
* Error code, as reported by the player
*/
readonly error_code?: number;
/**
* Duration of the event in milliseconds
*/
readonly duration?: number;
[k: string]: unknown;
};
[k: string]: unknown;
};
/**
* Schema of all properties of an Error event
*/
export type RumErrorEvent = CommonProperties & ActionChildProperties & ViewContainerSchema & {
/**
* RUM event type
*/
readonly type: 'error';
/**
* Error properties
*/
readonly error: {
/**
* UUID of the error
*/
readonly id?: string;
/**
* Error message
*/
message: string;
/**
* Source of the error
*/
readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report';
/**
* Stacktrace of the error
*/
stack?: string;
/**
* Causes of the error
*/
causes?: {
/**
* Error message
*/
message: string;
/**
* The type of the error
*/
readonly type?: string;
/**
* Stacktrace of the error
*/
stack?: string;
/**
* Source of the error
*/
readonly source: 'network' | 'source' | 'console' | 'logger' | 'agent' | 'webview' | 'custom' | 'report';
[k: string]: unknown;
}[];
/**
* Whether this error crashed the host application
*/
readonly is_crash?: boolean;
/**
* Fingerprint used for Error Tracking custom grouping
*/
fingerprint?: string;
/**
* The type of the error
*/
readonly type?: string;
/**
* The specific category of the error. It provides a high-level grouping for different types of errors.
*/
readonly category?: 'ANR' | 'App Hang' | 'Exception' | 'Watchdog Termination' | 'Memory Warning' | 'Network';
/**
* Whether the error has been handled manually in the source code or not
*/
readonly handling?: 'handled' | 'unhandled';
/**
* Handling call stack
*/
handling_stack?: string;
/**
* Source type of the error (the language or platform impacting the error stacktrace format)
*/
readonly source_type?: 'android' | 'browser' | 'ios' | 'react-native' | 'flutter' | 'roku' | 'ndk' | 'ios+il2cpp' | 'ndk+il2cpp' | 'windows' | 'macos' | 'linux' | 'maui';
/**
* Resource properties of the error
*/
readonly resource?: {
/**
* HTTP method of the resource
*/
readonly method: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT';
/**
* HTTP Status code of the resource
*/
readonly status_code: number;
/**
* URL of the resource
*/
url: string;
/**
* The provider for this resource
*/
readonly provider?: {
/**
* The domain name of the provider
*/
readonly domain?: string;
/**
* The user friendly name of the provider
*/
readonly name?: string;
/**
* The type of provider
*/
readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video';
[k: string]: unknown;
};
readonly graphql?: RumGraphql;
[k: string]: unknown;
};
/**
* Description of each thread in the process when error happened.
*/
threads?: {
/**
* Name of the thread (e.g. 'Thread 0').
*/
readonly name: string;
/**
* Tells if the thread crashed.
*/
readonly crashed: boolean;
/**
* Unsymbolicated stack trace of the given thread.
*/
readonly stack: string;
/**
* Platform-specific state of the thread when its state was captured (CPU registers dump for iOS, thread state enum for Android, etc.).
*/
readonly state?: string;
[k: string]: unknown;
}[];
/**
* Description of each binary image (native libraries; for Android: .so files) loaded or referenced by the process/application.
*/
readonly binary_images?: {
/**
* Build UUID that uniquely identifies the binary image.
*/
readonly uuid: string;
/**
* Name of the library.
*/
readonly name: string;
/**
* Determines if it's a system or user library.
*/
readonly is_system: boolean;
/**
* Library's load address (hexadecimal).
*/
readonly load_address?: string;
/**
* Max value from the library address range (hexadecimal).
*/
readonly max_address?: string;
/**
* CPU architecture from the library.
*/
readonly arch?: string;
[k: string]: unknown;
}[];
/**
* A boolean value saying if any of the stack traces was truncated due to minification.
*/
readonly was_truncated?: boolean;
/**
* Platform-specific metadata of the error event.
*/
readonly meta?: {
/**
* The CPU architecture of the process that crashed.
*/
readonly code_type?: string;
/**
* Parent process information.
*/
readonly parent_process?: string;
/**
* A client-generated 16-byte UUID of the incident.
*/
readonly incident_identifier?: string;
/**
* The name of the crashed process.
*/
readonly process?: string;
/**
* The name of the corresponding BSD termination signal. (in case of iOS crash)
*/
readonly exception_type?: string;
/**
* CPU specific information about the exception encoded into 64-bit hexadecimal number preceded by the signal code.
*/
readonly exception_codes?: string;
/**
* The location of the executable.
*/
readonly path?: string;
[k: string]: unknown;
};
/**
* Content Security Violation properties
*/
readonly csp?: {
/**
* In the context of CSP errors, indicates how the violated policy is configured to be treated by the user agent.
*/
readonly disposition?: 'enforce' | 'report';
[k: string]: unknown;
};
/**
* Time since application start when error happened (in milliseconds)
*/
readonly time_since_app_start?: number;
[k: string]: unknown;
};
/**
* Properties of App Hang and ANR errors
*/
readonly freeze?: {
/**
* Duration of the main thread freeze (in ns)
*/
readonly duration: number;
[k: string]: unknown;
};
/**
* View properties
*/
readonly view: {
/**
* Is the error starting in the foreground (focus in browser)
*/
readonly in_foreground?: boolean;
[k: string]: unknown;
};
/**
* Feature flags properties
*/
readonly feature_flags?: {
[k: string]: unknown;
};
/**
* Internal properties
*/
readonly _dd?: RumTrace & {
/**
* Profiling context
*/
profiling?: ProfilingInternalContextSchema;
/**
* Mapping of source file URLs to their debug IDs for source map deobfuscation
*/
debug_ids?: {
/**
* URL of the source file
*/
url: string;
/**
* Debug ID (UUID) for the source file
*/
id: string;
[k: string]: unknown;
}[];
[k: string]: unknown;
};
[k: string]: unknown;
};
/**
* Schema of all properties of a Long Task event
*/
export type RumLongTaskEvent = CommonProperties & ActionChildProperties & ViewContainerSchema & {
/**
* RUM event type
*/
readonly type: 'long_task';
readonly view: {
[k: string]: unknown;
};
/**
* Long Task properties
*/
readonly long_task: {
/**
* UUID of the long task or long animation frame
*/
readonly id?: string;
/**
* Start time of the long animation frame
*/
readonly start_time?: number;
/**
* Type of the event: long task or long animation frame
*/
readonly entry_type?: 'long-task' | 'long-animation-frame';
/**
* Duration in ns of the long task or long animation frame
*/
readonly duration: number;
/**
* Duration in ns for which the animation frame was being blocked
*/
readonly blocking_duration?: number;
/**
* Time difference (in ns) between the timeOrigin and the start time of the rendering cycle, which includes requestAnimationFrame callbacks, style and layout calculation, resize observer and intersection observer callbacks
*/
readonly render_start?: number;
/**
* Time difference (in ns) between the timeOrigin and the start time of the time period spent in style and layout calculations
*/
readonly style_and_layout_start?: number;
/**
* Time difference (in ns) between the timeOrigin and the start time of of the first UI event (mouse/keyboard and so on) to be handled during the course of this frame
*/
readonly first_ui_event_timestamp?: number;
/**
* Whether this long task is considered a frozen frame
*/
readonly is_frozen_frame?: boolean;
/**
* A list of long scripts that were executed over the course of the long frame
*/
readonly scripts?: {
/**
* Duration in ns between startTime and when the subsequent microtask queue has finished processing
*/
readonly duration?: number;
/**
* Duration in ns of the total time spent in 'pausing' synchronous operations (alert, synchronous XHR)
*/
readonly pause_duration?: number;
/**
* Duration in ns of the the total time spent processing forced layout and style inside this function
*/
readonly forced_style_and_layout_duration?: number;
/**
* Time the entry function was invoked
*/
readonly start_time?: number;
/**
* Time after compilation
*/
readonly execution_start?: number;
/**
* The script resource name where available (or empty if not found)
*/
source_url?: string;
/**
* The script function name where available (or empty if not found)
*/
readonly source_function_name?: string;
/**
* The script character position where available (or -1 if not found)
*/
readonly source_char_position?: number;
/**
* Information about the invoker of the script
*/
invoker?: string;
/**
* Type of the invoker of the script
*/
readonly invoker_type?: 'user-callback' | 'event-listener' | 'resolve-promise' | 'reject-promise' | 'classic-script' | 'module-script';
/**
* The container (the top-level document, or an <iframe>) the long animation frame occurred in
*/
readonly window_attribution?: string;
[k: string]: unknown;
}[];
[k: string]: unknown;
};
/**
* Internal properties
*/
readonly _dd?: {
/**
* Whether the long task should be discarded or indexed
*/
readonly discarded?: boolean;
/**
* Profiling context
*/
profiling?: ProfilingInternalContextSchema;
/**
* Mapping of source file URLs to their debug IDs for source map deobfuscation
*/
debug_ids?: {
/**
* URL of the source file
*/
url: string;
/**
* Debug ID (UUID) for the source file
*/
id: string;
[k: string]: unknown;
}[];
[k: string]: unknown;
};
[k: string]: unknown;
};
/**
* Schema of all properties of a Resource event
*/
export type RumResourceEvent = CommonProperties & ActionChildProperties & ViewContainerSchema & {
/**
* RUM event type
*/
readonly type: 'resource';
readonly view: {
[k: string]: unknown;
};
/**
* Resource properties
*/
readonly resource: {
/**
* UUID of the resource
*/
readonly id?: string;
/**
* Resource type
*/
readonly type: 'document' | 'xhr' | 'beacon' | 'fetch' | 'css' | 'js' | 'image' | 'font' | 'media' | 'other' | 'native';
/**
* HTTP method of the resource
*/
readonly method?: 'POST' | 'GET' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'OPTIONS' | 'CONNECT';
/**
* URL of the resource
*/
url: string;
/**
* HTTP status code of the resource
*/
readonly status_code?: number;
/**
* Duration of the resource
*/
readonly duration?: number;
/**
* Size in octet of the resource response body
*/
readonly size?: number;
/**
* Size in octet of the response body before removing any applied content encodings
*/
readonly encoded_body_size?: number;
/**
* Size in octet of the response body after removing any applied encoding
*/
readonly decoded_body_size?: number;
/**
* Size in octet of the fetched response resource
*/
readonly transfer_size?: number;
/**
* Render blocking status of the resource
*/
readonly render_blocking_status?: 'blocking' | 'non-blocking';
/**
* Worker phase properties
*/
readonly worker?: {
/**
* Duration in nanoseconds of the resource worker phase
*/
readonly duration: number;
/**
* Duration in nanoseconds between start of the request and start of the worker phase
*/
readonly start: number;
[k: string]: unknown;
};
/**
* Redirect phase properties
*/
readonly redirect?: {
/**
* Duration in ns of the resource redirect phase
*/
readonly duration: number;
/**
* Duration in ns between start of the request and start of the redirect phase
*/
readonly start: number;
[k: string]: unknown;
};
/**
* DNS phase properties
*/
readonly dns?: {
/**
* Duration in ns of the resource dns phase
*/
readonly duration: number;
/**
* Duration in ns between start of the request and start of the dns phase
*/
readonly start: number;
[k: string]: unknown;
};
/**
* Connect phase properties
*/
readonly connect?: {
/**
* Duration in ns of the resource connect phase
*/
readonly duration: number;
/**
* Duration in ns between start of the request and start of the connect phase
*/
readonly start: number;
[k: string]: unknown;
};
/**
* SSL phase properties
*/
readonly ssl?: {
/**
* Duration in ns of the resource ssl phase
*/
readonly duration: number;
/**
* Duration in ns between start of the request and start of the ssl phase
*/
readonly start: number;
[k: string]: unknown;
};
/**
* First Byte phase properties
*/
readonly first_byte?: {
/**
* Duration in ns of the resource first byte phase
*/
readonly duration: number;
/**
* Duration in ns between start of the request and start of the first byte phase
*/
readonly start: number;
[k: string]: unknown;
};
/**
* Download phase properties
*/
readonly download?: {
/**
* Duration in ns of the resource download phase
*/
readonly duration: number;
/**
* Duration in ns between start of the request and start of the download phase
*/
readonly start: number;
[k: string]: unknown;
};
/**
* Network protocol used to fetch the resource (e.g., 'http/1.1', 'h2')
*/
readonly protocol?: string;
/**
* Delivery type of the resource
*/
readonly delivery_type?: 'cache' | 'navigational-prefetch' | 'other';
/**
* Whether the resource was served from the device's local cache
*/
readonly local_cache_hit?: boolean;
/**
* The provider for this resource
*/
readonly provider?: {
/**
* The domain name of the provider
*/
readonly domain?: string;
/**
* The user friendly name of the provider
*/
readonly name?: string;
/**
* The type of provider
*/
readonly type?: 'ad' | 'advertising' | 'analytics' | 'cdn' | 'content' | 'customer-success' | 'first party' | 'hosting' | 'marketing' | 'other' | 'social' | 'tag-manager' | 'utility' | 'video';
[k: string]: unknown;
};
/**
* Request properties
*/
readonly request?: {
/**
* Size in octet of the request body sent over the network (after encoding)
*/
readonly encoded_body_size?: number;
/**
* Size in octet of the request body before any encoding
*/
readonly decoded_body_size?: number;
/**
* HTTP headers of the resource request
*/
headers?: {
[k: string]: string;
};
[k: string]: unknown;
};
/**
* Response properties
*/
readonly response?: {
/**
* HTTP headers of the resource response
*/
headers?: {
[k: string]: string;
};
[k: string]: unknown;
};
readonly graphql?: RumGraphql;
[k: string]: unknown;
};
/**
* Internal properties
*/
readonly _dd?: RumTrace & {
/**
* Whether the resource should be discarded or indexed
*/
readonly discarded?: boolean;
[k: string]: unknown;
};
[k: string]: unknown;
};
/**
* Schema of all properties of a View event
*/
export type RumViewEvent = CommonProperties & ViewContainerSchema & StreamSchema & ViewProperties & {
/**
* RUM event type
*/
readonly type: 'view';
view: {
time_spent: number;
action: {
[k: string]: unknown;
};
error: {
[k: string]: unknown;
};
resource: {
[k: string]: unknown;
};
[k: string]: unknown;
};
readonly _dd: {
[k: string]: unknown;
};
[k: string]: unknown;
};
/**
* Schema of all properties of a View Update event
*/
export type RumViewUpdateEvent = ViewContainerSchema & StreamSchema & ViewProperties & CommonProperties & {
/**
* RUM event type
*/
readonly type: 'view_update';
readonly view: {
[k: string]: unknown;
};
[k: string]: unknown;
};
export type RumVitalEvent = RumVitalDurationEvent | RumVitalOperationStepEvent | RumVitalAppLaunchEvent | RumVitalWebsocketConnectingEvent | RumVitalWebsocketOpenEvent | RumVitalWebsocketClosingEvent | RumVitalWebsocketClosedEvent;
/**
* Schema for a duration vital event.
*/
export type RumVitalDurationEvent = RumVitalEventCommonProperties & {
/**
* Vital properties
*/
readonly vital?: {
/**
* Type of the vital.
*/
readonly type: 'duration';
/**
* Duration of the vital in nanoseconds.
*/
readonly duration: number;
[k: string]: unknown;
};
[k: string]: unknown;
};
/**
* Schema of common properties for a Vital event
*/
export type RumVitalEventCommonProperties = CommonProperties & ViewContainerSchema & {
/**
* RUM event type
*/
readonly type: 'vital';
readonly view: {
[k: string]: unknown;
};
/**
* Vital properties
*/
readonly vital: {
/**
* UUID of the vital
*/
readonly id: string;
/**
* Name of the vital, as it is also used as facet path for its value, it must contain only letters, digits, or the characters - _ . @ $
*/
readonly name?: string;
/**
* Description of the vital. It can be used as a secondary identifier (URL, React component name...)
*/
readonly description?: string;
[k: string]: unknown;
};
/**
* Internal properties
*/
readonly _dd?: {
/**
* Profiling context
*/
profiling?: ProfilingInternalContextSchema;
[k: string]: unknown;
};
[k: string]: unknown;
};
/**
* Schema for a vital operation step event.
*/
export type RumVitalOperationStepEvent = RumVitalEventCommonProperties & {
/**
* Vital properties
*/
readonly vital?: {
/**
* Type of the vital.
*/
readonly type: 'operation_step';
/**
* Optional key to distinguish between multiple operations of the same name running in parallel (e.g., 'photo_upload' with keys 'profile_pic' vs 'cover')
*/
readonly operation_key?: string;
/**
* Type of the step that triggered the vital, if applicable
*/
readonly step_type: 'start' | 'update' | 'retry' | 'end';
/**
* Reason for the failure of the step, if applicable
*/
readonly failure_reason?: 'error' | 'abandoned' | 'other';
[k: string]: unknown;
};
[k: string]: unknown;
};
/**
* Schema for app launch metrics.
*/
export type RumVitalAppLaunchEvent = RumVitalEventCommonProperties & {
/**
* Vital properties
*/
readonly vital?: {
/**
* Type of the vital.
*/
readonly type: 'app_launch';
/**