Skip to content

Commit

Permalink
FEATURE: Tweak README
Browse files Browse the repository at this point in the history
  • Loading branch information
bwaidelich committed Apr 25, 2017
1 parent 046fb71 commit 3178c35
Showing 1 changed file with 44 additions and 8 deletions.
52 changes: 44 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
Yeebase.Graylog
================
# Yeebase.Graylog

The Yeebase.Graylog Flow package logs your exceptions as well as single messages to a central Graylog server. This
package also provides a simple backend to log message of Flows Logger classes to a Graylog server.

It depends on the official GELF php package https://github.com/bzikarsky/gelf-php

Installation & configuration
------------
## Installation & configuration

Just add "yeebase/graylog" as dependency to your composer.json and run a "composer update" in your project's root folder.
Just add "yeebase/graylog" as dependency to your composer.json and run a "composer update" in your project's root folder
or simply execute:
```
composer require yeebase/graylog
```
from your project's root.

Configure your Graylog Server:
```yaml
Expand All @@ -18,9 +21,9 @@ Yeebase:
host: '127.0.0.1'
port: 12201
chunksize: 'wan'
skipStatusCodes: [403, 404]
```
### Log exceptions
Activate the exception handler and configure the connection to your graylog server in your Settings.yaml:
Expand All @@ -32,17 +35,50 @@ Neos:
className: 'Yeebase\Graylog\Error\GraylogExceptionHandler'
```
If you wish to log normal log messages to your Graylog server just use the provided GraylogLoggerInterface:
*Note:* For `Development` context, the `Neos.Flow` package overrides this setting. Make sure to add this configuration
in the right context Settings.yaml.

#### Filter exceptions

To skip certain exceptions from being logged you can either use the `skipStatusCodes` setting:

```yaml
Yeebase:
Graylog:
# don't log any exceptions that would result in a HTTP status 403 (access denied) / 404 (not found)
skipStatusCodes: [403, 404]
```

Since version 2.1 you can alternatively use the `renderingGroups` Flow setting, i.e. to exclude certain Exception
*classes* from being logged:

```yaml
Neos:
Flow:
error:
exceptionHandler:
className: 'Yeebase\Graylog\Error\GraylogExceptionHandler'
renderingGroups:
'accessDeniedExceptions':
matchingExceptionClassNames: ['Neos\Flow\Security\Exception\AccessDeniedException']
options:
logException: false
```

### Manual logging


If you wish to log normal log messages to your Graylog server just use the provided `GraylogLoggerInterface`:

```php
use Neos\Flow\Annotations as Flow;
use Yeebase\Graylog\Log\GraylogLoggerInterface;
class SomeClass
{
/**
* @Flow\Inject
* @var Yeebase\Graylog\Log\GraylogLoggerInterface
* @var GraylogLoggerInterface
*/
protected $graylogLogger;
Expand Down

0 comments on commit 3178c35

Please sign in to comment.