system-memory-objects

Retrieves information about objects allocated in JVM off-heap memory.

Command properties

Property	Description
Command type	Driver query
Required permission	None
License usage	Not counted
Parallel execution	Not supported
Distributed execution	Not supported

Syntax

system-memory-objects

Options

None

Output fields

Field	Type	Description
type	string	Memory type. Always returns `offheap`.
name	string	Name of the object allocated in off-heap memory
using	long	Memory size currently used by the object (unit: bytes)

Error codes

Parsing errors

N/A

Runtime errors

N/A

Description

The system-memory-objects command retrieves the names and memory usage of objects allocated in JVM off-heap memory (outside the JVM heap). Logpresso uses off-heap memory to reduce JVM heap pressure when processing large volumes of data.

Examples

Retrieve all off-heap memory objects
```
system-memory-objects
```
Retrieves the names and memory usage of all objects allocated in off-heap memory.
Sort by memory usage
```
system-memory-objects | sort -using
```
Sorts objects from highest to lowest memory usage.
Sum total off-heap memory usage
```
system-memory-objects | stats sum(using) as total_offheap_bytes
```
Calculates the total off-heap memory usage across all objects.