https://github.com/mindreframer/ProFi.lua

a non-official git mirror for ProFi, a Lua profiler
https://github.com/mindreframer/ProFi.lua

Last synced: 6 months ago
JSON representation

a non-official git mirror for ProFi, a Lua profiler

• Host: GitHub
• URL: https://github.com/mindreframer/ProFi.lua
• Owner: mindreframer
• Created: 2013-04-05T16:26:59.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2015-10-16T10:36:35.000Z (about 10 years ago)
• Last Synced: 2024-11-25T01:02:39.376Z (about 1 year ago)
• Language: Lua
• Homepage: https://gist.github.com/perky/2838755
• Size: 130 KB
• Stars: 73
• Watchers: 7
• Forks: 16
• Open Issues: 3
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

• my-awesome-lua - ProFi - Simple profiler that works with LuaJIT and produces a report file. (Resources / Debugging)

README

          
## ProFi v1.3, by Luke Perkin 2012. MIT Licence http://www.opensource.org/licenses/mit-license.php.

Origin: https://gist.github.com/perky/2838755

## Example:

  ```lua

    ProFi = require 'ProFi'

    ProFi:start()

    some_function()

    another_function()

    coroutine.resume( some_coroutine )

    ProFi:stop()

    ProFi:writeReport( 'MyProfilingReport.txt' )

  ```

## API:

  Arguments are specified as: type/name/default.

      ProFi:start( string/once/nil )

      ProFi:stop()

      ProFi:checkMemory( number/interval/0, string/note/'' )

      ProFi:writeReport( string/filename/'ProFi.txt' )

      ProFi:reset()

      ProFi:setHookCount( number/hookCount/0 )

      ProFi:setGetTimeMethod( function/getTimeMethod/os.clock )

      ProFi:setInspect( string/methodName, number/levels/1 )