Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Cuizi7 committed Sep 21, 2021
1 parent 52f4657 commit c70e631
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions docs/source/development/collecting_logs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

RQAlpha 采用 `logbook`_ 作为默认的日志模块,开发者可以通过在 mod 中为 logger 添加 handler 实现自定义的日志收集。

以下是一个简单的 demo。

.. _`logbook`: https://logbook.readthedocs.io/en/stable/


Expand All @@ -14,8 +16,6 @@ Mod 示例

首先要做的是实现 `handler`_ 对象,此处实现的 handler 对象接受 :code:`send_log_handler` 函数作为参数,该函数会在打印日志的时候被调用。

formatter 使用了 :code:`rqalpha.utils.logger.user_std_handler_log_formatter`,该 formatter 在输出策略日志的时候会选用策略运行的时间而非物理时间作为日志的时间戳。

.. _`handler`: https://logbook.readthedocs.io/en/stable/quickstart.html#handlers

.. code-block:: python
Expand All @@ -24,15 +24,13 @@ formatter 使用了 :code:`rqalpha.utils.logger.user_std_handler_log_formatter`
from logbook.base import NOTSET
from rqalpha.environment import Environment
from rqalpha.utils.logger import user_std_handler_log_formatter
class LogHandler(Handler, StringFormatterHandlerMixin):
def __init__(self, send_log_handler, level=NOTSET, format_string=None, filter=None, bubble=False):
Handler.__init__(self, level, filter, bubble)
StringFormatterHandlerMixin.__init__(self, format_string)
self.send_log_handler = send_log_handler
self.formatter = user_std_handler_log_formatter
def _write(self, level_name, item):
dt = Environment.get_instance().calendar_dt
Expand Down

0 comments on commit c70e631

Please sign in to comment.