Skip to content
No description, website, or topics provided.
PHP
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
DependencyInjection
EventListener
Resources/config
Sentry
.gitignore
HautelookSentryBundle.php
LICENSE
README.md
composer.json

README.md

HautelookSentryBundle

Bundle to use hautelook/sentry-client, which is a guzzle based sentry client.

Installation

I recommend to only add the bundle in the production environment

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        ...

        if (in_array($this->getEnvironment(), array('prod'))) {
            $bundles[] = new Hautelook\SentryBundle\HautelookSentryBundle();
        }

        ...
    }
}

Example configuration

hautelook_sentry:
    client_options:
        dsn: %sentry.dsn%

        # you probabled do not want to log 404 exceptions
        ignored_exceptions:
            Symfony\Component\HttpKernel\Exception\NotFoundHttpException: true

        # add customs data/tags
        command:
            params:
                tags: {}

    error_handler: true # enables exception, error, fatal errors capture

    # this will remove delpoyments dates etc from stack traces files
    # without this sentry will fail to group exceptions happening on different capistrano deployments
    files_base_path: %kernel.root_dir%/../

Usage

Enabling the error handler will cover what you want out of this bundle is most cases, however you can capture messages or exception manually:

if ($container->has('hautelook_sentry.client')) {
    $container->get('hautelook_sentry.client')->captureException($e);
    $container->get('hautelook_sentry.client')->capture(array(
        'message' => 'sup ?',
    ));
}

Note that you have to catch yourself any exception that may happen when using the client directly.

Add capistrano revision to exceptions

imports:
    - { resource: revision.php }

hautelook_sentry:
    client_options:
        command:
            params:
                tags:
                    revision: %revision%
<?php
// app/config/revision.php

$revision = 'unknown';
if (file_exists($revisionFile = __DIR__ . '/../../REVISION')) {
    $revision = file_get_contents($revisionFile);
}

$container->setParameter('revision', $revision);

Config reference

# Default configuration for extension with alias: "hautelook_sentry"
hautelook_sentry:
    error_handler:
        enabled:                    false
        exception:                  true
        error:                      true
        fatal_error:                true
        throw_handler_exceptions:   false # By default any exception in the handler will be catched and ignored. Set to true to debug connection errors etc.
    files_base_path:      ~
    client_options:       # Required
        public_key:           ~ # Required
        secret_key:           ~ # Required
        project_id:           ~ # Required
        protocol:             https
        host:                 app.getsentry.com
        path:                 /
        port:                 ~
        dsn:                  ~
        exception_factory:    ~
        request:
            options:              [] # guzzle request options
        curl:
            options:              [] # guzzle curl options
        command:
            params:
                level:                ~
                logger:               ~
                platform:             ~
                tags:                 []
                extra:                []
                server_name:          localhost.localdomain
        ignored_exceptions:   []
You can’t perform that action at this time.