@sentry/types 8.41.0 → 8.43.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (177) hide show
  1. package/README.md +5 -1
  2. package/build/esm/package.json +1 -1
  3. package/build/types/index.d.ts +377 -53
  4. package/build/types/index.d.ts.map +1 -1
  5. package/build/types-ts3.8/index.d.ts +377 -53
  6. package/package.json +4 -1
  7. package/build/types/attachment.d.ts +0 -29
  8. package/build/types/attachment.d.ts.map +0 -1
  9. package/build/types/breadcrumb.d.ts +0 -96
  10. package/build/types/breadcrumb.d.ts.map +0 -1
  11. package/build/types/browseroptions.d.ts +0 -25
  12. package/build/types/browseroptions.d.ts.map +0 -1
  13. package/build/types/checkin.d.ts +0 -100
  14. package/build/types/checkin.d.ts.map +0 -1
  15. package/build/types/client.d.ts +0 -323
  16. package/build/types/client.d.ts.map +0 -1
  17. package/build/types/clientreport.d.ts +0 -12
  18. package/build/types/clientreport.d.ts.map +0 -1
  19. package/build/types/context.d.ts +0 -119
  20. package/build/types/context.d.ts.map +0 -1
  21. package/build/types/datacategory.d.ts +0 -2
  22. package/build/types/datacategory.d.ts.map +0 -1
  23. package/build/types/debugMeta.d.ts +0 -28
  24. package/build/types/debugMeta.d.ts.map +0 -1
  25. package/build/types/dsn.d.ts +0 -22
  26. package/build/types/dsn.d.ts.map +0 -1
  27. package/build/types/envelope.d.ts +0 -127
  28. package/build/types/envelope.d.ts.map +0 -1
  29. package/build/types/error.d.ts +0 -7
  30. package/build/types/error.d.ts.map +0 -1
  31. package/build/types/event.d.ts +0 -99
  32. package/build/types/event.d.ts.map +0 -1
  33. package/build/types/eventprocessor.d.ts +0 -12
  34. package/build/types/eventprocessor.d.ts.map +0 -1
  35. package/build/types/exception.d.ts +0 -12
  36. package/build/types/exception.d.ts.map +0 -1
  37. package/build/types/extra.d.ts +0 -3
  38. package/build/types/extra.d.ts.map +0 -1
  39. package/build/types/feedback/config.d.ts +0 -178
  40. package/build/types/feedback/config.d.ts.map +0 -1
  41. package/build/types/feedback/form.d.ts +0 -8
  42. package/build/types/feedback/form.d.ts.map +0 -1
  43. package/build/types/feedback/index.d.ts +0 -71
  44. package/build/types/feedback/index.d.ts.map +0 -1
  45. package/build/types/feedback/sendFeedback.d.ts +0 -49
  46. package/build/types/feedback/sendFeedback.d.ts.map +0 -1
  47. package/build/types/feedback/theme.d.ts +0 -35
  48. package/build/types/feedback/theme.d.ts.map +0 -1
  49. package/build/types/hub.d.ts +0 -195
  50. package/build/types/hub.d.ts.map +0 -1
  51. package/build/types/instrument.d.ts +0 -69
  52. package/build/types/instrument.d.ts.map +0 -1
  53. package/build/types/integration.d.ts +0 -52
  54. package/build/types/integration.d.ts.map +0 -1
  55. package/build/types/measurement.d.ts +0 -24
  56. package/build/types/measurement.d.ts.map +0 -1
  57. package/build/types/mechanism.d.ts +0 -51
  58. package/build/types/mechanism.d.ts.map +0 -1
  59. package/build/types/metrics.d.ts +0 -94
  60. package/build/types/metrics.d.ts.map +0 -1
  61. package/build/types/misc.d.ts +0 -53
  62. package/build/types/misc.d.ts.map +0 -1
  63. package/build/types/opentelemetry.d.ts +0 -14
  64. package/build/types/opentelemetry.d.ts.map +0 -1
  65. package/build/types/options.d.ts +0 -315
  66. package/build/types/options.d.ts.map +0 -1
  67. package/build/types/package.d.ts +0 -8
  68. package/build/types/package.d.ts.map +0 -1
  69. package/build/types/parameterize.d.ts +0 -5
  70. package/build/types/parameterize.d.ts.map +0 -1
  71. package/build/types/polymorphics.d.ts +0 -71
  72. package/build/types/polymorphics.d.ts.map +0 -1
  73. package/build/types/profiling.d.ts +0 -143
  74. package/build/types/profiling.d.ts.map +0 -1
  75. package/build/types/replay.d.ts +0 -25
  76. package/build/types/replay.d.ts.map +0 -1
  77. package/build/types/request.d.ts +0 -38
  78. package/build/types/request.d.ts.map +0 -1
  79. package/build/types/runtime.d.ts +0 -6
  80. package/build/types/runtime.d.ts.map +0 -1
  81. package/build/types/samplingcontext.d.ts +0 -41
  82. package/build/types/samplingcontext.d.ts.map +0 -1
  83. package/build/types/scope.d.ts +0 -241
  84. package/build/types/scope.d.ts.map +0 -1
  85. package/build/types/sdkinfo.d.ts +0 -8
  86. package/build/types/sdkinfo.d.ts.map +0 -1
  87. package/build/types/sdkmetadata.d.ts +0 -5
  88. package/build/types/sdkmetadata.d.ts.map +0 -1
  89. package/build/types/session.d.ts +0 -75
  90. package/build/types/session.d.ts.map +0 -1
  91. package/build/types/severity.d.ts +0 -2
  92. package/build/types/severity.d.ts.map +0 -1
  93. package/build/types/span.d.ts +0 -222
  94. package/build/types/span.d.ts.map +0 -1
  95. package/build/types/spanStatus.d.ts +0 -59
  96. package/build/types/spanStatus.d.ts.map +0 -1
  97. package/build/types/stackframe.d.ts +0 -22
  98. package/build/types/stackframe.d.ts.map +0 -1
  99. package/build/types/stacktrace.d.ts +0 -10
  100. package/build/types/stacktrace.d.ts.map +0 -1
  101. package/build/types/startSpanOptions.d.ts +0 -46
  102. package/build/types/startSpanOptions.d.ts.map +0 -1
  103. package/build/types/thread.d.ts +0 -10
  104. package/build/types/thread.d.ts.map +0 -1
  105. package/build/types/timedEvent.d.ts +0 -7
  106. package/build/types/timedEvent.d.ts.map +0 -1
  107. package/build/types/tracing.d.ts +0 -51
  108. package/build/types/tracing.d.ts.map +0 -1
  109. package/build/types/transaction.d.ts +0 -35
  110. package/build/types/transaction.d.ts.map +0 -1
  111. package/build/types/transport.d.ts +0 -32
  112. package/build/types/transport.d.ts.map +0 -1
  113. package/build/types/user.d.ts +0 -17
  114. package/build/types/user.d.ts.map +0 -1
  115. package/build/types/view-hierarchy.d.ts +0 -18
  116. package/build/types/view-hierarchy.d.ts.map +0 -1
  117. package/build/types/webfetchapi.d.ts +0 -15
  118. package/build/types/webfetchapi.d.ts.map +0 -1
  119. package/build/types/wrappedfunction.d.ts +0 -7
  120. package/build/types/wrappedfunction.d.ts.map +0 -1
  121. package/build/types-ts3.8/attachment.d.ts +0 -29
  122. package/build/types-ts3.8/breadcrumb.d.ts +0 -96
  123. package/build/types-ts3.8/browseroptions.d.ts +0 -25
  124. package/build/types-ts3.8/checkin.d.ts +0 -100
  125. package/build/types-ts3.8/client.d.ts +0 -323
  126. package/build/types-ts3.8/clientreport.d.ts +0 -12
  127. package/build/types-ts3.8/context.d.ts +0 -119
  128. package/build/types-ts3.8/datacategory.d.ts +0 -2
  129. package/build/types-ts3.8/debugMeta.d.ts +0 -28
  130. package/build/types-ts3.8/dsn.d.ts +0 -22
  131. package/build/types-ts3.8/envelope.d.ts +0 -136
  132. package/build/types-ts3.8/error.d.ts +0 -7
  133. package/build/types-ts3.8/event.d.ts +0 -99
  134. package/build/types-ts3.8/eventprocessor.d.ts +0 -12
  135. package/build/types-ts3.8/exception.d.ts +0 -12
  136. package/build/types-ts3.8/extra.d.ts +0 -3
  137. package/build/types-ts3.8/feedback/config.d.ts +0 -178
  138. package/build/types-ts3.8/feedback/form.d.ts +0 -8
  139. package/build/types-ts3.8/feedback/index.d.ts +0 -71
  140. package/build/types-ts3.8/feedback/sendFeedback.d.ts +0 -49
  141. package/build/types-ts3.8/feedback/theme.d.ts +0 -35
  142. package/build/types-ts3.8/hub.d.ts +0 -195
  143. package/build/types-ts3.8/instrument.d.ts +0 -69
  144. package/build/types-ts3.8/integration.d.ts +0 -52
  145. package/build/types-ts3.8/measurement.d.ts +0 -24
  146. package/build/types-ts3.8/mechanism.d.ts +0 -51
  147. package/build/types-ts3.8/metrics.d.ts +0 -94
  148. package/build/types-ts3.8/misc.d.ts +0 -53
  149. package/build/types-ts3.8/opentelemetry.d.ts +0 -17
  150. package/build/types-ts3.8/options.d.ts +0 -315
  151. package/build/types-ts3.8/package.d.ts +0 -8
  152. package/build/types-ts3.8/parameterize.d.ts +0 -5
  153. package/build/types-ts3.8/polymorphics.d.ts +0 -71
  154. package/build/types-ts3.8/profiling.d.ts +0 -143
  155. package/build/types-ts3.8/replay.d.ts +0 -25
  156. package/build/types-ts3.8/request.d.ts +0 -41
  157. package/build/types-ts3.8/runtime.d.ts +0 -6
  158. package/build/types-ts3.8/samplingcontext.d.ts +0 -41
  159. package/build/types-ts3.8/scope.d.ts +0 -241
  160. package/build/types-ts3.8/sdkinfo.d.ts +0 -8
  161. package/build/types-ts3.8/sdkmetadata.d.ts +0 -5
  162. package/build/types-ts3.8/session.d.ts +0 -75
  163. package/build/types-ts3.8/severity.d.ts +0 -2
  164. package/build/types-ts3.8/span.d.ts +0 -222
  165. package/build/types-ts3.8/spanStatus.d.ts +0 -59
  166. package/build/types-ts3.8/stackframe.d.ts +0 -22
  167. package/build/types-ts3.8/stacktrace.d.ts +0 -16
  168. package/build/types-ts3.8/startSpanOptions.d.ts +0 -46
  169. package/build/types-ts3.8/thread.d.ts +0 -10
  170. package/build/types-ts3.8/timedEvent.d.ts +0 -7
  171. package/build/types-ts3.8/tracing.d.ts +0 -51
  172. package/build/types-ts3.8/transaction.d.ts +0 -35
  173. package/build/types-ts3.8/transport.d.ts +0 -32
  174. package/build/types-ts3.8/user.d.ts +0 -17
  175. package/build/types-ts3.8/view-hierarchy.d.ts +0 -18
  176. package/build/types-ts3.8/webfetchapi.d.ts +0 -15
  177. package/build/types-ts3.8/wrappedfunction.d.ts +0 -7
@@ -1,69 +0,0 @@
1
- import { WebFetchHeaders } from './webfetchapi';
2
- type XHRSendInput = unknown;
3
- export type ConsoleLevel = 'debug' | 'info' | 'warn' | 'error' | 'log' | 'assert' | 'trace';
4
- export interface SentryWrappedXMLHttpRequest {
5
- __sentry_xhr_v3__?: SentryXhrData;
6
- __sentry_own_request__?: boolean;
7
- __sentry_xhr_span_id__?: string;
8
- setRequestHeader?: (key: string, val: string) => void;
9
- getResponseHeader?: (key: string) => string | null;
10
- }
11
- export interface SentryXhrData {
12
- method: string;
13
- url: string;
14
- status_code?: number;
15
- body?: XHRSendInput;
16
- request_body_size?: number;
17
- response_body_size?: number;
18
- request_headers: Record<string, string>;
19
- }
20
- export interface HandlerDataXhr {
21
- xhr: SentryWrappedXMLHttpRequest;
22
- startTimestamp?: number;
23
- endTimestamp?: number;
24
- }
25
- interface SentryFetchData {
26
- method: string;
27
- url: string;
28
- request_body_size?: number;
29
- response_body_size?: number;
30
- __span?: string;
31
- }
32
- export interface HandlerDataFetch {
33
- args: any[];
34
- fetchData: SentryFetchData;
35
- startTimestamp: number;
36
- endTimestamp?: number;
37
- response?: {
38
- readonly ok: boolean;
39
- readonly status: number;
40
- readonly url: string;
41
- headers: WebFetchHeaders;
42
- };
43
- error?: unknown;
44
- }
45
- export interface HandlerDataDom {
46
- event: object | {
47
- target: object;
48
- };
49
- name: string;
50
- global?: boolean;
51
- }
52
- export interface HandlerDataConsole {
53
- level: ConsoleLevel;
54
- args: any[];
55
- }
56
- export interface HandlerDataHistory {
57
- from: string | undefined;
58
- to: string;
59
- }
60
- export interface HandlerDataError {
61
- column?: number;
62
- error?: Error;
63
- line?: number;
64
- msg: string | object;
65
- url?: string;
66
- }
67
- export type HandlerDataUnhandledRejection = unknown;
68
- export {};
69
- //# sourceMappingURL=instrument.d.ts.map
@@ -1,52 +0,0 @@
1
- import { Client } from './client';
2
- import { Event, EventHint } from './event';
3
- /** Integration Class Interface */
4
- export interface IntegrationClass<T> {
5
- /**
6
- * Property that holds the integration name
7
- */
8
- id: string;
9
- new (...args: any[]): T;
10
- }
11
- /** Integration interface */
12
- export interface Integration {
13
- /**
14
- * The name of the integration.
15
- */
16
- name: string;
17
- /**
18
- * This hook is only called once, even if multiple clients are created.
19
- * It does not receives any arguments, and should only use for e.g. global monkey patching and similar things.
20
- */
21
- setupOnce?(): void;
22
- /**
23
- * Set up an integration for the given client.
24
- * Receives the client as argument.
25
- *
26
- * Whenever possible, prefer this over `setupOnce`, as that is only run for the first client,
27
- * whereas `setup` runs for each client. Only truly global things (e.g. registering global handlers)
28
- * should be done in `setupOnce`.
29
- */
30
- setup?(client: Client): void;
31
- /**
32
- * This hook is triggered after `setupOnce()` and `setup()` have been called for all integrations.
33
- * You can use it if it is important that all other integrations have been run before.
34
- */
35
- afterAllSetup?(client: Client): void;
36
- /**
37
- * An optional hook that allows to preprocess an event _before_ it is passed to all other event processors.
38
- */
39
- preprocessEvent?(event: Event, hint: EventHint | undefined, client: Client): void;
40
- /**
41
- * An optional hook that allows to process an event.
42
- * Return `null` to drop the event, or mutate the event & return it.
43
- * This receives the client that the integration was installed for as third argument.
44
- */
45
- processEvent?(event: Event, hint: EventHint, client: Client): Event | null | PromiseLike<Event | null>;
46
- }
47
- /**
48
- * An integration in function form.
49
- * This is expected to return an integration.
50
- */
51
- export type IntegrationFn<IntegrationType = Integration> = (...rest: any[]) => IntegrationType;
52
- //# sourceMappingURL=integration.d.ts.map
@@ -1,24 +0,0 @@
1
- /**
2
- * A time duration.
3
- */
4
- export type DurationUnit = 'nanosecond' | 'microsecond' | 'millisecond' | 'second' | 'minute' | 'hour' | 'day' | 'week';
5
- /**
6
- * Size of information derived from bytes.
7
- */
8
- export type InformationUnit = 'bit' | 'byte' | 'kilobyte' | 'kibibyte' | 'megabyte' | 'mebibyte' | 'gigabyte' | 'terabyte' | 'tebibyte' | 'petabyte' | 'exabyte' | 'exbibyte';
9
- /**
10
- * Fractions such as percentages.
11
- */
12
- export type FractionUnit = 'ratio' | 'percent';
13
- /**
14
- * Untyped value without a unit.
15
- */
16
- export type NoneUnit = '' | 'none';
17
- type LiteralUnion<T extends string> = T | Pick<T, Exclude<keyof T, T>>;
18
- export type MeasurementUnit = LiteralUnion<DurationUnit | InformationUnit | FractionUnit | NoneUnit>;
19
- export type Measurements = Record<string, {
20
- value: number;
21
- unit: MeasurementUnit;
22
- }>;
23
- export {};
24
- //# sourceMappingURL=measurement.d.ts.map
@@ -1,51 +0,0 @@
1
- /**
2
- * Metadata about a captured exception, intended to provide a hint as to the means by which it was captured.
3
- */
4
- export interface Mechanism {
5
- /**
6
- * For now, restricted to `onerror`, `onunhandledrejection` (both obvious), `instrument` (the result of
7
- * auto-instrumentation), and `generic` (everything else). Converted to a tag on ingest.
8
- */
9
- type: string;
10
- /**
11
- * In theory, whether or not the exception has been handled by the user. In practice, whether or not we see it before
12
- * it hits the global error/rejection handlers, whether through explicit handling by the user or auto instrumentation.
13
- * Converted to a tag on ingest and used in various ways in the UI.
14
- */
15
- handled?: boolean;
16
- /**
17
- * Arbitrary data to be associated with the mechanism (for example, errors coming from event handlers include the
18
- * handler name and the event target. Will show up in the UI directly above the stacktrace.
19
- */
20
- data?: {
21
- [key: string]: string | boolean;
22
- };
23
- /**
24
- * True when `captureException` is called with anything other than an instance of `Error` (or, in the case of browser,
25
- * an instance of `ErrorEvent`, `DOMError`, or `DOMException`). causing us to create a synthetic error in an attempt
26
- * to recreate the stacktrace.
27
- */
28
- synthetic?: boolean;
29
- /**
30
- * Describes the source of the exception, in the case that this is a derived (linked or aggregate) error.
31
- *
32
- * This should be populated with the name of the property where the exception was found on the parent exception.
33
- * E.g. "cause", "errors[0]", "errors[1]"
34
- */
35
- source?: string;
36
- /**
37
- * Indicates whether the exception is an `AggregateException`.
38
- */
39
- is_exception_group?: boolean;
40
- /**
41
- * An identifier for the exception inside the `event.exception.values` array. This identifier is referenced to via the
42
- * `parent_id` attribute to link and aggregate errors.
43
- */
44
- exception_id?: number;
45
- /**
46
- * References another exception via the `exception_id` field to indicate that this exception is a child of that
47
- * exception in the case of aggregate or linked errors.
48
- */
49
- parent_id?: number;
50
- }
51
- //# sourceMappingURL=mechanism.d.ts.map
@@ -1,94 +0,0 @@
1
- import { Client } from './client';
2
- import { DurationUnit, MeasurementUnit } from './measurement';
3
- import { Primitive } from './misc';
4
- export interface MetricData {
5
- unit?: MeasurementUnit;
6
- tags?: Record<string, Primitive>;
7
- timestamp?: number;
8
- client?: Client;
9
- }
10
- /**
11
- * An abstract definition of the minimum required API
12
- * for a metric instance.
13
- */
14
- export interface MetricInstance {
15
- /**
16
- * Returns the weight of the metric.
17
- */
18
- weight: number;
19
- /**
20
- * Adds a value to a metric.
21
- */
22
- add(value: number | string): void;
23
- /**
24
- * Serializes the metric into a statsd format string.
25
- */
26
- toString(): string;
27
- }
28
- export interface MetricBucketItem {
29
- metric: MetricInstance;
30
- timestamp: number;
31
- metricType: 'c' | 'g' | 's' | 'd';
32
- name: string;
33
- unit: MeasurementUnit;
34
- tags: Record<string, string>;
35
- }
36
- /**
37
- * A metrics aggregator that aggregates metrics in memory and flushes them periodically.
38
- */
39
- export interface MetricsAggregator {
40
- /**
41
- * Add a metric to the aggregator.
42
- */
43
- add(metricType: 'c' | 'g' | 's' | 'd', name: string, value: number | string, unit?: MeasurementUnit, tags?: Record<string, Primitive>, timestamp?: number): void;
44
- /**
45
- * Flushes the current metrics to the transport via the transport.
46
- */
47
- flush(): void;
48
- /**
49
- * Shuts down metrics aggregator and clears all metrics.
50
- */
51
- close(): void;
52
- /**
53
- * Returns a string representation of the aggregator.
54
- */
55
- toString(): string;
56
- }
57
- export interface Metrics {
58
- /**
59
- * Adds a value to a counter metric
60
- *
61
- * @experimental This API is experimental and might have breaking changes in the future.
62
- */
63
- increment(name: string, value?: number, data?: MetricData): void;
64
- /**
65
- * Adds a value to a distribution metric
66
- *
67
- * @experimental This API is experimental and might have breaking changes in the future.
68
- */
69
- distribution(name: string, value: number, data?: MetricData): void;
70
- /**
71
- * Adds a value to a set metric. Value must be a string or integer.
72
- *
73
- * @experimental This API is experimental and might have breaking changes in the future.
74
- */
75
- set(name: string, value: number | string, data?: MetricData): void;
76
- /**
77
- * Adds a value to a gauge metric
78
- *
79
- * @experimental This API is experimental and might have breaking changes in the future.
80
- */
81
- gauge(name: string, value: number, data?: MetricData): void;
82
- /**
83
- * Adds a timing metric.
84
- * The metric is added as a distribution metric.
85
- *
86
- * You can either directly capture a numeric `value`, or wrap a callback function in `timing`.
87
- * In the latter case, the duration of the callback execution will be captured as a span & a metric.
88
- *
89
- * @experimental This API is experimental and might have breaking changes in the future.
90
- */
91
- timing(name: string, value: number, unit?: DurationUnit, data?: Pick<MetricData, Exclude<keyof MetricData, 'unit'>>): void;
92
- timing<T>(name: string, callback: () => T, unit?: DurationUnit, data?: Pick<MetricData, Exclude<keyof MetricData, 'unit'>>): T;
93
- }
94
- //# sourceMappingURL=metrics.d.ts.map
@@ -1,53 +0,0 @@
1
- import { QueryParams } from './request';
2
- /**
3
- * Data extracted from an incoming request to a node server
4
- */
5
- export interface ExtractedNodeRequestData {
6
- [key: string]: any;
7
- /** Specific headers from the request */
8
- headers?: {
9
- [key: string]: string;
10
- };
11
- /** The request's method */
12
- method?: string;
13
- /** The request's URL, including query string */
14
- url?: string;
15
- /** String representing the cookies sent along with the request */
16
- cookies?: {
17
- [key: string]: string;
18
- };
19
- /** The request's query params */
20
- query_string?: QueryParams;
21
- /** Any data sent in the request's body, as a JSON string */
22
- data?: string;
23
- }
24
- /**
25
- * Location object on a service worker's `self` object.
26
- *
27
- * See https://developer.mozilla.org/en-US/docs/Web/API/WorkerLocation.
28
- */
29
- export interface WorkerLocation {
30
- /** The protocol scheme of the URL of the script executed in the Worker, including the final ':'. */
31
- readonly protocol: string;
32
- /** The host, that is the hostname, a ':', and the port of the URL of the script executed in the Worker. */
33
- readonly host: string;
34
- /** The domain of the URL of the script executed in the Worker. */
35
- readonly hostname: string;
36
- /** The canonical form of the origin of the specific location. */
37
- readonly origin: string;
38
- /** The port number of the URL of the script executed in the Worker. */
39
- readonly port: string;
40
- /** The path of the URL of the script executed in the Worker, beginning with a '/'. */
41
- readonly pathname: string;
42
- /** The parameters (query string) of the URL of the script executed in the Worker, beginning with a '?'. */
43
- readonly search: string;
44
- /** The fragment identifier of the URL of the script executed in the Worker, beginning with a '#'. */
45
- readonly hash: string;
46
- /** Stringifier that returns the whole URL of the script executed in the Worker. */
47
- readonly href: string;
48
- /** Synonym for `href` attribute */
49
- toString(): string;
50
- }
51
- export type Primitive = number | string | boolean | bigint | symbol | null | undefined;
52
- export type HttpHeaderValue = string | string[] | number | null;
53
- //# sourceMappingURL=misc.d.ts.map
@@ -1,17 +0,0 @@
1
- /**
2
- * Defines High-Resolution Time.
3
- *
4
- * The first number, HrTime[0], is UNIX Epoch time in seconds since 00:00:00 UTC on 1 January 1970.
5
- * The second number, HrTime[1], represents the partial second elapsed since Unix Epoch time represented by first number in nanoseconds.
6
- * For example, 2021-01-01T12:30:10.150Z in UNIX Epoch time in milliseconds is represented as 1609504210150.
7
- * The first number is calculated by converting and truncating the Epoch time in milliseconds to seconds:
8
- * HrTime[0] = Math.trunc(1609504210150 / 1000) = 1609504210.
9
- * The second number is calculated by converting the digits after the decimal point of the subtraction, (1609504210150 / 1000) - HrTime[0], to nanoseconds:
10
- * HrTime[1] = Number((1609504210.150 - HrTime[0]).toFixed(9)) * 1e9 = 150000000.
11
- * This is represented in HrTime format as [1609504210, 150000000].
12
- */
13
- export type HrTime = [
14
- number,
15
- number
16
- ];
17
- //# sourceMappingURL=opentelemetry.d.ts.map
@@ -1,315 +0,0 @@
1
- import { Breadcrumb, BreadcrumbHint } from './breadcrumb';
2
- import { ErrorEvent, EventHint, TransactionEvent } from './event';
3
- import { Integration } from './integration';
4
- import { SamplingContext } from './samplingcontext';
5
- import { CaptureContext } from './scope';
6
- import { SdkMetadata } from './sdkmetadata';
7
- import { SpanJSON } from './span';
8
- import { StackLineParser, StackParser } from './stacktrace';
9
- import { TracePropagationTargets } from './tracing';
10
- import { BaseTransportOptions, Transport } from './transport';
11
- export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOptions> {
12
- /**
13
- * Enable debug functionality in the SDK itself
14
- */
15
- debug?: boolean;
16
- /**
17
- * Specifies whether this SDK should send events to Sentry.
18
- * Defaults to true.
19
- */
20
- enabled?: boolean;
21
- /** Attaches stacktraces to pure capture message / log integrations */
22
- attachStacktrace?: boolean;
23
- /**
24
- * A flag enabling Sessions Tracking feature.
25
- * By default, Sessions Tracking is enabled.
26
- */
27
- autoSessionTracking?: boolean;
28
- /**
29
- * Send SDK Client Reports. When calling `Sentry.init()`, this option defaults to `true`.
30
- */
31
- sendClientReports?: boolean;
32
- /**
33
- * The Dsn used to connect to Sentry and identify the project. If omitted, the
34
- * SDK will not send any data to Sentry.
35
- */
36
- dsn?: string;
37
- /**
38
- * The release identifier used when uploading respective source maps. Specify
39
- * this value to allow Sentry to resolve the correct source maps when
40
- * processing events.
41
- */
42
- release?: string;
43
- /** The current environment of your application (e.g. "production"). */
44
- environment?: string;
45
- /** Sets the distribution for all events */
46
- dist?: string;
47
- /**
48
- * List of integrations that should be installed after SDK was initialized.
49
- */
50
- integrations: Integration[];
51
- /**
52
- * A function that takes transport options and returns the Transport object which is used to send events to Sentry.
53
- * The function is invoked internally when the client is initialized.
54
- */
55
- transport: (transportOptions: TO) => Transport;
56
- /**
57
- * A stack parser implementation
58
- * By default, a stack parser is supplied for all supported platforms
59
- */
60
- stackParser: StackParser;
61
- /**
62
- * Options for the default transport that the SDK uses.
63
- */
64
- transportOptions?: Partial<TO>;
65
- /**
66
- * Sample rate to determine trace sampling.
67
- *
68
- * 0.0 = 0% chance of a given trace being sent (send no traces) 1.0 = 100% chance of a given trace being sent (send
69
- * all traces)
70
- *
71
- * Tracing is enabled if either this or `tracesSampler` is defined. If both are defined, `tracesSampleRate` is
72
- * ignored.
73
- */
74
- tracesSampleRate?: number;
75
- /**
76
- * If this is enabled, spans and trace data will be generated and captured.
77
- * This will set the `tracesSampleRate` to the recommended default of `1.0` if `tracesSampleRate` is undefined.
78
- * Note that `tracesSampleRate` and `tracesSampler` take precedence over this option.
79
- *
80
- * @deprecated This option is deprecated and will be removed in the next major version. If you want to enable performance
81
- * monitoring, please use the `tracesSampleRate` or `tracesSampler` options instead. If you wan't to disable performance
82
- * monitoring, remove the `tracesSampler` and `tracesSampleRate` options.
83
- */
84
- enableTracing?: boolean;
85
- /**
86
- * If this is enabled, any spans started will always have their parent be the active root span,
87
- * if there is any active span.
88
- *
89
- * This is necessary because in some environments (e.g. browser),
90
- * we cannot guarantee an accurate active span.
91
- * Because we cannot properly isolate execution environments,
92
- * you may get wrong results when using e.g. nested `startSpan()` calls.
93
- *
94
- * To solve this, in these environments we'll by default enable this option.
95
- */
96
- parentSpanIsAlwaysRootSpan?: boolean;
97
- /**
98
- * Initial data to populate scope.
99
- */
100
- initialScope?: CaptureContext;
101
- /**
102
- * The maximum number of breadcrumbs sent with events. Defaults to 100.
103
- * Sentry has a maximum payload size of 1MB and any events exceeding that payload size will be dropped.
104
- */
105
- maxBreadcrumbs?: number;
106
- /**
107
- * A global sample rate to apply to all events.
108
- *
109
- * 0.0 = 0% chance of a given event being sent (send no events) 1.0 = 100% chance of a given event being sent (send
110
- * all events)
111
- */
112
- sampleRate?: number;
113
- /** Maximum number of chars a single value can have before it will be truncated. */
114
- maxValueLength?: number;
115
- /**
116
- * Maximum number of levels that normalization algorithm will traverse in objects and arrays.
117
- * Used when normalizing an event before sending, on all of the listed attributes:
118
- * - `breadcrumbs.data`
119
- * - `user`
120
- * - `contexts`
121
- * - `extra`
122
- * Defaults to `3`. Set to `0` to disable.
123
- */
124
- normalizeDepth?: number;
125
- /**
126
- * Maximum number of properties or elements that the normalization algorithm will output in any single array or object included in the normalized event.
127
- * Used when normalizing an event before sending, on all of the listed attributes:
128
- * - `breadcrumbs.data`
129
- * - `user`
130
- * - `contexts`
131
- * - `extra`
132
- * Defaults to `1000`
133
- */
134
- normalizeMaxBreadth?: number;
135
- /**
136
- * Controls how many milliseconds to wait before shutting down. The default is
137
- * SDK-specific but typically around 2 seconds. Setting this too low can cause
138
- * problems for sending events from command line applications. Setting it too
139
- * high can cause the application to block for users with network connectivity
140
- * problems.
141
- */
142
- shutdownTimeout?: number;
143
- /**
144
- * A pattern for error messages which should not be sent to Sentry.
145
- * By default, all errors will be sent.
146
- */
147
- ignoreErrors?: Array<string | RegExp>;
148
- /**
149
- * A pattern for transaction names which should not be sent to Sentry.
150
- * By default, all transactions will be sent.
151
- */
152
- ignoreTransactions?: Array<string | RegExp>;
153
- /**
154
- * A URL to an envelope tunnel endpoint. An envelope tunnel is an HTTP endpoint
155
- * that accepts Sentry envelopes for forwarding. This can be used to force data
156
- * through a custom server independent of the type of data.
157
- */
158
- tunnel?: string;
159
- /**
160
- * Controls if potentially sensitive data should be sent to Sentry by default.
161
- * Note that this only applies to data that the SDK is sending by default
162
- * but not data that was explicitly set (e.g. by calling `Sentry.setUser()`).
163
- *
164
- * Defaults to `false`.
165
- *
166
- * NOTE: This option currently controls only a few data points in a selected
167
- * set of SDKs. The goal for this option is to eventually control all sensitive
168
- * data the SDK sets by default. However, this would be a breaking change so
169
- * until the next major update this option only controls data points which were
170
- * added in versions above `7.9.0`.
171
- */
172
- sendDefaultPii?: boolean;
173
- /**
174
- * Set of metadata about the SDK that can be internally used to enhance envelopes and events,
175
- * and provide additional data about every request.
176
- */
177
- _metadata?: SdkMetadata;
178
- /**
179
- * Options which are in beta, or otherwise not guaranteed to be stable.
180
- */
181
- _experiments?: {
182
- [key: string]: any;
183
- };
184
- /**
185
- * A pattern for error URLs which should exclusively be sent to Sentry.
186
- * This is the opposite of {@link Options.denyUrls}.
187
- * By default, all errors will be sent.
188
- *
189
- * Requires the use of the `InboundFilters` integration.
190
- */
191
- allowUrls?: Array<string | RegExp>;
192
- /**
193
- * A pattern for error URLs which should not be sent to Sentry.
194
- * To allow certain errors instead, use {@link Options.allowUrls}.
195
- * By default, all errors will be sent.
196
- *
197
- * Requires the use of the `InboundFilters` integration.
198
- */
199
- denyUrls?: Array<string | RegExp>;
200
- /**
201
- * List of strings and/or Regular Expressions used to determine which outgoing requests will have `sentry-trace` and `baggage`
202
- * headers attached.
203
- *
204
- * **Default:** If this option is not provided, tracing headers will be attached to all outgoing requests.
205
- * If you are using a browser SDK, by default, tracing headers will only be attached to outgoing requests to the same origin.
206
- *
207
- * **Disclaimer:** Carelessly setting this option in browser environments may result into CORS errors!
208
- * Only attach tracing headers to requests to the same origin, or to requests to services you can control CORS headers of.
209
- * Cross-origin requests, meaning requests to a different domain, for example a request to `https://api.example.com/` while you're on `https://example.com/`, take special care.
210
- * If you are attaching headers to cross-origin requests, make sure the backend handling the request returns a `"Access-Control-Allow-Headers: sentry-trace, baggage"` header to ensure your requests aren't blocked.
211
- *
212
- * If you provide a `tracePropagationTargets` array, the entries you provide will be matched against the entire URL of the outgoing request.
213
- * If you are using a browser SDK, the entries will also be matched against the pathname of the outgoing requests.
214
- * This is so you can have matchers for relative requests, for example, `/^\/api/` if you want to trace requests to your `/api` routes on the same domain.
215
- *
216
- * If any of the two match any of the provided values, tracing headers will be attached to the outgoing request.
217
- * Both, the string values, and the RegExes you provide in the array will match if they partially match the URL or pathname.
218
- *
219
- * Examples:
220
- * - `tracePropagationTargets: [/^\/api/]` and request to `https://same-origin.com/api/posts`:
221
- * - Tracing headers will be attached because the request is sent to the same origin and the regex matches the pathname "/api/posts".
222
- * - `tracePropagationTargets: [/^\/api/]` and request to `https://different-origin.com/api/posts`:
223
- * - Tracing headers will not be attached because the pathname will only be compared when the request target lives on the same origin.
224
- * - `tracePropagationTargets: [/^\/api/, 'https://external-api.com']` and request to `https://external-api.com/v1/data`:
225
- * - Tracing headers will be attached because the request URL matches the string `'https://external-api.com'`.
226
- */
227
- tracePropagationTargets?: TracePropagationTargets;
228
- /**
229
- * Function to compute tracing sample rate dynamically and filter unwanted traces.
230
- *
231
- * Tracing is enabled if either this or `tracesSampleRate` is defined. If both are defined, `tracesSampleRate` is
232
- * ignored.
233
- *
234
- * Will automatically be passed a context object of default and optional custom data. See
235
- * {@link Transaction.samplingContext} and {@link Hub.startTransaction}.
236
- *
237
- * @returns A sample rate between 0 and 1 (0 drops the trace, 1 guarantees it will be sent). Returning `true` is
238
- * equivalent to returning 1 and returning `false` is equivalent to returning 0.
239
- */
240
- tracesSampler?: (samplingContext: SamplingContext) => number | boolean;
241
- /**
242
- * An event-processing callback for error and message events, guaranteed to be invoked after all other event
243
- * processors, which allows an event to be modified or dropped.
244
- *
245
- * Note that you must return a valid event from this callback. If you do not wish to modify the event, simply return
246
- * it at the end. Returning `null` will cause the event to be dropped.
247
- *
248
- * @param event The error or message event generated by the SDK.
249
- * @param hint Event metadata useful for processing.
250
- * @returns A new event that will be sent | null.
251
- */
252
- beforeSend?: (event: ErrorEvent, hint: EventHint) => PromiseLike<ErrorEvent | null> | ErrorEvent | null;
253
- /**
254
- * This function can be defined to modify or entirely drop a child span before it's sent.
255
- * Returning `null` will cause this span to be dropped.
256
- *
257
- * Note that this function is only called for child spans and not for the root span (formerly known as transaction).
258
- * If you want to modify or drop the root span, use {@link Options.beforeSendTransaction} instead.
259
- *
260
- * @param span The span generated by the SDK.
261
- *
262
- * @returns A new span that will be sent or null if the span should not be sent.
263
- */
264
- beforeSendSpan?: (span: SpanJSON) => SpanJSON | null;
265
- /**
266
- * An event-processing callback for transaction events, guaranteed to be invoked after all other event
267
- * processors. This allows an event to be modified or dropped before it's sent.
268
- *
269
- * Note that you must return a valid event from this callback. If you do not wish to modify the event, simply return
270
- * it at the end. Returning `null` will cause the event to be dropped.
271
- *
272
- * @param event The error or message event generated by the SDK.
273
- * @param hint Event metadata useful for processing.
274
- * @returns A new event that will be sent | null.
275
- */
276
- beforeSendTransaction?: (event: TransactionEvent, hint: EventHint) => PromiseLike<TransactionEvent | null> | TransactionEvent | null;
277
- /**
278
- * A callback invoked when adding a breadcrumb, allowing to optionally modify
279
- * it before adding it to future events.
280
- *
281
- * Note that you must return a valid breadcrumb from this callback. If you do
282
- * not wish to modify the breadcrumb, simply return it at the end.
283
- * Returning null will cause the breadcrumb to be dropped.
284
- *
285
- * @param breadcrumb The breadcrumb as created by the SDK.
286
- * @returns The breadcrumb that will be added | null.
287
- */
288
- beforeBreadcrumb?: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => Breadcrumb | null;
289
- }
290
- /** Base configuration options for every SDK. */
291
- export interface Options<TO extends BaseTransportOptions = BaseTransportOptions> extends Pick<Partial<ClientOptions<TO>>, Exclude<keyof Partial<ClientOptions<TO>>, 'integrations' | 'transport' | 'stackParser'>> {
292
- /**
293
- * If this is set to false, default integrations will not be added, otherwise this will internally be set to the
294
- * recommended default integrations.
295
- */
296
- defaultIntegrations?: false | Integration[];
297
- /**
298
- * List of integrations that should be installed after SDK was initialized.
299
- * Accepts either a list of integrations or a function that receives
300
- * default integrations and returns a new, updated list.
301
- */
302
- integrations?: Integration[] | ((integrations: Integration[]) => Integration[]);
303
- /**
304
- * A function that takes transport options and returns the Transport object which is used to send events to Sentry.
305
- * The function is invoked internally during SDK initialization.
306
- * By default, the SDK initializes its default transports.
307
- */
308
- transport?: (transportOptions: TO) => Transport;
309
- /**
310
- * A stack parser implementation or an array of stack line parsers
311
- * By default, a stack parser is supplied for all supported browsers
312
- */
313
- stackParser?: StackParser | StackLineParser[];
314
- }
315
- //# sourceMappingURL=options.d.ts.map