braune-digital/pitcher-bundle

Pitcher bundle

BrauneDigitalPitcherBundle

, _(*1)

Pitcher App (http://www.pitcher-app.com) is a webservice which allows you to easily send exceptions from your project. In contrast to classical monitoring webservices, Pitcher is able to pitch individual exceptions from projects, where Pitcher is acting like a satellite whith communicates which ground control. Register now at pitcher-app.com and create your project. After receiving the secret, the next step is installing the PHP component (or Bundle in case of using Symfony) and linking the satellite by defining the secret., _(*2)

This bundle integrates the Pitcher component (https://github.com/braune-digital/BrauneDigitalPitcher) into the Symfony framework. It allows you to define parameters in your configuration and serves with a simple service for sending notifications to Pitcher., _(*3)

Installation

Require the bundle with composer:, _(*4)

composer require braune-digital/pitcher-bundle

Now you can add the bundle to AppKernel.php:, _(*5)

<?php

use Symfony\Component\HttpKernel\Kernel;
use Symfony\Component\Config\Loader\LoaderInterface;

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            ...
            new BrauneDigital\PitcherBundle\BrauneDigitalPitcherBundle(),
            ...
        );
        ...
        return $bundles;
    }
    ...
}

Configuration

Paste this configuration into your config.yml and add edit your parameters.yml (and parameters.yml.dist in case you are going to deploy your app):, _(*6)

imports:
    - { resource: @BrauneDigitalPitcherBundle/Resources/config/config.yml }

parameters:
    ...
    braune_digital_pitcher.secret: SECRET_FROM PITCHER_APP // www.pitcher-app.com
    braune_digital_pitcher.satellite_name: YOU_ARE_FREE_TO_CHOOSE_A_NAME // for example: Projekt1

After that step you are ready to use the pitcher client. For testing your configuration you can use the pitcher:send_message command., _(*7)

Using the client service

If the service container is available in your class you are able to use the service and pitch errors to Pitcher App., _(*8)

$this->getContainer()->get('pitcher.client')->pitch(Notification::LEVEL_CRITICAL, 'XML API from server B is down');