Skip to content

Commit a4974dc

Browse files
committed
Edited README.md via GitHub
1 parent d5e370c commit a4974dc

File tree

1 file changed

+9
-15
lines changed

1 file changed

+9
-15
lines changed

README.md

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,19 @@
1-
A Python structured logger for Fluent
2-
=====================================
1+
# A Python structured logger for Fluent
2+
33

44
Many web/mobile applications generate huge amount of event logs (c,f. login, logout, purchase, follow, etc). To analyze these event logs could be really valuable for improving the service. However, the challenge is collecting these logs seasily and reliably.
55

66
[Fluent](http://github.com/fluent/fluent) solves that problem by having: easy installation, small footprint, plugins, reliable buffering, log forwarding, etc.
77

88
**fluent-logger-python** is a Python library, to record the events from Python application.
99

10-
Installation
11-
------------
10+
## Installation
1211

1312
This library is distributed as 'fluent-logger' python package. Please execute the following command to install it.
1413

1514
$ pip install fluent-logger
1615

17-
Configuration
18-
-------------
16+
## Configuration
1917

2018
Fluent daemon must be lauched with the following configuration:
2119

@@ -24,11 +22,9 @@ Fluent daemon must be lauched with the following configuration:
2422
port 24224
2523
</source>
2624

27-
Usage
28-
-----
25+
## Usage
2926

30-
Event-Based Interface
31-
^^^^^^^^^^^^^^^^^^^^^
27+
### Event-Based Interface
3228

3329
First, you need to call logger.setup() to create global logger instance. This call needs to be called only once, at the beggining of the application for example.
3430

@@ -51,9 +47,8 @@ Then, please create the events like this. This will send the event to fluent, wi
5147
'from': 'userA',
5248
'to': 'userB'
5349
})
54-
55-
Python logging.Handler interface
56-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
50+
51+
### Python logging.Handler interface
5752

5853
This client-library also has FluentHanler class for Python logging module.
5954

@@ -68,7 +63,6 @@ This client-library also has FluentHanler class for Python logging module.
6863
'to': 'userB'
6964
})
7065

71-
License
72-
-------
66+
## License
7367

7468
Apache License, Version 2.0

0 commit comments

Comments
 (0)