org.neo4j.kernel.diagnostics.KernelDiagnosticsOfflineReportProvider Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-kernel Show documentation
Show all versions of neo4j-kernel Show documentation
Neo4j kernel is a lightweight, embedded Java database designed to
store data structured as graphs rather than tables. For more
information, see http://neo4j.org.
/*
* Copyright (c) "Neo4j"
* Neo4j Sweden AB [https://neo4j.com]
*
* This file is part of Neo4j.
*
* Neo4j 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 databaseNames;
private Neo4jLayout neo4jLayout;
public KernelDiagnosticsOfflineReportProvider() {
super("logs", "plugins", "tree", "tx", "version");
}
@Override
public void init(FileSystemAbstraction fs, Config config, Set databaseNames) {
this.fs = fs;
this.config = config;
this.databaseNames = databaseNames;
this.neo4jLayout = Neo4jLayout.of(config);
}
@Override
protected List provideSources(Set classifiers) {
List sources = new ArrayList<>();
if (classifiers.contains("logs")) {
getLogFiles(sources);
}
if (classifiers.contains("plugins")) {
listPlugins(sources);
}
if (classifiers.contains("tree")) {
for (String databaseName : databaseNames) {
listDataDirectory(sources, databaseName);
}
}
if (classifiers.contains("tx")) {
for (String databaseName : databaseNames) {
getTransactionLogFiles(sources, databaseName);
}
}
if (classifiers.contains("version")) {
getVersion(sources);
}
return sources;
}
private static void getVersion(List sources) {
Supplier neo4jVersion = () -> "neo4j " + Version.getNeo4jVersion() + System.lineSeparator();
sources.add(DiagnosticsReportSources.newDiagnosticsString("version.txt", neo4jVersion));
}
/**
* Collect a list of all the files in the plugins directory.
*
* @param sources destination of the sources.
*/
private void listPlugins(List sources) {
Path pluginDirectory = config.get(GraphDatabaseSettings.plugin_dir);
if (fs.fileExists(pluginDirectory)) {
StringBuilder sb = new StringBuilder();
sb.append("List of plugin directory:").append(System.lineSeparator());
try {
listContentOfDirectory(pluginDirectory, " ", sb);
} catch (IOException e) {
sb.append(e.getMessage()).append(System.lineSeparator());
}
sources.add(DiagnosticsReportSources.newDiagnosticsString("plugins.txt", sb::toString));
}
}
private void listContentOfDirectory(Path directory, String prefix, StringBuilder sb) throws IOException {
if (!fs.isDirectory(directory)) {
return;
}
Path[] files = fs.listFiles(directory);
for (Path file : files) {
if (fs.isDirectory(file)) {
listContentOfDirectory(file, prefix + file.getFileSystem().getSeparator() + file.getFileName(), sb);
} else {
sb.append(prefix).append(file.getFileName()).append(System.lineSeparator());
}
}
}
/**
* Print a tree view of all the files in the database directory with files sizes.
*
* @param sources destination of the sources.
*/
private void listDataDirectory(List sources, String databaseName) {
DatabaseLayout databaseLayout = DatabaseLayout.of(neo4jLayout, databaseName);
StorageEngineFactory storageEngineFactory = StorageEngineFactory.selectStorageEngine(fs, databaseLayout, null);
StoreFilesDiagnostics storeFiles =
new StoreFilesDiagnostics(storageEngineFactory, fs, databaseLayout, loadDeviceMapper());
List files = new ArrayList<>();
storeFiles.dump(files::add);
sources.add(DiagnosticsReportSources.newDiagnosticsString(
databaseName + "/tree.txt", () -> String.join(System.lineSeparator(), files)));
}
private static DeviceMapper loadDeviceMapper() {
return DeviceMapperService.getInstance().createDeviceMapper(NullLogProvider.getInstance());
}
/**
* Add {@code debug.log}, {@code neo4j.log} and {@code gc.log}. All with all available rotated files.
*
* @param sources destination of the sources.
*/
private void getLogFiles(List sources) {
// Best effort of collecting log files, we can't know the exact path since that is defined in log4j
// debug.log
Path logDirectory = config.get(GraphDatabaseSettings.logs_directory);
Path debugLogFile = logDirectory.resolve(DEBUG_LOG);
if (fs.fileExists(debugLogFile)) {
sources.addAll(DiagnosticsReportSources.newDiagnosticsRotatingFile("logs/", fs, debugLogFile));
}
// neo4j.log
Path neo4jLog = logDirectory.resolve(USER_LOG);
if (fs.fileExists(neo4jLog)) {
sources.addAll(DiagnosticsReportSources.newDiagnosticsRotatingFile("logs/", fs, neo4jLog));
}
// gc.log
Path gcLog = logDirectory.resolve("gc.log");
if (fs.fileExists(gcLog)) {
sources.addAll(DiagnosticsReportSources.newDiagnosticsRotatingFile("logs/", fs, gcLog));
}
}
/**
* Add all available log files as sources.
*
* @param sources destination of the sources.
*/
private void getTransactionLogFiles(List sources, String databaseName) {
try {
DatabaseLayout databaseLayout = DatabaseLayout.of(neo4jLayout, databaseName);
LogFiles logFiles = LogFilesBuilder.logFilesBasedOnlyBuilder(
databaseLayout.getTransactionLogsDirectory(), fs)
.build();
for (Path file : logFiles.logFiles()) {
sources.add(DiagnosticsReportSources.newDiagnosticsFile(
databaseName + "/tx/" + file.getFileName(), fs, file));
}
} catch (IOException e) {
sources.add(DiagnosticsReportSources.newDiagnosticsString(
databaseName + "/tx.txt", () -> "Error getting tx logs: " + e.getMessage()));
}
}
}