@crawlee/core 4.0.0-beta.28 → 4.0.0-beta.280

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 (266) hide show
  1. package/README.md +15 -15
  2. package/byte-utils.d.ts +17 -0
  3. package/byte-utils.js +42 -0
  4. package/configuration.d.ts +75 -167
  5. package/configuration.js +164 -140
  6. package/debug.d.ts +36 -0
  7. package/debug.js +70 -0
  8. package/errors.d.ts +40 -19
  9. package/errors.js +52 -30
  10. package/events/{event_manager.d.ts → event-manager.d.ts} +29 -6
  11. package/events/{event_manager.js → event-manager.js} +10 -9
  12. package/events/index.d.ts +3 -3
  13. package/events/index.js +2 -3
  14. package/events/{local_event_manager.d.ts → local-event-manager.d.ts} +3 -10
  15. package/events/local-event-manager.js +101 -0
  16. package/events/system-info.d.ts +38 -0
  17. package/events/system-info.js +1 -0
  18. package/index.d.ts +9 -13
  19. package/index.js +10 -12
  20. package/internal.d.ts +8 -0
  21. package/internal.js +9 -0
  22. package/iterables.d.ts +79 -0
  23. package/iterables.js +134 -0
  24. package/log.d.ts +77 -1
  25. package/log.js +134 -1
  26. package/memory-storage/consts.d.ts +4 -0
  27. package/memory-storage/consts.js +4 -0
  28. package/memory-storage/index.d.ts +1 -0
  29. package/memory-storage/index.js +1 -0
  30. package/memory-storage/memory-storage.d.ts +43 -0
  31. package/memory-storage/memory-storage.js +158 -0
  32. package/memory-storage/resource-clients/common/base-client.d.ts +4 -0
  33. package/memory-storage/resource-clients/common/base-client.js +6 -0
  34. package/memory-storage/resource-clients/dataset.d.ts +35 -0
  35. package/memory-storage/resource-clients/dataset.js +108 -0
  36. package/memory-storage/resource-clients/key-value-store.d.ts +54 -0
  37. package/memory-storage/resource-clients/key-value-store.js +179 -0
  38. package/memory-storage/resource-clients/request-queue.d.ts +55 -0
  39. package/memory-storage/resource-clients/request-queue.js +413 -0
  40. package/memory-storage/utils.d.ts +16 -0
  41. package/memory-storage/utils.js +41 -0
  42. package/owned-or-injected.d.ts +58 -0
  43. package/owned-or-injected.js +98 -0
  44. package/package.json +23 -23
  45. package/proxy-configuration.d.ts +118 -0
  46. package/proxy-configuration.js +141 -0
  47. package/recoverable-state.d.ts +177 -0
  48. package/recoverable-state.js +268 -0
  49. package/request.d.ts +48 -101
  50. package/request.js +139 -249
  51. package/serialization.d.ts +0 -1
  52. package/serialization.js +18 -18
  53. package/{service_locator.d.ts → service-locator.d.ts} +66 -37
  54. package/service-locator.js +255 -0
  55. package/storages/batched-adds.d.ts +39 -0
  56. package/storages/batched-adds.js +81 -0
  57. package/storages/dataset.d.ts +105 -58
  58. package/storages/dataset.js +292 -151
  59. package/storages/index.d.ts +11 -12
  60. package/storages/index.js +7 -12
  61. package/storages/key-value-store-codec.d.ts +32 -0
  62. package/storages/key-value-store-codec.js +108 -0
  63. package/storages/{key_value_store.d.ts → key-value-store.d.ts} +169 -72
  64. package/storages/key-value-store.js +767 -0
  65. package/storages/request-dedup-cache.d.ts +20 -0
  66. package/storages/request-dedup-cache.js +48 -0
  67. package/storages/{request_list.d.ts → request-list.d.ts} +32 -171
  68. package/storages/{request_list.js → request-list.js} +276 -253
  69. package/storages/request-loader.d.ts +127 -0
  70. package/storages/request-loader.js +34 -0
  71. package/storages/request-manager-tandem.d.ts +82 -0
  72. package/storages/request-manager-tandem.js +200 -0
  73. package/storages/request-manager.d.ts +119 -0
  74. package/storages/request-manager.js +1 -0
  75. package/storages/{request_provider.d.ts → request-queue.d.ts} +127 -161
  76. package/storages/request-queue.js +871 -0
  77. package/storages/storage-instance-manager.d.ts +86 -0
  78. package/storages/storage-instance-manager.js +256 -0
  79. package/storages/storage-stats.d.ts +48 -0
  80. package/storages/storage-stats.js +29 -0
  81. package/storages/transaction.d.ts +270 -0
  82. package/storages/transaction.js +296 -0
  83. package/storages/utils.d.ts +59 -11
  84. package/storages/utils.js +76 -17
  85. package/system-info/cpu-info.d.ts +67 -0
  86. package/system-info/cpu-info.js +216 -0
  87. package/system-info/memory-info.d.ts +31 -0
  88. package/system-info/memory-info.js +115 -0
  89. package/system-info/ps-tree.d.ts +17 -0
  90. package/system-info/ps-tree.js +144 -0
  91. package/system-info/runtime.d.ts +14 -0
  92. package/system-info/runtime.js +80 -0
  93. package/typedefs.d.ts +0 -6
  94. package/typedefs.js +0 -1
  95. package/url.d.ts +9 -0
  96. package/url.js +11 -0
  97. package/validators.d.ts +23 -18
  98. package/validators.js +14 -18
  99. package/autoscaling/autoscaled_pool.d.ts +0 -298
  100. package/autoscaling/autoscaled_pool.d.ts.map +0 -1
  101. package/autoscaling/autoscaled_pool.js +0 -527
  102. package/autoscaling/autoscaled_pool.js.map +0 -1
  103. package/autoscaling/index.d.ts +0 -4
  104. package/autoscaling/index.d.ts.map +0 -1
  105. package/autoscaling/index.js +0 -4
  106. package/autoscaling/index.js.map +0 -1
  107. package/autoscaling/snapshotter.d.ts +0 -179
  108. package/autoscaling/snapshotter.d.ts.map +0 -1
  109. package/autoscaling/snapshotter.js +0 -279
  110. package/autoscaling/snapshotter.js.map +0 -1
  111. package/autoscaling/system_status.d.ts +0 -178
  112. package/autoscaling/system_status.d.ts.map +0 -1
  113. package/autoscaling/system_status.js +0 -168
  114. package/autoscaling/system_status.js.map +0 -1
  115. package/configuration.d.ts.map +0 -1
  116. package/configuration.js.map +0 -1
  117. package/cookie_utils.d.ts +0 -43
  118. package/cookie_utils.d.ts.map +0 -1
  119. package/cookie_utils.js +0 -111
  120. package/cookie_utils.js.map +0 -1
  121. package/crawlers/context_pipeline.d.ts +0 -61
  122. package/crawlers/context_pipeline.d.ts.map +0 -1
  123. package/crawlers/context_pipeline.js +0 -99
  124. package/crawlers/context_pipeline.js.map +0 -1
  125. package/crawlers/crawler_commons.d.ts +0 -191
  126. package/crawlers/crawler_commons.d.ts.map +0 -1
  127. package/crawlers/crawler_commons.js +0 -108
  128. package/crawlers/crawler_commons.js.map +0 -1
  129. package/crawlers/crawler_utils.d.ts +0 -10
  130. package/crawlers/crawler_utils.d.ts.map +0 -1
  131. package/crawlers/crawler_utils.js +0 -12
  132. package/crawlers/crawler_utils.js.map +0 -1
  133. package/crawlers/error_snapshotter.d.ts +0 -60
  134. package/crawlers/error_snapshotter.d.ts.map +0 -1
  135. package/crawlers/error_snapshotter.js +0 -118
  136. package/crawlers/error_snapshotter.js.map +0 -1
  137. package/crawlers/error_tracker.d.ts +0 -55
  138. package/crawlers/error_tracker.d.ts.map +0 -1
  139. package/crawlers/error_tracker.js +0 -309
  140. package/crawlers/error_tracker.js.map +0 -1
  141. package/crawlers/index.d.ts +0 -7
  142. package/crawlers/index.d.ts.map +0 -1
  143. package/crawlers/index.js +0 -7
  144. package/crawlers/index.js.map +0 -1
  145. package/crawlers/internals/types.d.ts +0 -8
  146. package/crawlers/internals/types.d.ts.map +0 -1
  147. package/crawlers/internals/types.js +0 -2
  148. package/crawlers/internals/types.js.map +0 -1
  149. package/crawlers/statistics.d.ts +0 -204
  150. package/crawlers/statistics.d.ts.map +0 -1
  151. package/crawlers/statistics.js +0 -350
  152. package/crawlers/statistics.js.map +0 -1
  153. package/enqueue_links/enqueue_links.d.ts +0 -254
  154. package/enqueue_links/enqueue_links.d.ts.map +0 -1
  155. package/enqueue_links/enqueue_links.js +0 -268
  156. package/enqueue_links/enqueue_links.js.map +0 -1
  157. package/enqueue_links/index.d.ts +0 -3
  158. package/enqueue_links/index.d.ts.map +0 -1
  159. package/enqueue_links/index.js +0 -3
  160. package/enqueue_links/index.js.map +0 -1
  161. package/enqueue_links/shared.d.ts +0 -84
  162. package/enqueue_links/shared.d.ts.map +0 -1
  163. package/enqueue_links/shared.js +0 -219
  164. package/enqueue_links/shared.js.map +0 -1
  165. package/errors.d.ts.map +0 -1
  166. package/errors.js.map +0 -1
  167. package/events/event_manager.d.ts.map +0 -1
  168. package/events/event_manager.js.map +0 -1
  169. package/events/index.d.ts.map +0 -1
  170. package/events/index.js.map +0 -1
  171. package/events/local_event_manager.d.ts.map +0 -1
  172. package/events/local_event_manager.js +0 -93
  173. package/events/local_event_manager.js.map +0 -1
  174. package/index.d.ts.map +0 -1
  175. package/index.js.map +0 -1
  176. package/log.d.ts.map +0 -1
  177. package/log.js.map +0 -1
  178. package/proxy_configuration.d.ts +0 -169
  179. package/proxy_configuration.d.ts.map +0 -1
  180. package/proxy_configuration.js +0 -247
  181. package/proxy_configuration.js.map +0 -1
  182. package/recoverable_state.d.ts +0 -122
  183. package/recoverable_state.d.ts.map +0 -1
  184. package/recoverable_state.js +0 -138
  185. package/recoverable_state.js.map +0 -1
  186. package/request.d.ts.map +0 -1
  187. package/request.js.map +0 -1
  188. package/router.d.ts +0 -134
  189. package/router.d.ts.map +0 -1
  190. package/router.js +0 -164
  191. package/router.js.map +0 -1
  192. package/serialization.d.ts.map +0 -1
  193. package/serialization.js.map +0 -1
  194. package/service_locator.d.ts.map +0 -1
  195. package/service_locator.js +0 -252
  196. package/service_locator.js.map +0 -1
  197. package/session_pool/consts.d.ts +0 -4
  198. package/session_pool/consts.d.ts.map +0 -1
  199. package/session_pool/consts.js +0 -4
  200. package/session_pool/consts.js.map +0 -1
  201. package/session_pool/errors.d.ts +0 -8
  202. package/session_pool/errors.d.ts.map +0 -1
  203. package/session_pool/errors.js +0 -12
  204. package/session_pool/errors.js.map +0 -1
  205. package/session_pool/events.d.ts +0 -3
  206. package/session_pool/events.d.ts.map +0 -1
  207. package/session_pool/events.js +0 -3
  208. package/session_pool/events.js.map +0 -1
  209. package/session_pool/index.d.ts +0 -6
  210. package/session_pool/index.d.ts.map +0 -1
  211. package/session_pool/index.js +0 -6
  212. package/session_pool/index.js.map +0 -1
  213. package/session_pool/session.d.ts +0 -186
  214. package/session_pool/session.d.ts.map +0 -1
  215. package/session_pool/session.js +0 -278
  216. package/session_pool/session.js.map +0 -1
  217. package/session_pool/session_pool.d.ts +0 -256
  218. package/session_pool/session_pool.d.ts.map +0 -1
  219. package/session_pool/session_pool.js +0 -386
  220. package/session_pool/session_pool.js.map +0 -1
  221. package/storages/access_checking.d.ts +0 -13
  222. package/storages/access_checking.d.ts.map +0 -1
  223. package/storages/access_checking.js +0 -14
  224. package/storages/access_checking.js.map +0 -1
  225. package/storages/dataset.d.ts.map +0 -1
  226. package/storages/dataset.js.map +0 -1
  227. package/storages/index.d.ts.map +0 -1
  228. package/storages/index.js.map +0 -1
  229. package/storages/key_value_store.d.ts.map +0 -1
  230. package/storages/key_value_store.js +0 -513
  231. package/storages/key_value_store.js.map +0 -1
  232. package/storages/request_list.d.ts.map +0 -1
  233. package/storages/request_list.js.map +0 -1
  234. package/storages/request_list_adapter.d.ts +0 -58
  235. package/storages/request_list_adapter.d.ts.map +0 -1
  236. package/storages/request_list_adapter.js +0 -81
  237. package/storages/request_list_adapter.js.map +0 -1
  238. package/storages/request_manager_tandem.d.ts +0 -68
  239. package/storages/request_manager_tandem.d.ts.map +0 -1
  240. package/storages/request_manager_tandem.js +0 -124
  241. package/storages/request_manager_tandem.js.map +0 -1
  242. package/storages/request_provider.d.ts.map +0 -1
  243. package/storages/request_provider.js +0 -592
  244. package/storages/request_provider.js.map +0 -1
  245. package/storages/request_queue.d.ts +0 -128
  246. package/storages/request_queue.d.ts.map +0 -1
  247. package/storages/request_queue.js +0 -320
  248. package/storages/request_queue.js.map +0 -1
  249. package/storages/request_queue_v2.d.ts +0 -87
  250. package/storages/request_queue_v2.d.ts.map +0 -1
  251. package/storages/request_queue_v2.js +0 -437
  252. package/storages/request_queue_v2.js.map +0 -1
  253. package/storages/sitemap_request_list.d.ts +0 -245
  254. package/storages/sitemap_request_list.d.ts.map +0 -1
  255. package/storages/sitemap_request_list.js +0 -431
  256. package/storages/sitemap_request_list.js.map +0 -1
  257. package/storages/storage_manager.d.ts +0 -60
  258. package/storages/storage_manager.d.ts.map +0 -1
  259. package/storages/storage_manager.js +0 -95
  260. package/storages/storage_manager.js.map +0 -1
  261. package/storages/utils.d.ts.map +0 -1
  262. package/storages/utils.js.map +0 -1
  263. package/typedefs.d.ts.map +0 -1
  264. package/typedefs.js.map +0 -1
  265. package/validators.d.ts.map +0 -1
  266. package/validators.js.map +0 -1
@@ -1,179 +0,0 @@
1
- import type { Log } from '@apify/log';
2
- import type { BetterIntervalID } from '@apify/utilities';
3
- import type { SystemInfo } from './system_status.js';
4
- export interface SnapshotterOptions {
5
- /**
6
- * Defines the interval of measuring the event loop response time.
7
- * @default 0.5
8
- */
9
- eventLoopSnapshotIntervalSecs?: number;
10
- /**
11
- * Defines the interval of checking the current state
12
- * of the remote API client.
13
- * @default 1
14
- */
15
- clientSnapshotIntervalSecs?: number;
16
- /**
17
- * Maximum allowed delay of the event loop in milliseconds.
18
- * Exceeding this limit overloads the event loop.
19
- * @default 50
20
- */
21
- maxBlockedMillis?: number;
22
- /**
23
- * Defines the maximum ratio of total memory that can be used.
24
- * Exceeding this limit overloads the memory.
25
- * @default 0.9
26
- */
27
- maxUsedMemoryRatio?: number;
28
- /**
29
- * Defines the maximum number of new rate limit errors within
30
- * the given interval.
31
- * @default 1
32
- */
33
- maxClientErrors?: number;
34
- /**
35
- * Sets the interval in seconds for which a history of resource snapshots
36
- * will be kept. Increasing this to very high numbers will affect performance.
37
- * @default 60
38
- */
39
- snapshotHistorySecs?: number;
40
- /** @internal */
41
- log?: Log;
42
- }
43
- interface MemorySnapshot {
44
- createdAt: Date;
45
- isOverloaded: boolean;
46
- usedBytes?: number;
47
- }
48
- interface CpuSnapshot {
49
- createdAt: Date;
50
- isOverloaded: boolean;
51
- usedRatio: number;
52
- ticks?: {
53
- idle: number;
54
- total: number;
55
- };
56
- }
57
- interface EventLoopSnapshot {
58
- createdAt: Date;
59
- isOverloaded: boolean;
60
- exceededMillis: number;
61
- }
62
- interface ClientSnapshot {
63
- createdAt: Date;
64
- isOverloaded: boolean;
65
- rateLimitErrorCount: number;
66
- }
67
- /**
68
- * Creates snapshots of system resources at given intervals and marks the resource
69
- * as either overloaded or not during the last interval. Keeps a history of the snapshots.
70
- * It tracks the following resources: Memory, EventLoop, API and CPU.
71
- * The class is used by the {@link AutoscaledPool} class.
72
- *
73
- * When running on the Apify platform, the CPU and memory statistics are provided by the platform,
74
- * as collected from the running Docker container. When running locally, `Snapshotter`
75
- * makes its own statistics by querying the OS.
76
- *
77
- * CPU becomes overloaded locally when its current use exceeds the `maxUsedCpuRatio` option or
78
- * when Apify platform marks it as overloaded.
79
- *
80
- * Memory becomes overloaded if its current use exceeds the `maxUsedMemoryRatio` option.
81
- * It's computed using the total memory available to the container when running on
82
- * the Apify platform and a quarter of total system memory when running locally.
83
- * Max total memory when running locally may be overridden by using the `CRAWLEE_MEMORY_MBYTES`
84
- * environment variable.
85
- *
86
- * Event loop becomes overloaded if it slows down by more than the `maxBlockedMillis` option.
87
- *
88
- * Client becomes overloaded when rate limit errors (429 - Too Many Requests),
89
- * typically received from the request queue, exceed the set limit within the set interval.
90
- * @category Scaling
91
- */
92
- export declare class Snapshotter {
93
- log: Log;
94
- eventLoopSnapshotIntervalMillis: number;
95
- clientSnapshotIntervalMillis: number;
96
- snapshotHistoryMillis: number;
97
- maxBlockedMillis: number;
98
- maxUsedMemoryRatio: number;
99
- maxClientErrors: number;
100
- maxMemoryBytes: number;
101
- cpuSnapshots: CpuSnapshot[];
102
- eventLoopSnapshots: EventLoopSnapshot[];
103
- memorySnapshots: MemorySnapshot[];
104
- clientSnapshots: ClientSnapshot[];
105
- eventLoopInterval: BetterIntervalID;
106
- clientInterval: BetterIntervalID;
107
- lastLoggedCriticalMemoryOverloadAt: Date | null;
108
- /**
109
- * @param [options] All `Snapshotter` configuration options.
110
- */
111
- constructor(options?: SnapshotterOptions);
112
- /**
113
- * Starts capturing snapshots at configured intervals.
114
- */
115
- start(): Promise<void>;
116
- /**
117
- * Stops all resource capturing.
118
- */
119
- stop(): Promise<void>;
120
- /**
121
- * Returns a sample of latest memory snapshots, with the size of the sample defined
122
- * by the sampleDurationMillis parameter. If omitted, it returns a full snapshot history.
123
- */
124
- getMemorySample(sampleDurationMillis?: number): MemorySnapshot[];
125
- /**
126
- * Returns a sample of latest event loop snapshots, with the size of the sample defined
127
- * by the sampleDurationMillis parameter. If omitted, it returns a full snapshot history.
128
- */
129
- getEventLoopSample(sampleDurationMillis?: number): EventLoopSnapshot[];
130
- /**
131
- * Returns a sample of latest CPU snapshots, with the size of the sample defined
132
- * by the sampleDurationMillis parameter. If omitted, it returns a full snapshot history.
133
- */
134
- getCpuSample(sampleDurationMillis?: number): CpuSnapshot[];
135
- /**
136
- * Returns a sample of latest Client snapshots, with the size of the sample defined
137
- * by the sampleDurationMillis parameter. If omitted, it returns a full snapshot history.
138
- */
139
- getClientSample(sampleDurationMillis?: number): ClientSnapshot[];
140
- /**
141
- * Finds the latest snapshots by sampleDurationMillis in the provided array.
142
- */
143
- protected _getSample<T extends {
144
- createdAt: Date;
145
- }>(snapshots: T[], sampleDurationMillis?: number): T[];
146
- /**
147
- * Creates a snapshot of current memory usage
148
- * using the Apify platform `systemInfo` event.
149
- */
150
- protected _snapshotMemory(systemInfo: SystemInfo): void;
151
- /**
152
- * Checks for critical memory overload and logs it to the console.
153
- */
154
- protected _memoryOverloadWarning(systemInfo: SystemInfo): void;
155
- /**
156
- * Creates a snapshot of current event loop delay.
157
- */
158
- protected _snapshotEventLoop(intervalCallback: () => unknown): void;
159
- /**
160
- * Creates a snapshot of current CPU usage using the Apify platform `systemInfo` event.
161
- */
162
- protected _snapshotCpu(systemInfo: SystemInfo): void;
163
- /**
164
- * Creates a snapshot of current API state by checking for
165
- * rate limit errors. Only errors produced by a 2nd retry
166
- * of the API call are considered for snapshotting since
167
- * earlier errors may just be caused by a random spike in
168
- * number of requests and do not necessarily signify API
169
- * overloading.
170
- */
171
- protected _snapshotClient(intervalCallback: () => unknown): void;
172
- /**
173
- * Removes snapshots that are older than the snapshotHistorySecs option
174
- * from the array (destructively - in place).
175
- */
176
- protected _pruneSnapshots(snapshots: MemorySnapshot[] | CpuSnapshot[] | EventLoopSnapshot[] | ClientSnapshot[], now: Date): void;
177
- }
178
- export {};
179
- //# sourceMappingURL=snapshotter.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"snapshotter.d.ts","sourceRoot":"","sources":["../../src/autoscaling/snapshotter.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAMzD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAMrD,MAAM,WAAW,kBAAkB;IAC/B;;;OAGG;IACH,6BAA6B,CAAC,EAAE,MAAM,CAAC;IAEvC;;;;OAIG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAEpC;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,gBAAgB;IAChB,GAAG,CAAC,EAAE,GAAG,CAAC;CACb;AAED,UAAU,cAAc;IACpB,SAAS,EAAE,IAAI,CAAC;IAChB,YAAY,EAAE,OAAO,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AACD,UAAU,WAAW;IACjB,SAAS,EAAE,IAAI,CAAC;IAChB,YAAY,EAAE,OAAO,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;CAC3C;AACD,UAAU,iBAAiB;IACvB,SAAS,EAAE,IAAI,CAAC;IAChB,YAAY,EAAE,OAAO,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;CAC1B;AACD,UAAU,cAAc;IACpB,SAAS,EAAE,IAAI,CAAC;IAChB,YAAY,EAAE,OAAO,CAAC;IACtB,mBAAmB,EAAE,MAAM,CAAC;CAC/B;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,WAAW;IACpB,GAAG,EAAE,GAAG,CAAC;IACT,+BAA+B,EAAE,MAAM,CAAC;IACxC,4BAA4B,EAAE,MAAM,CAAC;IACrC,qBAAqB,EAAE,MAAM,CAAC;IAC9B,gBAAgB,EAAE,MAAM,CAAC;IACzB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAG,MAAM,CAAC;IAExB,YAAY,EAAE,WAAW,EAAE,CAAM;IACjC,kBAAkB,EAAE,iBAAiB,EAAE,CAAM;IAC7C,eAAe,EAAE,cAAc,EAAE,CAAM;IACvC,eAAe,EAAE,cAAc,EAAE,CAAM;IAEvC,iBAAiB,EAAE,gBAAgB,CAAS;IAC5C,cAAc,EAAE,gBAAgB,CAAS;IAEzC,kCAAkC,EAAE,IAAI,GAAG,IAAI,CAAQ;IAEvD;;OAEG;gBACS,OAAO,GAAE,kBAAuB;IAsC5C;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IA+B5B;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAc3B;;;OAGG;IACH,eAAe,CAAC,oBAAoB,CAAC,EAAE,MAAM;IAI7C;;;OAGG;IACH,kBAAkB,CAAC,oBAAoB,CAAC,EAAE,MAAM;IAIhD;;;OAGG;IACH,YAAY,CAAC,oBAAoB,CAAC,EAAE,MAAM;IAI1C;;;OAGG;IACH,eAAe,CAAC,oBAAoB,CAAC,EAAE,MAAM;IAI7C;;OAEG;IACH,SAAS,CAAC,UAAU,CAAC,CAAC,SAAS;QAAE,SAAS,EAAE,IAAI,CAAA;KAAE,EAAE,SAAS,EAAE,CAAC,EAAE,EAAE,oBAAoB,CAAC,EAAE,MAAM,GAAG,CAAC,EAAE;IAoBvG;;;OAGG;IACH,SAAS,CAAC,eAAe,CAAC,UAAU,EAAE,UAAU;IAchD;;OAEG;IACH,SAAS,CAAC,sBAAsB,CAAC,UAAU,EAAE,UAAU;IA2BvD;;OAEG;IACH,SAAS,CAAC,kBAAkB,CAAC,gBAAgB,EAAE,MAAM,OAAO;IAuB5D;;OAEG;IACH,SAAS,CAAC,YAAY,CAAC,UAAU,EAAE,UAAU;IAY7C;;;;;;;OAOG;IACH,SAAS,CAAC,eAAe,CAAC,gBAAgB,EAAE,MAAM,OAAO;IAwBzD;;;OAGG;IACH,SAAS,CAAC,eAAe,CACrB,SAAS,EAAE,cAAc,EAAE,GAAG,WAAW,EAAE,GAAG,iBAAiB,EAAE,GAAG,cAAc,EAAE,EACpF,GAAG,EAAE,IAAI;CAUhB"}
@@ -1,279 +0,0 @@
1
- import { getMemoryInfo, isContainerized } from '@crawlee/utils';
2
- import ow from 'ow';
3
- import { betterClearInterval, betterSetInterval } from '@apify/utilities';
4
- import { log as defaultLog } from '../log.js';
5
- import { serviceLocator } from '../service_locator.js';
6
- const RESERVE_MEMORY_RATIO = 0.5;
7
- const CLIENT_RATE_LIMIT_ERROR_RETRY_COUNT = 2;
8
- const CRITICAL_OVERLOAD_RATE_LIMIT_MILLIS = 10000;
9
- /**
10
- * Creates snapshots of system resources at given intervals and marks the resource
11
- * as either overloaded or not during the last interval. Keeps a history of the snapshots.
12
- * It tracks the following resources: Memory, EventLoop, API and CPU.
13
- * The class is used by the {@link AutoscaledPool} class.
14
- *
15
- * When running on the Apify platform, the CPU and memory statistics are provided by the platform,
16
- * as collected from the running Docker container. When running locally, `Snapshotter`
17
- * makes its own statistics by querying the OS.
18
- *
19
- * CPU becomes overloaded locally when its current use exceeds the `maxUsedCpuRatio` option or
20
- * when Apify platform marks it as overloaded.
21
- *
22
- * Memory becomes overloaded if its current use exceeds the `maxUsedMemoryRatio` option.
23
- * It's computed using the total memory available to the container when running on
24
- * the Apify platform and a quarter of total system memory when running locally.
25
- * Max total memory when running locally may be overridden by using the `CRAWLEE_MEMORY_MBYTES`
26
- * environment variable.
27
- *
28
- * Event loop becomes overloaded if it slows down by more than the `maxBlockedMillis` option.
29
- *
30
- * Client becomes overloaded when rate limit errors (429 - Too Many Requests),
31
- * typically received from the request queue, exceed the set limit within the set interval.
32
- * @category Scaling
33
- */
34
- export class Snapshotter {
35
- log;
36
- eventLoopSnapshotIntervalMillis;
37
- clientSnapshotIntervalMillis;
38
- snapshotHistoryMillis;
39
- maxBlockedMillis;
40
- maxUsedMemoryRatio;
41
- maxClientErrors;
42
- maxMemoryBytes;
43
- cpuSnapshots = [];
44
- eventLoopSnapshots = [];
45
- memorySnapshots = [];
46
- clientSnapshots = [];
47
- eventLoopInterval = null;
48
- clientInterval = null;
49
- lastLoggedCriticalMemoryOverloadAt = null;
50
- /**
51
- * @param [options] All `Snapshotter` configuration options.
52
- */
53
- constructor(options = {}) {
54
- ow(options, ow.object.exactShape({
55
- eventLoopSnapshotIntervalSecs: ow.optional.number,
56
- clientSnapshotIntervalSecs: ow.optional.number,
57
- snapshotHistorySecs: ow.optional.number,
58
- maxBlockedMillis: ow.optional.number,
59
- maxUsedMemoryRatio: ow.optional.number,
60
- maxClientErrors: ow.optional.number,
61
- log: ow.optional.object,
62
- }));
63
- const { eventLoopSnapshotIntervalSecs = 0.5, clientSnapshotIntervalSecs = 1, snapshotHistorySecs = 30, maxBlockedMillis = 50, maxUsedMemoryRatio = 0.9, maxClientErrors = 3, log = defaultLog, } = options;
64
- this.log = log.child({ prefix: 'Snapshotter' });
65
- this.eventLoopSnapshotIntervalMillis = eventLoopSnapshotIntervalSecs * 1000;
66
- this.clientSnapshotIntervalMillis = clientSnapshotIntervalSecs * 1000;
67
- this.snapshotHistoryMillis = snapshotHistorySecs * 1000;
68
- this.maxBlockedMillis = maxBlockedMillis;
69
- this.maxUsedMemoryRatio = maxUsedMemoryRatio;
70
- this.maxClientErrors = maxClientErrors;
71
- // We need to pre-bind those functions to be able to successfully remove listeners.
72
- this._snapshotCpu = this._snapshotCpu.bind(this);
73
- this._snapshotMemory = this._snapshotMemory.bind(this);
74
- }
75
- /**
76
- * Starts capturing snapshots at configured intervals.
77
- */
78
- async start() {
79
- const memoryMbytes = serviceLocator.getConfiguration().get('memoryMbytes', 0);
80
- if (memoryMbytes > 0) {
81
- this.maxMemoryBytes = memoryMbytes * 1024 * 1024;
82
- }
83
- else {
84
- const containerized = serviceLocator.getConfiguration().get('containerized', await isContainerized());
85
- const memInfo = await getMemoryInfo(containerized);
86
- const totalBytes = memInfo.totalBytes;
87
- this.maxMemoryBytes = Math.ceil(totalBytes * serviceLocator.getConfiguration().get('availableMemoryRatio'));
88
- this.log.debug(`Setting max memory of this run to ${Math.round(this.maxMemoryBytes / 1024 / 1024)} MB. ` +
89
- 'Use the CRAWLEE_MEMORY_MBYTES or CRAWLEE_AVAILABLE_MEMORY_RATIO environment variable to override it.');
90
- }
91
- // Start snapshotting.
92
- this.eventLoopInterval = betterSetInterval(this._snapshotEventLoop.bind(this), this.eventLoopSnapshotIntervalMillis);
93
- this.clientInterval = betterSetInterval(this._snapshotClient.bind(this), this.clientSnapshotIntervalMillis);
94
- const events = serviceLocator.getEventManager();
95
- events.on("systemInfo" /* EventType.SYSTEM_INFO */, this._snapshotCpu);
96
- events.on("systemInfo" /* EventType.SYSTEM_INFO */, this._snapshotMemory);
97
- }
98
- /**
99
- * Stops all resource capturing.
100
- */
101
- async stop() {
102
- betterClearInterval(this.eventLoopInterval);
103
- betterClearInterval(this.clientInterval);
104
- const events = serviceLocator.getEventManager();
105
- events.off("systemInfo" /* EventType.SYSTEM_INFO */, this._snapshotCpu);
106
- events.off("systemInfo" /* EventType.SYSTEM_INFO */, this._snapshotMemory);
107
- // Allow microtask queue to unwind before stop returns.
108
- await new Promise((resolve) => {
109
- setImmediate(resolve);
110
- });
111
- }
112
- /**
113
- * Returns a sample of latest memory snapshots, with the size of the sample defined
114
- * by the sampleDurationMillis parameter. If omitted, it returns a full snapshot history.
115
- */
116
- getMemorySample(sampleDurationMillis) {
117
- return this._getSample(this.memorySnapshots, sampleDurationMillis);
118
- }
119
- /**
120
- * Returns a sample of latest event loop snapshots, with the size of the sample defined
121
- * by the sampleDurationMillis parameter. If omitted, it returns a full snapshot history.
122
- */
123
- getEventLoopSample(sampleDurationMillis) {
124
- return this._getSample(this.eventLoopSnapshots, sampleDurationMillis);
125
- }
126
- /**
127
- * Returns a sample of latest CPU snapshots, with the size of the sample defined
128
- * by the sampleDurationMillis parameter. If omitted, it returns a full snapshot history.
129
- */
130
- getCpuSample(sampleDurationMillis) {
131
- return this._getSample(this.cpuSnapshots, sampleDurationMillis);
132
- }
133
- /**
134
- * Returns a sample of latest Client snapshots, with the size of the sample defined
135
- * by the sampleDurationMillis parameter. If omitted, it returns a full snapshot history.
136
- */
137
- getClientSample(sampleDurationMillis) {
138
- return this._getSample(this.clientSnapshots, sampleDurationMillis);
139
- }
140
- /**
141
- * Finds the latest snapshots by sampleDurationMillis in the provided array.
142
- */
143
- _getSample(snapshots, sampleDurationMillis) {
144
- if (!sampleDurationMillis)
145
- return snapshots;
146
- const sample = [];
147
- let idx = snapshots.length;
148
- if (!idx)
149
- return sample;
150
- const latestTime = snapshots[idx - 1].createdAt;
151
- while (idx--) {
152
- const snapshot = snapshots[idx];
153
- if (+latestTime - +snapshot.createdAt <= sampleDurationMillis) {
154
- sample.unshift(snapshot);
155
- }
156
- else {
157
- break;
158
- }
159
- }
160
- return sample;
161
- }
162
- /**
163
- * Creates a snapshot of current memory usage
164
- * using the Apify platform `systemInfo` event.
165
- */
166
- _snapshotMemory(systemInfo) {
167
- const createdAt = systemInfo.createdAt ? new Date(systemInfo.createdAt) : new Date();
168
- this._pruneSnapshots(this.memorySnapshots, createdAt);
169
- const { memCurrentBytes } = systemInfo;
170
- const snapshot = {
171
- createdAt,
172
- isOverloaded: memCurrentBytes / this.maxMemoryBytes > this.maxUsedMemoryRatio,
173
- usedBytes: memCurrentBytes,
174
- };
175
- this.memorySnapshots.push(snapshot);
176
- this._memoryOverloadWarning(systemInfo);
177
- }
178
- /**
179
- * Checks for critical memory overload and logs it to the console.
180
- */
181
- _memoryOverloadWarning(systemInfo) {
182
- const { memCurrentBytes } = systemInfo;
183
- const createdAt = systemInfo.createdAt ? new Date(systemInfo.createdAt) : new Date();
184
- if (this.lastLoggedCriticalMemoryOverloadAt &&
185
- +createdAt < +this.lastLoggedCriticalMemoryOverloadAt + CRITICAL_OVERLOAD_RATE_LIMIT_MILLIS)
186
- return;
187
- const maxDesiredMemoryBytes = this.maxUsedMemoryRatio * this.maxMemoryBytes;
188
- const reserveMemory = this.maxMemoryBytes * (1 - this.maxUsedMemoryRatio) * RESERVE_MEMORY_RATIO;
189
- const criticalOverloadBytes = maxDesiredMemoryBytes + reserveMemory;
190
- const isCriticalOverload = memCurrentBytes > criticalOverloadBytes;
191
- if (isCriticalOverload) {
192
- const usedPercentage = Math.round((memCurrentBytes / this.maxMemoryBytes) * 100);
193
- const toMb = (bytes) => Math.round(bytes / 1024 ** 2);
194
- this.log.warning('Memory is critically overloaded. ' +
195
- `Using ${toMb(memCurrentBytes)} MB of ${toMb(this.maxMemoryBytes)} MB (${usedPercentage}%). Consider increasing available memory.`);
196
- this.lastLoggedCriticalMemoryOverloadAt = createdAt;
197
- }
198
- }
199
- /**
200
- * Creates a snapshot of current event loop delay.
201
- */
202
- _snapshotEventLoop(intervalCallback) {
203
- const now = new Date();
204
- this._pruneSnapshots(this.eventLoopSnapshots, now);
205
- const snapshot = {
206
- createdAt: now,
207
- isOverloaded: false,
208
- exceededMillis: 0,
209
- };
210
- const previousSnapshot = this.eventLoopSnapshots[this.eventLoopSnapshots.length - 1];
211
- if (previousSnapshot) {
212
- const { createdAt } = previousSnapshot;
213
- const delta = now.getTime() - +createdAt - this.eventLoopSnapshotIntervalMillis;
214
- if (delta > this.maxBlockedMillis)
215
- snapshot.isOverloaded = true;
216
- snapshot.exceededMillis = Math.max(delta - this.maxBlockedMillis, 0);
217
- }
218
- this.eventLoopSnapshots.push(snapshot);
219
- intervalCallback();
220
- }
221
- /**
222
- * Creates a snapshot of current CPU usage using the Apify platform `systemInfo` event.
223
- */
224
- _snapshotCpu(systemInfo) {
225
- const { cpuCurrentUsage, isCpuOverloaded } = systemInfo;
226
- const createdAt = systemInfo.createdAt ? new Date(systemInfo.createdAt) : new Date();
227
- this._pruneSnapshots(this.cpuSnapshots, createdAt);
228
- this.cpuSnapshots.push({
229
- createdAt,
230
- isOverloaded: isCpuOverloaded,
231
- usedRatio: Math.ceil(cpuCurrentUsage / 100),
232
- });
233
- }
234
- /**
235
- * Creates a snapshot of current API state by checking for
236
- * rate limit errors. Only errors produced by a 2nd retry
237
- * of the API call are considered for snapshotting since
238
- * earlier errors may just be caused by a random spike in
239
- * number of requests and do not necessarily signify API
240
- * overloading.
241
- */
242
- _snapshotClient(intervalCallback) {
243
- const now = new Date();
244
- this._pruneSnapshots(this.clientSnapshots, now);
245
- const allErrorCounts = serviceLocator.getStorageClient().stats?.rateLimitErrors ?? []; // storage client might not support this
246
- const currentErrCount = allErrorCounts[CLIENT_RATE_LIMIT_ERROR_RETRY_COUNT] || 0;
247
- // Handle empty snapshots array
248
- const snapshot = {
249
- createdAt: now,
250
- isOverloaded: false,
251
- rateLimitErrorCount: currentErrCount,
252
- };
253
- const previousSnapshot = this.clientSnapshots[this.clientSnapshots.length - 1];
254
- if (previousSnapshot) {
255
- const { rateLimitErrorCount } = previousSnapshot;
256
- const delta = currentErrCount - rateLimitErrorCount;
257
- if (delta > this.maxClientErrors)
258
- snapshot.isOverloaded = true;
259
- }
260
- this.clientSnapshots.push(snapshot);
261
- intervalCallback();
262
- }
263
- /**
264
- * Removes snapshots that are older than the snapshotHistorySecs option
265
- * from the array (destructively - in place).
266
- */
267
- _pruneSnapshots(snapshots, now) {
268
- let oldCount = 0;
269
- for (let i = 0; i < snapshots.length; i++) {
270
- const { createdAt } = snapshots[i];
271
- if (now.getTime() - new Date(createdAt).getTime() > this.snapshotHistoryMillis)
272
- oldCount++;
273
- else
274
- break;
275
- }
276
- snapshots.splice(0, oldCount);
277
- }
278
- }
279
- //# sourceMappingURL=snapshotter.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"snapshotter.js","sourceRoot":"","sources":["../../src/autoscaling/snapshotter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAChE,OAAO,EAAE,MAAM,IAAI,CAAC;AAIpB,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAG1E,OAAO,EAAE,GAAG,IAAI,UAAU,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAGvD,MAAM,oBAAoB,GAAG,GAAG,CAAC;AACjC,MAAM,mCAAmC,GAAG,CAAC,CAAC;AAC9C,MAAM,mCAAmC,GAAG,KAAK,CAAC;AAsElD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,OAAO,WAAW;IACpB,GAAG,CAAM;IACT,+BAA+B,CAAS;IACxC,4BAA4B,CAAS;IACrC,qBAAqB,CAAS;IAC9B,gBAAgB,CAAS;IACzB,kBAAkB,CAAS;IAC3B,eAAe,CAAS;IACxB,cAAc,CAAU;IAExB,YAAY,GAAkB,EAAE,CAAC;IACjC,kBAAkB,GAAwB,EAAE,CAAC;IAC7C,eAAe,GAAqB,EAAE,CAAC;IACvC,eAAe,GAAqB,EAAE,CAAC;IAEvC,iBAAiB,GAAqB,IAAK,CAAC;IAC5C,cAAc,GAAqB,IAAK,CAAC;IAEzC,kCAAkC,GAAgB,IAAI,CAAC;IAEvD;;OAEG;IACH,YAAY,UAA8B,EAAE;QACxC,EAAE,CACE,OAAO,EACP,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,6BAA6B,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM;YACjD,0BAA0B,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM;YAC9C,mBAAmB,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM;YACvC,gBAAgB,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM;YACpC,kBAAkB,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM;YACtC,eAAe,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM;YACnC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM;SAC1B,CAAC,CACL,CAAC;QAEF,MAAM,EACF,6BAA6B,GAAG,GAAG,EACnC,0BAA0B,GAAG,CAAC,EAC9B,mBAAmB,GAAG,EAAE,EACxB,gBAAgB,GAAG,EAAE,EACrB,kBAAkB,GAAG,GAAG,EACxB,eAAe,GAAG,CAAC,EACnB,GAAG,GAAG,UAAU,GACnB,GAAG,OAAO,CAAC;QAEZ,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;QAEhD,IAAI,CAAC,+BAA+B,GAAG,6BAA6B,GAAG,IAAI,CAAC;QAC5E,IAAI,CAAC,4BAA4B,GAAG,0BAA0B,GAAG,IAAI,CAAC;QACtE,IAAI,CAAC,qBAAqB,GAAG,mBAAmB,GAAG,IAAI,CAAC;QACxD,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QACzC,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAC7C,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QAEvC,mFAAmF;QACnF,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjD,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK;QACP,MAAM,YAAY,GAAG,cAAc,CAAC,gBAAgB,EAAE,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;QAE9E,IAAI,YAAY,GAAG,CAAC,EAAE,CAAC;YACnB,IAAI,CAAC,cAAc,GAAG,YAAY,GAAG,IAAI,GAAG,IAAI,CAAC;QACrD,CAAC;aAAM,CAAC;YACJ,MAAM,aAAa,GAAG,cAAc,CAAC,gBAAgB,EAAE,CAAC,GAAG,CAAC,eAAe,EAAE,MAAM,eAAe,EAAE,CAAC,CAAC;YACtG,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC,aAAa,CAAC,CAAC;YACnD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;YAEtC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,IAAI,CAC3B,UAAU,GAAG,cAAc,CAAC,gBAAgB,EAAE,CAAC,GAAG,CAAC,sBAAsB,CAAE,CAC9E,CAAC;YACF,IAAI,CAAC,GAAG,CAAC,KAAK,CACV,qCAAqC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,GAAG,IAAI,GAAG,IAAI,CAAC,OAAO;gBACrF,sGAAsG,CAC7G,CAAC;QACN,CAAC;QAED,sBAAsB;QACtB,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CACtC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAClC,IAAI,CAAC,+BAA+B,CACvC,CAAC;QACF,IAAI,CAAC,cAAc,GAAG,iBAAiB,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,4BAA4B,CAAC,CAAC;QAE5G,MAAM,MAAM,GAAG,cAAc,CAAC,eAAe,EAAE,CAAC;QAChD,MAAM,CAAC,EAAE,2CAAwB,IAAI,CAAC,YAAY,CAAC,CAAC;QACpD,MAAM,CAAC,EAAE,2CAAwB,IAAI,CAAC,eAAe,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI;QACN,mBAAmB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC5C,mBAAmB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAEzC,MAAM,MAAM,GAAG,cAAc,CAAC,eAAe,EAAE,CAAC;QAChD,MAAM,CAAC,GAAG,2CAAwB,IAAI,CAAC,YAAY,CAAC,CAAC;QACrD,MAAM,CAAC,GAAG,2CAAwB,IAAI,CAAC,eAAe,CAAC,CAAC;QAExD,uDAAuD;QACvD,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC1B,YAAY,CAAC,OAAO,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;OAGG;IACH,eAAe,CAAC,oBAA6B;QACzC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,eAAe,EAAE,oBAAoB,CAAC,CAAC;IACvE,CAAC;IAED;;;OAGG;IACH,kBAAkB,CAAC,oBAA6B;QAC5C,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,EAAE,oBAAoB,CAAC,CAAC;IAC1E,CAAC;IAED;;;OAGG;IACH,YAAY,CAAC,oBAA6B;QACtC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,EAAE,oBAAoB,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACH,eAAe,CAAC,oBAA6B;QACzC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,eAAe,EAAE,oBAAoB,CAAC,CAAC;IACvE,CAAC;IAED;;OAEG;IACO,UAAU,CAAgC,SAAc,EAAE,oBAA6B;QAC7F,IAAI,CAAC,oBAAoB;YAAE,OAAO,SAAS,CAAC;QAE5C,MAAM,MAAM,GAAQ,EAAE,CAAC;QACvB,IAAI,GAAG,GAAG,SAAS,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,GAAG;YAAE,OAAO,MAAM,CAAC;QAExB,MAAM,UAAU,GAAG,SAAS,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;QAChD,OAAO,GAAG,EAAE,EAAE,CAAC;YACX,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;YAChC,IAAI,CAAC,UAAU,GAAG,CAAC,QAAQ,CAAC,SAAS,IAAI,oBAAoB,EAAE,CAAC;gBAC5D,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACJ,MAAM;YACV,CAAC;QACL,CAAC;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;OAGG;IACO,eAAe,CAAC,UAAsB;QAC5C,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;QACrF,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;QACtD,MAAM,EAAE,eAAe,EAAE,GAAG,UAAU,CAAC;QACvC,MAAM,QAAQ,GAAmB;YAC7B,SAAS;YACT,YAAY,EAAE,eAAgB,GAAG,IAAI,CAAC,cAAe,GAAG,IAAI,CAAC,kBAAkB;YAC/E,SAAS,EAAE,eAAe;SAC7B,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpC,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAC5C,CAAC;IAED;;OAEG;IACO,sBAAsB,CAAC,UAAsB;QACnD,MAAM,EAAE,eAAe,EAAE,GAAG,UAAU,CAAC;QACvC,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;QACrF,IACI,IAAI,CAAC,kCAAkC;YACvC,CAAC,SAAS,GAAG,CAAC,IAAI,CAAC,kCAAkC,GAAG,mCAAmC;YAE3F,OAAO;QAEX,MAAM,qBAAqB,GAAG,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,cAAe,CAAC;QAC7E,MAAM,aAAa,GAAG,IAAI,CAAC,cAAe,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,oBAAoB,CAAC;QAClG,MAAM,qBAAqB,GAAG,qBAAqB,GAAG,aAAa,CAAC;QACpE,MAAM,kBAAkB,GAAG,eAAgB,GAAG,qBAAqB,CAAC;QAEpE,IAAI,kBAAkB,EAAE,CAAC;YACrB,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,eAAgB,GAAG,IAAI,CAAC,cAAe,CAAC,GAAG,GAAG,CAAC,CAAC;YACnF,MAAM,IAAI,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC;YAC9D,IAAI,CAAC,GAAG,CAAC,OAAO,CACZ,mCAAmC;gBAC/B,SAAS,IAAI,CAAC,eAAgB,CAAC,UAAU,IAAI,CACzC,IAAI,CAAC,cAAe,CACvB,QAAQ,cAAc,2CAA2C,CACzE,CAAC;YACF,IAAI,CAAC,kCAAkC,GAAG,SAAS,CAAC;QACxD,CAAC;IACL,CAAC;IAED;;OAEG;IACO,kBAAkB,CAAC,gBAA+B;QACxD,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,kBAAkB,EAAE,GAAG,CAAC,CAAC;QAEnD,MAAM,QAAQ,GAAG;YACb,SAAS,EAAE,GAAG;YACd,YAAY,EAAE,KAAK;YACnB,cAAc,EAAE,CAAC;SACpB,CAAC;QAEF,MAAM,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACrF,IAAI,gBAAgB,EAAE,CAAC;YACnB,MAAM,EAAE,SAAS,EAAE,GAAG,gBAAgB,CAAC;YACvC,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,+BAA+B,CAAC;YAEhF,IAAI,KAAK,GAAG,IAAI,CAAC,gBAAgB;gBAAE,QAAQ,CAAC,YAAY,GAAG,IAAI,CAAC;YAChE,QAAQ,CAAC,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC;QACzE,CAAC;QAED,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,gBAAgB,EAAE,CAAC;IACvB,CAAC;IAED;;OAEG;IACO,YAAY,CAAC,UAAsB;QACzC,MAAM,EAAE,eAAe,EAAE,eAAe,EAAE,GAAG,UAAU,CAAC;QACxD,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;QACrF,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;QAEnD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;YACnB,SAAS;YACT,YAAY,EAAE,eAAgB;YAC9B,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,eAAgB,GAAG,GAAG,CAAC;SAC/C,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;OAOG;IACO,eAAe,CAAC,gBAA+B;QACrD,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;QAEhD,MAAM,cAAc,GAAG,cAAc,CAAC,gBAAgB,EAAE,CAAC,KAAK,EAAE,eAAe,IAAI,EAAE,CAAC,CAAC,wCAAwC;QAC/H,MAAM,eAAe,GAAG,cAAc,CAAC,mCAAmC,CAAC,IAAI,CAAC,CAAC;QAEjF,+BAA+B;QAC/B,MAAM,QAAQ,GAAG;YACb,SAAS,EAAE,GAAG;YACd,YAAY,EAAE,KAAK;YACnB,mBAAmB,EAAE,eAAe;SACvC,CAAC;QACF,MAAM,gBAAgB,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC/E,IAAI,gBAAgB,EAAE,CAAC;YACnB,MAAM,EAAE,mBAAmB,EAAE,GAAG,gBAAgB,CAAC;YACjD,MAAM,KAAK,GAAG,eAAe,GAAG,mBAAmB,CAAC;YACpD,IAAI,KAAK,GAAG,IAAI,CAAC,eAAe;gBAAE,QAAQ,CAAC,YAAY,GAAG,IAAI,CAAC;QACnE,CAAC;QAED,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpC,gBAAgB,EAAE,CAAC;IACvB,CAAC;IAED;;;OAGG;IACO,eAAe,CACrB,SAAoF,EACpF,GAAS;QAET,IAAI,QAAQ,GAAG,CAAC,CAAC;QACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACxC,MAAM,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;YACnC,IAAI,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,qBAAqB;gBAAE,QAAQ,EAAE,CAAC;;gBACtF,MAAM;QACf,CAAC;QACD,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;IAClC,CAAC;CACJ"}
@@ -1,178 +0,0 @@
1
- import { Snapshotter } from './snapshotter.js';
2
- /**
3
- * Represents the current status of the system.
4
- */
5
- export interface SystemInfo {
6
- /** If false, system is being overloaded. */
7
- isSystemIdle: boolean;
8
- memInfo: ClientInfo;
9
- eventLoopInfo: ClientInfo;
10
- cpuInfo: ClientInfo;
11
- clientInfo: ClientInfo;
12
- memCurrentBytes?: number;
13
- /**
14
- * Platform only property
15
- * @internal
16
- */
17
- cpuCurrentUsage?: number;
18
- /**
19
- * Platform only property
20
- * @internal
21
- */
22
- isCpuOverloaded?: boolean;
23
- /**
24
- * Platform only property
25
- * @internal
26
- */
27
- createdAt?: Date;
28
- }
29
- export interface SystemStatusOptions {
30
- /**
31
- * Defines max age of snapshots used in the {@link SystemStatus.getCurrentStatus} measurement.
32
- * @default 5
33
- */
34
- currentHistorySecs?: number;
35
- /**
36
- * Sets the maximum ratio of overloaded snapshots in a memory sample.
37
- * If the sample exceeds this ratio, the system will be overloaded.
38
- * @default 0.2
39
- */
40
- maxMemoryOverloadedRatio?: number;
41
- /**
42
- * Sets the maximum ratio of overloaded snapshots in an event loop sample.
43
- * If the sample exceeds this ratio, the system will be overloaded.
44
- * @default 0.6
45
- */
46
- maxEventLoopOverloadedRatio?: number;
47
- /**
48
- * Sets the maximum ratio of overloaded snapshots in a CPU sample.
49
- * If the sample exceeds this ratio, the system will be overloaded.
50
- * @default 0.4
51
- */
52
- maxCpuOverloadedRatio?: number;
53
- /**
54
- * Sets the maximum ratio of overloaded snapshots in a Client sample.
55
- * If the sample exceeds this ratio, the system will be overloaded.
56
- * @default 0.3
57
- */
58
- maxClientOverloadedRatio?: number;
59
- /**
60
- * The `Snapshotter` instance to be queried for `SystemStatus`.
61
- */
62
- snapshotter?: Snapshotter;
63
- }
64
- export interface ClientInfo {
65
- isOverloaded: boolean;
66
- limitRatio: number;
67
- actualRatio: number;
68
- }
69
- export interface FinalStatistics {
70
- requestsFinished: number;
71
- requestsFailed: number;
72
- retryHistogram: number[];
73
- requestAvgFailedDurationMillis: number;
74
- requestAvgFinishedDurationMillis: number;
75
- requestsFinishedPerMinute: number;
76
- requestsFailedPerMinute: number;
77
- requestTotalDurationMillis: number;
78
- requestsTotal: number;
79
- crawlerRuntimeMillis: number;
80
- }
81
- /**
82
- * Provides a simple interface to reading system status from a {@link Snapshotter} instance.
83
- * It only exposes two functions {@link SystemStatus.getCurrentStatus}
84
- * and {@link SystemStatus.getHistoricalStatus}.
85
- * The system status is calculated using a weighted average of overloaded
86
- * messages in the snapshots, with the weights being the time intervals
87
- * between the snapshots. Each resource is calculated separately
88
- * and the system is overloaded whenever at least one resource is overloaded.
89
- * The class is used by the {@link AutoscaledPool} class.
90
- *
91
- * {@link SystemStatus.getCurrentStatus}
92
- * returns a boolean that represents the current status of the system.
93
- * The length of the current timeframe in seconds is configurable
94
- * by the `currentHistorySecs` option and represents the max age
95
- * of snapshots to be considered for the calculation.
96
- *
97
- * {@link SystemStatus.getHistoricalStatus}
98
- * returns a boolean that represents the long-term status
99
- * of the system. It considers the full snapshot history available
100
- * in the {@link Snapshotter} instance.
101
- * @category Scaling
102
- */
103
- export declare class SystemStatus {
104
- private readonly currentHistoryMillis;
105
- private readonly maxMemoryOverloadedRatio;
106
- private readonly maxEventLoopOverloadedRatio;
107
- private readonly maxCpuOverloadedRatio;
108
- private readonly maxClientOverloadedRatio;
109
- private readonly snapshotter;
110
- constructor(options?: SystemStatusOptions);
111
- /**
112
- * Returns an {@link SystemInfo} object with the following structure:
113
- *
114
- * ```javascript
115
- * {
116
- * isSystemIdle: Boolean,
117
- * memInfo: Object,
118
- * eventLoopInfo: Object,
119
- * cpuInfo: Object
120
- * }
121
- * ```
122
- *
123
- * Where the `isSystemIdle` property is set to `false` if the system
124
- * has been overloaded in the last `options.currentHistorySecs` seconds,
125
- * and `true` otherwise.
126
- */
127
- getCurrentStatus(): SystemInfo;
128
- /**
129
- * Returns an {@link SystemInfo} object with the following structure:
130
- *
131
- * ```javascript
132
- * {
133
- * isSystemIdle: Boolean,
134
- * memInfo: Object,
135
- * eventLoopInfo: Object,
136
- * cpuInfo: Object
137
- * }
138
- * ```
139
- *
140
- * Where the `isSystemIdle` property is set to `false` if the system
141
- * has been overloaded in the full history of the {@link Snapshotter}
142
- * (which is configurable in the {@link Snapshotter}) and `true` otherwise.
143
- */
144
- getHistoricalStatus(): SystemInfo;
145
- /**
146
- * Returns a system status object.
147
- */
148
- protected _isSystemIdle(sampleDurationMillis?: number): SystemInfo;
149
- /**
150
- * Returns an object with an isOverloaded property set to true
151
- * if the memory has been overloaded in the last sampleDurationMillis.
152
- */
153
- protected _isMemoryOverloaded(sampleDurationMillis?: number): ClientInfo;
154
- /**
155
- * Returns an object with an isOverloaded property set to true
156
- * if the event loop has been overloaded in the last sampleDurationMillis.
157
- */
158
- protected _isEventLoopOverloaded(sampleDurationMillis?: number): ClientInfo;
159
- /**
160
- * Returns an object with an isOverloaded property set to true
161
- * if the CPU has been overloaded in the last sampleDurationMillis.
162
- */
163
- protected _isCpuOverloaded(sampleDurationMillis?: number): ClientInfo;
164
- /**
165
- * Returns an object with an isOverloaded property set to true
166
- * if the client has been overloaded in the last sampleDurationMillis.
167
- */
168
- protected _isClientOverloaded(sampleDurationMillis?: number): ClientInfo;
169
- /**
170
- * Returns an object with sample information and an isOverloaded property
171
- * set to true if at least the ratio of snapshots in the sample are overloaded.
172
- */
173
- protected _isSampleOverloaded<T extends {
174
- createdAt: Date;
175
- isOverloaded: boolean;
176
- }>(sample: T[], ratio: number): ClientInfo;
177
- }
178
- //# sourceMappingURL=system_status.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"system_status.d.ts","sourceRoot":"","sources":["../../src/autoscaling/system_status.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;GAEG;AACH,MAAM,WAAW,UAAU;IACvB,4CAA4C;IAC5C,YAAY,EAAE,OAAO,CAAC;IACtB,OAAO,EAAE,UAAU,CAAC;IACpB,aAAa,EAAE,UAAU,CAAC;IAC1B,OAAO,EAAE,UAAU,CAAC;IACpB,UAAU,EAAE,UAAU,CAAC;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;OAGG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAChC;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;IAErC;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;CAC7B;AAED,MAAM,WAAW,UAAU;IACvB,YAAY,EAAE,OAAO,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,eAAe;IAC5B,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,8BAA8B,EAAE,MAAM,CAAC;IACvC,gCAAgC,EAAE,MAAM,CAAC;IACzC,yBAAyB,EAAE,MAAM,CAAC;IAClC,uBAAuB,EAAE,MAAM,CAAC;IAChC,0BAA0B,EAAE,MAAM,CAAC;IACnC,aAAa,EAAE,MAAM,CAAC;IACtB,oBAAoB,EAAE,MAAM,CAAC;CAChC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,YAAY;IACrB,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAS;IAC9C,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAS;IAClD,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAS;IACrD,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAS;IAC/C,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAS;IAClD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAc;gBAE9B,OAAO,GAAE,mBAAwB;IA8B7C;;;;;;;;;;;;;;;OAeG;IACH,gBAAgB,IAAI,UAAU;IAI9B;;;;;;;;;;;;;;;OAeG;IACH,mBAAmB,IAAI,UAAU;IAIjC;;OAEG;IACH,SAAS,CAAC,aAAa,CAAC,oBAAoB,CAAC,EAAE,MAAM,GAAG,UAAU;IAkBlE;;;OAGG;IACH,SAAS,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,EAAE,MAAM;IAK3D;;;OAGG;IACH,SAAS,CAAC,sBAAsB,CAAC,oBAAoB,CAAC,EAAE,MAAM;IAK9D;;;OAGG;IACH,SAAS,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,EAAE,MAAM;IAKxD;;;OAGG;IACH,SAAS,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,EAAE,MAAM,GAAG,UAAU;IAKxE;;;OAGG;IACH,SAAS,CAAC,mBAAmB,CAAC,CAAC,SAAS;QAAE,SAAS,EAAE,IAAI,CAAC;QAAC,YAAY,EAAE,OAAO,CAAA;KAAE,EAC9E,MAAM,EAAE,CAAC,EAAE,EACX,KAAK,EAAE,MAAM,GACd,UAAU;CA4BhB"}