DO NOT REPLY [Bug 21796] New: - SocketAppender doesn't fall back with FallbackErrorHandler

[bu...@apache.org]

DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG 
RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT
<http://nagoya.apache.org/bugzilla/show_bug.cgi?id=21796>.
ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND 
INSERTED IN THE BUG DATABASE.

http://nagoya.apache.org/bugzilla/show_bug.cgi?id=21796

SocketAppender doesn't fall back with FallbackErrorHandler

           Summary: SocketAppender doesn't fall back with
                    FallbackErrorHandler
           Product: Log4j
           Version: 1.2
          Platform: All
        OS/Version: All
            Status: NEW
          Severity: Normal
          Priority: Other
         Component: Appender
        AssignedTo: log4j-dev@jakarta.apache.org
        ReportedBy: miroslaw.rusin@mensa.org.pl


...i was playing with FallbackErrorHandler and came up
against problem with SocketAppender:

i set up logger
 with primary appender (SocketAppender)
  with errorHandler (FallbackErrorHandler)
   with backup appender

SocketAppender has ReconnectionDelay = 0 (no reconnecting)

problem occurs when SocketAppender meets connection-error:

1. when connection establishment fails
2. when connection is interrupted

...and ReconnectionDelay equals 0, SocketAppender is down forever.
in both cases errorHandler's error method invokation is missing
(in SocketAppender.java) when reconnectionDelay is 0.

here's org/apache/log4j/net/SocketAppender.java fix-diff

####### diff #######
56a57
> import org.apache.log4j.spi.ErrorCode;
259a261,264
>       else {
>         msg += " We are not retrying.";
>         errorHandler.error(msg, e, ErrorCode.GENERIC_FAILURE);
>       }
311a317,320
>         else {
>           errorHandler.error("Detected problem with connection, not 
reconnecting.", e,
>           ErrorCode.GENERIC_FAILURE);
>         } 
####### diff #######



test case:

note1: exception is ok, it just says that connection failed, that's
what we want. error handler should fallback and replace primary
appender with backup appender

note2: it's just test for '1. when connection establishment fails' case


####### SocketAppenderTest.java #######

import java.net.*;
import java.io.*;

import junit.framework.*;

import org.apache.log4j.*;
import org.apache.log4j.net.*;
import org.apache.log4j.spi.*;
import org.apache.log4j.xml.*;
import org.apache.log4j.helpers.*;


public class SocketAppenderTest extends TestCase
{
        
        public static void main(String args[])
        {
                junit.textui.TestRunner.run(SocketAppenderTest.class);
        }
        

        /* JUnit's setUp and tearDown */
        
        protected void setUp()
        {
                DOMConfigurator.configure("SocketAppenderTestLog4j.xml");

                logger = Logger.getLogger(SocketAppenderTest.class);
                primary = logger.getAppender("remote");
                secondary = (LastOnlyAppender)Logger.getLogger
("SocketAppenderTestDummy").getAppender("lastOnly");
        }

        protected void tearDown()
        {
                // null-save interrupt
                if (serverThread != null && !serverThread.interrupted())
                        serverThread.interrupt();
        }

        
        /* Tests */
        
        public void testFallbackErrorHandlerWhenStarting()
        {
                String msg = "testFallbackErrorHandlerWhenStarting";
                logger.debug(msg);

                // above debug log will fail and shoul be redirected to 
secondary appender
                assertEquals("SocketAppender with FallbackErrorHandler", msg, 
secondary.getLastMessage());
        }
        
        
        /* Helper methods */
        /* INFO: it's unused
        private void startServerThread()
        {
                // null-save interrupt
                if (serverThread != null && !serverThread.interrupted())
                        serverThread.interrupt();
                
                serverThread = new Thread()
                        {
                                public void run()
                                {
                                        try
                                        {
                                                int port = 
8189; //primary.getPort();
                                                ServerSocket serverSocket = new 
ServerSocket(port);
                                                Socket socket = 
serverSocket.accept();
                                                Hierarchy h = new
Hierarchy(Logger.getLogger("SocketAppenderTestServerThread"));
                                                new SocketNode(socket,h).run();
                                        }
                                        catch (IOException e)
                                        {
                                                System.err.println("server 
thread io exception");
                                        }
                                }
                        };
                serverThread.start();
        }*/
        

        /* Fields */
        
        private static Logger logger;
        private static Appender primary;
        private static LastOnlyAppender secondary;
        private static Thread serverThread;
        /* Inner classes */
        
        /** Inner-class
         *  For debugging purposes only
         *  Saves last LoggerEvent
         */
        static public class LastOnlyAppender extends AppenderSkeleton
        {
                protected void append(LoggingEvent event)
                {
                        this.lastEvent = event;
                }

                public boolean requiresLayout()
                {
                        return false;
                }

                public void close()
                {
                        this.closed = true;
                }
                
                /** @return last appended LoggingEvent's message
                 */
                public String getLastMessage()
                {
                        if (this.lastEvent != null)
                                return this.lastEvent.getMessage().toString();
                        else
                                return "";
                }

                private LoggingEvent lastEvent;
        };
        
}
####### /SocketAppenderTest.java #######


####### SocketAppenderTestLog4j.xml #######
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<log4j:configuration debug="true" 
xmlns:log4j='http://jakarta.apache.org/log4j/'>


        <!-- primary appender -->
        <appender name="remote" class="org.apache.log4j.net.SocketAppender">

                <!-- fallback on error -->
                <errorHandler 
class="org.apache.log4j.varia.FallbackErrorHandler">
                        <logger-ref ref="SocketAppenderTest"/>
                        <appender-ref ref="lastOnly"/>
                </errorHandler>
                
                <param name="RemoteHost" value="localhost"/>
                <param name="Port" value="8189"/>
                <param name="ReconnectionDelay" value="0"/>
        </appender>

        
        <!-- secondary appender -->
        <appender name="lastOnly" 
class="SocketAppenderTest$LastOnlyAppender"></appender>

        
        <!-- logger -->
        <logger name="SocketAppenderTest">
                <appender-ref ref="remote"/>
        </logger>

        
        <!-- logger
             dummy, so i can have early access to lastOnly appender instance
        -->
        <logger name="SocketAppenderTestDummy">
                <appender-ref ref="lastOnly"/>
        </logger>

        
</log4j:configuration>

####### /SocketAppenderTestLog4j.xml #######

---------------------------------------------------------------------
To unsubscribe, e-mail: log4j-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: log4j-dev-help@jakarta.apache.org