Skip to content

Memory diagnostics

Reference for the command that reads the memory consumption of the app and of the managed terminals.

View Markdown
elyra diagnostics memory [--json]

Collects a point-in-time snapshot of the memory of the app and of the terminals it manages.

What the command does

Characteristic Detail
Operation Read-only
Scope The running app and the terminals it manages
Options Only the global CLI options; --json is the machine-readable form
Same scan It is the same scan used by the app’s resource usage panel

Do not use it as a heartbeat

This command is deliberately expensive. It scans host processes. Do not use it as a periodic check or as a liveness signal.

It exists for the moment when you need a picture of the consumption — before reporting a performance problem, for example.

Output

A snapshot with the consumption of the runtime and of the managed terminals. The command writes and changes nothing.

Limits

  • The snapshot can contain session data. Review it before publishing a real example.
  • The diagnostics section of the Privacy screen is another surface, separate, behind a build condition; nothing on this page depends on it.