Merge pull request #15 from Hexanet/better-doc

Better doc

Author: notFloran

README.md

@@ -6,64 +6,125 @@ Symfony2 bundle with extra processors and logger to log request/response.
 
 ## Installation
 
-```
+```bash
 composer require hexanet/monolog-extra-bundle
 ```
 
-## Configuration reference
+## Usage
+
+### Processors
+
+The bundle provides several processors:
+
+* User
+* Session ID
+* UID
+* Additions
+
+#### User
 
+The *UserProcessor* add data about the current user in each log entry.
+
+```yaml
+hexanet_monolog_extra:
+    processor:
+        user: true
 ```
+
+The default provider returns:
+* anonymous when no user is logged
+* the username of the current logged user
+* cli
+
+You can create your own provider by creating a service that implements *Hexanet\Common\MonologExtraBundle\Provider\User\UserProviderInterface*.
+
+```yaml
 hexanet_monolog_extra:
+    provider:
+        user: your_own_provider_service_id
+```
+
+#### Session ID
 
-    # add data to extra in each records of log
+Add the session id in each log entry.
+
+```yaml
+hexanet_monolog_extra:
     processor:
+        session_id: true
+```
 
-        # add the username of the current user
-        user: true
+You can create your own provider by creating a service that implements *Hexanet\Common\MonologExtraBundle\Provider\Session\SessionIdProviderInterface*.
 
-        # add the session id
-        session_id: false
+```yaml
+hexanet_monolog_extra:
+    provider:
+        session_id: your_own_provider_service_id
+```
 
-        # add Unique Identification Number
-        uid: true
+#### UID
 
-        # add symfony environnement
-        environment: true
+Add an unique identifier for the request in each log entry.
 
-        # add static data
-        additions:
-            type: symfony
-            application: symfony application
-            extra_info: blabla
+```yaml
+hexanet_monolog_extra:
+    processor:
+        uid: true
+```
 
-    logger:
-        # log each request
-        on_request: true
+The bundle comes with 2 providers:
 
-        # log console exception
-        on_console_exception: true
+* UniqidProvider (default): use `uniqid`
+* ApacheUniqueIdProvider: get from environment, need [*mod_unique_id*](https://httpd.apache.org/docs/2.4/mod/mod_unique_id.html) of Apache
 
-        # add uid in the headers of responses
-        add_uid_to_response: true
+You can create your own provider by creating a service that implements *Hexanet\Common\MonologExtraBundle\Provider\Uid\UidProviderInterface*.
 
-    # you can change the provider for uid, user and session_id
+```yaml
+hexanet_monolog_extra:
     provider:
-        uid: hexanet_monolog_extra.logger.provider.uid.apache_unique_id
+        uid: your_own_provider_service_id
+```
+
+#### Additions
 
-        user: hexanet_monolog_extra.logger.provider.user.symfony
+Add custom data in each log entry.
 
-        session_id: hexanet_monolog_extra.logger.provider.session.symfony
+```yaml
+hexanet_monolog_extra:
+  additions:
+      type: symfony
+      application: the best symfony application
+      locale: "%locale%"
+      environment: "%kernel.environment%"
 ```
 
+### Loggers
+
+#### On request
+
+Create a log entry with the request data.
+
+#### On response
+
+Create a log entry with the response data.
 
-### Apache Unique ID
+#### On console exception
 
-This module add an unique id to each request.
+Create a log entry when an exception occurs in console.
+
+#### Add UID to response
+
+Add the UID of the previous processor in the response headers.
 
 ```
-a2enmod unique_id
+HTTP/1.1 302 Found
+X-UID: 57c5f5e842b10
 ```
 
+## Configuration reference
+
+[Configuration reference](doc/configuration_reference.md) for a reference on the available configuration options.
+
 ## Credits
 
 Developed by the [Web Team](https://teamweb.hexanet.fr/) of [Hexanet](http://www.hexanet.fr/).

doc/configuration_reference.md

@@ -0,0 +1,45 @@
+# Configuration reference
+
+```yaml
+hexanet_monolog_extra:
+
+    # add data to extra in each records of log
+    processor:
+
+        # add the username of the current user
+        user: true
+
+        # add the session id
+        session_id: false
+
+        # add Unique Identification Number
+        uid: true
+
+        # add static data
+        additions:
+            type: symfony
+            application: symfony application
+            extra_info: blabla
+            environment:  "%kernel.environment%"
+
+    logger:
+        # log each request
+        on_request: true
+
+        # log each response
+        on_response: true
+
+        # log console exception
+        on_console_exception: true
+
+        # add uid in the headers of responses
+        add_uid_to_response: true
+
+    # you can change the provider for uid, user and session_id
+    provider:
+        uid: hexanet_monolog_extra.logger.provider.uid.apache_unique_id
+
+        user: hexanet_monolog_extra.logger.provider.user.symfony
+
+        session_id: hexanet_monolog_extra.logger.provider.session.symfony
+```