Skip to content

Commit 403873f

Browse files
author
thang
committed
correct section index
1 parent 8dc9aad commit 403873f

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Python logging library to emit JSON log that can be easily indexed and searchabl
33
If you're using Cloud Foundry, it worth to check out the library [SAP/cf-python-logging-support](https://github.com/SAP/cf-python-logging-support) which I'm also original author and contributor.
44
# Content
55
1. [Features](#1-features)
6-
2. [Usage](#3-usage)
6+
2. [Usage](#2-usage)
77
2.1 [Non-web application log](#21-non-web-application-log)
88
2.2 [Web application log](#22-web-application-log)
99
2.3 [Get current correlation-id](#23-get-current-correlation-id)
@@ -116,7 +116,7 @@ logging.basicConfig()
116116
json_logging.config_root_logger()
117117
```
118118

119-
# 4. Configuration
119+
# 3. Configuration
120120
logging library can be configured by setting the value in json_logging
121121

122122
Name | Description | Default value
@@ -133,11 +133,11 @@ COMPONENT_NAME | A human-friendly name representing the software component | EMP
133133
COMPONENT_INSTANCE_INDEX | Instance's index of horizontally scaled service | 0
134134
CREATE_CORRELATION_ID_IF_NOT_EXISTS | Whether to generate an new correlation-id in case one is not present| True
135135

136-
# 5. Python References
136+
# 4. Python References
137137

138138
TODO: update Python API docs on Github page
139139

140-
# 6. Framework support plugin development
140+
# 5. Framework support plugin development
141141
To add support for a new web framework, you need to extend following classes in [**framework_base**](/blob/master/json_logging/framework_base.py) and register support using [**json_logging.register_framework_support**](https://github.com/thangbn/json-logging-python/blob/master/json_logging/__init__.py#L38) method:
142142

143143
Class | Description | Mandatory
@@ -149,7 +149,7 @@ AppRequestInstrumentationConfigurator | Class to perform request instrumentation
149149

150150
Take a look at [**json_logging/base_framework.py**](blob/master/json_logging/framework_base.py), [**json_logging.flask**](tree/master/json_logging/framework/flask) and [**json_logging.sanic**](/tree/master/json_logging/framework/sanic) packages for reference implementations.
151151

152-
# 7. FAQ & Troubleshooting
152+
# 6. FAQ & Troubleshooting
153153
1. I configured everything, but no logs are printed out?
154154

155155
- Forgot to add handlers to your logger?
@@ -168,7 +168,7 @@ set SANIC_NO_UVLOOP=true
168168
set SANIC_NO_UJSON=true
169169
pip3 install .
170170
```
171-
# 8. References
171+
# 7. References
172172
## [0] Full logging format references
173173
- Common field
174174
Field | Description | Format | Example

0 commit comments

Comments
 (0)