aboutsummaryrefslogtreecommitdiffstats
path: root/container-core/src/test/java/com/yahoo/container/logging/JSONLogTestCase.java
blob: 1c66a1d805aa4241f8842f16b0d1daf08e6549b9 (plain) (blame)
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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.container.logging;

import com.yahoo.yolean.trace.TraceNode;
import org.junit.jupiter.api.Test;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.time.Duration;
import java.time.Instant;

import static com.yahoo.test.json.JsonTestHelper.assertJsonEquals;


/**
 * @author frodelu
 */
public class JSONLogTestCase {

    private static String ipAddress = "152.200.54.243";

    private RequestLogEntry.Builder newRequestLogEntry(final String query) {
        return newRequestLogEntry(query, new Coverage(100,100,100,0));
    }
    private RequestLogEntry.Builder newRequestLogEntry(final String query, Coverage coverage) {
        return new RequestLogEntry.Builder()
                .rawQuery("query=" + query)
                .rawPath("")
                .peerAddress(ipAddress)
                .httpMethod("GET")
                .httpVersion("HTTP/1.1")
                .userAgent("Mozilla/4.05 [en] (Win95; I)")
                .hitCounts(new HitCounts(0, 10, 1234, 0, 10, coverage))
                .hostString("localhost")
                .statusCode(200)
                .timestamp(Instant.ofEpochMilli(920880005023L))
                .duration(Duration.ofMillis(122))
                .responseSize(9875)
                .localPort(0)
                .peerPort(0);
    }

    @Test
    void test_json_log_entry() {
        RequestLogEntry entry = newRequestLogEntry("test").build();

        String expectedOutput =
                "{\"ip\":\"152.200.54.243\"," +
                        "\"peeraddr\":\"152.200.54.243\"," +
                        "\"time\":920880005.023," +
                        "\"duration\":0.122," +
                        "\"responsesize\":9875," +
                        "\"requestsize\":0," +
                        "\"code\":200," +
                        "\"method\":\"GET\"," +
                        "\"uri\":\"?query=test\"," +
                        "\"version\":\"HTTP/1.1\"," +
                        "\"agent\":\"Mozilla/4.05 [en] (Win95; I)\"," +
                        "\"host\":\"localhost\"," +
                        "\"scheme\":null," +
                        "\"localport\":0," +
                        "\"search\":{" +
                        "\"totalhits\":1234," +
                        "\"hits\":0," +
                        "\"coverage\":{\"coverage\":100,\"documents\":100}" +
                        "}" +
                        "}";

        assertJsonEquals(formatEntry(entry), expectedOutput);
    }

    @Test
    void test_json_of_trace() {
        TraceNode root = new TraceNode("root", 7);
        RequestLogEntry entry = newRequestLogEntry("test")
                .traceNode(root)
                .build();

        String expectedOutput =
                "{\"ip\":\"152.200.54.243\"," +
                        "\"peeraddr\":\"152.200.54.243\"," +
                        "\"time\":920880005.023," +
                        "\"duration\":0.122," +
                        "\"responsesize\":9875," +
                        "\"requestsize\":0," +
                        "\"code\":200," +
                        "\"method\":\"GET\"," +
                        "\"uri\":\"?query=test\"," +
                        "\"version\":\"HTTP/1.1\"," +
                        "\"agent\":\"Mozilla/4.05 [en] (Win95; I)\"," +
                        "\"host\":\"localhost\"," +
                        "\"scheme\":null," +
                        "\"localport\":0," +
                        "\"trace\":{\"timestamp\":0,\"message\":\"root\"}," +
                        "\"search\":{" +
                        "\"totalhits\":1234," +
                        "\"hits\":0," +
                        "\"coverage\":{\"coverage\":100,\"documents\":100}" +
                        "}" +
                        "}";

        assertJsonEquals(formatEntry(entry), expectedOutput);
    }

    @Test
    void test_with_keyvalues() {
        RequestLogEntry entry = newRequestLogEntry("test")
                .addExtraAttribute("singlevalue", "value1")
                .addExtraAttribute("multivalue", "value2")
                .addExtraAttribute("multivalue", "value3")
                .build();

        String expectedOutput =
                "{\"ip\":\"152.200.54.243\"," +
                        "\"peeraddr\":\"152.200.54.243\"," +
                        "\"time\":920880005.023," +
                        "\"duration\":0.122," +
                        "\"responsesize\":9875," +
                        "\"requestsize\":0," +
                        "\"code\":200," +
                        "\"method\":\"GET\"," +
                        "\"uri\":\"?query=test\"," +
                        "\"version\":\"HTTP/1.1\"," +
                        "\"agent\":\"Mozilla/4.05 [en] (Win95; I)\"," +
                        "\"host\":\"localhost\"," +
                        "\"scheme\":null," +
                        "\"localport\":0," +
                        "\"search\":{" +
                        "\"totalhits\":1234," +
                        "\"hits\":0," +
                        "\"coverage\":{\"coverage\":100,\"documents\":100}" +
                        "}," +
                        "\"attributes\":{" +
                        "\"singlevalue\":\"value1\"," +
                        "\"multivalue\":[\"value2\",\"value3\"]}" +
                        "}";

        assertJsonEquals(formatEntry(entry), expectedOutput);

    }

    @Test
    void test_with_remoteaddrport() throws Exception {
        RequestLogEntry entry = newRequestLogEntry("test")
                .remoteAddress("FE80:0000:0000:0000:0202:B3FF:FE1E:8329")
                .build();

        String expectedOutput =
                "{\"ip\":\"152.200.54.243\"," +
                        "\"peeraddr\":\"152.200.54.243\"," +
                        "\"time\":920880005.023," +
                        "\"duration\":0.122," +
                        "\"responsesize\":9875," +
                        "\"requestsize\":0," +
                        "\"code\":200," +
                        "\"method\":\"GET\"," +
                        "\"uri\":\"?query=test\"," +
                        "\"version\":\"HTTP/1.1\"," +
                        "\"agent\":\"Mozilla/4.05 [en] (Win95; I)\"," +
                        "\"host\":\"localhost\"," +
                        "\"scheme\":null," +
                        "\"localport\":0," +
                        "\"remoteaddr\":\"FE80:0000:0000:0000:0202:B3FF:FE1E:8329\"," +
                        "\"search\":{" +
                        "\"totalhits\":1234," +
                        "\"hits\":0," +
                        "\"coverage\":{\"coverage\":100,\"documents\":100}" +
                        "}" +
                        "}";

        assertJsonEquals(formatEntry(entry), expectedOutput);

        // Add remote port and verify
        entry = newRequestLogEntry("test")
                .remoteAddress("FE80:0000:0000:0000:0202:B3FF:FE1E:8329")
                .remotePort(1234)
                .build();

        expectedOutput =
                "{\"ip\":\"152.200.54.243\"," +
                        "\"peeraddr\":\"152.200.54.243\"," +
                        "\"time\":920880005.023," +
                        "\"duration\":0.122," +
                        "\"responsesize\":9875," +
                        "\"requestsize\":0," +
                        "\"code\":200," +
                        "\"method\":\"GET\"," +
                        "\"uri\":\"?query=test\"," +
                        "\"version\":\"HTTP/1.1\"," +
                        "\"agent\":\"Mozilla/4.05 [en] (Win95; I)\"," +
                        "\"host\":\"localhost\"," +
                        "\"scheme\":null," +
                        "\"localport\":0," +
                        "\"remoteaddr\":\"FE80:0000:0000:0000:0202:B3FF:FE1E:8329\"," +
                        "\"remoteport\":1234," +
                        "\"search\":{" +
                        "\"totalhits\":1234," +
                        "\"hits\":0," +
                        "\"coverage\":{\"coverage\":100,\"documents\":100}" +
                        "}" +
                        "}";

        assertJsonEquals(formatEntry(entry), expectedOutput);
    }

    @Test
    void test_remote_address_same_as_ip_address() throws Exception {
        RequestLogEntry entry = newRequestLogEntry("test").build();
        RequestLogEntry entrywithremote = newRequestLogEntry("test")
                .remoteAddress(entry.peerAddress().get())
                .build();
        JSONFormatter formatter = new JSONFormatter();
        assertJsonEquals(formatEntry(entry), formatEntry(entrywithremote));
    }

    @Test
    void test_useragent_with_quotes() {
        RequestLogEntry entry = new RequestLogEntry.Builder()
                .rawQuery("query=test")
                .rawPath("")
                .peerAddress(ipAddress)
                .httpMethod("GET")
                .httpVersion("HTTP/1.1")
                .userAgent("Mozilla/4.05 [en] (Win95; I; \"Best Browser Ever\")")
                .hitCounts(new HitCounts(0, 10, 1234, 0, 10, new Coverage(100, 200, 200, 0)))
                .hostString("localhost")
                .statusCode(200)
                .timestamp(Instant.ofEpochMilli(920880005023L))
                .duration(Duration.ofMillis(122))
                .responseSize(9875)
                .localPort(0)
                .peerPort(0)
                .build();

        String expectedOutput =
                "{\"ip\":\"152.200.54.243\"," +
                        "\"peeraddr\":\"152.200.54.243\"," +
                        "\"time\":920880005.023," +
                        "\"duration\":0.122," +
                        "\"responsesize\":9875," +
                        "\"requestsize\":0," +
                        "\"code\":200," +
                        "\"method\":\"GET\"," +
                        "\"uri\":\"?query=test\"," +
                        "\"version\":\"HTTP/1.1\"," +
                        "\"agent\":\"Mozilla/4.05 [en] (Win95; I; \\\"Best Browser Ever\\\")\"," +
                        "\"host\":\"localhost\"," +
                        "\"scheme\":null," +
                        "\"localport\":0," +
                        "\"search\":{" +
                        "\"totalhits\":1234," +
                        "\"hits\":0," +
                        "\"coverage\":{\"coverage\":50,\"documents\":100,\"degraded\":{\"non-ideal-state\":true}}" +
                        "}" +
                        "}";

        assertJsonEquals(formatEntry(entry), expectedOutput);
    }

    private void verifyCoverage(String coverage, RequestLogEntry entry) {
        assertJsonEquals(formatEntry(entry),
                "{\"ip\":\"152.200.54.243\"," +
                "\"peeraddr\":\"152.200.54.243\"," +
                "\"time\":920880005.023," +
                "\"duration\":0.122," +
                "\"responsesize\":9875," +
                "\"requestsize\":0," +
                "\"code\":200," +
                "\"method\":\"GET\"," +
                "\"uri\":\"?query=test\"," +
                "\"version\":\"HTTP/1.1\"," +
                "\"agent\":\"Mozilla/4.05 [en] (Win95; I)\"," +
                "\"host\":\"localhost\"," +
                "\"scheme\":null," +
                "\"localport\":0," +
                "\"search\":{" +
                "\"totalhits\":1234," +
                "\"hits\":0," +
                coverage +
                "}" +
                "}");
    }

    @Test
    void test_with_coverage_degradation() {
        verifyCoverage("\"coverage\":{\"coverage\":50,\"documents\":100,\"degraded\":{\"non-ideal-state\":true}}",
                newRequestLogEntry("test",  new Coverage(100, 200, 200, 0)).build());
        verifyCoverage("\"coverage\":{\"coverage\":50,\"documents\":100,\"degraded\":{\"match-phase\":true}}",
                newRequestLogEntry("test",  new Coverage(100, 200, 200, 1)).build());
        verifyCoverage("\"coverage\":{\"coverage\":50,\"documents\":100,\"degraded\":{\"timeout\":true}}",
                newRequestLogEntry("test",  new Coverage(100, 200, 200, 2)).build());
        verifyCoverage("\"coverage\":{\"coverage\":50,\"documents\":100,\"degraded\":{\"adaptive-timeout\":true}}",
                newRequestLogEntry("test",  new Coverage(100, 200, 200, 4)).build());
    }

    private String formatEntry(RequestLogEntry entry) {
        try (ByteArrayOutputStream outputStream = new ByteArrayOutputStream()) {
            new JSONFormatter().write(entry, outputStream);
            return outputStream.toString();
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }
}