Skip to content

Commit 8a5eec8

Browse files
committed
docs
1 parent 76eec7f commit 8a5eec8

File tree

3 files changed

+73
-16
lines changed

3 files changed

+73
-16
lines changed

README.md

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,35 @@
66
Bundle for Symfony3 that integrates Rollbar tracker
77

88
# Work in progress
9-
Current realization is used in one of my projects, so You can expect a big list of updates, features and very small time for fixes and features.
9+
Current realization is used in one of my projects, so You can expect fast reactions on issues, features request and e.t.c.
1010

1111
# Install
1212
1. Add SymfonyRollbarBundle with composer: ``` composer require oxcom/symfony-rollbar-bundle```
1313
2. Register SymfonyRollbarBundle in AppKernel::registerBundles()
14+
```php
15+
public function registerBundles()
16+
{
17+
$bundles = [
18+
// ...
19+
new \Symfony\Bundle\FrameworkBundle\FrameworkBundle(),
20+
// ...
21+
new \SymfonyRollbarBundle\SymfonyRollbarBundle(),
22+
// ...
23+
];
24+
25+
return $bundles;
26+
}
27+
```
28+
3. Setup configuration
1429
```php
15-
public function registerBundles()
16-
{
17-
$bundles = [
18-
// ...
19-
new \Symfony\Bundle\FrameworkBundle\FrameworkBundle(),
20-
// ...
21-
new \SymfonyRollbarBundle\SymfonyRollbarBundle(),
22-
// ...
23-
];
24-
25-
return $bundles;
26-
}
30+
symfony_rollbar:
31+
rollbar:
32+
access_token: 'some-secret-token-here'
33+
environment: '%kernel.environment%'
2734
```
2835

36+
More docs [here](https://github.com/OxCom/symfony3-rollbar-bundle/tree/master/docs)
37+
2938
# Test
3039
To run test You have to provide an access token and then run test
3140
```bash
@@ -35,6 +44,3 @@ $ ./vendor/bin/phpunit -c tests/
3544

3645
# Bugs and Issues
3746
Please, if You found a bug or something, that is not working properly, contact me and tell what's wrong. It's nice to have an example how to reproduce a bug, or any idea how to fix it in Your request. I'll take care about it ASAP.
38-
39-
# Thanks
40-
I would like to thanks all people how are lazy.

docs/config.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Configuration
2+
Simple configuration of bundle:
3+
```php
4+
symfony_rollbar:
5+
rollbar:
6+
access_token: 'some-secret-token-here'
7+
environment: '%kernel.environment%'
8+
```
9+
10+
#### Common settings
11+
```enable```: It's possible to enable or disable handling of errors and exceptions. Default: ```true```
12+
13+
```rollbar``` - configuration parameters for Rollbar instance. Full list of options can be found on [official documentation](https://rollbar.com/docs/notifier/rollbar-php/) page for PHP lib.
14+
15+
#### RollBar settings
16+
Here you can find a list of some configuration options for RollBar.
17+
18+
```access_token```: Your project access token.
19+
20+
```agent_log_location```: Path to the directory where agent relay log files should be written. Should not include final slash. Only used when handler is agent. Default: ```%kernel.logs_dir%/rollbar.log```
21+
22+
```environment```: Environment name, e.g. 'production' or 'development'. Default: ```production```
23+
24+
```root```: Path to your project's root dir. Default ```%kernel.root_dir%```
25+
26+
More configuration details can be found in [DependencyInjection/Configuration.php](https://github.com/OxCom/symfony3-rollbar-bundle/blob/master/src/DependencyInjection/Configuration.php)

docs/install.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Install
2+
1. Add SymfonyRollbarBundle with composer: ``` composer require oxcom/symfony-rollbar-bundle```
3+
2. Register SymfonyRollbarBundle in AppKernel::registerBundles()
4+
```php
5+
public function registerBundles()
6+
{
7+
$bundles = [
8+
// ...
9+
new \Symfony\Bundle\FrameworkBundle\FrameworkBundle(),
10+
// ...
11+
new \SymfonyRollbarBundle\SymfonyRollbarBundle(),
12+
// ...
13+
];
14+
15+
return $bundles;
16+
}
17+
```
18+
3. Setup configuration
19+
```php
20+
symfony_rollbar:
21+
enable: true
22+
rollbar:
23+
access_token: '%env(ROLLBAR_ACCESS_TOKEN)%'
24+
environment: '%kernel.environment%'
25+
```

0 commit comments

Comments
 (0)