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
|
/*
* This file is part of spark.
*
* Copyright (c) lucko (Luck) <luck@lucko.me>
* Copyright (c) contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package me.lucko.spark.common.command.modules;
import me.lucko.spark.common.SparkPlatform;
import me.lucko.spark.common.activitylog.Activity;
import me.lucko.spark.common.command.Arguments;
import me.lucko.spark.common.command.Command;
import me.lucko.spark.common.command.CommandModule;
import me.lucko.spark.common.command.CommandResponseHandler;
import me.lucko.spark.common.command.sender.CommandSender;
import me.lucko.spark.common.command.tabcomplete.TabCompleter;
import me.lucko.spark.common.heapdump.HeapDump;
import me.lucko.spark.common.heapdump.HeapDumpSummary;
import me.lucko.spark.common.util.Compression;
import me.lucko.spark.common.util.FormatUtil;
import me.lucko.spark.common.util.MediaTypes;
import me.lucko.spark.proto.SparkHeapProtos;
import net.kyori.adventure.text.event.ClickEvent;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Iterator;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicLong;
import java.util.function.Consumer;
import java.util.function.LongConsumer;
import static net.kyori.adventure.text.Component.text;
import static net.kyori.adventure.text.format.NamedTextColor.GOLD;
import static net.kyori.adventure.text.format.NamedTextColor.GRAY;
import static net.kyori.adventure.text.format.NamedTextColor.GREEN;
import static net.kyori.adventure.text.format.NamedTextColor.RED;
public class HeapAnalysisModule implements CommandModule {
@Override
public void registerCommands(Consumer<Command> consumer) {
consumer.accept(Command.builder()
.aliases("heapsummary")
.argumentUsage("save-to-file", null)
.executor(HeapAnalysisModule::heapSummary)
.tabCompleter((platform, sender, arguments) -> TabCompleter.completeForOpts(arguments, "--save-to-file", "--run-gc-before"))
.build()
);
consumer.accept(Command.builder()
.aliases("heapdump")
.argumentUsage("compress", "type")
.executor(HeapAnalysisModule::heapDump)
.tabCompleter((platform, sender, arguments) -> TabCompleter.completeForOpts(arguments, "--compress", "--run-gc-before", "--include-non-live"))
.build()
);
}
private static void heapSummary(SparkPlatform platform, CommandSender sender, CommandResponseHandler resp, Arguments arguments) {
if (arguments.boolFlag("run-gc-before")) {
resp.broadcastPrefixed(text("Running garbage collector..."));
System.gc();
}
resp.broadcastPrefixed(text("Creating a new heap dump summary, please wait..."));
HeapDumpSummary heapDump;
try {
heapDump = HeapDumpSummary.createNew();
} catch (Exception e) {
resp.broadcastPrefixed(text("An error occurred whilst inspecting the heap.", RED));
e.printStackTrace();
return;
}
SparkHeapProtos.HeapData output = heapDump.toProto(platform, sender);
boolean saveToFile = false;
if (arguments.boolFlag("save-to-file")) {
saveToFile = true;
} else {
try {
String key = platform.getBytebinClient().postContent(output, MediaTypes.SPARK_HEAP_MEDIA_TYPE).key();
String url = platform.getViewerUrl() + key;
resp.broadcastPrefixed(text("Heap dump summmary output:", GOLD));
resp.broadcast(text()
.content(url)
.color(GRAY)
.clickEvent(ClickEvent.openUrl(url))
.build()
);
platform.getActivityLog().addToLog(Activity.urlActivity(sender, System.currentTimeMillis(), "Heap dump summary", url));
} catch (Exception e) {
resp.broadcastPrefixed(text("An error occurred whilst uploading the data. Attempting to save to disk instead.", RED));
e.printStackTrace();
saveToFile = true;
}
}
if (saveToFile) {
Path file = platform.resolveSaveFile("heapsummary", "sparkheap");
try {
Files.write(file, output.toByteArray());
resp.broadcastPrefixed(text()
.content("Heap dump summary written to: ")
.color(GOLD)
.append(text(file.toString(), GRAY))
.build()
);
resp.broadcastPrefixed(text("You can read the heap dump summary file using the viewer web-app - " + platform.getViewerUrl(), GRAY));
platform.getActivityLog().addToLog(Activity.fileActivity(sender, System.currentTimeMillis(), "Heap dump summary", file.toString()));
} catch (IOException e) {
resp.broadcastPrefixed(text("An error occurred whilst saving the data.", RED));
e.printStackTrace();
}
}
}
private static void heapDump(SparkPlatform platform, CommandSender sender, CommandResponseHandler resp, Arguments arguments) {
Path file = platform.resolveSaveFile("heap", HeapDump.isOpenJ9() ? "phd" : "hprof");
boolean liveOnly = !arguments.boolFlag("include-non-live");
if (arguments.boolFlag("run-gc-before")) {
resp.broadcastPrefixed(text("Running garbage collector..."));
System.gc();
}
resp.broadcastPrefixed(text("Creating a new heap dump, please wait..."));
try {
HeapDump.dumpHeap(file, liveOnly);
} catch (Exception e) {
resp.broadcastPrefixed(text("An error occurred whilst creating a heap dump.", RED));
e.printStackTrace();
return;
}
resp.broadcastPrefixed(text()
.content("Heap dump written to: ")
.color(GOLD)
.append(text(file.toString(), GRAY))
.build()
);
platform.getActivityLog().addToLog(Activity.fileActivity(sender, System.currentTimeMillis(), "Heap dump", file.toString()));
Compression compressionMethod = null;
Iterator<String> compressArgs = arguments.stringFlag("compress").iterator();
if (compressArgs.hasNext()) {
try {
compressionMethod = Compression.valueOf(compressArgs.next().toUpperCase());
} catch (IllegalArgumentException e) {
// ignore
}
}
if (compressionMethod != null) {
try {
heapDumpCompress(platform, resp, file, compressionMethod);
} catch (IOException e) {
e.printStackTrace();
}
}
}
private static void heapDumpCompress(SparkPlatform platform, CommandResponseHandler resp, Path file, Compression method) throws IOException {
resp.broadcastPrefixed(text("Compressing heap dump, please wait..."));
long size = Files.size(file);
AtomicLong lastReport = new AtomicLong(System.currentTimeMillis());
LongConsumer progressHandler = progress -> {
long timeSinceLastReport = System.currentTimeMillis() - lastReport.get();
if (timeSinceLastReport > TimeUnit.SECONDS.toMillis(5)) {
lastReport.set(System.currentTimeMillis());
platform.getPlugin().executeAsync(() -> {
resp.broadcastPrefixed(text()
.color(GRAY)
.append(text("Compressed "))
.append(text(FormatUtil.formatBytes(progress), GOLD))
.append(text(" / "))
.append(text(FormatUtil.formatBytes(size), GOLD))
.append(text(" so far... ("))
.append(text(FormatUtil.percent(progress, size), GREEN))
.append(text(")"))
.build()
);
});
}
};
Path compressedFile = method.compress(file, progressHandler);
long compressedSize = Files.size(compressedFile);
resp.broadcastPrefixed(text()
.color(GRAY)
.append(text("Compression complete: "))
.append(text(FormatUtil.formatBytes(size), GOLD))
.append(text(" --> "))
.append(text(FormatUtil.formatBytes(compressedSize), GOLD))
.append(text(" ("))
.append(text(FormatUtil.percent(compressedSize, size), GREEN))
.append(text(")"))
.build()
);
resp.broadcastPrefixed(text()
.content("Compressed heap dump written to: ")
.color(GOLD)
.append(text(compressedFile.toString(), GRAY))
.build()
);
}
}
|
