get https://api-sdk.lmnl.dev/metrics
This function retrieves the amount of memory being utilized by Liminal Express on the client's server. It provides a detailed report on memory consumption, enabling users to monitor and manage the resources used by Liminal Express effectively. This function is crucial for maintaining optimal performance and avoiding potential system overloads.
| Field | Description | Utility |
|---|---|---|
| mem.rss | The Resident Set Size - total memory allocated for the process. | Helps monitor the memory usage of the process. |
| mem.heapTotal | Total size of the allocated heap for the process. | Provides insight into the total memory reserved for the process's heap. |
| mem.heapUsed | Amount of memory used within the allocated heap. | Useful for understanding how much of the allocated heap is actually being used by the process. |
| mem.external | Memory used by C++ objects bound to JavaScript objects managed by V8 engine. | Helps in tracking memory used by non-JavaScript components. |
| mem.arrayBuffers | Memory used by ArrayBuffers. | Useful for tracking memory usage by ArrayBuffers, which can impact overall memory consumption. |
| uptime | The number of seconds the process has been running for. | Useful for monitoring the duration the process has been active. |