summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/function-stats.md
diff options
context:
space:
mode:
Diffstat (limited to 'iredis/data/commands/function-stats.md')
-rw-r--r--iredis/data/commands/function-stats.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/iredis/data/commands/function-stats.md b/iredis/data/commands/function-stats.md
new file mode 100644
index 0000000..005b47b
--- /dev/null
+++ b/iredis/data/commands/function-stats.md
@@ -0,0 +1,21 @@
+Return information about the function that's currently running and information about the available execution engines.
+
+The reply is map with two keys:
+
+1. `running_script`: information about the running script.
+ If there's no in-flight function, the server replies with a _nil_.
+ Otherwise, this is a map with the following keys:
+ * **name:** the name of the function.
+ * **command:** the command and arguments used for invoking the function.
+ * **duration_ms:** the function's runtime duration in milliseconds.
+2. `engines`: this is a map of maps. Each entry in the map represent a single engine.
+ Engine map contains statistics about the engine like number of functions and number of libraries.
+
+
+You can use this command to inspect the invocation of a long-running function and decide whether kill it with the `FUNCTION KILL` command.
+
+For more information please refer to [Introduction to Redis Functions](/topics/functions-intro).
+
+@return
+
+@array-reply \ No newline at end of file