keboola/gelf-server

Simple PHP server for GELF logger

3.0.3 2022-08-25 07:29 UTC

Requires

• php: ^7.4|^8.0
• ext-json: *
• graylog2/gelf-php: ^1.5
• react/datagram: ^1.2
• react/socket: ^0.8
• symfony/process: ^4.1|^5.4

Requires (Dev)

• ext-sockets: *
• ext-zlib: *
• keboola/coding-standard: >=7.0.2
• phpstan/phpstan: ^1.5
• phpstan/phpstan-phpunit: ^1.0.0
• phpunit/phpunit: ^9.3

MIT

• Keboola

README

A php implementation of a gelf compatible backend like Graylog2. This library provides a simple server to which a GELF client can connect.

Installation

Recommended installation via composer:

Add gelf-server to composer.json either by running composer require keboola/gelf-server or by defining it manually:

"require": {
   // ...
   "keboola/gelf-server": "^1.1"
   // ...
}

Reinstall dependencies: composer install

Usage

To create a server, use the ServerFactory class:

$server = ServerFactory::createServer(ServerFactory::SERVER_TCP);

To start listening for connections, us the start method. This method has the following parameters:

• $minPort and $maxPort - to set port on which the server listens. To listen on a single port use the same value for both $minPort and $maxPort. Otherwise the server will randomly choose a free port in the specified range (inclusive).
• $onStart - Callback executed when the server successfully started listening, the callback signature is function ($port), which gives you the actual port the server is listening on.
• $onProcess - Callback executed periodically when the server is running. The callback has signature function (&$terminated). The server will keep running indefinitely until you set $terminated to true in this callback.
• $onEvent - Callback executed when a GELF event is received. The callback has signature function ($event). The $event variable contains associative array with GELF fields
• $onTerminate - Optional callback executed when the server terminates - after it stops listening for connections. The callback signature is function ().

Examples

For usage examples, see the /examples directory.

License

MIT licensed, see LICENSE file.