#include <TcpLogger.h>

Inheritance diagram for Log::TcpLogger:

Collaboration diagram for Log::TcpLogger:

Public Types
typedef CbcPointer< TcpLogger >	Pointer

Public Member Functions
bool	canBeCalled (AsyncCall &call) const
	whether we can be called

void	callStart (AsyncCall &call)

virtual void	callEnd ()
	called right after the called job method

virtual void	callException (const std::exception &e)
	called when the job throws during an async call

void	handleStopRequest ()
	process external request to terminate now (i.e. during this async call)

virtual void *	toCbdata ()=0

Static Public Member Functions
static int	Open (Logfile lf, const char path, size_t bufSz, int fatalFlag)

static void	Start (const Pointer &job)

static void	RegisterWithCacheManager ()

Public Attributes
const InstanceId< AsyncJob >	id
	job identifier

Protected Member Functions
	TcpLogger (size_t, bool, Ip::Address)

	~TcpLogger () override

void	endGracefully ()

void	logRecord (const char *buf, size_t len)
	buffers record and possibly writes it to the remote logger

void	flush ()
	write all currently buffered records ASAP

void	start () override
	called by AsyncStart; do not call directly

bool	doneAll () const override
	whether positive goal has been reached

void	swanSong () override

void	deleteThis (const char *aReason)

void	mustStop (const char *aReason)

bool	done () const
	the job is destroyed in callEnd() when done()

virtual const char *	status () const
	internal cleanup; do not call directly

Static Protected Member Functions
static void	ReportAllJobs (StoreEntry *)
	writes a cache manager report about all jobs existing in this worker

Protected Attributes
const char *	stopReason
	reason for forcing done() to be true

const char *	typeName
	kid (leaf) class name, for debugging

AsyncCall::Pointer	inCall
	the asynchronous call being handled, if any

bool	started_ = false
	Start() has finished successfully.

bool	swanSang_ = false
	swanSong() was called

Private Member Functions
	CBDATA_CHILD (TcpLogger)

void	delayedReconnect ()
	"sleep a little before trying to connect again" event callback

bool	canFit (const size_t len) const
	whether len more bytes can be buffered

void	appendRecord (const char *buf, size_t len)
	buffer a record that might exceed IoBufSize

void	appendChunk (const char *chunk, const size_t len)
	buffer a record chunk without splitting it across buffers

void	writeIfNeeded ()
	starts writing if and only if it is time to write accumulated records

void	writeIfPossible ()
	starts writing if possible

void	doConnect ()
	starts [re]connecting to the remote logger

void	disconnect ()
	close our connection now, without flushing

void	connectDone (const CommConnectCbParams &conn)
	Comm::ConnOpener callback.

void	writeDone (const CommIoCbParams &io)
	Comm::Write callback.

void	handleClosure (const CommCloseCbParams &io)

virtual void	finalizedInCbdataChild ()=0
	hack: ensure CBDATA_CHILD() after a toCbdata()-defining CBDATA_INTERMEDIATE()

Static Private Member Functions
static void	Flush (Logfile *lf)

static void	WriteLine (Logfile lf, const char buf, size_t len)

static void	StartLine (Logfile *lf)

static void	EndLine (Logfile *lf)

static void	Rotate (Logfile *lf, const int16_t)

static void	Close (Logfile *lf)

static TcpLogger *	StillLogging (Logfile *lf)

static void	DelayedReconnect (void *data)
	Log::TcpLogger::delayedReconnect() wrapper.

Private Attributes
bool	dieOnError

std::list< MemBlobPointer >	buffers
	I/O buffers.

size_t	bufferCapacity
	bufferedSize limit

size_t	bufferedSize
	number of log record bytes stored in RAM now

size_t	flushDebt
	how many record bytes we still need to write ASAP

bool	quitOnEmpty
	whether this job should quit when buffers are empty

bool	reconnectScheduled
	we are sleeping before the next connection attempt

bool	writeScheduled
	we are waiting for the latest write() results

Comm::ConnectionPointer	conn
	opened connection to the remote logger

Ip::Address	remote
	where the remote logger expects our records

AsyncCall::Pointer	closer
	handles unexpected/external conn closures

JobWait< Comm::ConnOpener >	connWait
	waits for a connection to the remote logger to be established/opened

uint64_t	connectFailures
	number of sequential connection failures

uint64_t	drops
	number of records dropped during the current outage

Static Private Attributes
static const size_t	IoBufSize = 2*MAX_URL
	fixed I/O buffer size

static const size_t	BufferCapacityMin = 2*Log::TcpLogger::IoBufSize
	minimum bufferCapacity value

Detailed Description

Sends log records to a remote TCP logger at the configured IP:port address. Handles loss of connectivity, record buffering, and buffer overflows.

Definition at line 33 of file TcpLogger.h.

Member Typedef Documentation

◆ Pointer

typedef CbcPointer<TcpLogger> Log::TcpLogger::Pointer

Definition at line 38 of file TcpLogger.h.

Constructor & Destructor Documentation

◆ TcpLogger()

Log::TcpLogger::TcpLogger	(	size_t	bufCap,
		bool	dieOnErr,
		Ip::Address	them
	)

protected

Definition at line 36 of file TcpLogger.cc.

References bufferCapacity, BufferCapacityMin, DBG_IMPORTANT, debugs, MY_DEBUG_SECTION, and remote.

◆ ~TcpLogger()

Log::TcpLogger::~TcpLogger ( )

overrideprotected

Definition at line 60 of file TcpLogger.cc.

References assert.

Member Function Documentation

◆ appendChunk()

void Log::TcpLogger::appendChunk	(	const char *	chunk,
		const size_t	len
	)

private

Definition at line 220 of file TcpLogger.cc.

References debugs, Must, and MY_DEBUG_SECTION.

◆ appendRecord()

void Log::TcpLogger::appendRecord	(	const char *	buf,
		size_t	len
	)

private

Definition at line 200 of file TcpLogger.cc.

References min(), and off.

◆ callEnd()

void AsyncJob::callEnd ( )

virtualinherited

called right after the called job method

Reimplemented in Adaptation::Icap::Xaction.

Definition at line 152 of file AsyncJob.cc.

References assert, AsyncCall::debugLevel, debugs, AsyncCall::debugSection, AsyncJob::done(), AsyncJob::inCall, AsyncJob::started_, AsyncJob::status(), AsyncJob::swanSang_, AsyncJob::swanSong(), and AsyncJob::typeName.

Referenced by Adaptation::Icap::Xaction::callEnd(), and AsyncJob::deleteThis().

◆ callException()

void AsyncJob::callException ( const std::exception & e )

virtualinherited

Reimplemented in ConnStateData, ClientHttpRequest, Rock::Rebuild, Adaptation::Icap::ModXact, Adaptation::Icap::ServiceRep, Adaptation::Icap::Xaction, Ipc::Forwarder, Ipc::Inquirer, and Ftp::Server.

Definition at line 143 of file AsyncJob.cc.

References cbdataReferenceValid(), debugs, Must, AsyncJob::mustStop(), and CbdataParent::toCbdata().

Referenced by ConnStateData::callException(), Adaptation::Icap::Xaction::callException(), Ipc::Forwarder::callException(), Ipc::Inquirer::callException(), and Ftp::Server::callException().

◆ callStart()

void AsyncJob::callStart ( AsyncCall & call )

inherited

called just before the called method

Definition at line 130 of file AsyncJob.cc.

References cbdataReferenceValid(), AsyncCall::debugLevel, debugs, AsyncCall::debugSection, AsyncJob::inCall, Must, AsyncJob::status(), CbdataParent::toCbdata(), and AsyncJob::typeName.

◆ canBeCalled()

bool AsyncJob::canBeCalled ( AsyncCall & call ) const

inherited

Definition at line 117 of file AsyncJob.cc.

References AsyncCall::cancel(), debugs, and AsyncJob::inCall.

◆ canFit()

bool Log::TcpLogger::canFit ( const size_t len ) const

private

Definition at line 158 of file TcpLogger.cc.

References DBG_CRITICAL, DBG_IMPORTANT, debugs, fatal(), and MY_DEBUG_SECTION.

◆ CBDATA_CHILD()

Log::TcpLogger::CBDATA_CHILD ( TcpLogger )

private

◆ Close()

void Log::TcpLogger::Close ( Logfile * lf )

staticprivate

Definition at line 435 of file TcpLogger.cc.

References asyncCall(), Logfile::data, debugs, endGracefully(), and ScheduleCallHere.

◆ connectDone()

void Log::TcpLogger::connectDone ( const CommConnectCbParams & conn )

private

Definition at line 263 of file TcpLogger.cc.

References comm_add_close_handler(), CommCommonCbParams::conn, DBG_IMPORTANT, debugs, DelayedReconnect(), eventAdd(), CommCommonCbParams::flag, handleClosure(), JobCallback, Must, MY_DEBUG_SECTION, and Comm::OK.

Referenced by doConnect().

◆ delayedReconnect()

void Log::TcpLogger::delayedReconnect ( )

private

Definition at line 321 of file TcpLogger.cc.

References Must.

Referenced by DelayedReconnect().

◆ DelayedReconnect()

void Log::TcpLogger::DelayedReconnect ( void * data )

staticprivate

Definition at line 304 of file TcpLogger.cc.

References assert, delayedReconnect(), JobCallback, MY_DEBUG_SECTION, ScheduleCallHere, and CbcPointer< Cbc >::valid().

Referenced by connectDone().

◆ deleteThis()

void AsyncJob::deleteThis ( const char * aReason )

protectedinherited

Definition at line 65 of file AsyncJob.cc.

References asyncCall(), AsyncJob::callEnd(), debugs, AsyncJob::deleteThis(), AsyncJob::inCall, JobMemFun(), Must, AsyncJob::stopReason, and AsyncJob::typeName.

Referenced by ConnStateData::connStateClosed(), and AsyncJob::deleteThis().

◆ disconnect()

void Log::TcpLogger::disconnect ( )

private

Definition at line 381 of file TcpLogger.cc.

References comm_remove_close_handler().

◆ doConnect()

void Log::TcpLogger::doConnect ( )

private

Definition at line 241 of file TcpLogger.cc.

References connectDone(), debugs, Ip::Address::isIPv4(), JobCallback, Comm::Connection::local, Must, MY_DEBUG_SECTION, Comm::Connection::remote, Ip::Address::setAnyAddr(), Ip::Address::setIPv4(), and shutting_down.

◆ done()

bool AsyncJob::done ( ) const

protectedinherited

Definition at line 106 of file AsyncJob.cc.

References AsyncJob::doneAll(), and AsyncJob::stopReason.

Referenced by AsyncJob::callEnd(), HappyConnOpener::checkForNewConnection(), Downloader::downloadFinished(), and HappyConnOpener::maybeOpenPrimeConnection().

◆ doneAll()

bool Log::TcpLogger::doneAll ( ) const

overrideprotectedvirtual

Reimplemented from AsyncJob.

Definition at line 73 of file TcpLogger.cc.

References debugs, AsyncJob::doneAll(), and MY_DEBUG_SECTION.

◆ endGracefully()

void Log::TcpLogger::endGracefully ( )

protected

Called when Squid is reconfiguring (or exiting) to give us a chance to flush remaining buffers and end this job w/o loss of data. No new log records are expected. Must be used as (or inside) an async job call and will result in [eventual] job termination.

Definition at line 102 of file TcpLogger.cc.

References assert.

Referenced by Close().

◆ EndLine()

void Log::TcpLogger::EndLine ( Logfile * lf )

staticprivate

Definition at line 423 of file TcpLogger.cc.

References SquidConfig::buffered_logs, Config, and SquidConfig::onoff.

◆ finalizedInCbdataChild()

virtual void CbdataParent::finalizedInCbdataChild ( )

privatepure virtualinherited

◆ flush()

void Log::TcpLogger::flush ( )

protected

Definition at line 111 of file TcpLogger.cc.

Referenced by Flush().

◆ Flush()

void Log::TcpLogger::Flush ( Logfile * lf )

staticprivate

Definition at line 404 of file TcpLogger.cc.

References flush().

◆ handleClosure()

void Log::TcpLogger::handleClosure ( const CommCloseCbParams & io )

private

This is our comm_close_handler. It is called when some external force (e.g., reconfigure or shutdown) is closing the connection (rather than us).

Definition at line 367 of file TcpLogger.cc.

References assert.

Referenced by connectDone().

◆ handleStopRequest()

void AsyncJob::handleStopRequest ( )

inlineinherited

Definition at line 73 of file AsyncJob.h.

References AsyncJob::mustStop().

◆ logRecord()

void Log::TcpLogger::logRecord	(	const char *	buf,
		size_t	len
	)

protected

Definition at line 118 of file TcpLogger.cc.

◆ mustStop()

void AsyncJob::mustStop ( const char * aReason )

protectedinherited

Definition at line 85 of file AsyncJob.cc.

References debugs, AsyncJob::inCall, Must, AsyncJob::stopReason, and AsyncJob::typeName.

Referenced by HttpStateData::abortAll(), AsyncJob::callException(), HttpStateData::continueAfterParsingHeader(), HttpStateData::drop1xx(), AsyncJob::handleStopRequest(), HttpStateData::httpStateConnClosed(), HttpStateData::httpTimeout(), HttpStateData::proceedAfter1xx(), ConnStateData::proxyProtocolError(), HttpStateData::readReply(), HttpStateData::start(), and HttpStateData::wroteLast().

◆ Open()

int Log::TcpLogger::Open	(	Logfile *	lf,
		const char *	path,
		size_t	bufSz,
		int	fatalFlag
	)

static

Definition at line 452 of file TcpLogger.cc.

References assert, Logfile::data, DBG_IMPORTANT, debugs, Logfile::f_close, Logfile::f_flush, Logfile::f_lineend, Logfile::f_linestart, Logfile::f_linewrite, Logfile::f_rotate, FALSE, Logfile::fatal, fatalf(), Logfile::flags, GetHostWithPort(), Logfile::path, safe_free, AsyncJob::Start(), and xstrdup.

Referenced by logfileOpen(), and STUB_RETVAL().

◆ RegisterWithCacheManager()

void AsyncJob::RegisterWithCacheManager ( )

staticinherited

Definition at line 215 of file AsyncJob.cc.

References Mgr::RegisterAction(), and AsyncJob::ReportAllJobs().

Referenced by mainInitialize().

◆ ReportAllJobs()

void AsyncJob::ReportAllJobs ( StoreEntry * e )

staticprotectedinherited

Definition at line 198 of file AsyncJob.cc.

References AllJobs().

Referenced by AsyncJob::RegisterWithCacheManager().

◆ Rotate()

void Log::TcpLogger::Rotate	(	Logfile *	lf,
		const int16_t
	)

staticprivate

Definition at line 430 of file TcpLogger.cc.

◆ start()

void Log::TcpLogger::start ( )

overrideprotectedvirtual

Reimplemented from AsyncJob.

Definition at line 67 of file TcpLogger.cc.

◆ Start()

void AsyncJob::Start ( const Pointer & job )

staticinherited

Promises to start the configured job (eventually). The job is deemed to be running asynchronously beyond this point, so the caller should only access the job object via AsyncCalls rather than directly.

swanSong() is only called for jobs for which this method has returned successfully (i.e. without throwing).

Definition at line 37 of file AsyncJob.cc.

References CallJobHere, AsyncJob::start(), and AsyncJob::started_.

Referenced by Ftp::Server::AcceptCtrlConnection(), clientListenerConnectionOpened(), Ipc::Coordinator::handleCacheMgrRequest(), Ipc::Coordinator::handleSnmpRequest(), httpAccept(), httpsAccept(), httpStart(), idnsInitVC(), Ftp::Gateway::listenForDataChannel(), Ftp::Server::listenForDataConnection(), Open(), peerProbeConnect(), Mgr::FunAction::respond(), Mgr::InfoAction::respond(), Ipc::SendMessage(), Mgr::Inquirer::sendResponse(), snmpConstructReponse(), SquidMain(), CacheManager::start(), Adaptation::AccessCheck::Start(), Rock::Rebuild::Start(), JobWaitBase::start_(), BodyPipe::startAutoConsumptionIfNeeded(), Ftp::StartGateway(), Ftp::StartRelay(), and Rock::SwapDir::updateHeaders().

◆ StartLine()

void Log::TcpLogger::StartLine ( Logfile * lf )

staticprivate

Definition at line 418 of file TcpLogger.cc.

◆ status()

const char * AsyncJob::status ( ) const

protectedvirtualinherited

for debugging, starts with space

Reimplemented in Adaptation::Ecap::XactionRep, Adaptation::Icap::ServiceRep, Adaptation::Icap::Xaction, Adaptation::Initiate, Http::Tunneler, Comm::TcpAcceptor, HappyConnOpener, Ipc::Inquirer, and Security::PeerConnector.

Definition at line 182 of file AsyncJob.cc.

References MemBuf::append(), Packable::appendf(), MemBuf::content(), MemBuf::reset(), AsyncJob::stopReason, and MemBuf::terminate().

Referenced by AsyncJob::callEnd(), AsyncJob::callStart(), Adaptation::Initiate::status(), and Comm::TcpAcceptor::status().

◆ StillLogging()

Log::TcpLogger * Log::TcpLogger::StillLogging ( Logfile * lf )

staticprivate

Converts Logfile into a pointer to a valid TcpLogger job or, if the logger job has quit, into a nill pointer

Definition at line 396 of file TcpLogger.cc.

References Logfile::data.

◆ swanSong()

void Log::TcpLogger::swanSong ( )

overrideprotectedvirtual

Reimplemented from AsyncJob.

Definition at line 95 of file TcpLogger.cc.

References AsyncJob::swanSong().

◆ toCbdata()

virtual void * CbdataParent::toCbdata ( )

pure virtualinherited

Referenced by AsyncJob::callException(), and AsyncJob::callStart().

◆ writeDone()

void Log::TcpLogger::writeDone ( const CommIoCbParams & io )

private

Definition at line 331 of file TcpLogger.cc.

References debugs, Comm::ERR_CLOSING, CommCommonCbParams::flag, Must, MY_DEBUG_SECTION, Comm::OK, CommIoCbParams::size, MemBlob::size, CommCommonCbParams::xerrno, and xstrerr().

Referenced by writeIfPossible().

◆ writeIfNeeded()

void Log::TcpLogger::writeIfNeeded ( )

private

Definition at line 126 of file TcpLogger.cc.

◆ writeIfPossible()

void Log::TcpLogger::writeIfPossible ( )

private

Definition at line 135 of file TcpLogger.cc.

References debugs, fd_table, JobCallback, MemBlob::mem, MY_DEBUG_SECTION, MemBlob::size, Comm::Write(), and writeDone().

◆ WriteLine()

void Log::TcpLogger::WriteLine	(	Logfile *	lf,
		const char *	buf,
		size_t	len
	)

staticprivate

Definition at line 411 of file TcpLogger.cc.

Member Data Documentation

◆ bufferCapacity

size_t Log::TcpLogger::bufferCapacity

private

Definition at line 100 of file TcpLogger.h.

Referenced by TcpLogger().

◆ BufferCapacityMin

const size_t Log::TcpLogger::BufferCapacityMin = 2*Log::TcpLogger::IoBufSize

staticprivate

Definition at line 92 of file TcpLogger.h.

Referenced by TcpLogger().

◆ bufferedSize

size_t Log::TcpLogger::bufferedSize

private

Definition at line 101 of file TcpLogger.h.

◆ buffers

std::list<MemBlobPointer> Log::TcpLogger::buffers

private

Definition at line 99 of file TcpLogger.h.

◆ closer

AsyncCall::Pointer Log::TcpLogger::closer

private

Definition at line 110 of file TcpLogger.h.

◆ conn

Comm::ConnectionPointer Log::TcpLogger::conn

private

Definition at line 108 of file TcpLogger.h.

◆ connectFailures

uint64_t Log::TcpLogger::connectFailures

private

Definition at line 115 of file TcpLogger.h.

◆ connWait

JobWait<Comm::ConnOpener> Log::TcpLogger::connWait

private

Definition at line 113 of file TcpLogger.h.

◆ dieOnError

bool Log::TcpLogger::dieOnError

private

Whether this job must kill Squid on the first unrecoverable error. Note that we may be able to recover from a failure to connect, but we cannot recover from forgetting (dropping) a record while connecting.

Definition at line 97 of file TcpLogger.h.

◆ drops

uint64_t Log::TcpLogger::drops

private

Definition at line 116 of file TcpLogger.h.

◆ flushDebt

size_t Log::TcpLogger::flushDebt

private

Definition at line 102 of file TcpLogger.h.

◆ id

const InstanceId<AsyncJob> AsyncJob::id

inherited

Definition at line 75 of file AsyncJob.h.

◆ inCall

AsyncCall::Pointer AsyncJob::inCall

protectedinherited

Definition at line 86 of file AsyncJob.h.

Referenced by AsyncJob::callEnd(), AsyncJob::callStart(), AsyncJob::canBeCalled(), AsyncJob::deleteThis(), and AsyncJob::mustStop().

◆ IoBufSize

const size_t Log::TcpLogger::IoBufSize = 2*MAX_URL

staticprivate

Definition at line 91 of file TcpLogger.h.

◆ quitOnEmpty

bool Log::TcpLogger::quitOnEmpty

private

Definition at line 104 of file TcpLogger.h.

◆ reconnectScheduled

bool Log::TcpLogger::reconnectScheduled

private

Definition at line 105 of file TcpLogger.h.

◆ remote

Ip::Address Log::TcpLogger::remote

private

Definition at line 109 of file TcpLogger.h.

Referenced by TcpLogger().

◆ started_

bool AsyncJob::started_ = false

protectedinherited

Definition at line 88 of file AsyncJob.h.

Referenced by AsyncJob::~AsyncJob(), AsyncJob::callEnd(), and AsyncJob::Start().

◆ stopReason

const char* AsyncJob::stopReason

protectedinherited

Definition at line 84 of file AsyncJob.h.

Referenced by AsyncJob::deleteThis(), AsyncJob::done(), AsyncJob::mustStop(), AsyncJob::status(), and HappyConnOpener::status().

◆ swanSang_

bool AsyncJob::swanSang_ = false

protectedinherited

Definition at line 89 of file AsyncJob.h.

Referenced by AsyncJob::~AsyncJob(), and AsyncJob::callEnd().

◆ typeName

const char* AsyncJob::typeName

protectedinherited

Definition at line 85 of file AsyncJob.h.

Referenced by AsyncJob::AsyncJob(), Adaptation::Icap::Xaction::Xaction(), AsyncJob::~AsyncJob(), AsyncJob::callEnd(), AsyncJob::callStart(), AsyncJob::deleteThis(), and AsyncJob::mustStop().

◆ writeScheduled

bool Log::TcpLogger::writeScheduled

private

Definition at line 106 of file TcpLogger.h.

The documentation for this class was generated from the following files:

squid/src/log/TcpLogger.h
squid/src/log/TcpLogger.cc

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ Pointer

Constructor & Destructor Documentation

◆ TcpLogger()

◆ ~TcpLogger()

Member Function Documentation

◆ appendChunk()

◆ appendRecord()

◆ callEnd()

◆ callException()

◆ callStart()

◆ canBeCalled()

◆ canFit()

◆ CBDATA_CHILD()

◆ Close()

◆ connectDone()

◆ delayedReconnect()

◆ DelayedReconnect()

◆ deleteThis()

◆ disconnect()

◆ doConnect()

◆ done()

◆ doneAll()

◆ endGracefully()

◆ EndLine()

◆ finalizedInCbdataChild()

◆ flush()

◆ Flush()

◆ handleClosure()

◆ handleStopRequest()

◆ logRecord()

◆ mustStop()

◆ Open()

◆ RegisterWithCacheManager()

◆ ReportAllJobs()

◆ Rotate()

◆ start()

◆ Start()

◆ StartLine()

◆ status()

◆ StillLogging()

◆ swanSong()

◆ toCbdata()

◆ writeDone()

◆ writeIfNeeded()

◆ writeIfPossible()

◆ WriteLine()

Member Data Documentation

◆ bufferCapacity

◆ BufferCapacityMin

◆ bufferedSize

◆ buffers

◆ closer

◆ conn

◆ connectFailures

◆ connWait

◆ dieOnError

◆ drops

◆ flushDebt

◆ id

◆ inCall

◆ IoBufSize

◆ quitOnEmpty

◆ reconnectScheduled

◆ remote

◆ started_

◆ stopReason

◆ swanSang_