Merge pull request php-telegram-bot#200 from MBoretto/monolog

Adventures with Monolog, ready for the real world 👌

Author: noplanman

README.md

@@ -43,7 +43,7 @@ A Telegram Bot based on the official [Telegram Bot API](https://core.telegram.or
     - [Set Admins](#set-admins)
     - [Channel Administration](#channel-administration)
 - [Upload and Download directory path](#upload-and-download-directory-path)
-- [Logging](#logging)
+- [Logging](doc/01-utils.md)
 - [Documentation](#documentation)
 - [Projects with this library](#projects-with-this-library)
 - [Troubleshooting](#troubleshooting)
@@ -511,27 +511,6 @@ $telegram->setDownloadPath('yourpath/Download');
 $telegram->setUploadPath('yourpath/Upload');
 ```
 
-### Logging
-Thrown Exceptions are not stored by default. You can Enable this feature adding this line in your 'webhook.php' or 'getUpdates.php'
-
-```php
-    Longman\TelegramBot\Logger::initialize('your_path/TelegramException.log');
-```
-
-Incoming update (json string from webhook and getUpdates) can be logged in a text file. Set those options with the methods:
-```php
-$telegram->setLogRequests(true);
-$telegram->setLogPath($BOT_NAME . '.log');
-```
-
-Set verbosity to 3 to also log curl requests and responses from the bot to Telegram:
-
-```php
-$telegram->setLogRequests(true);
-$telegram->setLogPath($BOT_NAME . '.log');
-$telegram->setLogVerbosity(3);
-```
-
 ## Documentation
 
 Take a look at the repo [Wiki](https://github.com/akalongman/php-telegram-bot/wiki) for further information and tutorials!

composer.json

@@ -20,7 +20,8 @@
     "require": {
         "php": ">=5.5.0",
         "ext-pdo": "*",
-        "ext-curl": "*"
+        "ext-curl": "*",
+        "monolog/monolog": "^1.19"
     },
     "autoload": {
         "psr-4": {

composer.lock

@@ -0,0 +1,37 @@
+## Logging
+Telegram bot library feats [Monolog](https://github.com/Seldaek/monolog) to store logs.
+
+Logs are divided in those streams:
+### Error
+Collects all the exceptions throwned by the library:
+
+```php
+TelegramLog::initErrorLog($path . '/' . $BOT_NAME . '_error.log');
+```
+
+### Debug
+Stores Curl messages with the server, useful for debugging:
+
+```php
+TelegramLog::initDebugLog($path . '/' . $BOT_NAME . '_debug.log');
+```
+
+### Raw data
+Incoming updates (json string from webhook and getUpdates) can be logged in a text file. Set this option with the methods:
+```php
+TelegramLog::initUpdateLog($path . '/' . $BOT_NAME . '_update.log');
+```
+Why I need raw log?  
+Telegram api changes continuously and often happen that db schema is not uptodate with new entities/features. So can happen that your table schema would not be able to store valuable new information coming from Telegram.
+
+If you store raw data you can port all updates on the newest table schema just using [this script](../utils/importFromLog.php).
+Remember always backup first!!
+
+## Stream and external sources
+Error and Debug streams relies on the `bot_log` instance that can be provided from an external source:
+
+```php
+TelegramLog::initialize($monolog);
+```
+
+Raw data relies on the `bot_update_log` instance that feats a custom format for this kind of logs.