https://github.com/gaogaotiantian/vizplugins

official plugins for VizTracer
https://github.com/gaogaotiantian/vizplugins

Last synced: 26 days ago
JSON representation

official plugins for VizTracer

• Host: GitHub
• URL: https://github.com/gaogaotiantian/vizplugins
• Owner: gaogaotiantian
• License: apache-2.0
• Created: 2020-12-16T02:41:52.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2023-12-02T22:03:41.000Z (12 months ago)
• Last Synced: 2024-10-07T19:41:19.101Z (about 1 month ago)
• Language: Python
• Size: 268 KB
• Stars: 12
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# vizplugins

[![build](https://github.com/gaogaotiantian/vizplugins/workflows/build/badge.svg)](https://github.com/gaogaotiantian/vizplugins/actions?query=workflow%3Abuild)  [![coverage](https://img.shields.io/codecov/c/github/gaogaotiantian/vizplugins)](https://codecov.io/gh/gaogaotiantian/vizplugins)  [![pypi](https://img.shields.io/pypi/v/vizplugins.svg)](https://pypi.org/project/vizplugins/)  [![support-version](https://img.shields.io/pypi/pyversions/vizplugins)](https://img.shields.io/pypi/pyversions/vizplugins)  [![license](https://img.shields.io/github/license/gaogaotiantian/vizplugins)](https://github.com/gaogaotiantian/vizplugins/blob/master/LICENSE)  [![commit](https://img.shields.io/github/last-commit/gaogaotiantian/vizplugins)](https://github.com/gaogaotiantian/vizplugins/commits/master)

official plugins for VizTracer; currently support tracing cpu and memory usage through psutil.

## Install

The prefered way to install vizplugins is via pip

```

pip install vizplugins

```

## Basic Usage

The vizplugin should be used with viztracer.

You can use VizTracer and the plugin by

```

viztracer --plugin vizplugins.cpu_usage -- my_script.py arg1 arg2

```

which will record the cpu percent of the process and generate a ```result.html``` file in the directory you run this command, which you can open with Chrome.

The plugin samples cpu usage per 0.02s by default, but you can explicitly indicate the desired frequency at which to sample data per second

```

viztracer --plugin "vizplugins.cpu_usage -f 20" -- my_script.py arg1 arg2

```

which will sample data approximately 20 times per second, with a sampling interval of 0.05 second.

You can also trace the memory usage and cpu usage by

```

viztracer --plugin "vizplugins --cpu_usage --memory_usage" -- my_script.py arg1 arg2

```

which will record both the cpu and memory usage.

## Example

The below image is an example of the resulting html, which is called on an recursively defined fibonacci funtion.

The "cpu_usage" on the top indicates the corresponding cpu usage at each time period. The "memory_usage" have two colors, representing rss(Resident Set Size, the non-swapped physical memory) and vms(Virtual Memory Size). You can see the details by clicking on one of the periods.

[![example_img](https://github.com/in-the-ocean/vizplugins/blob/readme/img/fib.png)](https://github.com/in-the-ocean/vizplugins/blob/readme/img/fib.png)