summaryrefslogtreecommitdiffstats
path: root/src/commands/latency-histogram.json
blob: 5e33eb60d4d78349e4c02a59730267c312ce542b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
{
    "HISTOGRAM": {
        "summary": "Returns the cumulative distribution of latencies of a subset or all commands.",
        "complexity": "O(N) where N is the number of commands with latency information being retrieved.",
        "group": "server",
        "since": "7.0.0",
        "arity": -2,
        "container": "LATENCY",
        "function": "latencyCommand",
        "command_flags": [
            "ADMIN",
            "NOSCRIPT",
            "LOADING",
            "STALE"
        ],
        "command_tips": [
            "NONDETERMINISTIC_OUTPUT",
            "REQUEST_POLICY:ALL_NODES",
            "RESPONSE_POLICY:SPECIAL"
        ],
        "reply_schema": {
            "type": "object",
            "description": "A map where each key is a command name, and each value is a map with the total calls, and an inner map of the histogram time buckets.",
            "patternProperties": {
                "^.*$": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "calls": {
                            "description": "The total calls for the command.",
                            "type": "integer",
                            "minimum": 0
                        },
                        "histogram_usec": {
                            "description": "Histogram map, bucket id to latency",
                            "type": "object",
                            "additionalProperties": {
                                "type": "integer"
                            }
                        }
                    }
                }
            }
        },
        "arguments": [
            {
                "name": "COMMAND",
                "type": "string",
                "optional": true,
                "multiple": true
            }
        ]
    }
}