org.neo4j.commandline.dbms.DiagnosticsReportCommandProvider Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of neo4j-dbms Show documentation

This component provides management functionality and product surface for Neo4j instances.

There is a newer version: 5.23.0

/*
 * Copyright (c) 2002-2020 "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.commandline.dbms;

import java.nio.file.Path;
import javax.annotation.Nonnull;

import org.neo4j.commandline.admin.AdminCommand;
import org.neo4j.commandline.admin.AdminCommandSection;
import org.neo4j.commandline.admin.OutsideWorld;
import org.neo4j.commandline.arguments.Arguments;

import static org.neo4j.commandline.dbms.DiagnosticsReportCommand.DEFAULT_CLASSIFIERS;

public class DiagnosticsReportCommandProvider extends AdminCommand.Provider
{
    public DiagnosticsReportCommandProvider()
    {
        super( "report" );
    }

    @Nonnull
    @Override
    public Arguments allArguments()
    {
        return DiagnosticsReportCommand.allArguments();
    }

    @Nonnull
    @Override
    public String summary()
    {
        return "Produces a zip/tar of the most common information needed for remote assessments.";
    }

    @Nonnull
    @Override
    public AdminCommandSection commandSection()
    {
        return AdminCommandSection.general();
    }

    @Nonnull
    @Override
    public String description()
    {
        return "Will collect information about the system and package everything in an archive. If you specify 'all', " +
                "everything will be included. You can also fine tune the selection by passing classifiers to the tool, " +
                "e.g 'logs tx threads'. For a complete list of all available classifiers call the tool with " +
                "the '--list' flag. If no classifiers are passed, the default list of `" +
                String.join( " ", DEFAULT_CLASSIFIERS ) + "` will be used." ;
    }

    @Nonnull
    @Override
    public AdminCommand create( Path homeDir, Path configDir, OutsideWorld outsideWorld )
    {
        return new DiagnosticsReportCommand( homeDir, configDir, outsideWorld );
    }
}