Graylog SDK

Graylog API PHP SDK., _(*1)

, _(*2)

, _(*3)

Documentation

All the installation and usage instructions are located in this README. Check it for a specific versions:, _(*4)

0.x

Prerequisites

This version of the project requires:, _(*5)

PHP 7.0+

Installation

First of all, you need to require this library through Composer:, _(*6)

``` bash composer require nexylan/graylog-sdk, _(*7)


## Usage

```php
$graylog = new \Nexy\Graylog\Graylog([
    'base_uri' => 'https://your.graylog.instance.com/api'
]);

// You may authenticate with API token:
$graylog->auth('YourApiToken');
// Or user credentials:
$graylog->auth('YourGraylogUsername', 'YourGrayLogPassword');

// Then, start using the API:
$result = $graylog->search()->relative()->terms('file', 'source: host.com', 0);

Symfony integration

Activate the bundle:, _(*8)

// config/bundles.php

return [
    Nexy\Graylog\Bridge\Symfony\Bundle\NexyGraylogBundle::class => ['all' => true],
];

Add the configuration file:, _(*9)

// config/packages/nexy_graylog.yaml

nexy_graylog:
    options:
        base_uri:             ~ # Required
    auth:

        # Can be a username or a token.
        user:                 ~ # Required

        # Required only for username auth.
        password:             null

Then, inject the Graylog service thanks to autowiring:, _(*10)

class MyService
{
    private $graylog;

    public function __construct(Nexy\Graylog\Graylog $graylog)
    {
        $this->graylog = $graylog;
    }
}