org.neo4j.bolt.logging.BoltMessageLoggerImpl Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of neo4j-bolt Show documentation
The core of Neo4j Bolt Protocol, this contains the state machine for Bolt sessions.
There is a newer version: 5.23.0
/*
 * Copyright (c) 2002-2018 "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.bolt.logging;

import io.netty.channel.Channel;
import io.netty.util.AttributeKey;
import org.codehaus.jackson.map.ObjectMapper;

import java.io.IOException;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.net.SocketAddress;
import java.util.UUID;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Supplier;

import org.neo4j.kernel.api.exceptions.Status;
import org.neo4j.values.AnyValue;
import org.neo4j.values.utils.PrettyPrinter;
import org.neo4j.values.virtual.MapValue;

import static java.lang.String.format;

/**
 * Logs Bolt messages for a client-server pair.
 */
class BoltMessageLoggerImpl implements BoltMessageLogger
{
    private static final ObjectMapper jsonObjectMapper = new ObjectMapper();
    private static final Supplier PLACEHOLDER_DETAIL_SUPPLIER = () -> "-";
    private final BoltMessageLog messageLog;

    private final String remoteAddress;
    private Channel channel;

    private static final String BOLT_X_CORRELATION_ID_HEADER = "BoltCorrelationId";
    public static final AttributeKey CORRELATION_ATTRIBUTE_KEY = AttributeKey.valueOf(
            BOLT_X_CORRELATION_ID_HEADER );

    BoltMessageLoggerImpl( BoltMessageLog messageLog, Channel channel )
    {
        this.messageLog = messageLog;
        this.channel = channel;
        this.remoteAddress = remoteAddress( channel );
    }

    @Override
    public void clientEvent( String eventName )
    {
        clientEvent( eventName, PLACEHOLDER_DETAIL_SUPPLIER );
    }

    @Override
    public void clientEvent( String eventName, Supplier detailsSupplier )
    {
        infoLogger().accept( format( "C %s", eventName ), detailsSupplier.get() );
    }

    @Override
    public void clientError( String eventName, String errorMessage, Supplier detailsSupplier )
    {
        errorLoggerWithArgs( errorMessage ).accept( format( "C %s", eventName ), detailsSupplier.get() );
    }

    @Override
    public void serverEvent( String eventName )
    {
        serverEvent( eventName, PLACEHOLDER_DETAIL_SUPPLIER );
    }

    @Override
    public void serverEvent( String eventName, Supplier detailsSupplier )
    {
        infoLogger().accept( format( "S %s", eventName ), detailsSupplier.get() );
    }

    @Override
    public void serverError( String eventName, String errorMessage )
    {
        errorLogger( errorMessage ).accept( format( "S %s", eventName ) );
    }

    @Override
    public void serverError( String eventName, Status status )
    {
        serverError( eventName, status.code().serialize() );
    }

    @Override
    public void logInit( String userAgent )
    {
        clientEvent( "INIT", () -> userAgent);
    }

    @Override
    public void logRun()
    {
        clientEvent( "RUN", PLACEHOLDER_DETAIL_SUPPLIER );
    }

    @Override
    public void logPullAll()
    {
        clientEvent( "PULL_ALL", PLACEHOLDER_DETAIL_SUPPLIER );
    }

    @Override
    public void logDiscardAll()
    {
        clientEvent( "DISCARD_ALL", PLACEHOLDER_DETAIL_SUPPLIER );
    }

    @Override
    public void logAckFailure()
    {
        clientEvent( "ACK_FAILURE", PLACEHOLDER_DETAIL_SUPPLIER );
    }

    @Override
    public void logReset()
    {
        clientEvent( "RESET", PLACEHOLDER_DETAIL_SUPPLIER );
    }

    @Override
    public void logSuccess( Supplier metadataSupplier )
    {
        serverEvent( "SUCCESS", () -> formatAnyValue( metadataSupplier.get() ) );
    }

    @Override
    public void logFailure( Status status )
    {
        serverEvent( "FAILURE", () -> status.code().serialize() );
    }

    @Override
    public void logIgnored()
    {
        serverEvent( "IGNORED", PLACEHOLDER_DETAIL_SUPPLIER );
    }

    private Consumer errorLogger( String errorMessage )
    {
        return formatMessageWithEventName ->
                messageLog.error( remoteAddress, getCorrelationId(), formatMessageWithEventName, errorMessage );
    }

    private String randomCorrelationIdGenerator()
    {
        return UUID.randomUUID().toString();
    }

    private BiConsumer infoLogger()
    {
        return ( formatMessageWithEventName, details ) ->
                messageLog.info( remoteAddress,
                        getCorrelationId(),
                        format( "%s %s", formatMessageWithEventName, details ) );
    }

    private String getCorrelationId()
    {
        if ( !channel.hasAttr( CORRELATION_ATTRIBUTE_KEY ) )
        {
            channel.attr( CORRELATION_ATTRIBUTE_KEY ).set( randomCorrelationIdGenerator() );
        }

        return channel.attr( CORRELATION_ATTRIBUTE_KEY ).get();
    }

    private BiConsumer errorLoggerWithArgs( String errorMessage )
    {
        return ( formatMessageWithEventName, details ) ->
                errorLogger( errorMessage ).accept( format( "%s %s", formatMessageWithEventName, details ) );
    }

    private static String remoteAddress( Channel channel )
    {
        try
        {
            InetSocketAddress remoteAddress = (InetSocketAddress) channel.remoteAddress();
            InetAddress address = remoteAddress.getAddress();
            String hostAddress = address.getHostAddress();
            int port = remoteAddress.getPort();
            return format( "%s:%s", hostAddress, port );
        }
        catch ( ClassCastException e )
        {
            SocketAddress remoteAddress = channel.remoteAddress();
            return remoteAddress.toString();
        }
    }

    private static String json( Object arg )
    {
        try
        {
            return jsonObjectMapper.writeValueAsString( arg );
        }
        catch ( IOException e )
        {
            return "?";
        }
    }

    private static String formatAnyValue( AnyValue mapValue )
    {
        PrettyPrinter printer = new PrettyPrinter();
        mapValue.writeTo( printer );
        return printer.value();
    }
}