Scaphandre v1.0.0

[bpetit]

Release v1.0.0 is out ! 🥳

Feel free to ask questions in this discussion regarding the release and/or any comments.

Please consider sponsoring if you want this project to thrive ! 🙏🏽

1.0.0

Added

• Host resources consumption metrics : scaph_host_swap_total_bytes, scaph_host_swap_free_bytes, scaph_host_memory_free_bytes, scaph_host_memory_available_bytes, scaph_host_memory_total_bytes, scaph_host_disk_total_bytes, scaph_host_disk_available_bytes, scaph_host_cpu_frequency, scaph_host_load_avg_fifteen, scaph_host_load_avg_five, scaph_host_load_avg_one - see https://hubblo-org.github.io/scaphandre-documentation/references/metrics.html for details, RAM capacity metric #271 and WIP 272 disk type and capacity metrics #278 for reference
• Per-process resource consumption metrics : scaph_process_cpu_usage_percentage, scaph_process_memory_bytes, scaph_process_memory_virtual_bytes, scaph_process_disk_total_write_bytes, scaph_process_disk_write_bytes, scaph_process_disk_read_bytes, scaph_process_disk_total_read_bytes - see https://hubblo-org.github.io/scaphandre-documentation/references/metrics.html for details, CPU percentage usage per process #141 and WIP 273 processes ressources consumption #274 for reference
• Added service monitor to helm chart, see feat: Add service monitor on helm chart #230, thanks @mmadoo
• Added packaging folder with sample systemd services files, see adding packaging folder with sample service files #317 and Systemd unit #261, thanks @jcaesar
• Added prometheus push mode exporter, see Prometheus push mode exporter #269
• Added RPM build github action workflow, see RPM package #310
• Added RAPL mmio metric, when the domain is present, see Add a metric for RAPL mmio #318 and Add a specific metric for rapl psys domain when available + use it as host_power when available #329
• Added specific RAPL PSYS metric, when available, see Add a specific metric for RAPL psys domain, when available #316 and Add a specific metric for rapl psys domain when available + use it as host_power when available #329
• Filtering per process in JSON exporter, see Json exporter with regex filtering #216
• Github action workflow to build Windows EXE installer on each release, see chore: new iss file to build exe package #333
• Github action workflow to build DEB package on each release, see Create Debian package with version tag #352, thanks @bdromard
• Added warning messages when powercap files permissions won't allow Scaphandre to read RAPL data, see Power of 0 returned for all processes on Ubuntu 22.04.1 LTS #214

Changed

• Global power metrics have changed and could give higher numbers than previously. Please have a look at the documentation.
• scaph_self_mem_total_program_size, scaph_self_mem_resident_set_size and scaph_self_mem_shared_resident_size are replaced by scaph_self_memory_bytes and scaph_self_memory_virtual_bytes, see https://github.com/hubblo-org/scaphandre/pull/274/files
• Refactored warp10 exporter, see Refactoring warp10 exporter #291 and Refactor warp10 using MetricGenerator #105
• Refactored exporters creation with clap4, see Refactor exporter creation with clap v4 #292, thanks @TheElectronWill
• Default docker-compose sets a privileged container now, otherwise it doesn't work in an apparmor context, see "ptrace call denied" logs when running Scaphandre in container #135 and a1a06ea
• Moved from procfs, to sysinfo, see Procfs v0.8.1 does not support kernel version string larger than 256 #267

Fixed

• Fixed doc broken links, see 📝 Fix doc broken links #259 and Some links in the documentation seem to be broken #288, thanks @homersimpsons
• Now works on more than 1 vcpu Qemu/KVM virtual machines, see Scaphandre does not work on VMs with more than one logical host CPU #133 and Addressed issue #133 #207, thanks @tawalaya
• Fix for Kubernetes, don't create PSP if version of kubernetes is above 1.25, see fix: Don't create PSP if k8s >= 1.25 #250, thanks @rossf7
• Fixed bug in --containers flag, see fix: Don't use value for --containers flag in chart #326, thanks rossf7
• Fix on qemu exporter, see qemu command does not start the qemu exporter in v0.5.0 (regression) #260
• Fixed panics on regex filters, see v0.5: Using regex filter causes Scaphandre to panic #295
• Fixed invalid escape sequence in Prometheus exporter, see Invalid escape sequence in prometheus output #204, thanks @demeringo
• Removed broken python bindings, until it is fixed, see Remove broken python bindings #315 and Python bindings are non-functional #296

---

This discussion was created from the release Scaphandre v1.0.0.

[bpetit]

A special thank you to @Vic063 for his contributions on the windows driver, thus enabling Scaphandre on windows ! :)

[ejhusom]

Hi! :)

When I'm downloading the .deb package and installing using apt or dpkg on Ubuntu 22.10, the version I get is 0.5.0. Anyone else struggling with this?

Thank you for the amazing work on Scaphandre! It's an invaluable tool :)

[jcaesar]

You're in fact getting 1.0.0, just with the wrong version tag, which was forgotten and only added after 1.0.0 was released. c43d72b...eebb06b

Imho, this would warrant a 1.0.1, but in practice, you can just ignore it.

(For the AUR build, I decided to patch…)

[ejhusom]

I see, thanks for clearing that up! :)