Scaphandre v1.0.0

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, #271 and #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, #141 and #274 for reference
• Added service monitor to helm chart, see #230, thanks @mmadoo
• Added packaging folder with sample systemd services files, see #317 and #261, thanks @jcaesar
• Added prometheus push mode exporter, see #269
• Added RPM build github action workflow, see #310
• Added RAPL mmio metric, when the domain is present, see #318 and #329
• Added specific RAPL PSYS metric, when available, see #316 and #329
• Filtering per process in JSON exporter, see #216
• Github action workflow to build Windows EXE installer on each release, see #333
• Github action workflow to build DEB package on each release, see #352, thanks @bdromard
• Added warning messages when powercap files permissions won't allow Scaphandre to read RAPL data, see #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 #291 and #105
• Refactored exporters creation with clap4, see #292, thanks @TheElectronWill
• Default docker-compose sets a privileged container now, otherwise it doesn't work in an apparmor context, see #135 and a1a06ea
• Moved from procfs, to sysinfo, see #267

Fixed

• Fixed doc broken links, see #259 and #288, thanks @homersimpsons
• Now works on more than 1 vcpu Qemu/KVM virtual machines, see #133 and #207, thanks @tawalaya
• Fix for Kubernetes, don't create PSP if version of kubernetes is above 1.25, see #250, thanks @rossf7
• Fixed bug in --containers flag, see #326, thanks rossf7
• Fix on qemu exporter, see #260
• Fixed panics on regex filters, see #295
• Fixed invalid escape sequence in Prometheus exporter, see #204, thanks @demeringo
• Removed broken python bindings, until it is fixed, see #315 and #296

Scaphandre v0.5.0

0.5.0

Changed

• Upgraded procfs to 0.12 : #144
• Rollbacked to ubuntu 20.04 as the base docker image : #151, thanks to @demeringo
• Using github action to tag docker image : #160, thanks to @rossf7

Added

• New level of abstraction regarding structs managed by Sensors, so we could implement more sensors in an easier way : #149
• Enable JSON exporter to run as a daemon : #169
• First building blocks for conditional compilation depending on the OS : #148
• Mitigation for machines where powercap is not able to feed rapl domain folders, and only has socket ones : #198
• Experimental support for Windows 10, 11, server 2019 : #74 and #247
• Added --containers option to JSON exporter : #217

Fixed

• Kubernetes pods using containerd are now supported : #130, thanks to @rossf7
• Excluded unrelevant procfs metrics from calculation of cpu cycles consumed by processes : #132
• Mitigated possible decrepancies between host (rapl) total power usage metric and the sum of per-process power usage metrics : #20, note that some issues show remaining issues on this topic. Further investigation and work needed.
• Documentation fix for helm install : #136, thanks to @arthurzenika
• New helm chart values: arguments and backtrace : #139, thanks to @jotak
• Some documentation typos : #157, thanks to @metacosm
• Aligning on new clippy rules : #162, thanks to @demeringo
• Always set last pods check timestamp : #173, thanks to @rossf7
• Support kubelets using systemd cgroup driver: #146, thanks to @rossf7
• Fix missing volume in psp (helm chart): #168, thanks to @olevitt
• Spelling check in documentation : #183, thanks to @irishgordo
• No more duplicated HELP and TYPE lines in prometheus exporter: #165 and #192
• Escaping newlines in cmdline: #175, thanks to @uggla

Scaphandre v0.4.1

Changed

• Updated k8s-sync crate to 0.2.3 to get authentication by token feature

Scaphandre v0.4.0

Added

• Riemann exporter now supports mTLS: #103 thanks @uggla !
• --containers option, in prometheus exporter, tells scaphandre to add labels to metrics related to a docker container or a kubernetes pod, to make getting metrics of a distributed application easier: #84 thanks @rossf7 for the tests, feedbacks, helm configuration and thanks @uggla for the reviews !
• stdout exporter now allows to choose the number of processes to watch, with the --process-number flag and to filter processes watched thanks to a regex, with the --regex-filter option: #98, thanks @uggla !
• MetricGenerator includes timestamp in Metrics now : #113

Fixed

• Added Cargo.lock to the repository: #111
• Ensured domains names are feteched properly in any case : #114 thanks @PierreRust !

Changed

• Manipulating flags as a Vec of clap::Arg instead of a HashMap of ExporterOption in exporters: #100, thanks @uggla !
• Json and Stdout exporters are now using MetricGenerator as an inteface to get metrics properly : #113

Scaphandre v0.3.0

Added

• New MetricGenerator and Metric structs and helper functions to make writing exporters easier. Riemann and Prometheus exporters now share the same code pattern: #79 thanks @uggla !
• New Warp10 exporter ! #76
• Updated riemann_client and protobuf crates dependencies #70 thanks @uggla !
• Successfully tested on AMD CPUs (AMD Ryzen 5 2600X): #55 (requires a kernel 5.11 or later) thanks @barnumbirr and @kamaradclimber !
• Scaphandre can now be tested locally thanks to a docker-compose stack ! #61 thanks @PierreRust !
• Added a CITATION file for references: #95 thanks @tstrempel !

Fixed

• Allowing scaphandre to run even if intel_rapl modules are not found: #65 (needed to run scaphandre on AMD CPUs)
• Fixed typos and lacks in the documentation: #81, #77, #80 thanks @pierreozoux, @LudovicRousseau, @maethor, @wallet77
• Moved documentation output to another repository: #94 (documentation is now available here: https://hubblo-org.github.io/scaphandre-documentation)
• Json exporter has been refactored: #87 thanks @jdrouet !

Scaphandre v0.2.0

Added

• Docker image (hubblo/scaphandre), ubuntu based: #48, thanks @rossf7
• Helm chart to run scaphandre as a DaemonSet in a kubernetes cluster: #72 - thanks @rossf7
• JsonExporter, to get metrics in JSON either in stdout or files: #68 - thanks @wallet77
• RiemannExporter, to send metrics to Riemann monitoring tool: #58 - thanks @uggla
• --qemu flag on PrometheusExporter, to add a "vmname" label to metrics related to processes that represent qemu-kvm virtual machines: #41 - thanks @uggla
• Better documentation structure (based on divio's documentation framework and mdbook): #45, result here: https://hubblo-org.github.io/scaphandre/
• Automated CI tests including cargo test --all, running on a (bare metal) machine: #62

Fixed

• Improved QemuExporter documentation: #42 - thanks @uggla

Scaphandre v0.1.1

[0.1.1]

Added

• -s, --step option added by @uggla, to specify time step between two measurements, when using StdoutExporter

Removed

• removed energy_records_to_power_record function from src/sensors/mod.rs.
  get_records_diff_power_microwatts functions from Topology and CPUSocket should be used instead

Fixed

• README typos and misusage of english fixed by @uggla and @florimondmanca
• @uggla made init.sh script more robust
• cleaning of internal structs (records, cpustat, processes) was buggy, it is fixed
• linux kernels < 5, on intel CPUs (>2012) may me measurable now (fixed kernel modules names check)

Scaphandre v0.1.0

Added

• Exporters and sensors design.
• Stdout exporter.
• Prometheus exporter.
• Powercap_rapl sensor.
• Qemu exporter.