/ 
OpenTracing-AutoScope-0.101.0
River stage one • 1 direct dependent • 1 total dependent
/ OpenTracing::WrapScope

NAME

OpenTracing::WrapScope - Automatically add spans to selected subroutines

SYNOPSIS

 use OpenTracing::WrapScope qw/foo Foo::bar/;
 use Foo;
   
 sub foo { ... }

 package Foo {
     sub bar { ... }
 }

or:

use OpenTracing::WrapScope;

OpenTracing::WrapScope::install_wrapped('foo');
OpenTracing::WrapScope::install_wrapped('Foo::Bar');

which is roughly equivalent to:

use OpenTracing::AutoScope;

sub foo {
    OpenTracing::AutoScope->start_guarded_span();
    ...
}

package Foo {
    sub bar {
        OpenTracing::AutoScope->start_guarded_span();
        ...
    }
}

IMPORT ARGUMENTS

import takes subroutine names as arguments, these need to be fully qualified if they are not in the current package. All specified subroutines will have spans attached to them. Context and caller frames will be preserved.

The following tags will be automatically added to each span:

caller.file - filename where the subroutine was called
caller.line - line number on which the subroutine was called
caller.package - the calling package
caller.subname - the name of the calling subroutine (won't be added if there is none)
source.file - filename where the subroutine is defined
source.line - line on which the subroutine is defined
source.package - package in which the subroutine is located
source.subname - the name of the subroutine

Additionally, if a wrapped subroutine dies, an additional error tag, containing the error message ($@) will be added to the span.

FUNCTIONS

install_wrapped($sub)

Replaces the specified subroutine with a span-handling version. $sub needs to be a fully qualified subroutine name or an unqualified name from the current package. The subroutine needs to be defined or a warning will be thrown. This warning can be made fatal with:

use warnings FATAL => 'OpenTracing::WrapScope';

or disabled with:

no warnings 'OpenTracing::WrapScope';

wrapped($code_ref)

Returns a version of the given code reference with span handling attached. Useful for adding spans to anonymous subroutines.

CAVEATS

caller

Because this module overrides caller, it's best to use it as soon as possible, before caller-using code is compiled. It likely won't work well with other modules which override caller themselves.

Exporter

Subroutines exported using Exporter or a similar module could split into two versions. If the export happens before the span handling is applied to a subroutine, only the original version will have a span, the exported version will be unmodified.

In order to wrap subroutines in modules utilising Exporter, use OpenTracing::WrapScope directly in those modules.

AUTHOR

Szymon Nieznanski <snieznanski@perceptyx.com>

COPYRIGHT AND LICENSE

'OpenTracing::WrapScope' is Copyright (C) 2020, Perceptyx Inc

This library is free software; you can redistribute it and/or modify it under the terms of the Artistic License 2.0.

This package is distributed in the hope that it will be useful, but it is provided "as is" and without any express or implied warranties.

For details, see the full text of the license in the file LICENSE.