All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
This may be not up to date, please check main branch.
- Updated k8s-sync crate to 0.2.3 to get authentication by token feature
- Riemann exporter now supports mTLS: #103 thanks @uggla !
--containersoption, 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
- Added Cargo.lock to the repository: #111
- Ensured domains names are feteched properly in any case : #114 thanks @PierreRust !
- 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
- 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 !
- 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 !
- 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-documentation/
- Automated CI tests including cargo test --all, running on a (bare metal) machine: #62
- Improved QemuExporter documentation: #42 - thanks @uggla
-s, --stepoption added by @Uggla, to specify time step between two measurements, when using StdoutExporter
- removed
energy_records_to_power_recordfunctionfrom src/sensors/mod.rs.get_records_diff_power_microwattsfunctions from Topology and CPUSocket should be used instead
- 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)
- Exporters and sensors design.
- Stdout exporter.
- Prometheus exporter.
- Powercap_rapl sensor.
- Qemu exporter.
Here are the sub-sections that can be included in each release section:
- Added for new features.
- Changed for changes in existing functionality.
- Deprecated for soon-to-be removed features.
- Removed for now removed features.
- Fixed for any bug fixes.
- Security in case of vulnerabilities.