Metadata-Version: 1.2
Name: procfs-sensor
Version: 0.1.0
Summary: Procfs-Sensor is a sensor that monitor CPU usage of cgroup
Home-page: UNKNOWN
Author: Lauric Desauw
License: MIT
Description: # Procfs-Sensor
        
        The Proc Filesystem Sensor is a tool that monitor the CPU usage of cgroup via
        the linux's proc filesystem.
        It use `pidstat` to retreive the percentage of CPU usage of each process.
        It then use the `/sys/fs/perf_event` directory to find the appartenance of
        processes to cgroup.
        
        The sensor need the cgroup version 1. The version 2 is not supported yet.
        
        # About
        
        Procfs Sensor is an open-source project developed by the [Spirals research
        group](https://team.inria.fr/spirals) (University of Lille 1 and Inria).
        
        The documentation is not available yet.
        
        ## Contributing
        
        If you would like to contribute code you can do so through GitHub by forking the
        repository and sending a pull request.
        You should start by reading the [contribution guide](https://github.com/powerapi-ng/procfs-sensor/blob/main/contributing.md)
        
        When submitting code, please check that it is conform by using `pylint` and
        `flake8` with the configurations files at the root of the project.
        
        ## Acknowledgments
        
        Procfs Sensor is written in [Python](https://www.python.org/) (under [PSF
        license](https://docs.python.org/3/license.html)).
        It also use [`pidstat`](https://github.com/sysstat/sysstat)
        
        MIT License
        
        Copyright (c) 2021 PowerAPI
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Keywords: energy,powerapi,containers,sensor
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Requires-Python: >=3.7
