Skip to content

Commit ff66c0a

Browse files
author
thang
committed
update README.md
1 parent 21a0760 commit ff66c0a

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,21 @@ If you're using Cloud Foundry, it worth to check out the library [SAP/cf-python-
1717
7. [References](#7-references)
1818

1919
# 1. Features
20-
1. Lightweight, no dependencies. Minimal configuration needed (1 LoC to getting started)
21-
2. 100% compatible with built-in **logging** module. Support both Python 2.7.x and 3.x
22-
3. Emit JSON logs. See for detailed log format here [\[0\]](#0-full-logging-format-references)
23-
4. Support **correlation-id** [\[1\]](#1-what-is-correlation-idrequest-id)
24-
5. Support HTTP request instrumentation. Built in support for [Flask](http://flask.pocoo.org/) & [Sanic](http://flask.pocoo.org/).
25-
Extensible to support other web frameworks. Pull Request welcome :smiley: .
26-
6. Support inject arbitrary extra properties to JSON log message.
20+
1. Emit JSON logs.([format detail](#0-full-logging-format-references))
21+
2. Support **correlation-id** [\[1\]](#1-what-is-correlation-idrequest-id)
22+
3. Lightweight, no dependencies. Minimal configuration needed (1 LoC to get it working)
23+
4. Fully compatible with Python **logging** module. Support both Python 2.7.x and 3.x
24+
5. Support HTTP request instrumentation. Built in support for [Flask](http://flask.pocoo.org/) & [Sanic](http://flask.pocoo.org/). Extensible to support other web frameworks. PR welcome :smiley: .
25+
6. Support inject arbitrary extra properties to JSON log message.
2726

2827
# 2. Usage
2928
Install by running this command:
3029
> pip install json-logging
3130
32-
By default log will be emitted in normal format to ease the local development. To enable it on production set either json_logging.ENABLE_JSON_LOGGING or ENABLE_JSON_LOGGING environment variable to true.
31+
By default log will be emitted in normal format to ease the local development. To enable it on production set either **json_logging.ENABLE_JSON_LOGGING** or **ENABLE_JSON_LOGGING environment variable** to true.
3332

34-
To configure, call json_logging.init(framework_name). Once configured library will try to configure all loggers (existing and newly created) to emit log in JSON format. See each use case for more detail.
33+
To configure, call **json_logging.init(framework_name)**. Once configured library will try to configure all loggers (existing and newly created) to emit log in JSON format.
34+
See following use cases for more detail.
3535

3636
TODO: update guide on how to use ELK stack to view log
3737
## 2.1 Non-web application log

0 commit comments

Comments
 (0)