summaryrefslogtreecommitdiffstats
path: root/src/commands/function-stats.json
diff options
context:
space:
mode:
Diffstat (limited to 'src/commands/function-stats.json')
-rw-r--r--src/commands/function-stats.json81
1 files changed, 81 insertions, 0 deletions
diff --git a/src/commands/function-stats.json b/src/commands/function-stats.json
new file mode 100644
index 0000000..65519db
--- /dev/null
+++ b/src/commands/function-stats.json
@@ -0,0 +1,81 @@
+{
+ "STATS": {
+ "summary": "Returns information about a function during execution.",
+ "complexity": "O(1)",
+ "group": "scripting",
+ "since": "7.0.0",
+ "arity": 2,
+ "container": "FUNCTION",
+ "function": "functionStatsCommand",
+ "command_flags": [
+ "NOSCRIPT",
+ "ALLOW_BUSY"
+ ],
+ "acl_categories": [
+ "SCRIPTING"
+ ],
+ "command_tips": [
+ "NONDETERMINISTIC_OUTPUT",
+ "REQUEST_POLICY:ALL_SHARDS",
+ "RESPONSE_POLICY:SPECIAL"
+ ],
+ "reply_schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "running_script": {
+ "description": "information about the running script.",
+ "oneOf": [
+ {
+ "description": "If there's no in-flight function",
+ "type": "null"
+ },
+ {
+ "description": "a map with the information about the running script",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "description": "the name of the function.",
+ "type": "string"
+ },
+ "command": {
+ "description": "the command and arguments used for invoking the function.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "duration_ms": {
+ "description": "the function's runtime duration in milliseconds.",
+ "type": "integer"
+ }
+ }
+ }
+ ]
+ },
+ "engines": {
+ "description": "A map when each entry in the map represent a single engine.",
+ "type": "object",
+ "patternProperties": {
+ "^.*$": {
+ "description": "Engine map contains statistics about the engine",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "libraries_count": {
+ "description": "number of libraries",
+ "type": "integer"
+ },
+ "functions_count": {
+ "description": "number of functions",
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+}