File Coverage

blib/lib/Mojolicious/Plugin/ErrorTracking/Sentry.pm

Criterion	Covered	Total	%
statement	51	60	85.0
branch	5	12	41.6
condition	2	7	28.5
subroutine	12	13	92.3
pod	1	1	100.0
total	71	93	76.3

package Mojolicious::Plugin::ErrorTracking::Sentry;
use 5.008001;
use strict;
use warnings;

our $VERSION = '1.1.0';

use Mojo::Base 'Mojolicious::Plugin';

use English '-no_match_vars';
use Data::Dump 'dump';
use Devel::StackTrace;
use Sentry::Raven;

sub register {
	my ( $self, $app, $conf ) = @_;
	my $raven = Sentry::Raven->new(
		environment => $conf->{environment},
		release     => $conf->{release},
		sentry_dsn  => $conf->{sentry_dsn},
		timeout     => $conf->{timeout},
	);

	$app->helper(
		capture_message => sub {
			my ( $self, $data, %p ) = @_;

			$p{level} ||= 'info';
			my $stacktrace = Devel::StackTrace->new( skip_frames => 2 );
			my $context = _make_context( $raven, $self->req, $stacktrace, \%p );
			my $event_id = $raven->capture_message( $data, %$context );
			if ( !defined($event_id) ) {
				die "failed to submit event to sentry service:\n"
					. dump( $raven->_construct_message_event( $data, %$context ) );
			}
		}
	);

	$app->hook(
		around_dispatch => sub {
			my ( $next, $c ) = @_;

			my $stacktrace;
			return if eval {
				local $SIG{__DIE__} = sub { $stacktrace = Devel::StackTrace->new( skip_frames => 1 ) };
				$next->();
				1;
			};

			my $message = my $eval_error = $EVAL_ERROR;
			chomp($message);

			my $custom_context = _build_custom_context( $conf, $c );
			my $context = _make_context( $raven, $c->req, $stacktrace, $custom_context );
			my %exception_context = ( type => ( ref $eval_error ) || 'Mojo::Exception' );
			my $event_id = $raven->capture_exception( $message, %exception_context, %$context );
			if ( !defined($event_id) ) {
				die "failed to submit event to sentry service:\n"
					. dump( $raven->_construct_exception_event( $message, %exception_context, %$context ) );
			}

			# Raise error for Mojolicious
			return ref $eval_error ? CORE::die($eval_error) : Mojo::Exception->throw($eval_error);
		}
	);

	return 1;
} ## end sub register

sub _build_custom_context {
	my ( $conf, $c ) = @_;
	return $conf->{on_error}->($c) if ( $conf->{on_error} && ref( $conf->{on_error} ) eq 'CODE' );
	return {};
}

sub _make_context {
	my ( $raven, $req, $stacktrace, $custom_context ) = @_;
	my %request_context = $raven->request_context(
		$req->url->to_string,
		method  => $req->method,
		data    => $req->params->to_hash,
		headers => { map { $_ => ~~ $req->headers->header($_) } @{ $req->headers->names } },
	);
	my %stacktrace_context
		= $stacktrace ? $raven->stacktrace_context( $raven->_get_frames_from_devel_stacktrace($stacktrace) ) : ();

	return { culprit => $PROGRAM_NAME, %$custom_context, %request_context, %stacktrace_context, };
} ## end sub _make_context

1;
__END__

=encoding utf-8

=head1 NAME

Mojolicious::Plugin::ErrorTracking::Sentry - error tracking plugin for Mojolicious with Sentry

=head1 SYNOPSIS

    # Mojolicious
    $self->plugin('ErrorTracking::Sentry', sentry_dsn => 'http://<publickey>:<secretkey>@app.getsentry.com/<projectid>');

    # Custom error context handling
    use Sentry::Raven;

    $self->plugin('ErrorTracking::Sentry',
        sentry_dsn => 'http://<publickey>:<secretkey>@app.getsentry.com/<projectid>',
        on_error => sub {
            my $c = shift;
            # Make context you want.
            my %user_context = Sentry::Raven->user_context(
                id => $c->stash->{user}->{id},
            );
            return \%user_context; # Must return HashRef.
        },
    );

=head1 DESCRIPTION

Mojolicious::Plugin::ErrorTracking::Sentry is a Mojolicious plugin to send error reports to Sentry.

=head1 CONFIG

=head2 C<< sentry_dsn => 'http://<publickey>:<secretkey>@app.getsentry.com/<projectid>' >>

The DSN for your sentry service.  Get this from the client configuration page for your project.

=head2 C<< timeout => 5 >>

Do not wait longer than this number of seconds when attempting to send an event.

=head2 C<on_error>

You can pass custom error context. For example

    $self->plugin('ErrorTracking::Sentry', on_error => sub {
        my $c = shift;
        return +{
            Sentry::Raven->user_context(id => $c->stash->{id}) ,
        };
    });

=head1 SEE ALSO

=over 4

=item L<Sentry::Raven>

This plugin uses Sentry::Raven.

=back

=head1 AUTHORS

Akira Osada E<lt>[e-mail]<gt>

Andrew Pam E<lt>[e-mail]<gt>

=head1 COPYRIGHT AND LICENSE

Copyright 2017, 2019 Akira Osada and Andrew Pam

Released under the MIT license
http://opensource.org/licenses/mit-license.php

=cut