Merge branch 'develop'

OxCom · Jan 13, 2018 · 3051e79 · 3051e79
2 parents 1ae4b80 + 4f50b8f
commit 3051e79
Show file tree

Hide file tree

Showing 3 changed files with 67 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -4,7 +4,8 @@
 [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
 
 Bundle for Symfony3 that integrates Rollbar tracker
-Docs [here](https://github.com/OxCom/symfony3-rollbar-bundle/tree/master/Resources/doc)
+
+Some documentation can be found here [here](https://github.com/OxCom/symfony3-rollbar-bundle/tree/master/Resources/doc)
 
 # Tests
 To run test You have to provide an access token and then run test

diff --git a/Resources/doc/configuration.rst b/Resources/doc/configuration.rst
@@ -1,23 +1,65 @@
 Configuration
-=======================
+=============
+
 Simple configuration of bundle:
-.. code-block:: php
-    symfony_rollbar:
-      rollbar:
-        access_token: 'some-secret-token-here'
-        environment: '%kernel.environment%'
 
+.. code-block:: yaml
+
+    symfony_rollbar:
+        enable: true
+        rollbar:
+            access_token: 'some-secret-token-here'
+            environment: '%kernel.environment%'
+            agent_log_location: '%kernel.logs_dir%/rollbar.log'
+            allow_exec: true
+            endpoint: 'https://api.rollbar.com/api/1/'
+            base_api_url: 'https://api.rollbar.com/api/1/'
+            branch: 'master'
+            capture_error_stacktraces: true
+            checkIgnore: null
+            code_version: ''
+            enable_utf8_sanitization': true
+            environment: 'production'
+            custom: []
+            error_sample_rates: []
+            exception_sample_rates: []
+            fluent_host: '127.0.0.1'
+            fluent_port: 24224
+            fluent_tag: 'rollbar'
+            handler: 'blocking'
+            host: null
+            include_error_code_context: false
+            include_exception_code_context: false
+            included_errno: E_ERROR | E_WARNING | E_PARSE | E_CORE_ERROR | E_USER_ERROR | E_RECOVERABLE_ERROR
+            logger: null
+            person: []
+            person_fn: null
+            root: '%kernel.root_dir%'
+            scrub_fields: ['passwd', 'password', 'secret', 'confirm_password', 'password_confirmation', 'auth_token', 'csrf_token']
+            scrub_whitelist: null
+            shift_function': true
+            timeout: 3
+            report_suppressed: false
+            use_error_reporting: false
+            proxy: null
+            send_message_trace: false
+            include_raw_request_body: false
+            local_vars_dump: false
 
 Bundle configuration
----------------------------
-####
+--------------------
+
 ``enable``: It's possible to enable or disable handling of errors and exceptions.  Default: ``true``
 
-``rollbar`` - configuration parameters for Rollbar instance. Full list of options can be found
+``rollbar``: Configuration parameters for Rollbar instance. Full list of options can be found
 in `official documentation`_ for Rollbar PHP lib.
 
-#### RollBar settings
-Here you can find a list of some configuration options for RollBar.
+.. _`official documentation`: https://rollbar.com/docs/notifier/rollbar-php/
+
+RollBar settings
+--------------------
+
+Here you can description of some important configuration options for RollBar.
 
 ``access_token``: Your project access token.
 
@@ -26,8 +68,3 @@ Here you can find a list of some configuration options for RollBar.
 ``environment``: Environment name, e.g. 'production' or 'development'. Default: ``production``
 
 ``root``: Path to your project's root dir. Default ``%kernel.root_dir%``
-
-More configuration details can be found in `DependencyInjection/Configuration.php`_ file.
-
-.. _`official documentation`: https://rollbar.com/docs/notifier/rollbar-php/
-.. _`DependencyInjection/Configuration.php`: https://github.com/OxCom/symfony3-rollbar-bundle/blob/master/DependencyInjection/Configuration.php
diff --git a/Resources/doc/index.rst b/Resources/doc/index.rst
@@ -12,7 +12,7 @@ Step 1: Download the Bundle
 Open a command console, enter your project directory and execute the
 following command to download the latest stable version of this bundle:
 
-.. code-block:: bash
+.. code-block:: yaml
 
     $ composer require oxcom/symfony-rollbar-bundle
 
@@ -25,9 +25,7 @@ Then, enable the bundle by adding it to the list of registered bundles
 in the ``AppKernel::registerBundles()`` of your project:
 
 .. code-block:: php
-    <?php
 
-    // ..
     public function registerBundles()
     {
         $bundles = [
@@ -40,13 +38,17 @@ in the ``AppKernel::registerBundles()`` of your project:
     }
 
 Step 3: Update configuration
----------------------------
-3. Update configuration
-.. code-block:: yml
+----------------------------
+Add new section in configuration file
+
+.. code-block:: yaml
+
     symfony_rollbar:
-      enable: true
-      rollbar:
-        access_token: '%ROLLBAR_ACCESS_TOKEN%'
-        environment: '%kernel.environment%'
+        enable: true
+        rollbar:
+            access_token: '%ROLLBAR_ACCESS_TOKEN%'
+            environment: '%kernel.environment%'
+
+Replace ``%ROLLBAR_ACCESS_TOKEN%`` with token for Rollbar
 
 .. _`installation chapter`: https://getcomposer.org/doc/00-intro.md