From 4e150e2ff03181b32b6fcfdbd9c6253fc099fa58 Mon Sep 17 00:00:00 2001 From: Luck Date: Sun, 10 Jun 2018 11:43:55 +0100 Subject: Add license headers, update readme with new commands --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index a980524..a6244ec 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # :zap: spark Spark is a CPU profiling plugin based on sk89q's [WarmRoast profiler](https://github.com/sk89q/WarmRoast). +The latest downloads are [available on Jenkins](https://ci.lucko.me/job/spark/). + ## What does it do? Effectively, it monitors the activity of the server, and records statistical data about which actions take up the most processing time. These statistics can then be used to diagnose potential performance issues with certain parts of the server or specific plugins. @@ -83,6 +85,10 @@ Starts a new profiling operation. * Specifies the interval between samples. Measured in milliseconds. * Lower values will improve the accuracy of the results, but may result in server lag. * If left unspecified, a default interval of 10 milliseconds is used. +* `--not-combined` + * Specifies that threads from a pool should not be combined into a single node. +* `--only-ticks-over ` + * Specifies that entries should only be included if they were part of a tick that took longer than the specified duration to execute. ___ #### `/profiler info` Prints information about the active profiler, if present. @@ -95,6 +101,14 @@ ___ #### `/profiler cancel` Cancels the current profiling operation, and discards any recorded data without uploading it. +___ +#### `/profiler monitoring` +Starts/stops the tick monitoring system. + +**Arguments** +* `--threshold ` + * Specifies the report threshold, measured as a percentage increase from the average tick duration. + ## License spark is a fork of [WarmRoast](https://github.com/sk89q/WarmRoast), which is [licensed under the GNU General Public License](https://github.com/sk89q/WarmRoast/blob/3fe5e5517b1c529d95cf9f43fd8420c66db0092a/src/main/java/com/sk89q/warmroast/WarmRoast.java#L1-L17). -- cgit