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
|
#!/bin/sh
#
# Copyright (c) 2022 Varnish Software AS
# All rights reserved.
#
# Author: Dridi Boukelmoune <dridi.boukelmoune@gmail.com>
#
# SPDX-License-Identifier: BSD-2-Clause
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
set -e
set -u
readonly SCRIPT=$0
readonly TMP=$(mktemp -d)
trap 'rm -rf $TMP' EXIT
usage() {
test $# -eq 1 &&
printf 'Error: %s.\n\n' "$1"
sed 's:@: :' <<-EOF
Usage: $SCRIPT <file1> <file2>
$SCRIPT -h
Show the differences between two sets of varnish metrics extracted
with 'varnishstat -1'.
Available options:
-h : show this help and exit
Considering the following metrics in <file1>:
FOO.counter 123 12 Only in file 1
BAR.counter 456 45 Counter present in both files
BAR.gauge 999 . Gauge present in both files
And the following metrics in <file2>:
BAR.counter 789 79 Counter present in both files
BAR.gauge 555 . Gauge present in both files
BAZ.gauge 0 . Only in file 2
The output is sorted by metric name and looks like this:
--- <file1>
+++ <file2>
@BAR.counter -456 -45 Counter present in both files
@ +789 +79
@BAR.gauge -999 . Gauge present in both files
@ +555 .
+BAZ.gauge 0 . Only in file 2
-FOO.counter 123 12 Only in file 1
The output looks like a unified diff except that when metrics are
present in both files, the diff is rendered as such only in the
metrics columns.
EOF
exit $#
}
join_prepare() {
# NB: the metrics need to be sorted to later be joined, and since
# the metrics descriptions contain spaces, using a delimiter other
# than space solves the problem. Hopefully @ never shows up in the
# varnishstat -1 output.
sort -k 1b,1 "$1" |
sed 's: *:@: ; s::@: ; s::@:'
}
join_render() {
# The resulting columns are:
# 1: metric name
# 2: value in file 1
# 3: rate in file 1
# 4: value in file 2
# 5: rate in file 2
# 6: description in file 1
# 7: description in file 2
join -a1 -a2 -t@ -o '0 1.2 1.3 2.2 2.3 1.4 2.4' -- "$1" "$2"
}
diff_preamble() {
printf "%s %s\n+++ %s\n" --- "$1" "$2"
}
diff_measure() {
awk -F@ '
BEGIN {
max[1] = 0
max[2] = 0
max[3] = 0
max[4] = 0
max[5] = 0
}
$2 != $4 || $3 != $5 {
for (i in max) {
if (max[i] < length($i))
max[i] = length($i)
}
}
END {
if (max[2] < max[4])
max[2] = max[4]
if (max[3] < max[5])
max[3] = max[5]
printf "%d %d %d\n", max[1] + 2, max[2] + 2, max[3] + 2
}
'
}
diff_render() {
read l1 l2 l3
awk -F@ -v l1="$l1" -v l2="$l2" -v l3="$l3" '
$2 != "" && $4 != "" && ($2 != $4 || $3 != $5) { # present in both
sgn = "-"
if ($3 == ".")
sgn = " "
printf " %-*s-%-*s%s%-*s%s\n", l1, $1, l2, $2, sgn, l3, $3, $6
sgn = "+"
if ($5 == ".")
sgn = " "
printf " %-*s+%-*s%s%s\n", l1, "", l2, $4, sgn, $5
}
$2 != "" && $4 == "" { # only in file 1
printf "-%-*s %-*s %-*s%s\n", l1, $1, l2, $2, l3, $3, $6
}
$2 == "" && $4 != "" { # only in file 2
printf "+%-*s %-*s %-*s%s\n", l1, $1, l2, $4, l3, $5, $7
}
' <"$1"
}
while getopts h OPT
do
case $OPT in
h) usage ;;
*) usage "wrong usage" >&2 ;;
esac
done
shift $((OPTIND - 1))
test $# -lt 2 && usage "not enough arguments" >&2
test $# -gt 2 && usage "too many arguments" >&2
export LC_ALL=C.utf-8
join_prepare "$1" >"$TMP"/1
join_prepare "$2" >"$TMP"/2
join_render "$TMP"/1 "$TMP"/2 >"$TMP"/join
diff_preamble "$1" "$2"
diff_measure <"$TMP"/join |
diff_render "$TMP"/join
|
