# /proc Tracer
This is the developer/maintainer documentation. For user documentation, go to https://github.com/david-kracht/proctracer
## Setup
You can run proctracer from source in Windows, MacOS, and Linux:
- Install pip following [pip docs](https://pip.pypa.io/en/stable/installation/).
- Clone proctracer repository:
```bash
$ git clone https://github.com/david-kracht/proctracer.git
```
- Install in editable mode
```bash
$ cd proctracer && sudo pip install -e .
```
- You are ready, try to run proctracer:
```bash
$ proctracer --help
usage: /proc Tracer (Daemon) [-h] [-c CONFIG] [-o OUTPUT_PATH] [-n REPORT_NAME] [-f] {start,stop,restart,message} ...
positional arguments:
{start,stop,restart,message}
start Start Tracer
stop Stop Tracer
restart Restart Tracer
message Message to Running Tracer
optional arguments:
-h, --help show this help message and exit
-c CONFIG, --config CONFIG
Path to /proc Tracer config yaml.
-o OUTPUT_PATH, --output_path OUTPUT_PATH
Output path for report.
-n REPORT_NAME, --report_name REPORT_NAME
Name of the report file.
-f, --foreground Start Tracer in foreground, not daemonized.
```
- Examplary usage and result:
```bash
$ proctracer -o ~/1/2 -n proc_report start
Start /proc Tracer (Daemon)...
Output will be written to: /root/1/2
$ proctracer message first
Message to running /proc Tracer (Daemon) ...
$ proctracer message 2nd
Message to running /proc Tracer (Daemon) ...
$ proctracer message 2nd
Message to running /proc Tracer (Daemon) ...
$ proctracer message 3rd
Message to running /proc Tracer (Daemon) ...
$ stress -c 1 -t 5
stress: info: [514601] dispatching hogs: 1 cpu, 0 io, 0 vm, 0 hdd
stress: info: [514601] successful run completed in 5s
$ proctracer stop
Stop /proc Tracer (Daemon).
$ tree ~/1
/home/user/1
└── 2
└── proc_report.pdf
```
- Package and Upload
Place token in ```~/.pypirc```, i.e
> [pypi]
> username = __token__
> password = pypi-AgEIcHlwa0A5vasXU4w
```bash
$ chmod 600 ~/.pypirc
$ sudo pip install twine
$ python3 setup.py sdist bdist_wheel
$ twine upload dist/*
```
Raw data
{
"_id": null,
"home_page": "https://github.com/david-kracht/proctracer",
"name": "proctracer",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "package,proc ,trace",
"author": "David Kracht",
"author_email": "dave.kracht@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/58/d6/cd8a7a6bfefdb654b5cf8f20f8bf3736edb767dfa74fe7d9d654093e1561/proctracer-0.0.32.tar.gz",
"platform": null,
"description": "# /proc Tracer\n\nThis is the developer/maintainer documentation. For user documentation, go to https://github.com/david-kracht/proctracer\n\n## Setup\n\nYou can run proctracer from source in Windows, MacOS, and Linux:\n\n- Install pip following [pip docs](https://pip.pypa.io/en/stable/installation/).\n\n- Clone proctracer repository:\n```bash\n$ git clone https://github.com/david-kracht/proctracer.git\n```\n\n- Install in editable mode\n```bash\n$ cd proctracer && sudo pip install -e .\n```\n\n- You are ready, try to run proctracer:\n```bash\n$ proctracer --help\nusage: /proc Tracer (Daemon) [-h] [-c CONFIG] [-o OUTPUT_PATH] [-n REPORT_NAME] [-f] {start,stop,restart,message} ...\n\npositional arguments:\n {start,stop,restart,message}\n start Start Tracer\n stop Stop Tracer\n restart Restart Tracer\n message Message to Running Tracer\n\noptional arguments:\n -h, --help show this help message and exit\n -c CONFIG, --config CONFIG\n Path to /proc Tracer config yaml.\n -o OUTPUT_PATH, --output_path OUTPUT_PATH\n Output path for report.\n -n REPORT_NAME, --report_name REPORT_NAME\n Name of the report file.\n -f, --foreground Start Tracer in foreground, not daemonized.\n```\n\n- Examplary usage and result:\n```bash\n$ proctracer -o ~/1/2 -n proc_report start\nStart /proc Tracer (Daemon)...\nOutput will be written to: /root/1/2\n\n$ proctracer message first\nMessage to running /proc Tracer (Daemon) ...\n$ proctracer message 2nd\nMessage to running /proc Tracer (Daemon) ...\n$ proctracer message 2nd\nMessage to running /proc Tracer (Daemon) ...\n$ proctracer message 3rd\nMessage to running /proc Tracer (Daemon) ...\n\n$ stress -c 1 -t 5\nstress: info: [514601] dispatching hogs: 1 cpu, 0 io, 0 vm, 0 hdd\nstress: info: [514601] successful run completed in 5s\n\n$ proctracer stop\nStop /proc Tracer (Daemon).\n\n$ tree ~/1\n/home/user/1\n\u2514\u2500\u2500 2\n \u2514\u2500\u2500 proc_report.pdf\n```\n\n- Package and Upload\nPlace token in ```~/.pypirc```, i.e\n\n> [pypi]\n> username = __token__\n> password = pypi-AgEIcHlwa0A5vasXU4w\n\n\n```bash\n$ chmod 600 ~/.pypirc\n\n$ sudo pip install twine\n\n$ python3 setup.py sdist bdist_wheel\n$ twine upload dist/*\n```\n",
"bugtrack_url": null,
"license": "BSD-3",
"summary": "/proc Tracer",
"version": "0.0.32",
"project_urls": {
"Documentation": "https://github.com/david-kracht/proctracer",
"Homepage": "https://github.com/david-kracht/proctracer",
"Source": "https://github.com/david-kracht/proctracer.git",
"Tracker": "https://github.com/david-kracht/proctracer/issues"
},
"split_keywords": [
"package",
"proc ",
"trace"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "71c9424de07c07af118dc1ad9d0f049e7768c862b08bf781fbb341b71db068c0",
"md5": "8840b6bcaae618c065656d93975e094b",
"sha256": "323fb638e4281101a2e3f6adda38aa17207189050ffc85214af9fce2c639c340"
},
"downloads": -1,
"filename": "proctracer-0.0.32-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8840b6bcaae618c065656d93975e094b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 20626,
"upload_time": "2023-08-08T15:13:36",
"upload_time_iso_8601": "2023-08-08T15:13:36.959704Z",
"url": "https://files.pythonhosted.org/packages/71/c9/424de07c07af118dc1ad9d0f049e7768c862b08bf781fbb341b71db068c0/proctracer-0.0.32-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "58d6cd8a7a6bfefdb654b5cf8f20f8bf3736edb767dfa74fe7d9d654093e1561",
"md5": "69d888af7ca23cebd746db6948347e72",
"sha256": "d3de9589015c0ab8e7e5662450bc4bec0896d2382652e96141b62d76847c15b4"
},
"downloads": -1,
"filename": "proctracer-0.0.32.tar.gz",
"has_sig": false,
"md5_digest": "69d888af7ca23cebd746db6948347e72",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 16170,
"upload_time": "2023-08-08T15:13:38",
"upload_time_iso_8601": "2023-08-08T15:13:38.538848Z",
"url": "https://files.pythonhosted.org/packages/58/d6/cd8a7a6bfefdb654b5cf8f20f8bf3736edb767dfa74fe7d9d654093e1561/proctracer-0.0.32.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-08 15:13:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "david-kracht",
"github_project": "proctracer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "proctracer"
}
JSON
