| /* |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. See the NOTICE file distributed with |
| * this work for additional information regarding copyright ownership. |
| * The ASF licenses this file to You 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. |
| */ |
| |
| |
| #if !defined(_LOG4CXX_ROLLING_TIME_BASED_ROLLING_POLICY_H) |
| #define _LOG4CXX_ROLLING_TIME_BASED_ROLLING_POLICY_H |
| |
| #include <log4cxx/portability.h> |
| #include <log4cxx/rolling/rollingpolicybase.h> |
| #include <log4cxx/rolling/triggeringpolicy.h> |
| #include <log4cxx/writerappender.h> |
| #include <log4cxx/helpers/outputstream.h> |
| #include <apr_mmap.h> |
| |
| namespace log4cxx { |
| |
| namespace rolling { |
| |
| |
| |
| /** |
| * <code>TimeBasedRollingPolicy</code> is both easy to configure and quite |
| * powerful. |
| * |
| * <p>In order to use <code>TimeBasedRollingPolicy</code>, the |
| * <b>FileNamePattern</b> option must be set. It basically specifies the name of the |
| * rolled log files. The value <code>FileNamePattern</code> should consist of |
| * the name of the file, plus a suitably placed <code>%d</code> conversion |
| * specifier. The <code>%d</code> conversion specifier may contain a date and |
| * time pattern as specified by the {@link log4cxx::helpers::SimpleDateFormat} class. If |
| * the date and time pattern is ommitted, then the default pattern of |
| * "yyyy-MM-dd" is assumed. The following examples should clarify the point. |
| * |
| * <p> |
| * <table cellspacing="5px" border="1"> |
| * <tr> |
| * <th><code>FileNamePattern</code> value</th> |
| * <th>Rollover schedule</th> |
| * <th>Example</th> |
| * </tr> |
| * <tr> |
| * <td nowrap="true"><code>/wombat/folder/foo.%d</code></td> |
| * <td>Daily rollover (at midnight). Due to the omission of the optional |
| * time and date pattern for the %d token specifier, the default pattern |
| * of "yyyy-MM-dd" is assumed, which corresponds to daily rollover. |
| * </td> |
| * <td>During November 23rd, 2004, logging output will go to |
| * the file <code>/wombat/foo.2004-11-23</code>. At midnight and for |
| * the rest of the 24th, logging output will be directed to |
| * <code>/wombat/foo.2004-11-24</code>. |
| * </td> |
| * </tr> |
| * <tr> |
| * <td nowrap="true"><code>/wombat/foo.%d{yyyy-MM}.log</code></td> |
| * <td>Rollover at the beginning of each month.</td> |
| * <td>During the month of October 2004, logging output will go to |
| * <code>/wombat/foo.2004-10.log</code>. After midnight of October 31st |
| * and for the rest of November, logging output will be directed to |
| * <code>/wombat/foo.2004-11.log</code>. |
| * </td> |
| * </tr> |
| * </table> |
| * <h2>Automatic file compression</h2> |
| * <code>TimeBasedRollingPolicy</code> supports automatic file compression. |
| * This feature is enabled if the value of the <b>FileNamePattern</b> option |
| * ends with <code>.gz</code> or <code>.zip</code>. |
| * <p> |
| * <table cellspacing="5px" border="1"> |
| * <tr> |
| * <th><code>FileNamePattern</code> value</th> |
| * <th>Rollover schedule</th> |
| * <th>Example</th> |
| * </tr> |
| * <tr> |
| * <td nowrap="true"><code>/wombat/foo.%d.gz</code></td> |
| * <td>Daily rollover (at midnight) with automatic GZIP compression of the |
| * arcived files.</td> |
| * <td>During November 23rd, 2004, logging output will go to |
| * the file <code>/wombat/foo.2004-11-23</code>. However, at midnight that |
| * file will be compressed to become <code>/wombat/foo.2004-11-23.gz</code>. |
| * For the 24th of November, logging output will be directed to |
| * <code>/wombat/folder/foo.2004-11-24</code> until its rolled over at the |
| * beginning of the next day. |
| * </td> |
| * </tr> |
| * </table> |
| * |
| * <h2>Decoupling the location of the active log file and the archived log files</h2> |
| * <p>The <em>active file</em> is defined as the log file for the current period |
| * whereas <em>archived files</em> are thos files which have been rolled over |
| * in previous periods. |
| * |
| * <p>By setting the <b>ActiveFileName</b> option you can decouple the location |
| * of the active log file and the location of the archived log files. |
| * <p> |
| * <table cellspacing="5px" border="1"> |
| * <tr> |
| * <th><code>FileNamePattern</code> value</th> |
| * <th>ActiveFileName</th> |
| * <th>Rollover schedule</th> |
| * <th>Example</th> |
| * </tr> |
| * <tr> |
| * <td nowrap="true"><code>/wombat/foo.log.%d</code></td> |
| * <td nowrap="true"><code>/wombat/foo.log</code></td> |
| * <td>Daily rollover.</td> |
| * |
| * <td>During November 23rd, 2004, logging output will go to |
| * the file <code>/wombat/foo.log</code>. However, at midnight that file |
| * will archived as <code>/wombat/foo.log.2004-11-23</code>. For the 24th |
| * of November, logging output will be directed to |
| * <code>/wombat/folder/foo.log</code> until its archived as |
| * <code>/wombat/foo.log.2004-11-24</code> at the beginning of the next |
| * day. |
| * </td> |
| * </tr> |
| * </table> |
| * <p> |
| * If configuring programatically, do not forget to call {@link #activateOptions} |
| * method before using this policy. Moreover, {@link #activateOptions} of |
| * <code> TimeBasedRollingPolicy</code> must be called <em>before</em> calling |
| * the {@link #activateOptions} method of the owning |
| * <code>RollingFileAppender</code>. |
| */ |
| class LOG4CXX_EXPORT TimeBasedRollingPolicy : public RollingPolicyBase, |
| public TriggeringPolicy { |
| DECLARE_LOG4CXX_OBJECT(TimeBasedRollingPolicy) |
| BEGIN_LOG4CXX_CAST_MAP() |
| LOG4CXX_CAST_ENTRY(TimeBasedRollingPolicy) |
| LOG4CXX_CAST_ENTRY_CHAIN(RollingPolicyBase) |
| LOG4CXX_CAST_ENTRY_CHAIN(TriggeringPolicy) |
| END_LOG4CXX_CAST_MAP() |
| |
| private: |
| /** |
| * Time for next determination if time for rollover. |
| */ |
| log4cxx_time_t nextCheck; |
| |
| /** |
| * File name at last rollover. |
| */ |
| LogString lastFileName; |
| |
| /** |
| * mmap pointer |
| */ |
| apr_mmap_t* _mmap; |
| |
| /* |
| * pool for mmap handler |
| * */ |
| log4cxx::helpers::Pool* _mmapPool; |
| |
| /** |
| * mmap file descriptor |
| */ |
| apr_file_t* _file_map; |
| |
| /** |
| * mmap file name |
| */ |
| std::string _mapFileName; |
| |
| /* |
| * lock file handle |
| * */ |
| apr_file_t* _lock_file; |
| |
| /** |
| * Check nextCheck if it has already been set |
| * Timebased rolling policy has an issue when working at low rps. |
| * Under low rps, multiple processes will not be scheduled in time for the second chance(do rolling), |
| * so the rolling mechanism will not be triggered even if the time period is out of date. |
| * This results in log entries will be accumulated for serveral minutes to be rolling. |
| * Adding this flag to provide rolling opportunity for a process even if it is writing the first log entry |
| */ |
| bool bAlreadyInitialized; |
| |
| /* |
| * If the current file name contains date information, retrieve the current writting file from mmap |
| * */ |
| bool bRefreshCurFile; |
| |
| /* |
| * mmap file name |
| * */ |
| LogString _fileNamePattern; |
| |
| /** |
| * Length of any file type suffix (.gz, .zip). |
| */ |
| int suffixLength; |
| |
| public: |
| TimeBasedRollingPolicy(); |
| void addRef() const; |
| void releaseRef() const; |
| void activateOptions(log4cxx::helpers::Pool& ); |
| |
| #ifdef LOG4CXX_MULTI_PROCESS |
| virtual ~TimeBasedRollingPolicy(); |
| |
| /** |
| * Generate mmap file |
| */ |
| int createMMapFile(const std::string& lastfilename, log4cxx::helpers::Pool& pool); |
| |
| /** |
| * Detect if the mmap file is empty |
| */ |
| bool isMapFileEmpty(log4cxx::helpers::Pool& pool); |
| |
| /** |
| * init MMapFile |
| */ |
| void initMMapFile(const LogString& lastFileName, log4cxx::helpers::Pool& pool); |
| |
| /** |
| * lock MMapFile |
| */ |
| int lockMMapFile(int type); |
| |
| /** |
| * unlock MMapFile |
| */ |
| int unLockMMapFile(); |
| |
| /** |
| * create MMapFile/lockFile |
| */ |
| const std::string createFile(const std::string& filename, const std::string& suffix, log4cxx::helpers::Pool& pool); |
| #endif |
| |
| /** |
| * {@inheritDoc} |
| */ |
| RolloverDescriptionPtr initialize( |
| const LogString& currentActiveFile, |
| const bool append, |
| log4cxx::helpers::Pool& pool); |
| |
| /** |
| * {@inheritDoc} |
| */ |
| RolloverDescriptionPtr rollover( |
| const LogString& currentActiveFile, |
| const bool append, |
| log4cxx::helpers::Pool& pool); |
| |
| /** |
| * Determines if a rollover may be appropriate at this time. If |
| * true is returned, RolloverPolicy.rollover will be called but it |
| * can determine that a rollover is not warranted. |
| * |
| * @param appender A reference to the appender. |
| * @param event A reference to the currently event. |
| * @param filename The filename for the currently active log file. |
| * @param fileLength Length of the file in bytes. |
| * @return true if a rollover should occur. |
| */ |
| virtual bool isTriggeringEvent( |
| Appender* appender, |
| const log4cxx::spi::LoggingEventPtr& event, |
| const LogString& filename, |
| size_t fileLength); |
| |
| protected: |
| log4cxx::pattern::PatternMap getFormatSpecifiers() const; |
| |
| }; |
| |
| LOG4CXX_PTR_DEF(TimeBasedRollingPolicy); |
| |
| } |
| } |
| |
| #endif |
| |
