Skip to content

Commit f41711e

Browse files
egahlinegahlin
committedOct 21, 2022
8295650: JFR: jfr scrub should warn if an event type doesn't exist
Reviewed-by: mgronlun
·
jdk-21+2121-genzgc+1-8
1 parent 0c13d66 commit f41711e

File tree

5 files changed

+66
-22
lines changed

5 files changed

+66
-22
lines changed
 

‎src/jdk.jfr/share/classes/jdk/jfr/internal/tool/Filters.java

+15-2
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
*/
4141
public class Filters {
4242

43-
static Predicate<EventType> createCategoryFilter(String filterText) throws UserSyntaxException {
43+
static Predicate<EventType> createCategoryFilter(String filterText, List<EventType> types) throws UserSyntaxException {
4444
List<String> filters = explodeFilter(filterText);
4545
Predicate<EventType> f = eventType -> {
4646
for (String category : eventType.getCategoryNames()) {
@@ -55,10 +55,13 @@ static Predicate<EventType> createCategoryFilter(String filterText) throws UserS
5555
}
5656
return false;
5757
};
58+
if (unknownEventType(f, types)) {
59+
System.out.println("Warning, no event type matched category filter: " + filterText);
60+
}
5861
return createCache(f, EventType::getId);
5962
}
6063

61-
static Predicate<EventType> createEventTypeFilter(String filterText) throws UserSyntaxException {
64+
static Predicate<EventType> createEventTypeFilter(String filterText, List<EventType> types) throws UserSyntaxException {
6265
List<String> filters = explodeFilter(filterText);
6366
Predicate<EventType> f = eventType -> {
6467
for (String filter : filters) {
@@ -73,9 +76,19 @@ static Predicate<EventType> createEventTypeFilter(String filterText) throws User
7376
}
7477
return false;
7578
};
79+
if (unknownEventType(f, types)) {
80+
System.out.println("Warning, no event type matched filter: " + filterText);
81+
}
7682
return createCache(f, EventType::getId);
7783
}
7884

85+
private static boolean unknownEventType(Predicate<EventType> f, List<EventType> types) {
86+
if (types.isEmpty()) {
87+
return false;
88+
}
89+
return !types.stream().anyMatch(f);
90+
}
91+
7992
public static <T> Predicate<T> matchAny(List<Predicate<T>> filters) {
8093
if (filters.isEmpty()) {
8194
return t -> true;

‎src/jdk.jfr/share/classes/jdk/jfr/internal/tool/Metadata.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ public void execute(Deque<String> options) throws UserSyntaxException, UserDataE
178178
foundEventFilter = true;
179179
String filterStr = options.remove();
180180
warnForWildcardExpansion("--events", filterStr);
181-
filters.add(Filters.createEventTypeFilter(filterStr));
181+
filters.add(Filters.createEventTypeFilter(filterStr, List.of()));
182182
}
183183
if (acceptFilterOption(options, "--categories")) {
184184
if (foundCategoryFilter) {
@@ -187,7 +187,7 @@ public void execute(Deque<String> options) throws UserSyntaxException, UserDataE
187187
foundCategoryFilter = true;
188188
String filterStr = options.remove();
189189
warnForWildcardExpansion("--categories", filterStr);
190-
filters.add(Filters.createCategoryFilter(filterStr));
190+
filters.add(Filters.createCategoryFilter(filterStr, List.of()));
191191
}
192192
if (optionCount == options.size()) {
193193
// No progress made

‎src/jdk.jfr/share/classes/jdk/jfr/internal/tool/Print.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ public void execute(Deque<String> options) throws UserSyntaxException, UserDataE
116116
foundEventFilter = true;
117117
String filter = options.remove();
118118
warnForWildcardExpansion("--events", filter);
119-
eventFilters.add(Filters.createEventTypeFilter(filter));
119+
eventFilters.add(Filters.createEventTypeFilter(filter, List.of()));
120120
}
121121
if (acceptFilterOption(options, "--categories")) {
122122
if (foundCategoryFilter) {
@@ -125,7 +125,7 @@ public void execute(Deque<String> options) throws UserSyntaxException, UserDataE
125125
foundCategoryFilter = true;
126126
String filter = options.remove();
127127
warnForWildcardExpansion("--categories", filter);
128-
eventFilters.add(Filters.createCategoryFilter(filter));
128+
eventFilters.add(Filters.createCategoryFilter(filter, List.of()));
129129
}
130130
if (acceptOption(options, "--stack-depth")) {
131131
String value = options.pop();

‎src/jdk.jfr/share/classes/jdk/jfr/internal/tool/Scrub.java

+18-12
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
import java.util.List;
3535
import java.util.function.Predicate;
3636

37+
import jdk.jfr.EventType;
3738
import jdk.jfr.consumer.RecordedEvent;
3839
import jdk.jfr.consumer.RecordingFile;
3940

@@ -135,31 +136,43 @@ public void execute(Deque<String> options) throws UserSyntaxException, UserDataE
135136
}
136137
ensureUsableOutput(input, output);
137138

139+
try (RecordingFile rf = new RecordingFile(input)) {
140+
List<EventType> types = rf.readEventTypes();
141+
Predicate<RecordedEvent> filter = createFilter(options, types);
142+
rf.write(output, filter);
143+
} catch (IOException ioe) {
144+
couldNotReadError(input, ioe);
145+
}
146+
println("Scrubbed recording file written to:");
147+
println(output.toAbsolutePath().toString());
148+
}
149+
150+
private Predicate<RecordedEvent> createFilter(Deque<String> options, List<EventType> types) throws UserSyntaxException, UserDataException {
138151
List<Predicate<RecordedEvent>> filters = new ArrayList<>();
139152
int optionCount = options.size();
140153
while (optionCount > 0) {
141154
if (acceptFilterOption(options, "--include-events")) {
142155
String filter = options.remove();
143156
warnForWildcardExpansion("--include-events", filter);
144-
var f = Filters.createEventTypeFilter(filter);
157+
var f = Filters.createEventTypeFilter(filter, types);
145158
filters.add(Filters.fromEventType(f));
146159
}
147160
if (acceptFilterOption(options, "--exclude-events")) {
148161
String filter = options.remove();
149162
warnForWildcardExpansion("--exclude-events", filter);
150-
var f = Filters.createEventTypeFilter(filter);
163+
var f = Filters.createEventTypeFilter(filter, types);
151164
filters.add(Filters.fromEventType(f.negate()));
152165
}
153166
if (acceptFilterOption(options, "--include-categories")) {
154167
String filter = options.remove();
155168
warnForWildcardExpansion("--include-categories", filter);
156-
var f = Filters.createCategoryFilter(filter);
169+
var f = Filters.createCategoryFilter(filter, types);
157170
filters.add(Filters.fromEventType(f));
158171
}
159172
if (acceptFilterOption(options, "--exclude-categories")) {
160173
String filter = options.remove();
161174
warnForWildcardExpansion("--exclude-categories", filter);
162-
var f = Filters.createCategoryFilter(filter);
175+
var f = Filters.createCategoryFilter(filter, types);
163176
filters.add(Filters.fromEventType(f.negate()));
164177
}
165178
if (acceptFilterOption(options, "--include-threads")) {
@@ -183,14 +196,7 @@ public void execute(Deque<String> options) throws UserSyntaxException, UserDataE
183196
}
184197
optionCount = options.size();
185198
}
186-
187-
try (RecordingFile rf = new RecordingFile(input)) {
188-
rf.write(output, Filters.matchAny(filters));
189-
} catch (IOException ioe) {
190-
couldNotReadError(input, ioe);
191-
}
192-
println("Scrubbed recording file written to:");
193-
println(output.toAbsolutePath().toString());
199+
return Filters.matchAny(filters);
194200
}
195201

196202
private void ensureUsableOutput(Path input, Path output) throws UserSyntaxException, UserDataException {

‎test/jdk/jdk/jfr/tool/TestScrub.java

+29-4
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,12 @@
2323

2424
package jdk.jfr.tool;
2525

26-
import java.io.FileWriter;
27-
import java.io.IOException;
28-
import java.lang.reflect.InvocationTargetException;
2926
import java.nio.file.Files;
3027
import java.nio.file.Path;
3128
import java.util.ArrayList;
3229
import java.util.Arrays;
3330
import java.util.List;
3431

35-
import jdk.test.lib.Utils;
3632
import jdk.test.lib.process.OutputAnalyzer;
3733
import jdk.jfr.Name;
3834
import jdk.jfr.Recording;
@@ -91,6 +87,8 @@ public static void main(String[] args) throws Throwable {
9187

9288
testThreadExclude(file);
9389
testThreadInclude(file);
90+
91+
testMissingEventType(file);
9492
}
9593

9694
private static void testInputOutput(Path file) throws Throwable {
@@ -250,6 +248,33 @@ private static void testThreadExclude(Path file) throws Throwable {
250248
}
251249
}
252250

251+
private static void testMissingEventType(Path input) throws Throwable {
252+
Path output = Path.of("scrubbed.jfr");
253+
String[] args = {
254+
"scrub",
255+
"--exclude-events", "Foo",
256+
"--include-events", "example.Zebra",
257+
"--include-events", "jdk.Bar",
258+
"--include-events", "example.Tigerfish",
259+
"--exclude-categories", "Mammal",
260+
"--exclude-categories", "jdk.Baz",
261+
"--include-categories", "Fish",
262+
"--include-categories", "jdk.Qux,jdk.Quuz",
263+
input.toAbsolutePath().toString(),
264+
output.toAbsolutePath().toString()
265+
};
266+
var outp = ExecuteHelper.jfr(args);
267+
outp.shouldContain("Warning, no event type matched filter: Foo");
268+
outp.shouldContain("Warning, no event type matched filter: jdk.Bar");
269+
outp.shouldContain("Warning, no event type matched category filter: jdk.Baz");
270+
outp.shouldContain("Warning, no event type matched category filter: jdk.Qux,jdk.Quuz");
271+
outp.shouldNotContain("Warning, no event type matched filter: example.Zebra");
272+
outp.shouldNotContain("Warning, no event type matched filter: example.Tigerfish");
273+
outp.shouldNotContain("Warning, no event type matched category filter: Mammal");
274+
outp.shouldNotContain("Warning, no event type matched category filter: Fish");
275+
Files.delete(output);
276+
}
277+
253278
private static void assertNotThread(RecordedEvent event, String... threadNames) {
254279
String s = event.getThread().getJavaName();
255280
for (String threadName : threadNames) {

0 commit comments

Comments
 (0)
Please sign in to comment.