vProfiler/README.md

2.9 KiB

vProfiler

vProfiler is a tool for collecting, analyzing, and exporting system information for debugging Linux systems running on HyperV.

Since this tool is meant for log collection and debugging, it may not modify the system in any way without explicite consent from the user.

Usage

The behavior of vProfiler is determined by the YAML plugin list. By default vProfiler uses plugins.yaml but the plugin list file can be changed using --config FILE.

Using the --help flag will list all of the available options. These options will vary based on the plugins list being used.

In most cases the user will simply run ./vProfiler.py which will run the default behavior as defined in the plugin list file.

Contributing

A detailed description for how to add a plugin can be found in the Wiki.

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Legal Notices

Microsoft and any contributors grant you a license to the Microsoft documentation and other content in this repository under the Creative Commons Attribution 4.0 International Public License, see the LICENSE file, and grant you a license to any code in the repository under the MIT License, see the LICENSE-CODE file.

Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries. The licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks. Microsoft's general trademark guidelines can be found at http://go.microsoft.com/fwlink/?LinkID=254653.

Privacy information can be found at https://privacy.microsoft.com/en-us/

Microsoft and any contributors reserve all other rights, whether under their respective copyrights, patents, or trademarks, whether by implication, estoppel or otherwise.