goose 0.19.1

A load testing framework inspired by Locust.
Documentation 
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231

(function () {
    // The report's response time heatmap. The data comes from the JSON
    // element Goose writes before this script; request names reach the page
    // only as the text of the select's options, never as markup.
    var holder = document.getElementById('graph-latency-heatmap');
    var source = document.getElementById('graph-latency-heatmap-data');
    if (!holder || !source || typeof echarts === 'undefined') {
        return;
    }
    var data = JSON.parse(source.textContent);
    if (!data || !data.series || data.series.length === 0) {
        return;
    }
    var select = document.getElementById('graph-latency-heatmap-series');
    var views = document.getElementById('graph-latency-heatmap-views');
    var buttons = views.querySelectorAll('button');
    var note = document.getElementById('graph-latency-heatmap-width');
    var legendMin = document.getElementById('graph-latency-heatmap-min');
    var legendMax = document.getElementById('graph-latency-heatmap-max');
    var chart = echarts.init(holder);
    var view = 'adjusted';

    data.series.forEach(function (series, index) {
        var option = document.createElement('option');
        option.value = String(index);
        option.textContent = series.name;
        select.appendChild(option);
    });

    // The dashboard's colour ramp: one hue, light for the sparsest cells
    // and dark for the busiest. `level` runs from 0 to 1000.
    function color(level) {
        var t = level / 1000;
        var saturation = 80 + 5 * t;
        var lightness = 64 - 42 * t;
        return 'hsl(222, ' + saturation.toFixed(1) + '%, ' + lightness.toFixed(1) + '%)';
    }
    document.getElementById('graph-latency-heatmap-ramp').style.background =
        'linear-gradient(to right, ' + color(0) + ', ' + color(1000) + ')';

    // Each bucket as [time, lowest, highest] in microseconds: 100
    // microseconds each under a millisecond.
    var micros = data.buckets_us;

    // A bucket's span on the logarithmic axis, in milliseconds: from its
    // lowest time to past its highest. The bucket from 0 starts at half its
    // end, 0.05 ms.
    function span(bucket) {
        var row = micros[bucket];
        var end = (row[2] + 1) / 1000;
        return [row[1] === 0 ? end / 2 : row[1] / 1000, end];
    }

    function pad(number) {
        return (number < 10 ? '0' : '') + number;
    }

    // Times are shifted to the Goose host's zone and drawn as UTC.
    function clock(ms) {
        var date = new Date(ms);
        return date.getUTCFullYear() + '-' + pad(date.getUTCMonth() + 1) + '-' +
            pad(date.getUTCDate()) + ' ' + pad(date.getUTCHours()) + ':' +
            pad(date.getUTCMinutes()) + ':' + pad(date.getUTCSeconds());
    }

    // A percentile, the middle of its row, at the rows' precision: to the
    // tenth under 1 ms and whole from 1 ms, truncated, so it names the row
    // it is in.
    function rowMs(us) {
        if (us < 1000) {
            return String(Math.floor(us / 100) / 10);
        }
        return Math.floor(us / 1000).toLocaleString();
    }

    function requests(count) {
        return count.toLocaleString() + (count === 1 ? ' request' : ' requests');
    }

    function bucketText(bucket) {
        var row = micros[bucket];
        if (row[2] < 1000) {
            return (row[1] / 1000) + ' to ' + ((row[2] + 1) / 1000) + ' ms';
        }
        // A row's bounds are exact; whole milliseconds, truncated, never
        // name a time above the row.
        var lowest = Math.floor(row[1] / 1000);
        if (row[2] - row[1] < 1000) {
            return lowest.toLocaleString() + ' ms';
        }
        return lowest.toLocaleString() + ' to ' + Math.floor((row[2] + 1) / 1000).toLocaleString() + ' ms';
    }

    function tooltip(params) {
        var value = params.value;
        if (params.seriesType === 'custom') {
            return clock(value[0]) + ' to ' + clock(value[1]) + '<br>' +
                bucketText(value[6]) + ': ' + requests(value[5]) + '<br>' +
                'p50 / p95 / p99: ' + rowMs(value[7]) + ' / ' + rowMs(value[8]) + ' / ' +
                rowMs(value[9]) + ' ms';
        }
        return clock(value[0]) + '<br>' + params.seriesName + ': ' + rowMs(value[2]) + ' ms';
    }

    function draw() {
        var series = data.series[Number(select.value)];
        var adjustable = series.adjusted !== null;
        views.hidden = !adjustable;
        var adjusted = adjustable && view === 'adjusted';
        for (var b = 0; b < buttons.length; b++) {
            var pressed = (buttons[b].getAttribute('data-view') === 'adjusted') === adjusted;
            buttons[b].setAttribute('aria-pressed', pressed ? 'true' : 'false');
            buttons[b].className = pressed ? 'active' : '';
        }
        var shown = adjusted ? series.adjusted : series.measured;
        var widthMs = series.width * 1000;
        var first = data.start + data.offset + data.origin * 1000;
        var cells = [];
        var lines = [[], [], []];
        var low = Infinity;
        var high = 0;
        var end = first;
        var previous = null;
        shown.columns.forEach(function (column) {
            var from = first + column[0] * widthMs;
            var to = from + widthMs;
            end = Math.max(end, to);
            // A column with no requests breaks the lines.
            if (previous !== null && column[0] > previous + 1) {
                for (var gap = 0; gap < 3; gap++) {
                    lines[gap].push([from - widthMs / 2, null, null]);
                }
            }
            previous = column[0];
            for (var p = 0; p < 3; p++) {
                // The percentiles are in microseconds. The value axis is
                // logarithmic, so a percentile under 0.05 ms is drawn where
                // the lowest bucket starts.
                lines[p].push([(from + to) / 2, Math.max(column[1 + p] / 1000, 0.05), column[1 + p]]);
            }
            for (var i = 4; i + 2 < column.length; i += 3) {
                var bucketSpan = span(column[i]);
                low = Math.min(low, bucketSpan[0]);
                high = Math.max(high, bucketSpan[1]);
                cells.push([from, to, bucketSpan[0], bucketSpan[1], column[i + 2],
                    column[i + 1], column[i], column[1], column[2], column[3]]);
            }
        });
        if (cells.length === 0) {
            low = 0.05;
            high = 1000;
        }
        note.textContent = 'Each column is ' +
            (series.width === 1 ? '1 second' : series.width + ' seconds') +
            '. Color shows how many requests took that long; the lines are each column\'s p50, p95 and p99.';
        legendMin.textContent = requests(shown.min);
        legendMax.textContent = requests(shown.max);
        var line = function (name, color, values) {
            return {
                name: name,
                type: 'line',
                symbol: 'none',
                connectNulls: false,
                lineStyle: { color: color, width: 2 },
                itemStyle: { color: color },
                encode: { x: 0, y: 1 },
                data: values
            };
        };
        chart.setOption({
            animation: false,
            useUTC: true,
            tooltip: { trigger: 'item', formatter: tooltip },
            legend: { data: ['p50', 'p95', 'p99'] },
            grid: { left: 80, right: 40, top: 40, bottom: 50 },
            xAxis: { type: 'time', min: first, max: Math.max(end, first + widthMs) },
            yAxis: {
                name: 'Response time [ms]',
                nameLocation: 'center',
                nameRotate: 90,
                nameGap: 55,
                type: 'log',
                logBase: 10,
                min: low,
                max: high
            },
            series: [
                {
                    type: 'custom',
                    // Drawn in one pass, not over several frames, so a
                    // printed report has every cell.
                    progressive: 0,
                    renderItem: function (params, api) {
                        // Edges on whole pixels, so neighbouring cells meet
                        // without a pale seam between them.
                        var topLeft = api.coord([api.value(0), api.value(3)]);
                        var bottomRight = api.coord([api.value(1), api.value(2)]);
                        var left = Math.round(topLeft[0]);
                        var top = Math.round(topLeft[1]);
                        var right = Math.round(bottomRight[0]);
                        var bottom = Math.round(bottomRight[1]);
                        return {
                            type: 'rect',
                            shape: {
                                x: left,
                                y: top,
                                width: Math.max(right - left, 1),
                                height: Math.max(bottom - top, 1)
                            },
                            style: { fill: color(api.value(4)) }
                        };
                    },
                    encode: { x: [0, 1], y: [2, 3] },
                    data: cells
                },
                line('p50', '#2c664f', lines[0]),
                line('p95', '#d4730b', lines[1]),
                line('p99', '#b33f3f', lines[2])
            ]
        }, true);
    }

    select.addEventListener('change', draw);
    for (var b = 0; b < buttons.length; b++) {
        buttons[b].addEventListener('click', function (event) {
            view = event.currentTarget.getAttribute('data-view');
            draw();
        });
    }
    draw();
})();