org.neo4j.kernel.diagnostics.providers.StoreFilesDiagnostics 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
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.
There is a newer version: 5.25.1
Show newest version
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://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 .
 */
package org.neo4j.kernel.diagnostics.providers;

import java.io.IOException;
import java.nio.file.FileStore;
import java.nio.file.Files;
import java.nio.file.Path;
import java.time.ZoneId;
import java.time.ZonedDateTime;
import java.util.Arrays;
import java.util.Comparator;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.function.Predicate;

import org.neo4j.internal.diagnostics.DiagnosticsLogger;
import org.neo4j.internal.diagnostics.NamedDiagnosticsProvider;
import org.neo4j.io.fs.FileSystemAbstraction;
import org.neo4j.io.fs.FileUtils;
import org.neo4j.io.layout.DatabaseLayout;
import org.neo4j.kernel.internal.NativeIndexFileFilter;
import org.neo4j.storageengine.api.StorageEngineFactory;

import static java.time.format.DateTimeFormatter.ISO_OFFSET_DATE_TIME;
import static org.neo4j.io.ByteUnit.bytesToString;
import static org.neo4j.io.fs.FileUtils.getFileStoreType;

public class StoreFilesDiagnostics extends NamedDiagnosticsProvider
{
    private final StorageEngineFactory storageEngineFactory;
    private final FileSystemAbstraction fs;
    private final DatabaseLayout databaseLayout;

    public StoreFilesDiagnostics( StorageEngineFactory storageEngineFactory, FileSystemAbstraction fs, DatabaseLayout databaseLayout )
    {
        super( "Store files" );
        this.storageEngineFactory = storageEngineFactory;
        this.fs = fs;
        this.databaseLayout = databaseLayout;
    }

    @Override
    public void dump( DiagnosticsLogger logger )
    {
        logger.log( getDiskSpace( databaseLayout ) );
        logger.log( "Storage files stored on file store: " + getFileStoreType( databaseLayout.databaseDirectory() ) );
        logger.log( "Storage files: (filename : modification date - size)" );
        MappedFileCounter mappedCounter = new MappedFileCounter();
        long totalSize = logStoreFiles( logger, "  ", databaseLayout.databaseDirectory(), mappedCounter );
        logger.log( "Storage summary: " );
        logger.log( "  Total size of store: " + bytesToString( totalSize ) );
        logger.log( "  Total size of mapped files: " + bytesToString( mappedCounter.getSize() ) );
    }

    private long logStoreFiles( DiagnosticsLogger logger, String prefix, Path dir, MappedFileCounter mappedCounter )
    {
        if ( !Files.isDirectory( dir ) )
        {
            return 0;
        }
        Path[] files = FileUtils.listPaths( dir );
        if ( files == null )
        {
            logger.log( prefix + "" );
            return 0;
        }
        long total = 0;

        // Sort by name
        List fileList = Arrays.asList( files );
        fileList.sort( Comparator.comparing( Path::getFileName ) );

        for ( Path file : fileList )
        {
            long size = 0;
            String filename = file.getFileName().toString();
            if ( Files.isDirectory( file ) )
            {
                logger.log( prefix + filename + ":" );
                size = logStoreFiles( logger, prefix + "  ", file, mappedCounter );
                filename = "- Total";
            }
            else
            {
                try
                {
                    size = Files.size( file );
                }
                catch ( IOException ignored )
                {
                    // Preserve behaviour of File.length()
                }
                mappedCounter.addFile( file );
            }

            String fileModificationDate = getFileModificationDate( file );
            String bytes = bytesToString( size );
            String fileInformation = String.format( "%s%s: %s - %s", prefix, filename, fileModificationDate, bytes );
            logger.log( fileInformation );

            total += size;
        }
        return total;
    }

    private static String getFileModificationDate( Path file )
    {
        try
        {
            ZonedDateTime modifiedDate = Files.getLastModifiedTime( file ).toInstant()
                    .atZone( ZoneId.systemDefault() )
                    .withNano( 0 ); // truncate milliseconds
            return ISO_OFFSET_DATE_TIME.format( modifiedDate );
        }
        catch ( IOException e )
        {
            return "";
        }
    }

    private static String getDiskSpace( DatabaseLayout databaseLayout )
    {
        String header = "Disk space on partition (Total / Free / Free %%):";
        try
        {
            Path directory = databaseLayout.databaseDirectory();
            FileStore fileStore = Files.getFileStore( directory );
            long free = fileStore.getUnallocatedSpace();
            long total = fileStore.getTotalSpace();
            long percentage = total != 0 ? (free * 100 / total) : 0;
            return String.format( header + " %s / %s / %s", total, free, percentage );
        }
        catch ( IOException e )
        {
            return header + " Unable to determine disk space on the partition";
        }
    }

    private class MappedFileCounter
    {
        private final Set mappedCandidates = new HashSet<>();
        private long size;
        private final Predicate mappedIndexFilter;

        MappedFileCounter()
        {
            try
            {
                mappedCandidates.addAll( storageEngineFactory.listStorageFiles( fs, databaseLayout ) );
            }
            catch ( IOException e )
            {
                // Hmm, there was no storage here
            }
            mappedIndexFilter = new NativeIndexFileFilter( databaseLayout.databaseDirectory() );
        }

        void addFile( Path file )
        {
            if ( canBeManagedByPageCache( file ) || mappedIndexFilter.test( file ) )
            {
                try
                {
                    size += Files.size( file );
                }
                catch ( IOException ignored )
                {
                    // Preserve behaviour of File.length()
                }
            }
        }

        public long getSize()
        {
            return size;
        }

        /**
         * Returns whether or not store file by given file name should be managed by the page cache.
         *
         * @param storeFile file of the store file to check.
         * @return Returns whether or not store file by given file name should be managed by the page cache.
         */
        boolean canBeManagedByPageCache( Path storeFile )
        {
            boolean isScanStore = databaseLayout.labelScanStore().equals( storeFile ) || databaseLayout.relationshipTypeScanStore().equals( storeFile );
            return isScanStore || mappedCandidates.contains( storeFile );
        }
    }
}