devgroup/yii2-graylog-target

Graylog2 log target for Yii2 framework applications

yii2-graylog-target

Graylog2 log target for Yii2 framework applications

, _(*1)

, _(*2)

, _(*3)

Installation

For installation the yii2-graylog-target library in your projects as composer dependency, run the command:, _(*4)

php composer.phar require "devgroup/yii2-graylog-target:*", _(*5)

... or just add to composer.json file the following line:, _(*6)

"devgroup/yii2-graylog-target": "*"

Configuration

Configure from config array, _(*7)

'components' => [
  'log' => [
    'grayii' => [
      'transport' => [
        'class' => \Gelf\Transport\HttpTransport::class,
        'host' => 'http://graylog2-server.com',
        'port' => 12201,
      ],
      'appName' => 'app name',
    ]
  ]
]

Available config parameters:

Usage

• Sent additional data:, _(*8)

  Yii::info([
  'short' => 'Short message or title',  // required. alternate usage variant: `Short message or title` (without a key 'short', but first item in array)
  'full' => 'Full message',             // optional. full message of log. For example, may be a stack trace as string or other detalized message
  '_field1' => 'value1',                // optional. additional field starts with '_' symbol
  '_field2' => 'value2',                // optional. additional field starts with '_' symbol
  ]);
  

• Sent exception:, _(*9)

  try {
  ... running code with harmful bugs...
  } catch (\Throwable $t) {
  Yii::warning($t);
  }
  

• Sent short message:, _(*10)

  Yii::trace('The short message example'); // or equivalent usage is Yii::trace(['The short message example']);
  

Tests

Tests was placed int the test directory. Tests can be running by the command:, _(*11)

php composer.phar exec codecept run, _(*12)

Tests with different php versions with docker:

• PHP v5.6, _(*13)

  docker run -it --rm --name php56-for-grayii-tests -v "$PWD":/usr/src/myapp -w /usr/src/myapp php:5.6-cli php vendor/bin/codecept run, _(*14)

• PHP v7.0, _(*15)

  docker run -it --rm --name php70-for-grayii-tests -v "$PWD":/usr/src/myapp -w /usr/src/myapp php:7.0-cli php vendor/bin/codecept run, _(*16)

• HHVM, _(*17)

  docker run -it --rm --name hhvm-for-grayii-tests -v "$PWD":/usr/src/myapp -w /usr/src/myapp diegomarangoni/hhvm:cli hhvm vendor/bin/codecept run, _(*18)