Logging custom docs

docs/examples.md

@@ -0,0 +1,17 @@
+# Examples
+
+## Custom logging
+
+The below `logging_example.yaml` is a yaml representation of the default logging configuration.
+You can pass it loading a dict, using the `--log-config` flag.
+It sets 2 loggers:
+1. `uvicorn.error` whose formatter is the `uvicorn.logging.DefaultFormatter`. 
+2. `uvicorn.access` whose formatter is the `uvicorn.logging.AccessFormatter`. 
+
+Both formatters will output a colorized automatically if a tty is detected.
+
+If you used the `--use-colors / --no-use-colors` then the output will / won't be colorized.
+
+```yaml hl_lines="7 11 38 39 40 41"
+{!./src/logging_example/logging_example.yaml!}
+```

docs/settings.md

@@ -32,6 +32,8 @@ equivalent keyword arguments, eg. `uvicorn.run("example:app", port=5000, reload=
 * `--no-access-log` - Disable access log only, without changing log level.
 * `--use-colors / --no-use-colors` - Enable / disable colorized formatting of the log records, in case this is not set it will be auto-detected.
 
+See a custom logging configuration [example](examples.md)
+
 ## Implementation
 
 * `--loop <str>` - Set the event loop implementation. The uvloop implementation provides greater performance, but is not compatible with Windows or PyPy. But you can use IOCP in windows. **Options:** *'auto', 'asyncio', 'uvloop', 'iocp'.* **Default:** *'auto'*.

docs/src/logging_example/logging_example.yaml

@@ -0,0 +1,29 @@
+version: 1
+disable_existing_loggers: False
+formatters:
+  default:
+    "()": uvicorn.logging.DefaultFormatter
+    format: "%(levelprefix)s %(message)s"
+  access:
+    "()": uvicorn.logging.AccessFormatter
+    format: '%(levelprefix)s %(client_addr)s - "%(request_line)s" %(status_code)s'
+handlers:
+  default:
+    formatter: default
+    class: logging.StreamHandler
+    stream: ext://sys.stdout
+  access:
+    formatter: access
+    class: logging.StreamHandler
+    stream: ext://sys.stdout
+loggers:
+  uvicorn.error:
+    level: INFO
+    handlers:
+      - default
+    propagate: no
+  uvicorn.access:
+    level: INFO
+    handlers:
+      - access
+    propagate: no

mkdocs.yml

@@ -17,3 +17,5 @@ pages:
 markdown_extensions:
   - markdown.extensions.codehilite:
       guess_lang: false
+  - markdown_include.include:
+      base_path: docs

requirements.txt

@@ -19,3 +19,4 @@ requests
 # Documentation
 mkdocs
 mkdocs-material
+markdown-include