230 lines
7.4 KiB
C++
230 lines
7.4 KiB
C++
/*
|
|
* Copyright 2003,2004 The Apache Software Foundation.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#ifndef _LOG4CXX_NET_SOCKET_HUB_APPENDER_H
|
|
#define _LOG4CXX_NET_SOCKET_HUB_APPENDER_H
|
|
|
|
#include <log4cxx/appenderskeleton.h>
|
|
#include <log4cxx/helpers/socket.h>
|
|
#include <log4cxx/helpers/thread.h>
|
|
#include <vector>
|
|
#include <log4cxx/helpers/socket.h>
|
|
|
|
namespace log4cxx
|
|
{
|
|
namespace helpers
|
|
{
|
|
class SocketOutputStream;
|
|
typedef helpers::ObjectPtrT<SocketOutputStream> SocketOutputStreamPtr;
|
|
}
|
|
|
|
namespace net
|
|
{
|
|
/**
|
|
Sends {@link spi::LoggingEvent LoggingEvent} objects to a set of remote log
|
|
servers, usually a SocketNode.
|
|
|
|
<p>Acts just like SocketAppender except that instead of
|
|
connecting to a given remote log server,
|
|
<code>SocketHubAppender</code> accepts connections from the remote
|
|
log servers as clients. It can accept more than one connection.
|
|
When a log event is received, the event is sent to the set of
|
|
currently connected remote log servers. Implemented this way it does
|
|
not require any update to the configuration file to send data to
|
|
another remote log server. The remote log server simply connects to
|
|
the host and port the <code>SocketHubAppender</code> is running on.
|
|
|
|
<p>The <code>SocketHubAppender</code> does not store events such
|
|
that the remote side will events that arrived after the
|
|
establishment of its connection. Once connected, events arrive in
|
|
order as guaranteed by the TCP protocol.
|
|
|
|
<p>This implementation borrows heavily from the SocketAppender.
|
|
|
|
<p>The SocketHubAppender has the following characteristics:
|
|
|
|
- If sent to a SocketNode, logging is non-intrusive as
|
|
far as the log event is concerned. In other words, the event will be
|
|
logged with the same time stamp, NDC,
|
|
location info as if it were logged locally.
|
|
|
|
- <code>SocketHubAppender</code> does not use a layout. It
|
|
ships a serialized spi::LoggingEvent object to the remote side.
|
|
|
|
- <code>SocketHubAppender</code> relies on the TCP
|
|
protocol. Consequently, if the remote side is reachable, then log
|
|
events will eventually arrive at remote client.
|
|
|
|
- If no remote clients are attached, the logging requests are
|
|
simply dropped.
|
|
|
|
- Logging events are automatically <em>buffered</em> by the
|
|
native TCP implementation. This means that if the link to remote
|
|
client is slow but still faster than the rate of (log) event
|
|
production, the application will not be affected by the slow network
|
|
connection. However, if the network connection is slower then the
|
|
rate of event production, then the local application can only
|
|
progress at the network rate. In particular, if the network link to
|
|
the the remote client is down, the application will be blocked.
|
|
@n @n On the other hand, if the network link is up, but the remote
|
|
client is down, the client will not be blocked when making log
|
|
requests but the log events will be lost due to client
|
|
unavailability.
|
|
@n @n The single remote client case extends to multiple clients
|
|
connections. The rate of logging will be determined by the slowest
|
|
link.
|
|
|
|
- If the application hosting the <code>SocketHubAppender</code>
|
|
exits before the <code>SocketHubAppender</code> is closed either
|
|
explicitly or subsequent to garbage collection, then there might
|
|
be untransmitted data in the pipe which might be lost. This is a
|
|
common problem on Windows based systems.
|
|
@n @n To avoid lost data, it is usually sufficient to #close
|
|
the <code>SocketHubAppender</code> either explicitly or by calling
|
|
the LogManager#shutdown method before
|
|
exiting the application.
|
|
*/
|
|
|
|
class LOG4CXX_EXPORT SocketHubAppender : public AppenderSkeleton
|
|
{
|
|
private:
|
|
/**
|
|
The default port number of the ServerSocket will be created on.
|
|
*/
|
|
static int DEFAULT_PORT;
|
|
|
|
int port;
|
|
std::vector<helpers::SocketOutputStreamPtr> oosList;
|
|
bool locationInfo;
|
|
|
|
public:
|
|
DECLARE_LOG4CXX_OBJECT(SocketHubAppender)
|
|
BEGIN_LOG4CXX_CAST_MAP()
|
|
LOG4CXX_CAST_ENTRY(SocketHubAppender)
|
|
LOG4CXX_CAST_ENTRY_CHAIN(AppenderSkeleton)
|
|
END_LOG4CXX_CAST_MAP()
|
|
|
|
SocketHubAppender();
|
|
~SocketHubAppender();
|
|
|
|
/**
|
|
Connects to remote server at <code>address</code> and <code>port</code>.
|
|
*/
|
|
SocketHubAppender(int port) ;
|
|
|
|
/**
|
|
Set up the socket server on the specified port.
|
|
*/
|
|
virtual void activateOptions();
|
|
|
|
/**
|
|
Set options
|
|
*/
|
|
virtual void setOption(const String& option, const String& value);
|
|
|
|
/**
|
|
Close this appender.
|
|
<p>This will mark the appender as closed and
|
|
call then #cleanUp method.
|
|
*/
|
|
virtual void close();
|
|
|
|
/**
|
|
Release the underlying ServerMonitor thread, and drop the connections
|
|
to all connected remote servers. */
|
|
void cleanUp();
|
|
|
|
/**
|
|
Append an event to all of current connections. */
|
|
virtual void append(const spi::LoggingEventPtr& event);
|
|
|
|
/**
|
|
The SocketHubAppender does not use a layout. Hence, this method returns
|
|
<code>false</code>. */
|
|
virtual bool requiresLayout() const
|
|
{ return false; }
|
|
|
|
/**
|
|
The <b>Port</b> option takes a positive integer representing
|
|
the port where the server is waiting for connections. */
|
|
inline void setPort(int port)
|
|
{ this->port = port; }
|
|
|
|
/**
|
|
Returns value of the <b>Port</b> option. */
|
|
inline int getPort() const
|
|
{ return port; }
|
|
|
|
/**
|
|
The <b>LocationInfo</b> option takes a boolean value. If true,
|
|
the information sent to the remote host will include location
|
|
information. By default no location information is sent to the server. */
|
|
inline void setLocationInfo(bool locationInfo)
|
|
{ this->locationInfo = locationInfo; }
|
|
|
|
/**
|
|
Returns value of the <b>LocationInfo</b> option. */
|
|
inline bool getLocationInfo() const
|
|
{ return locationInfo; }
|
|
|
|
/**
|
|
Start the ServerMonitor thread. */
|
|
private:
|
|
void startServer();
|
|
|
|
/**
|
|
This class is used internally to monitor a ServerSocket
|
|
and register new connections in a vector passed in the
|
|
constructor. */
|
|
class LOG4CXX_EXPORT ServerMonitor :
|
|
public helpers::Runnable,
|
|
public helpers::ObjectImpl
|
|
{
|
|
private:
|
|
int port;
|
|
std::vector<helpers::SocketOutputStreamPtr> oosList;
|
|
bool keepRunning;
|
|
helpers::Thread * monitorThread;
|
|
|
|
public:
|
|
BEGIN_LOG4CXX_CAST_MAP()
|
|
LOG4CXX_CAST_ENTRY(ServerMonitor)
|
|
END_LOG4CXX_CAST_MAP()
|
|
|
|
/**
|
|
Create a thread and start the monitor. */
|
|
ServerMonitor(int port,
|
|
const std::vector<helpers::SocketOutputStreamPtr>& oosList);
|
|
|
|
/**
|
|
Stops the monitor. This method will not return until
|
|
the thread has finished executing. */
|
|
void stopMonitor();
|
|
|
|
/**
|
|
Method that runs, monitoring the ServerSocket and adding connections as
|
|
they connect to the socket. */
|
|
void run();
|
|
}; // class ServerMonitor
|
|
|
|
typedef helpers::ObjectPtrT<ServerMonitor> ServerMonitorPtr;
|
|
ServerMonitorPtr serverMonitor;
|
|
}; // class SocketHubAppender
|
|
} // namespace net
|
|
}; // namespace log4cxx
|
|
|
|
#endif // _LOG4CXX_NET_SOCKET_HUB_APPENDER_H
|