khalyomede/syslog-interface

Standard proposal for Syslog protocol across any classes

v1.0.1 2018-03-30 21:42 UTC

This package is auto-updated.

Last update: 2021-11-29 02:17:59 UTC


README

PHP from Packagist Packagist Packagist

Standard proposal for Syslog protocol across any classes.

class MyLog implements SyslogInterface {
  // ...
}
$log = new MyLog;

$log->warning('Request invalidated for user {userid}', ['userid' => 'John']);

Summary

Problem solved with this standard

This interface aim to bring a common strategy for various implementer of syslog solutions. It is based on PSR-3 Log standard (but does not implement its interface because of the lack of support for type hinting in method prototypes) and provide a overlay to it by following the Syslog Protocol RFC 5424.

Installation

In your project folder:

composer require khalyomede/syslog-interface:1.*

Warnings

Methods definitions

Alert

Log a message with an alert severity level.

public function alert(string $message, array $context = []);

Critical

Log a message with a critical severity level.

public function critical(string $message, array $context = []);

Date

Force the date for the next log.

public function date(DateTime $date);

debug

Log a message with a debug severity log.

public function debug(string $message, array $context = []);

device

Set the originated device (mobile device, webcam, web server, ...) that generated the log.

public function device(string $device);

emergency

Log a message with an emergency severity level.

public function emergency(string $message, array $context = []);

error

Log a messae with an error severity level.

public function error(string $message, array $context = []);

facility

Represents the origin process. For a list of common facilities, follow this link.

public function facility(int $category);

host

Represents the machine that will receive the log.

public function host(string $host);

identifier

An identifier (can be a string or an integer) that represents the serie of logs.

public function identifier(string $identifier);

info

Log a message with an info severity level.

public function info(string $message, array $context = []);

log

Log the message.

public function log(string $level, string $message, array $context = []);

notice

Log a message with a notice severity level.

public function notice(string $message, array $context = []);

port

Set the port to log through.

public function port(int $port);

processus

Set the originated machine, device, ... that is responsible for generating the log.

public function processus(string $processus);

source

Set the originated domain that host the device. For more information check the hostname property RFC5424.

public function source(string $source);

Note

  • The source should be a valid domain or ip
  • The validation should be made via filter_var and prefix by http:// if it is missing

warning

Log a message with a warning severity level.

public function warning(string $message, array $context = []);

MIT Licence

Syslog interface

Copyright © 2018 Khalyomede

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the oftware, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN CTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.