serato/app-events

There is no license information available for the latest version (v1.0.0) of this package.

A PHP library for delivering application event data to external consumers.

v1.0.0 2020-04-09 03:26 UTC

Requires

• php: >=7.1
• monolog/monolog: ^1.0.0
• psr/log: ^1.0.0

Requires (Dev)

• phpstan/phpstan-phpunit: ^0.11.0
• phpunit/phpunit: ~7.0
• squizlabs/php_codesniffer: ~2.0

Unknown License

README

A PHP library for delivering application event data to external consumers.

Installation

To include this library in a PHP project add the following line to the project's composer.json file in the require section:

{
  "require": {
    "serato/app-events": "^1.0.0"
  }
}

See Packagist for a list of all available versions.

Events

Each instrumented event is encapsulated in a model containing set methods for populating the event data. The currently implemented events are:

• Checkout Order completion
• Digital Asset download
• Sera.to redirects
• Software license authorization

Basic usage

Simply create an event model instance and populate it:

use Serato\AppEvents\Event\SeraTo\Redirect;

$event = new Redirect;
$event
    ->setHttpReferrer('http://serato.com/dj')
    ->setClientIp('24.30.52.126')
    ->setUserAgent(
        'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 ' .
        '(KHTML, like Gecko) Chrome/80.0.3987.132 Safari/537.36'
    )
    ->setRedirectId('id-123')
    ->setRedirectName('Manage Subscription')
    ->setRedirectGroup('Serato DJ (app)')
    ->setRedirectShortUrl('sera.to/-b6ap')
    ->setRedirectDestinationUrl('https://account.serato.com/#/subscriptions');

Event target

Event targets are destinations for event data. Currently only Elasticsearch is supported (via Filebeat).

Basic usage

Create the event target instance and pass it an event instance via the sendEvent method.

use Serato\AppEvents\EventTarget\Filebeat;
use Serato\AppEvents\Event\SeraTo\Redirect;

$event = new Redirect;
# Populate $event...

# Create the event target instance.
# Application name is important. ALL events will be tagged with the application name.
$eventTarget = new Filebeat('My App Name', '/path/to/log/file.log');
# Send the event to the target
$eventTarget->sendEvent($event);