简介
- 一个简单的日志滚动器
- 业界已有大量优秀的日志滚动工具来限制日志大小
- 本工具只是仿制了Apache httpd中的rotatelogs
- 不同的是，工作模式参考了yarn namenode日志的管理模式
- 按照参数配置，工具会限制日志文件的数量及每个文件的体积，同时保证后缀最大的日志文件中为较老旧日志，用户配置的 $USER_LOG_FILE 总是会被刷新，保持日志最新内容在当前文件中
- 日志滚动
Features
- 支持Linux管道操作
- 支持文件体积限制
- 支持文件数量限制
- 保证所有日志按文件有序，日志按由新到旧分别组织在后缀递增的文件中，当前 $USER_LOG_FILE保持最新日志
- 相比Apache rotatelogs，有些许速度优势
- 内存开销可忽略
- 简单的使用方式
- 干净的环境依赖，只需要python 2.7.x即可
- 轻量级的日志滚动管理工具
source code
#!/usr/bin/python
# -*- coding: UTF-8 -*-
__author__ = 'enzhao'
# Created by enzhao on 2019/8/14.
# git: https://github.com/Suanec
# repo: https://github.com/Suanec/suanec_rotatelogs.git
# ===========================================================================
# I DO NOT KNOW THE DIFFERENCE FROM EVERY LICENSE OF OPEN SOURCE CODE YET
# NOW JUST COPY SPARK'S LICENSE TO HERE
# I PLAN TO LEARN ABOUT POPULAR LICENSE TO KNOW THE DIFFERENCE BETWEEN THEM.
# ===========================================================================
# Apache License
# Version 2.0, January 2004
# http://www.apache.org/licenses/
# TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
# 1. Definitions.
# "License" shall mean the terms and conditions for use, reproduction,
# and distribution as defined by Sections 1 through 9 of this document.
# "Licensor" shall mean the copyright owner or entity authorized by
# the copyright owner that is granting the License.
# "Legal Entity" shall mean the union of the acting entity and all
# other entities that control, are controlled by, or are under common
# control with that entity. For the purposes of this definition,
# "control" means (i) the power, direct or indirect, to cause the
# direction or management of such entity, whether by contract or
# otherwise, or (ii) ownership of fifty percent (50%) or more of the
# outstanding shares, or (iii) beneficial ownership of such entity.
# "You" (or "Your") shall mean an individual or Legal Entity
# exercising permissions granted by this License.
# "Source" form shall mean the preferred form for making modifications,
# including but not limited to software source code, documentation
# source, and configuration files.
# "Object" form shall mean any form resulting from mechanical
# transformation or translation of a Source form, including but
# not limited to compiled object code, generated documentation,
# and conversions to other media types.
# "Work" shall mean the work of authorship, whether in Source or
# Object form, made available under the License, as indicated by a
# copyright notice that is included in or attached to the work
# (an example is provided in the Appendix below).
# "Derivative Works" shall mean any work, whether in Source or Object
# form, that is based on (or derived from) the Work and for which the
# editorial revisions, annotations, elaborations, or other modifications
# represent, as a whole, an original work of authorship. For the purposes
# of this License, Derivative Works shall not include works that remain
# separable from, or merely link (or bind by name) to the interfaces of,
# the Work and Derivative Works thereof.
# "Contribution" shall mean any work of authorship, including
# the original version of the Work and any modifications or additions
# to that Work or Derivative Works thereof, that is intentionally
# submitted to Licensor for inclusion in the Work by the copyright owner
# or by an individual or Legal Entity authorized to submit on behalf of
# the copyright owner. For the purposes of this definition, "submitted"
# means any form of electronic, verbal, or written communication sent
# to the Licensor or its representatives, including but not limited to
# communication on electronic mailing lists, source code control systems,
# and issue tracking systems that are managed by, or on behalf of, the
# Licensor for the purpose of discussing and improving the Work, but
# excluding communication that is conspicuously marked or otherwise
# designated in writing by the copyright owner as "Not a Contribution."
# "Contributor" shall mean Licensor and any individual or Legal Entity
# on behalf of whom a Contribution has been received by Licensor and
# subsequently incorporated within the Work.
# 2. Grant of Copyright License. Subject to the terms and conditions of
# this License, each Contributor hereby grants to You a perpetual,
# worldwide, non-exclusive, no-charge, royalty-free, irrevocable
# copyright license to reproduce, prepare Derivative Works of,
# publicly display, publicly perform, sublicense, and distribute the
# Work and such Derivative Works in Source or Object form.
# 3. Grant of Patent License. Subject to the terms and conditions of
# this License, each Contributor hereby grants to You a perpetual,
# worldwide, non-exclusive, no-charge, royalty-free, irrevocable
# (except as stated in this section) patent license to make, have made,
# use, offer to sell, sell, import, and otherwise transfer the Work,
# where such license applies only to those patent claims licensable
# by such Contributor that are necessarily infringed by their
# Contribution(s) alone or by combination of their Contribution(s)
# with the Work to which such Contribution(s) was submitted. If You
# institute patent litigation against any entity (including a
# cross-claim or counterclaim in a lawsuit) alleging that the Work
# or a Contribution incorporated within the Work constitutes direct
# or contributory patent infringement, then any patent licenses
# granted to You under this License for that Work shall terminate
# as of the date such litigation is filed.
# 4. Redistribution. You may reproduce and distribute copies of the
# Work or Derivative Works thereof in any medium, with or without
# modifications, and in Source or Object form, provided that You
# meet the following conditions:
# (a) You must give any other recipients of the Work or
# Derivative Works a copy of this License; and
# (b) You must cause any modified files to carry prominent notices
# stating that You changed the files; and
# (c) You must retain, in the Source form of any Derivative Works
# that You distribute, all copyright, patent, trademark, and
# attribution notices from the Source form of the Work,
# excluding those notices that do not pertain to any part of
# the Derivative Works; and
# (d) If the Work includes a "NOTICE" text file as part of its
# distribution, then any Derivative Works that You distribute must
# include a readable copy of the attribution notices contained
# within such NOTICE file, excluding those notices that do not
# pertain to any part of the Derivative Works, in at least one
# of the following places: within a NOTICE text file distributed
# as part of the Derivative Works; within the Source form or
# documentation, if provided along with the Derivative Works; or,
# within a display generated by the Derivative Works, if and
# wherever such third-party notices normally appear. The contents
# of the NOTICE file are for informational purposes only and
# do not modify the License. You may add Your own attribution
# notices within Derivative Works that You distribute, alongside
# or as an addendum to the NOTICE text from the Work, provided
# that such additional attribution notices cannot be construed
# as modifying the License.
# You may add Your own copyright statement to Your modifications and
# may provide additional or different license terms and conditions
# for use, reproduction, or distribution of Your modifications, or
# for any such Derivative Works as a whole, provided Your use,
# reproduction, and distribution of the Work otherwise complies with
# the conditions stated in this License.
# 5. Submission of Contributions. Unless You explicitly state otherwise,
# any Contribution intentionally submitted for inclusion in the Work
# by You to the Licensor shall be under the terms and conditions of
# this License, without any additional terms or conditions.
# Notwithstanding the above, nothing herein shall supersede or modify
# the terms of any separate license agreement you may have executed
# with Licensor regarding such Contributions.
# 6. Trademarks. This License does not grant permission to use the trade
# names, trademarks, service marks, or product names of the Licensor,
# except as required for reasonable and customary use in describing the
# origin of the Work and reproducing the content of the NOTICE file.
# 7. Disclaimer of Warranty. Unless required by applicable law or
# agreed to in writing, Licensor provides the Work (and each
# Contributor provides its Contributions) on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied, including, without limitation, any warranties or conditions
# of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
# PARTICULAR PURPOSE. You are solely responsible for determining the
# appropriateness of using or redistributing the Work and assume any
# risks associated with Your exercise of permissions under this License.
# 8. Limitation of Liability. In no event and under no legal theory,
# whether in tort (including negligence), contract, or otherwise,
# unless required by applicable law (such as deliberate and grossly
# negligent acts) or agreed to in writing, shall any Contributor be
# liable to You for damages, including any direct, indirect, special,
# incidental, or consequential damages of any character arising as a
# result of this License or out of the use or inability to use the
# Work (including but not limited to damages for loss of goodwill,
# work stoppage, computer failure or malfunction, or any and all
# other commercial damages or losses), even if such Contributor
# has been advised of the possibility of such damages.
# 9. Accepting Warranty or Additional Liability. While redistributing
# the Work or Derivative Works thereof, You may choose to offer,
# and charge a fee for, acceptance of support, warranty, indemnity,
# or other liability obligations and/or rights consistent with this
# License. However, in accepting such obligations, You may act only
# on Your own behalf and on Your sole responsibility, not on behalf
# of any other Contributor, and only if You agree to indemnify,
# defend, and hold each Contributor harmless for any liability
# incurred by, or claims asserted against, such Contributor by reason
# of your accepting any such warranty or additional liability.
# END OF TERMS AND CONDITIONS
# APPENDIX: How to apply the Apache License to your work.
# To apply the Apache License to your work, attach the following
# boilerplate notice, with the fields enclosed by brackets "[]"
# replaced with your own identifying information. (Don't include
# the brackets!) The text should be enclosed in the appropriate
# comment syntax for the file format. We also recommend that a
# file or class name and description of purpose be included on the
# same "printed page" as the copyright notice for easier
# identification within third-party archives.
# Copyright [yyyy] [name of copyright owner]
# 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.
import argparse,sys
import os
# target cmd : ./rotatelogs -n 5 ./weiflow-from-weiclient.log 100M
# target_support : Usage: ../rotatelogs [-v] [-l] [-L linkname] [-p prog] [-f] [-t] [-e] [-c] [-n number] <logfile> {<rotation time in seconds>|<rotation size>(B|K|M|G)} [offset minutes from UTC]
OPEN_ERROR = 211
WRITE_ERROR = 212
FILERENAME_ERROR = 213
FILEREMOVE_ERROR = 214
ACCESS_ERROR = 215
class SizeMetric(object):
def __init__(self, _rotate_size):
self._rotate_size_str = _rotate_size
self.ROTATION_SIZE_UNIT = {
"B" : 1,
"K" : 1024,
"M" : 1024 ** 2,
"G" : 1024 ** 3
}
self.ROTATION_SIZE_METRIC = self.ROTATION_SIZE_UNIT.keys()
self.size_metric_convert()
def size_metric_convert(self):
self.rotation_metric = self._rotate_size_str[-1].upper()
self.rotation_size = int(self._rotate_size_str) if(self.rotation_metric.isdigit()) else int(self._rotate_size_str[:-1])
if(self.rotation_metric in self.ROTATION_SIZE_METRIC):
self.rotation_size = int(self._rotate_size_str[:-1]) * self.ROTATION_SIZE_UNIT[self.rotation_metric]
return self.rotation_size
@property
def rotate_size(self):
return self.rotation_size
class RotateLogFileManager(SizeMetric):
def __init__(self, _rotate_size, _log_file):
super(RotateLogFileManager, self).__init__(_rotate_size= _rotate_size)
self.log_file = _log_file
try:
self.file_abs_dir = os.path.realpath(os.path.dirname(self.log_file))
except Exception,e:
exit(ACCESS_ERROR)
def file_name_generator(self, _suffix):
if(not _suffix):
return self.log_file
else:
return self.log_file + "." + str(_suffix)
class FileNumberLimit(RotateLogFileManager):
def __init__(self, _num_file, _rotate_size, _log_file):
super(FileNumberLimit, self).__init__(_rotate_size=_rotate_size, _log_file=_log_file)
self.num_file = int(_num_file)
self.max_fsuffix = self.num_file -1
self.file_list = [self.file_name_generator(i) for i in xrange(1,self.num_file)]
self.fsuffix_need_to_write = None
def fsuffix_detected(self):
fsuffix_not_exist = [_fsuffix for _fsuffix in xrange(1,self.num_file) if not os.path.exists(self.file_name_generator(_fsuffix))]
if(len(fsuffix_not_exist) == self.max_fsuffix):
self.fsuffix_need_to_write = None
return self.fsuffix_need_to_write
self.fsuffix_need_to_write = (self.max_fsuffix) if(len(fsuffix_not_exist) < 1) else min(fsuffix_not_exist)
return self.fsuffix_need_to_write
def file_rotate(self):
self.fsuffix_detected()
try:
if(self.fsuffix_need_to_write == self.max_fsuffix):
if(os.path.exists(self.file_name_generator(self.max_fsuffix))):
os.remove(self.file_name_generator(self.max_fsuffix))
except Exception,e:
sys.exit(FILEREMOVE_ERROR)
try:
if(self.fsuffix_need_to_write):
for suffix in xrange(self.fsuffix_need_to_write, 1, -1):
os.rename(self.file_name_generator(suffix -1), self.file_name_generator(suffix))
os.rename(self.log_file, self.file_name_generator(1))
except Exception,e:
sys.exit(FILERENAME_ERROR)
class RotateLogWriter(FileNumberLimit):
def __init__(self, _num_file, _rotate_size, _log_file):
super(RotateLogWriter, self).__init__(_num_file=_num_file, _rotate_size=_rotate_size, _log_file=_log_file)
try:
if(os.path.exists(self.log_file)):
self.log_writer = open(self.log_file, "r")
self.writted_size = len(self.log_writer.read())
self.log_writer.close()
else:
self.writted_size = 0
self.log_writer = open(self.log_file, "ab+")
self.write("")
except Exception,e:
sys.exit(OPEN_ERROR)
def write(self, _msg = ''):
msg_size = len(_msg)
try:
self.log_writer.write(_msg)
self.writted_size += msg_size
if(self.writted_size >= self.rotate_size):
self.log_writer.flush()
self.log_writer.close()
self.file_rotate()
self.log_writer = open(self.log_file, "ab+")
self.writted_size = 0
except Exception,e:
print e.message
sys.exit(WRITE_ERROR)
if __name__ == '__main__':
parser = argparse.ArgumentParser(
description='Run a test HTTPS server. '
'By default, the current directory is served.')
parser.add_argument('-n', '--number-of-files', dest='file_number', type=int, default=2,
help='Use a circular list of filenames without timestamps. With -n 3, the series of log files opened would be "logfile", "logfile.1", "logfile.2", then overwriting "logfile". (default: %(default)s)')
parser.add_argument("log_file", type=str, default='weiflow-from-weiclient.log',
help="The path plus basename of the logfile. If logfile includes any '%' characters, it is treated as a format string for strftime(3). Otherwise, the suffix .nnnnnnnnnn is automatically added and is the time in seconds (unless the -t option is used). Both formats compute the start time from the beginning of the current period. For example, if a rotation time of 86400 is specified, the hour, minute, and second fields created from the strftime(3) format will all be zero, referring to the beginning of the current 24-hour period (midnight).")
parser.add_argument("rotation_size", type=str, default='500M',
help="The path plus basename of the logfile. If logfile includes any '%' characters, it is treated as a format string for strftime(3). Otherwise, the suffix .nnnnnnnnnn is automatically added and is the time in seconds (unless the -t option is used). Both formats compute the start time from the beginning of the current period. For example, if a rotation time of 86400 is specified, the hour, minute, and second fields created from the strftime(3) format will all be zero, referring to the beginning of the current 24-hour period (midnight).")
args = parser.parse_args()
print args
rotation_size = SizeMetric(args.rotation_size).rotate_size
print rotation_size
rotator = RotateLogWriter(args.file_number, args.rotation_size, args.log_file)
for line in sys.stdin:
rotator.write(line)
# for line in xrange(1,100000):
# rotator.write('%s %s %s %s %s %s %s %s %s %s %s ' % (line, line, line, line, line, line, line, line, line, line, line))
suanec_rotatelogs
rotatelogs
isometric3
___ ___ ___ ___ ___ ___ ___
/ / / / ___ / / ___ / / / / / / / /
/ /:: / /:: / / / /:: / / / /:/_ / /:: / /:/_ / /:/_
/ /:/: / /:/: / /:/ / /:/: / /:/ / /:/ / ___ ___ / /:/: / /:/ / / /:/ /
/ /:/~/:/ / /:/ : / /:/ / /:/~/:: / /:/ / /:/ /:/_ /__/ / / / /:/ : / /:/_/:: / /:/ /::
/__/:/ /:/___ /__/:/ \__: / /:: /__/:/ /:/: / /:: /__/:/ /:/ / : / /:/ /__/:/ \__: /__/:/__/: /__/:/ /:/:
:/:::::/ : / /:/ /__/:/: :/:/__/ /__/:/: :/:/ /:/ : /:/ : / /:/ : /~~/:/ :/:/~/:/
::/~~~~ : /:/ \__/ : ::/ \__/ : ::/ /:/ :/:/ : /:/ : /:/ ::/ /:/
: :/:/ : : : :/:/ ::/ :/:/ :/:/ \__/ /:/
: ::/ \__/ : \__/ ::/ \__/ ::/ ::/ /__/:/
\__/ \__/ \__/ \__/ \__/ \__/ \__/
slant
____ ____ _________ ______________ ____ ___________
/ __ / __ /_ __/ |/_ __/ ____/ / / __ / ____/ ___/
/ /_/ / / / / / / / /| | / / / __/ / / / / / / / __ \__
/ _, _/ /_/ / / / / ___ |/ / / /___/ /___/ /_/ / /_/ /___/ /
/_/ |_|\____/ /_/ /_/ |_/_/ /_____/_____/\____/\____//____/
standard
____ ___ _____ _ _____ _____ _ ___ ____ ____
| _ / _ \_ _|/ |_ _| ____| | / _ / ___/ ___|
| |_) | | | || | / _ | | | _| | | | | | | | _\___
| _ <| |_| || |/ ___ | | | |___| |__| |_| | |_| |___) |
|_| \_\___/ |_/_/ \_\_| |_____|_____\___/ \____|____/
instruction
A simple rotatelog tool.
there is a lots of log rotator tools for limit log file size.
this is a simple implementations for Apache httpd rotatelogs.
with a differences is work in yarn namenode log mode.
that's means the oldest log was in the largest suffix file with $USER_LOG_FILE always fresh.
Features
- support Linux pipe operation.
- support file size limitation.
- support file number limitation.
- maintain all log file in ordered with the latest log in $USER_LOG_FILE and oldest log in the largest suffix file.
- a few faster than Apache rotatelogs. speed performance was not considered well.
- few memory cost.
- simple usage
- clean dependencies by implementations in naive Python 2.7
- light tools for log file maintaining.
- easy code for redevelopment and bug location.
- free use for anyone.
requirement
python 2.7.x
reference
https://httpd.apache.org/docs/2.4/programs/rotatelogs.html
usage
chmod +x ${CUSTOM_PATH}/rotatelogs.py
$commandLine | ./rotatelogs.py -n 5 /data0/suanec/control_center/weibox/rotate_logs/weiflow-from-weiclient.log 100M
test command
set -efx
IDX=20
START_DATE=`date +"%s"`
rm -f ./weiflow-from-weiclient.log*
for i in `seq 1 $IDX`
do
echo $i
# hive -e "select * from online_data_record_per_hour_new_tag where dt=20190801 and hour=18" 2> ./weiflow-from-weiclient.log | head -n 30000 >> /data0/suanec/control_center/weibox/rotate_logs/weiflow-from-weiclient.log
# hive -e "select * from online_data_record_per_hour_new_tag where dt=20190801 and hour=18" 2> ./weiflow-from-weiclient.log 1> /data0/suanec/control_center/weibox/rotate_logs/weiflow-from-weiclient.log
# hive -e "select * from online_data_record_per_hour_new_tag where dt=20190801 and hour=18" 2> ./weiflow-from-weiclient.log | tail -n 30000 >> /data0/suanec/control_center/weibox/rotate_logs/weiflow-from-weiclient.log
# hive -e "select * from online_data_record_per_hour_new_tag where dt=20190801 and hour=18" 2> ./weiflow-from-weiclient.log | /data0/suanec/control_center/weibox/rotate_logs/../rotatelogs -n 3 /data0/suanec/control_center/weibox/rotate_logs/weiflow-from-weiclient.log 500M
# hive -e "select * from online_data_record_per_hour_new_tag where dt=20190801 and hour=18" 2> ./weiflow-from-weiclient.log | python ./rotatelogs.py -n 5 /data0/suanec/control_center/weibox/rotate_logs/weiflow-from-weiclient.log 100M
# hive -e "select * from online_data_record_per_hour_new_tag where dt=20190801 and hour=18" 2> ./weiflow-from-weiclient.log | python ./rotatelogs.py -n 3 /data0/suanec/control_center/weibox/rotate_logs/weiflow-from-weiclient.log 500M
# hive -e "select * from online_data_record_per_hour_new_tag where dt=20190801 and hour=18" 2> ./weiflow-from-weiclient.log | ./rotatelogs.py -n 3 /data0/suanec/control_center/weibox/rotate_logs/weiflow-from-weiclient.log 500M
done
END_DATE=`date +"%s"`
RUN_TIME=$(echo "(${END_DATE}-${START_DATE})/${IDX}" | bc -l )
echo "RUN_TIME : "
echo ${RUN_TIME}
result size
/business/content/datasource/online_data_record_per_hour_new_tag/dt=20190801/hour=18/ori_new_tag.txt
6.1G
simple result
| command | time-cost |
|---|---|
| head -3w | 13s |
| all | 136s |
| tail -3w | 66s |
| apache rotateLogs -n 3 500M | 102s |
| suanec rotateLogs -n 5 100M | 60s |
| suanec rotateLogs -n 3 500M | 56s |
result size
[root@header-1 rotate_logs]# ll
总用量 1272308
-rw-r--r-- 1 root root 10970 8月 15 13:45 rotatelogs.py
-rw-r--r-- 1 root root 240 8月 15 16:25 test_rotatelog.sh
-rw-r--r-- 1 root root 3061 8月 15 16:12 user_custom_script.sh
-rw-r--r-- 1 root root 254170229 8月 15 16:13 weiflow-from-weiclient.log
-rw-r--r-- 1 root root 524304017 8月 15 16:13 weiflow-from-weiclient.log.1
-rw-r--r-- 1 root root 524290323 8月 15 16:13 weiflow-from-weiclient.log.2
[root@header-1 rotate_logs]# ll -h
总用量 1.3G
-rw-r--r-- 1 root root 11K 8月 15 13:45 rotatelogs.py
-rw-r--r-- 1 root root 240 8月 15 16:25 test_rotatelog.sh
-rw-r--r-- 1 root root 3.0K 8月 15 16:12 user_custom_script.sh
-rw-r--r-- 1 root root 243M 8月 15 16:13 weiflow-from-weiclient.log
-rw-r--r-- 1 root root 501M 8月 15 16:13 weiflow-from-weiclient.log.1
-rw-r--r-- 1 root root 501M 8月 15 16:13 weiflow-from-weiclient.log.2
future
- rotatelogs - Piped logging program to rotate Apache logs
- all mentioned in https://httpd.apache.org/docs/2.4/programs/rotatelogs.html will be added.
addition
- all pr is welcome
- all comments is welcome at https://www.cnblogs.com/suanec/p/11359349.html