@scrypted/cosmotop
v0.0.25
Published
cosmotop monitoring interface for Scrypted
Readme
cosmotop
This plugin downloads and installs the cosmotop monitoring tool, making it available for use inside Scrypted.
Setup and customization
Out of the box, cosmotop is able to view CPU, memory, disk, network, and process activity in your Scrypted installation environment.
Configuration
The Configuration device under this plugin provides a handy way to view and edit the configuration file for cosmotop, typically stored on disk at ~/.config/cosmotop/cosmotop.conf. This file is kept up to date by Scrypted and will be included in Scrypted system backups.
GPU monitoring
Monitoring of GPUs is supported on Linux and Windows.
- Windows: LibreHardwareMonitor is included with
cosmotopand automatically used to fetch GPU information. - Linux: Intel, AMD, and NVIDIA GPUs are supported, provided the appropriate driver is installed, and the following:
- Intel: The simplest setup is to run Scrypted as root (if using a local install) or in a privileged container (if using Docker or LXC), however this is insecure and not recommended. Instead, run intel-gpu-exporter in a privileged Docker container, then set the
intel_gpu_exporterconfiguration option incosmotopto the exporter's HTTP endpoint. - AMD: Should work out of the box.
- NVIDIA:
libnvidia-ml.somust be accessible by Scrypted.
- Intel: The simplest setup is to run Scrypted as root (if using a local install) or in a privileged container (if using Docker or LXC), however this is insecure and not recommended. Instead, run intel-gpu-exporter in a privileged Docker container, then set the
NPU monitoring
Utilization monitoring of Intel and Rockchip NPUs is supported on Linux, provided the following:
- Intel: The path
/sys/devices/pci0000:00/0000:00:0b.0must be readable by Scrypted. - Rockchip: The path
/sys/kernel/debug/rknpumust be readable by Scrypted.
The Apple Neural Engine on M series Macs is supported and detected as an NPU.
Themes
A number of themes are available within cosmotop. A list of available themes is listed under the Configuration device's README. To download additional themes, add URLs under the Theme Manager device.
Recommended plugins
@scrypted/x11-camera
This plugin allows you to set up a virtual camera that converts cosmotop output into a video stream. The stream can then be viewed by external Scrypted integrations like a normal camera, and even be recorded by Scrypted NVR.
To set up, follow the installation instructions under the @scrypted/x11-camera README and create a new virtual camera device. Set the executable to cosmotop (or cosmotop.exe on Windows).
