diff options
| author | Jefferson González <jgmdev@gmail.com> | 2022-11-17 01:50:42 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-17 01:50:42 -0400 |
| commit | 0a75b7908741b284d6e617a66d5221c419cf6e2e (patch) | |
| tree | 9cc787e0ad91a2a0376d785a0794bd744a15c261 /plugins/profiler/README.md | |
| parent | 9db8c6625d8a9f462c2b4b52a91a9cce725dab63 (diff) | |
| download | lite-xl-plugins-0a75b7908741b284d6e617a66d5221c419cf6e2e.tar.gz lite-xl-plugins-0a75b7908741b284d6e617a66d5221c419cf6e2e.zip | |
Add Profiler Plugin (#155)
Diffstat (limited to 'plugins/profiler/README.md')
| -rw-r--r-- | plugins/profiler/README.md | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/plugins/profiler/README.md b/plugins/profiler/README.md new file mode 100644 index 0000000..4f113b8 --- /dev/null +++ b/plugins/profiler/README.md @@ -0,0 +1,46 @@ +# Profiler Plugin + +Profiling is mainly the runtime analysis of a program performance by counting +the call count and duration for the various routines executed thru the lifecycle +of the application. For more information view the [wikipedia] article. + +This plugin adds the ability to profile function calls while running Lite XL +to investigate performance related issues and more easily pinpoint what could +be causing the slowdowns. It integrates the [lua-profiler] which provides +the functionality we need. + +## Usage + +Open Lite XL and access the command palette by pressing `ctrl+shift+p` and +search for profiler. The command `Profiler: Toggle` command will be shown to +lets you start or stop the profiler. You should start the profiler before +triggering the events that are causing any performance issues. + + + +> **Note:** Starting the profiler will make the editor more slower since it is +> now accumulating metrics about every function call. Do not worry, this is +> expected and shouldn't affect the end result, just be patience because +> everything will be slower. + +There may also be some situations when you would like to enable the profiler +early on the startup process so we provided a config option for that. + + + +You can also change the default `profiler.log` path. Notice that since the +profiler is not part of the core but a plugin it will only start measuring +metrics once the plugin is loaded. The `priority` tag of the profiler plugin +was set to `0` to make it one of the first plugins to start. + +Once you have profiled enough you can execute the `Profiler: Toggle` command +to stop the profiler and it will automatically open a document view with the +recollected metrics as shown below: + + + +You can send Lite XL developers the output of `profiler.log` so it can be +more easily diagnosed what could be causing any issue. + +[wikipedia]: https://en.wikipedia.org/wiki/Profiling_(computer_programming) +[lua-profiler]: https://github.com/charlesmallah/lua-profiler |