https://github.com/linkorb/app-event

A library providing the means to log Application Events
https://github.com/linkorb/app-event

Last synced: 3 months ago
JSON representation

A library providing the means to log Application Events

• Host: GitHub
• URL: https://github.com/linkorb/app-event
• Owner: linkorb
• Created: 2019-08-12T13:27:20.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-09-29T11:40:08.000Z (over 2 years ago)
• Last Synced: 2025-02-07T11:50:36.976Z (4 months ago)
• Language: PHP
• Size: 9.77 KB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# linkorb/app-event

This library provides a way for applications to integrate a standard scheme for

logging Application Events.  Specifically, it provides:

-   AppEventFormatter, which:

    - normalises Monolog log records to the structure required for LinkORB

      Application Events and

    - formats the log records as Newline Delimited JSON (ndjson)

-   AppEventLoggerAwareInterface which describes a method (`setAppEventLogger`)

    by which an Application Event Logger may be injected into services and

controllers which need to log Application Events

-   AppEventLoggerInterface which describes a method (`log`) by which services

    may log Application Events

-   AppEventLoggerTrait which provides implementations of

    AppEventLoggerAwareInterface and AppEventLoggerInterface

An example:-

```php

class MyService implements AppEventLoggerAwareInterface,

    AppEventLoggerInterface

{

    use AppEventLoggerTrait;

    public function doSomething()

    {

        // ... do something ...

        $this->log('something.was.done', ['some-info' => '...', 'more' => ...]);

    }

}

```