Maison > Article > développement back-end > Compréhension approfondie du module de journalisation Python
Compréhension approfondie du module de journalisation Python
- 零到壹度original
- 2018-04-03 15:02:061937parcourir
Cet article présente principalement une compréhension approfondie du module de journalisation Python. L'éditeur le trouve plutôt bon. Il explique principalement comment utiliser la journalisation pour générer des journaux dans un multi-processus. Comment diviser les fichiers journaux en toute sécurité. Maintenant, je le partage avec vous et le donne comme référence. Suivons l'éditeur et jetons un coup d'œil
1 Introduction au module de journalisation
Le module de journalisation de Python fournit un module standard flexible, permettant à tout programme Python d'utiliser ce module tiers pour implémenter la journalisation. documentation officielle de python logging
Le framework de logging est principalement composé de quatre parties :
Loggers : une interface qui peut être directement appelée par le programme
-
Gestionnaires : déterminez l'allocation des enregistrements de journaux à la bonne destination
Filtres : fournissez un jugement plus précis sur l'opportunité de sortir les journaux
Formateurs : Développer la mise en page du format pour l'impression finale des enregistrements
2. La composition des
enregistreurs
loggers est une interface de journalisation qui peut être directement appelée par le programme et peut directement écrire des informations de journal dans l'enregistreur. . Le logger n'est pas directement instancié, mais l'objet est obtenu via logging.getLogger(name). En fait, l'objet logger est un mode singleton et la journalisation est multi-thread, c'est-à-dire que l'objet logger est obtenu quel que soit l'endroit où le programme en a besoin. à connecter. C'est le même. Mais malheureusement, logger ne prend pas en charge le multi-processus. Cela sera expliqué dans les chapitres suivants et quelques solutions seront proposées.
[Note] L'objet loggers a une relation parent-enfant. Lorsqu'il n'y a pas d'objet logger parent, son objet parent est racine. Lorsqu'il y a un objet parent, la relation parent-enfant sera corrigée. Par exemple, logging.getLogger("abc.xyz") créera deux objets enregistreur, l'un est l'objet parent abc et l'autre est l'objet enfant xyz. En même temps, abc n'a pas d'objet parent, donc son objet parent est root. Mais en fait, abc est un objet réservé (objet de journal virtuel) et il n'existe aucun gestionnaire pour traiter le journal. Cependant, root n'est pas un objet d'espace réservé. Si un objet journal enregistre, son objet parent recevra le journal en même temps. Par conséquent, certains utilisateurs constatent que lorsqu'ils créent un objet enregistreur, ils enregistrent deux fois. journaux créés. Le journal est enregistré une fois et l'objet racine est également enregistré une fois.
Chaque enregistreur a un niveau de journalisation. Les niveaux suivants sont définis dans la journalisation
| Level | Numeric value |
|---|---|
| NOTSET | 0 |
| DEBUG | 10 |
| INFO | 20 |
| WARNING | 30 |
| ERROR | 40 |
| CRITICAL | 50 |
Lorsqu'un enregistreur reçoit les informations du journal, il détermine d'abord si elles répondent au niveau. S'il décide de les traiter, il transmet les informations aux gestionnaires pour traitement.
Handlers
Les handlers distribuent avec précision les informations envoyées par l'enregistreur et les envoient au bon endroit. Par exemple, envoyez-le à la console ou au fichier, ou aux deux, ou à d'autres endroits (canalisations de processus, etc.). Il détermine le comportement de chaque journal et constitue la zone clé qui doit être configurée ultérieurement.
Chaque gestionnaire a également un niveau de journalisation. Un enregistreur peut avoir plusieurs gestionnaires, ce qui signifie que l'enregistreur peut transmettre des journaux à différents gestionnaires en fonction de différents niveaux de journalisation. Bien entendu, le même niveau peut également être transmis à plusieurs gestionnaires, qui peuvent être définis de manière flexible en fonction des besoins.
Filtres
Les filtres fournissent un jugement plus précis pour décider si le journal doit être imprimé. En principe, lorsque le gestionnaire obtient un journal, celui-ci sera traité uniformément en fonction du niveau, mais si le gestionnaire dispose d'un filtre, un traitement et un jugement supplémentaires peuvent être effectués sur le journal. Par exemple, Filter peut intercepter ou modifier les logs d'une source spécifique ou encore modifier son niveau de log (le niveau sera jugé après modification).
L'enregistreur et le gestionnaire peuvent installer des filtres et même plusieurs filtres peuvent être installés en série.
Formatters
Formatters spécifie la présentation du format pour l'impression finale d'un certain enregistrement. Formatter regroupera les informations transmises dans une chaîne spécifique. Par défaut, Format n'imprimera que les informations %(message)s directement. Certaines propriétés LogRecord intégrées peuvent être utilisées dans Format, comme indiqué dans le tableau suivant :
| Attribut | Format | Description |
|---|---|---|
| asctime | %(asctime)s | Construisez l'heure du journal sous une forme lisible, par défaut il s'agit de '2016-02-08 12:00:00,123' avec une précision en millisecondes |
| filename | %(filename)s | Nom du fichier contenant le chemin |
| funcName | %(funcName ) s | log émis par quelle fonction |
| levelname | %(levelname)s | Le niveau final du log (reçu par filtre modifié) |
| message | %(message)s | Message du journal |
| lineno | %(lineno)d | Le numéro de ligne du journal actuel |
| pathname | %( pathname)s | Chemin complet |
| processus | %(process)s | Processus actuel |
| thread | %(thread)s | thread actuel |
Un gestionnaire ne peut avoir qu'un seul formateur, donc si vous souhaitez obtenir une sortie dans plusieurs formats, vous ne pouvez utiliser que plusieurs gestionnaires.
3. Configuration de la journalisation
Configuration simple
Tout d'abord, dans le chapitre sur les enregistreurs, nous avons une racine d'objet de journal par défaut. L'avantage de cet objet de journal racine est que nous. peut utiliser directement la journalisation pour la configuration et la journalisation. Par exemple :
logging.basicConfig(level=logging.INFO,filename='logger.log')
logging.info("info message")La configuration simple ici fait donc référence à l'objet de journal racine, qui peut être utilisé à tout moment. Chaque enregistreur est un objet singleton, donc après l'avoir configuré, il peut être appelé n'importe où dans le programme. Il suffit d'appeler basicConfig pour configurer simplement l'objet de journal racine. En fait, cette méthode est assez efficace et facile à utiliser. Cela garantit que lorsqu'un enregistreur est appelé, il y aura au moins un gestionnaire capable de gérer le journal.
Une configuration simple peut être grossièrement configurée comme ceci :
logging.basicConfig(level=logging.INFO,
format='%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s',
datefmt='[%Y-%m_%d %H:%M:%S]',
filename='../log/my.log',
filemode='a')Configuration du code
Une autre méthode de configuration plus détaillée consiste à la configurer dans le code, mais cette méthode de configuration est la moins méthode utilisée, après tout, personne ne veut coder en dur les paramètres dans le code. Mais voici une brève introduction. Même s’il n’est pas très utilisé, vous pouvez toujours en utiliser un lorsque cela est nécessaire. (À ajouter ultérieurement)
Configuration du fichier de configuration
Le fichier de configuration de journalisation en python est basé sur la fonction de ConfigParser. En d’autres termes, le format du fichier de configuration est également écrit de cette manière. Laissez-moi d'abord vous donner un fichier de configuration plus général puis vous l'expliquer en détail
############################################## [loggers] keys=root, log02 [logger_root] level=INFO handlers=handler01 [logger_log02] level=DEBUG handler=handler02 qualname=log02 ############################################## [handlers] keys=handler01,handler02 [handler_handler01] class=FileHandler level=INFO formatter=form01 args=('../log/cv_parser_gm_server.log',"a") [handler_handler02] class=StreamHandler level=NOTSET formatter=form01 args=(sys.stdout,) ############################################## [formatters] keys=form01,form02 [formatter_form01] format=%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(process)d %(message)s datefmt=[%Y-%m-%d %H:%M:%S] [formatter_form02] format=(message)s ##############################################
Je crois qu'après l'avoir relu, je retrouverai le modèle. utilisez # pour marquer quelques gros morceaux. Chaque enregistreur, gestionnaire ou formateur a un nom de clé. En prenant logger comme exemple, vous devez d'abord ajouter le nom de la clé à la configuration [loggers] pour représenter le logger. Utilisez ensuite [loggers_xxxx] où xxxx est le nom de la clé pour configurer spécifiquement cet enregistreur. Dans log02, j'ai configuré le niveau et un nom de gestionnaire. Bien sûr, vous pouvez configurer plusieurs gestionnaires. Selon ce nom de gestionnaire, accédez à [handlers] pour trouver la configuration du gestionnaire spécifique, et ainsi de suite.
Puis dans le code, chargez le fichier de configuration comme ceci
logging.config.fileConfig(log_conf_file)
在handler中有一个class配置，可能有些读者并不是很懂。其实这个是logging里面原先就写好的一些handler类，你可以在这里直接调用。class指向的类相当于具体处理的Handler的执行者。在logging的文档中可以知道这里所有的Handler类都是线程安全的，大家可以放心使用。那么问题就来了，如果多进程怎么办呢。在下一章我主要就是重写Handler类，来实现在多进程环境下使用logging。 我们自己重写或者全部新建一个Handler类，然后将class配置指向自己的Handler类就可以加载自己重写的Handler了。
4. logging遇到多进程（important）
这部分其实是我写这篇文章的初衷。python中由于某种历史原因，多线程的性能基本可以无视。所以一般情况下python要实现并行操作或者并行计算的时候都是使用多进程。但是 python 中logging 并不支持多进程，所以会遇到不少麻烦。
本次就以 TimedRotatingFileHandler 这个类的问题作为例子。这个Handler本来的作用是：按天切割日志文件。（当天的文件是xxxx.log 昨天的文件是xxxx.log.2016-06-01）。这样的好处是，一来可以按天来查找日志，二来可以让日志文件不至于非常大, 过期日志也可以按天删除。
但是问题来了，如果是用多进程来输出日志，则只有一个进程会切换，其他进程会在原来的文件中继续打，还有可能某些进程切换的时候早就有别的进程在新的日志文件里打入东西了，那么他会无情删掉之，再建立新的日志文件。反正将会很乱很乱，完全没法开心的玩耍。
所以这里就想了几个办法来解决多进程logging问题
原因
在解决之前，我们先看看为什么会导致这样的原因。
先将 TimedRotatingFileHandler 的源代码贴上来，这部分是切换时所作的操作：
def doRollover(self):
"""
do a rollover; in this case, a date/time stamp is appended to the filename
when the rollover happens. However, you want the file to be named for the
start of the interval, not the current time. If there is a backup count,
then we have to get a list of matching filenames, sort them and remove
the one with the oldest suffix.
"""
if self.stream:
self.stream.close()
self.stream = None
# get the time that this sequence started at and make it a TimeTuple
currentTime = int(time.time())
dstNow = time.localtime(currentTime)[-1]
t = self.rolloverAt - self.interval
if self.utc:
timeTuple = time.gmtime(t)
else:
timeTuple = time.localtime(t)
dstThen = timeTuple[-1]
if dstNow != dstThen:
if dstNow:
addend = 3600
else:
addend = -3600
timeTuple = time.localtime(t + addend)
dfn = self.baseFilename + "." + time.strftime(self.suffix, timeTuple)
if os.path.exists(dfn):
os.remove(dfn)
# Issue 18940: A file may not have been created if delay is True.
if os.path.exists(self.baseFilename):
os.rename(self.baseFilename, dfn)
if self.backupCount > 0:
for s in self.getFilesToDelete():
os.remove(s)
if not self.delay:
self.stream = self._open()
newRolloverAt = self.computeRollover(currentTime)
while newRolloverAt <= currentTime:
newRolloverAt = newRolloverAt + self.interval
#If DST changes and midnight or weekly rollover, adjust for this.
if (self.when == 'MIDNIGHT' or self.when.startswith('W')) and not self.utc:
dstAtRollover = time.localtime(newRolloverAt)[-1]
if dstNow != dstAtRollover:
if not dstNow: # DST kicks in before next rollover, so we need to deduct an hour
addend = -3600
else: # DST bows out before next rollover, so we need to add an hour
addend = 3600
newRolloverAt += addend
self.rolloverAt = newRolloverAt
我们观察 if os.path.exists(dfn) 这一行开始，这里的逻辑是如果 dfn 这个文件存在，则要先删除掉它，然后将 baseFilename 这个文件重命名为 dfn 文件。然后再重新打开 baseFilename这个文件开始写入东西。那么这里的逻辑就很清楚了
假设当前日志文件名为 current.log 切分后的文件名为 current.log.2016-06-01
判断 current.log.2016-06-01 是否存在，如果存在就删除
将当前的日志文件名 改名为current.log.2016-06-01
重新打开新文件（我观察到源代码中默认是”a” 模式打开，之前据说是”w”）
于是在多进程的情况下，一个进程切换了，其他进程的句柄还在 current.log.2016-06-01 还会继续往里面写东西。又或者一个进程执行切换了，会把之前别的进程重命名的 current.log.2016-06-01 文件直接删除。又或者还有一个情况，当一个进程在写东西，另一个进程已经在切换了，会造成不可预估的情况发生。还有一种情况两个进程同时在切文件，第一个进程正在执行第3步，第二进程刚执行完第2步，然后第一个进程 完成了重命名但还没有新建一个新的 current.log 第二个进程开始重命名，此时第二个进程将会因为找不到 current 发生错误。如果第一个进程已经成功创建了 current.log 第二个进程会将这个空文件另存为 current.log.2016-06-01。那么不仅删除了日志文件，而且，进程一认为已经完成过切分了不会再切，而事实上他的句柄指向的是current.log.2016-06-01。
好了这里看上去很复杂，实际上就是因为对于文件操作时，没有对多进程进行一些约束，而导致的问题。
那么如何优雅地解决这个问题呢。我提出了两种方案，当然我会在下面提出更多可行的方案供大家尝试。
解决方案1
先前我们发现 TimedRotatingFileHandler 中逻辑的缺陷。我们只需要稍微修改一下逻辑即可：
判断切分后的文件 current.log.2016-06-01 是否存在，如果不存在则进行重命名。（如果存在说明有其他进程切过了，我不用切了，换一下句柄即可）
以”a”模式 打开 current.log
发现修改后就这么简单~
talking is cheap show me the code:不要以为代码那么长，其实修改部分就是 “##” 注释的地方而已，其他都是照抄源代码。这个类继承了 TimedRotatingFileHandler 重写了这个切分的过程。这个解决方案十分优雅，改换的地方非常少，也十分有效。但有网友提出，这里有一处地方依然不完美，就是rename的那一步，如果就是这么巧，同时两个或者多个进程进入了 if 语句，先后开始 rename 那么依然会发生删除掉日志的情况。确实这种情况确实会发生，由于切分文件一天才一次，正好切分的时候同时有两个Handler在操作，又正好同时走到这里，也是蛮巧的，但是为了完美，可以加上一个文件锁，if 之后加锁，得到锁之后再判断一次，再进行rename这种方式就完美了。代码就不贴了，涉及到锁代码，影响美观。
class SafeRotatingFileHandler(TimedRotatingFileHandler): def __init__(self, filename, when='h', interval=1, backupCount=0, encoding=None, delay=False, utc=False): TimedRotatingFileHandler.__init__(self, filename, when, interval, backupCount, encoding, delay, utc) """ Override doRollover lines commanded by "##" is changed by cc """ def doRollover(self): """ do a rollover; in this case, a date/time stamp is appended to the filename when the rollover happens. However, you want the file to be named for the start of the interval, not the current time. If there is a backup count, then we have to get a list of matching filenames, sort them and remove the one with the oldest suffix. Override, 1. if dfn not exist then do rename 2. _open with "a" model """ if self.stream: self.stream.close() self.stream = None # get the time that this sequence started at and make it a TimeTuple currentTime = int(time.time()) dstNow = time.localtime(currentTime)[-1] t = self.rolloverAt - self.interval if self.utc: timeTuple = time.gmtime(t) else: timeTuple = time.localtime(t) dstThen = timeTuple[-1] if dstNow != dstThen: if dstNow: addend = 3600 else: addend = -3600 timeTuple = time.localtime(t + addend) dfn = self.baseFilename + "." + time.strftime(self.suffix, timeTuple) ## if os.path.exists(dfn): ## os.remove(dfn) # Issue 18940: A file may not have been created if delay is True. ## if os.path.exists(self.baseFilename): if not os.path.exists(dfn) and os.path.exists(self.baseFilename): os.rename(self.baseFilename, dfn) if self.backupCount > 0: for s in self.getFilesToDelete(): os.remove(s) if not self.delay: self.mode = "a" self.stream = self._open() newRolloverAt = self.computeRollover(currentTime) while newRolloverAt <= currentTime: newRolloverAt = newRolloverAt + self.interval #If DST changes and midnight or weekly rollover, adjust for this. if (self.when == 'MIDNIGHT' or self.when.startswith('W')) and not self.utc: dstAtRollover = time.localtime(newRolloverAt)[-1] if dstNow != dstAtRollover: if not dstNow: # DST kicks in before next rollover, so we need to deduct an hour addend = -3600 else: # DST bows out before next rollover, so we need to add an hour addend = 3600 newRolloverAt += addend self.rolloverAt = newRolloverAt
解决方案2
我认为最简单有效的解决方案。重写FileHandler类（这个类是所有写入文件的Handler都需要继承的TimedRotatingFileHandler 就是继承的这个类；我们增加一些简单的判断和操作就可以。
我们的逻辑是这样的：
判断当前时间戳是否与指向的文件名是同一个时间
-
如果不是，则切换 指向的文件即可
结束，是不是很简单的逻辑。
talking is cheap show me the code
check_baseFilename 就是执行逻辑1判断；build_baseFilename 就是执行逻辑2换句柄。就这么简单完成了。
这种方案与之前不同的是，当前文件就是 current.log.2016-06-01 ，到了明天当前文件就是current.log.2016-06-02 没有重命名的情况，也没有删除的情况。十分简洁优雅。也能解决多进程的logging问题。
class SafeFileHandler(FileHandler): def __init__(self, filename, mode, encoding=None, delay=0): """ Use the specified filename for streamed logging """ if codecs is None: encoding = None FileHandler.__init__(self, filename, mode, encoding, delay) self.mode = mode self.encoding = encoding self.suffix = "%Y-%m-%d" self.suffix_time = "" def emit(self, record): """ Emit a record. Always check time """ try: if self.check_baseFilename(record): self.build_baseFilename() FileHandler.emit(self, record) except (KeyboardInterrupt, SystemExit): raise except: self.handleError(record) def check_baseFilename(self, record): """ Determine if builder should occur. record is not used, as we are just comparing times, but it is needed so the method signatures are the same """ timeTuple = time.localtime() if self.suffix_time != time.strftime(self.suffix, timeTuple) or not os.path.exists(self.baseFilename+'.'+self.suffix_time): return 1 else: return 0 def build_baseFilename(self): """ do builder; in this case, old time stamp is removed from filename and a new time stamp is append to the filename """ if self.stream: self.stream.close() self.stream = None # remove old suffix if self.suffix_time != "": index = self.baseFilename.find("."+self.suffix_time) if index == -1: index = self.baseFilename.rfind(".") self.baseFilename = self.baseFilename[:index] # add new suffix currentTimeTuple = time.localtime() self.suffix_time = time.strftime(self.suffix, currentTimeTuple) self.baseFilename = self.baseFilename + "." + self.suffix_time self.mode = 'a' if not self.delay: self.stream = self._open()
解决方案其他
当然还有其他的解决方案，例如由一个logging进程统一打日志，其他进程将所有的日志内容打入logging进程管道由它来打理。还有将日志打入网络socket当中也是同样的道理。
5. 参考资料
python logging 官方文档
林中小灯的切分方案，方案一就是从这儿来的
Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!