update doc
This commit is contained in:
parent
5ee7b6caeb
commit
ddc039ed2e
@ -9,12 +9,6 @@ A simple example using default settings would be like this:
|
|||||||
|
|
||||||
```python
|
```python
|
||||||
from sanic import Sanic
|
from sanic import Sanic
|
||||||
from sanic.config import LOGGING
|
|
||||||
|
|
||||||
# The default logging handlers are ['accessStream', 'errorStream']
|
|
||||||
# but we change it to use other handlers here for demo purpose
|
|
||||||
LOGGING['loggers']['network']['handlers'] = [
|
|
||||||
'accessSysLog', 'errorSysLog']
|
|
||||||
|
|
||||||
app = Sanic('test')
|
app = Sanic('test')
|
||||||
|
|
||||||
@ -23,14 +17,14 @@ async def test(request):
|
|||||||
return response.text('Hello World!')
|
return response.text('Hello World!')
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
app.run(log_config=LOGGING)
|
app.run(debug=True, access_log=True)
|
||||||
```
|
```
|
||||||
|
|
||||||
And to close logging, simply assign log_config=None:
|
And to close logging, simply assign access_log=False:
|
||||||
|
|
||||||
```python
|
```python
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
app.run(log_config=None)
|
app.run(access_log=False)
|
||||||
```
|
```
|
||||||
|
|
||||||
This would skip calling logging functions when handling requests.
|
This would skip calling logging functions when handling requests.
|
||||||
@ -38,59 +32,24 @@ And you could even do further in production to gain extra speed:
|
|||||||
|
|
||||||
```python
|
```python
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
# disable internal messages
|
# disable debug messages
|
||||||
app.run(debug=False, log_config=None)
|
app.run(debug=False, access_log=False)
|
||||||
```
|
```
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
|
|
||||||
By default, log_config parameter is set to use sanic.config.LOGGING dictionary for configuration. The default configuration provides several predefined `handlers`:
|
By default, log_config parameter is set to use sanic.log.LOGGING_CONFIG_DEFAULTS dictionary for configuration.
|
||||||
|
|
||||||
- internal (using [logging.StreamHandler](https://docs.python.org/3/library/logging.handlers.html#logging.StreamHandler))<br>
|
There are three `loggers` used in sanic, and **must be defined if you want to create your own logging configuration**:
|
||||||
For internal information console outputs.
|
|
||||||
|
|
||||||
|
- root:<br>
|
||||||
- accessStream (using [logging.StreamHandler](https://docs.python.org/3/library/logging.handlers.html#logging.StreamHandler))<br>
|
|
||||||
For requests information logging in console
|
|
||||||
|
|
||||||
|
|
||||||
- errorStream (using [logging.StreamHandler](https://docs.python.org/3/library/logging.handlers.html#logging.StreamHandler))<br>
|
|
||||||
For error message and traceback logging in console.
|
|
||||||
|
|
||||||
|
|
||||||
- accessSysLog (using [logging.handlers.SysLogHandler](https://docs.python.org/3/library/logging.handlers.html#logging.handlers.SysLogHandler))<br>
|
|
||||||
For requests information logging to syslog.
|
|
||||||
Currently supports Windows (via localhost:514), Darwin (/var/run/syslog),
|
|
||||||
Linux (/dev/log) and FreeBSD (/dev/log).<br>
|
|
||||||
You would not be able to access this property if the directory doesn't exist.
|
|
||||||
(Notice that in Docker you have to enable everything by yourself)
|
|
||||||
|
|
||||||
|
|
||||||
- errorSysLog (using [logging.handlers.SysLogHandler](https://docs.python.org/3/library/logging.handlers.html#logging.handlers.SysLogHandler))<br>
|
|
||||||
For error message and traceback logging to syslog.
|
|
||||||
Currently supports Windows (via localhost:514), Darwin (/var/run/syslog),
|
|
||||||
Linux (/dev/log) and FreeBSD (/dev/log).<br>
|
|
||||||
You would not be able to access this property if the directory doesn't exist.
|
|
||||||
(Notice that in Docker you have to enable everything by yourself)
|
|
||||||
|
|
||||||
|
|
||||||
And `filters`:
|
|
||||||
|
|
||||||
- accessFilter (using sanic.log.DefaultFilter)<br>
|
|
||||||
The filter that allows only levels in `DEBUG`, `INFO`, and `NONE(0)`
|
|
||||||
|
|
||||||
|
|
||||||
- errorFilter (using sanic.log.DefaultFilter)<br>
|
|
||||||
The filter that allows only levels in `WARNING`, `ERROR`, and `CRITICAL`
|
|
||||||
|
|
||||||
There are two `loggers` used in sanic, and **must be defined if you want to create your own logging configuration**:
|
|
||||||
|
|
||||||
- sanic:<br>
|
|
||||||
Used to log internal messages.
|
Used to log internal messages.
|
||||||
|
|
||||||
|
- sanic.error:<br>
|
||||||
|
Used to log error logs.
|
||||||
|
|
||||||
- network:<br>
|
- sanic.access:<br>
|
||||||
Used to log requests from network, and any information from those requests.
|
Used to log access logs.
|
||||||
|
|
||||||
#### Log format:
|
#### Log format:
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user