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
|
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.hosted.controller.auditlog;
import com.google.common.base.CharMatcher;
import com.google.common.collect.Ordering;
import java.time.Instant;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.Predicate;
/**
* This represents the audit log of a hosted Vespa system. The audit log contains manual actions performed through
* operator APIs served by the controller.
*
* @author mpolden
*/
public class AuditLog {
public static final AuditLog empty = new AuditLog(List.of());
private final List<Entry> entries;
/** DO NOT USE. Public for serialization purposes */
public AuditLog(List<Entry> entries) {
this.entries = Ordering.natural().immutableSortedCopy(entries);
}
/** Returns a new audit log without entries older than given instant */
public AuditLog pruneBefore(Instant instant) {
List<Entry> entries = new ArrayList<>(this.entries);
entries.removeIf(entry -> entry.at().isBefore(instant));
return new AuditLog(entries);
}
/** Returns an new audit log with given entry added */
public AuditLog with(Entry entry) {
List<Entry> entries = new ArrayList<>(this.entries);
entries.add(entry);
return new AuditLog(entries);
}
/** Returns the first n entries in this. Since entries are sorted descendingly, this will be the n newest entries */
public AuditLog first(int n) {
if (entries.size() < n) return this;
return new AuditLog(entries.subList(0, n));
}
/** Returns all entries in this. Entries are sorted descendingly by their timestamp */
public List<Entry> entries() {
return entries;
}
/** An entry in the audit log. This describes an HTTP request */
public static class Entry implements Comparable<Entry> {
private final static int maxDataLength = 1024;
private final static Comparator<Entry> comparator = Comparator.comparing(Entry::at).reversed();
private final Instant at;
private final String principal;
private final Method method;
private final String resource;
private final Optional<String> data;
public Entry(Instant at, String principal, Method method, String resource, Optional<String> data) {
this.at = Objects.requireNonNull(at, "at must be non-null");
this.principal = Objects.requireNonNull(principal, "principal must be non-null");
this.method = Objects.requireNonNull(method, "method must be non-null");
this.resource = Objects.requireNonNull(resource, "resource must be non-null");
this.data = sanitize(data);
}
/** Time of the request */
public Instant at() {
return at;
}
/** The principal performing the request */
public String principal() {
return principal;
}
/** Request method */
public Method method() {
return method;
}
/** API resource (URL path) */
public String resource() {
return resource;
}
/** Request data. This may be truncated if request data logged in this entry was too large */
public Optional<String> data() {
return data;
}
@Override
public int compareTo(Entry that) {
return comparator.compare(this, that);
}
/** HTTP methods that should be logged */
public enum Method {
POST,
PATCH,
PUT,
DELETE
}
private static Optional<String> sanitize(Optional<String> data) {
Objects.requireNonNull(data, "data must be non-null");
return data.filter(Predicate.not(String::isBlank))
.filter(CharMatcher.ascii()::matchesAllOf)
.map(v -> {
if (v.length() > maxDataLength) {
return v.substring(0, maxDataLength);
}
return v;
});
}
}
}
|
