OpenTelemetry/Instrumentation/DBI.pm

filter: Statementstmt 45.5% 56 / 123 Branchbran 7.6% 2 / 26 Conditioncond 0.0% 0 / 18 MC/DCmcdc 0.0% 0 / 11 Subroutinesub 75.0% 18 / 24 Podpod 66.6% 2 / 3 totaltotal 38.0% 78 / 205 CC 22 SCAR 50.9
CC
22
Cov
35%
__ANON__
380.0
install
11.0
uninstall
3.0
CRAP 161.9
↑ Summary OpenTelemetry/Instrumentation.pm »
1 package OpenTelemetry::Instrumentation::DBI;
2 # ABSTRACT: OpenTelemetry instrumentation for DBI
3  
4 1 our $VERSION = '0.040';
5  
6 1 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
7 1 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
8 1 ▶use experimental 'signatures';
Subroutine BEGIN: called CC=1 SCAR=0.0
9 1 ▶use feature 'state';
Subroutine BEGIN: called CC=1 SCAR=0.0
10  
11 1 ▶use Class::Inspector;
Subroutine BEGIN: called CC=1 SCAR=0.0
12 1 ▶use Class::Method::Modifiers 'install_modifier';
Subroutine BEGIN: called CC=1 SCAR=0.0
13 1 ▶use Feature::Compat::Try;
Subroutine BEGIN: called CC=1 SCAR=0.0
14 1 ▶use OpenTelemetry::Constants qw( SPAN_KIND_CLIENT SPAN_STATUS_ERROR SPAN_STATUS_OK );
Subroutine BEGIN: called CC=1 SCAR=0.0
15 1 ▶use OpenTelemetry::Context;
Subroutine BEGIN: called CC=1 SCAR=0.0
16 1 ▶use OpenTelemetry::Trace;
Subroutine BEGIN: called CC=1 SCAR=0.0
17 1 ▶use OpenTelemetry;
Subroutine BEGIN: called CC=1 SCAR=0.0
18 1 ▶use Scalar::Util 'blessed';
Subroutine BEGIN: called CC=1 SCAR=0.0
19 1 ▶use Syntax::Keyword::Dynamically;
Subroutine BEGIN: called CC=1 SCAR=0.0
20 1 ▶use Feature::Compat::Defer;
Subroutine BEGIN: called CC=1 SCAR=0.0
21  
22 1 ▶use parent 'OpenTelemetry::Instrumentation';
Subroutine BEGIN: called CC=1 SCAR=0.0
23  
24 0 ▶sub dependencies { 'DBI' }
Subroutine dependencies: not called CC=1 SCAR=6.9
Pod documented
25  
26 1 my ( $CONNECT, $EXECUTE, $DO, $loaded );
27 0 ▶sub uninstall ( $class ) {
Subroutine uninstall: not called CC=2 SCAR=10.9
Pod undocumented
28 0 ▶ return unless $loaded;
Branch: 1 branch
BranchTrueFalseTotal
unless $loaded 0 0 0
29 1 ▶ no strict 'refs';
Subroutine BEGIN: called CC=1 SCAR=0.0
30 1 ▶ no warnings 'redefine';
Subroutine BEGIN: called CC=1 SCAR=0.0
31 0 delete $Class::Method::Modifiers::MODIFIER_CACHE{'DBI::st'}{execute};
32 0 *{'DBI::st::execute'} = $EXECUTE;
33 0 *{'DBI::db::do'} = $DO;
34 0 undef $loaded;
35 0 return;
36 }
37  
38 1 ▶sub install ( $class, %options ) {
Subroutine install: called CC=3 SCAR=24.0
Pod documented
39 1 ▶ return if $loaded;
Branch: 1 branch
BranchTrueFalseTotal
if $loaded 0 1 1
40 1 ▶ return unless Class::Inspector->loaded('DBI');
Branch: 1 branch
BranchTrueFalseTotal
unless "Class::Inspector"->loaded("DBI") 1 0 1
41  
42 0 ▶ my $wrapper = sub ( $opts, $orig, $invokant, @args ) {
Subroutine __ANON__: not called CC=19 SCAR=59.4
43 # from https://opentelemetry.io/docs/specs/semconv/registry/attributes/db/#db-system-name
44 0 state %system_name = (
45 Pg => 'postgresql',
46 PgAsync => 'postgresql',
47 mysql => 'mysql',
48 Oracle => 'oracle.db',
49 SQLite => 'sqlite',
50 MariaDB => 'mariadb',
51 Cassandra => 'cassandra',
52 Sybase => 'microsoft.sql_server',
53 );
54  
55 0 state %meta;
56  
57 0 ▶ my $name = $opts->{dbh}{name} // '';
Condition0%0/2
$opts->{"dbh"}{"name"} // ""
l!l
00
MC/DC0%0/1
$opts->{"dbh"}{"name"} // ""
$opts->{"dbh"}{"name"}
Truth table0%0/2
A
A= $opts->{"dbh"}{"name"}
Aresult
11
00
58  
59 0 ▶ my $info = $meta{$name} //= do {
Condition0%0/3
$meta{$name} //= do { my %meta; if (my $system_name = $system_name{$opts->{"dbh"}{"driver"} // ""}) { $meta{"db.system.name"} = $system_name; } ; $meta{"server.address"} = $1 if $name =~ /host=([^;]+)/; $meta{"server.port"} = $1 if $name =~ /port=([0-9]+)/; if (($meta{"db.system.name"} // "") eq "mysql") { $meta{"network.transport"} = "IP.TCP"; } ; \%meta }
l!l&&r!l&&!r
000
MC/DC0%0/2
$meta{$name} //= do { my %meta; if (my $system_name = $system_name{$opts->{"dbh"}{"driver"} // ""}) { $meta{"db.system.name"} = $system_name; } ; $meta{"server.address"} = $1 if $name =~ /host=([^;]+)/; $meta{"server.port"} = $1 if $name =~ /port=([0-9]+)/; if (($meta{"db.system.name"} // "") eq "mysql") { $meta{"network.transport"} = "IP.TCP"; } ; \%meta }
$meta{$name} do { my %meta; if (my $system_name = $system_name{$opts->{"dbh"}{"driver"} // ""}) { $meta{"db.system.name"} = $system_name; } ; $meta{"server.address"} = $1 if $name =~ /host=([^;]+)/; $meta{"server.port"} = $1 if $name =~ /port=([0-9]+)/; if (($meta{"db.system.name"} // "") eq "mysql") { $meta{"network.transport"} = "IP.TCP"; } ; \%meta }
Truth table0%0/3
A //= B
A= $meta{$name}B= do { my %meta; if (my $system_name = $system_name{$opts->{"dbh"}{"driver"} // ""}) { $meta{"db.system.name"} = $system_name; } ; $meta{"server.address"} = $1 if $name =~ /host=([^;]+)/; $meta{"server.port"} = $1 if $name =~ /port=([0-9]+)/; if (($meta{"db.system.name"} // "") eq "mysql") { $meta{"network.transport"} = "IP.TCP"; } ; \%meta }
ABresult
1X1
011
000
60 0 my %meta;
61  
62 0 ▶ if ( my $system_name = $system_name{ $opts->{dbh}{driver} // '' } ) {
Branch: 1 branch
BranchTrueFalseTotal
if (my $system_name = $system_name{$opts->{"dbh"}{"driver"} // ""}) 0 0 0
Condition0%0/2
$opts->{"dbh"}{"driver"} // ""
l!l
00
MC/DC0%0/1
$opts->{"dbh"}{"driver"} // ""
$opts->{"dbh"}{"driver"}
Truth table0%0/2
A
A= $opts->{"dbh"}{"driver"}
Aresult
11
00
63 0 $meta{'db.system.name'} = $system_name;
64 }
65  
66 0 ▶ $meta{'server.address'} = $1 if $name =~ /host=([^;]+)/;
Branch: 1 branch
BranchTrueFalseTotal
if $name =~ /host=([^;]+)/ 0 0 0
67 0 ▶ $meta{'server.port'} = $1 if $name =~ /port=([0-9]+)/;
Branch: 1 branch
BranchTrueFalseTotal
if $name =~ /port=([0-9]+)/ 0 0 0
68  
69 # Driver-specific metadata available before call
70 0 ▶ if ( ( $meta{'db.system.name'} // '' ) eq 'mysql' ) {
Branch: 1 branch
BranchTrueFalseTotal
if (($meta{"db.system.name"} // "") eq "mysql") 0 0 0
Condition0%0/2
$meta{"db.system.name"} // ""
l!l
00
MC/DC0%0/1
$meta{"db.system.name"} // ""
$meta{"db.system.name"}
Truth table0%0/2
A
A= $meta{"db.system.name"}
Aresult
11
00
71 0 $meta{'network.transport'} = 'IP.TCP';
72 }
73  
74 0 \%meta;
75 };
76  
77 0 for ( $opts->{statement} ) {
78 0 ▶ last unless $_;
Branch: 1 branch
BranchTrueFalseTotal
unless $_ 0 0 0
79 0 s/^\s+|\s+$//g;
80 0 s/\s+/ /g;
81 }
82  
83 0 ▶ $opts->{name} //= substr( $opts->{statement}, 0, 100 ) =~ s/\s+$//r;
Condition0%0/3
$opts->{"name"} //= substr($opts->{"statement"}, 0, 100) =~ s/\s+$//r
l!l&&r!l&&!r
000
MC/DC0%0/2
$opts->{"name"} //= substr($opts->{"statement"}, 0, 100) =~ s/\s+$//r
$opts->{"name"} substr($opts->{"statement"}, 0, 100) =~ s/\s+$//r
Truth table0%0/3
A //= B
A= $opts->{"name"}B= substr($opts->{"statement"}, 0, 100) =~ s/\s+$//r
ABresult
1X1
011
000
84  
85 my $span = OpenTelemetry->tracer_provider->tracer->create_span(
86 name => $opts->{name},
87 kind => SPAN_KIND_CLIENT,
88 attributes => {
89 0 ▶ $opts->{statement} ? ( 'db.statement' => $opts->{statement} ) : (),
Branch: 1 branch
BranchTrueFalseTotal
$opts->{'statement'} ? : 0 0 0
90 %$info,
91 },
92 );
93  
94 0 defer { $span->end }
95  
96 0 dynamically OpenTelemetry::Context->current
97 = OpenTelemetry::Trace->context_with_span($span);
98  
99 0 my $errstr;
100 0 try {
101 0 ▶ if ( $opts->{name} eq 'connect' ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($opts->{"name"} eq "connect") 0 0 0
102 0 my $dbh = $invokant->$orig(@args);
103 0 ▶ $errstr = $DBI::errstr unless $dbh;
Branch: 1 branch
BranchTrueFalseTotal
unless $dbh 0 0 0
104 0 return $dbh;
105 }
106  
107 0 return $invokant->$orig(@args);
108 }
109 catch ( $error ) {
110 0 my ($description) = split /\n/, $error =~ s/^\s+|\s+$//gr, 2;
111 0 $description =~ s/ at \S+ line \d+\.$//a;
112  
113 0 $span->record_exception($error);
114 0 $span->set_status( SPAN_STATUS_ERROR, $description );
115  
116 0 die $error;
117 }
118 finally {
119 0 ▶ $errstr ||= $invokant->errstr
Branch: 1 branch
BranchTrueFalseTotal
if builtin::blessed($invokant) and $invokant->err 0 0 0
Condition0%0/6
builtin::blessed($invokant) and $invokant->err
!ll&&!rl&&r
000
$errstr ||= $invokant->errstr
l!l&&r!l&&!r
000
MC/DC0%0/2
builtin::blessed($invokant) and $invokant->err
builtin::blessed($invokant) $invokant->err
MC/DC0%0/2
$errstr ||= $invokant->errstr
$errstr $invokant->errstr
Truth table0%0/3
A and B
A= builtin::blessed($invokant)B= $invokant->err
ABresult
0X0
100
111
Truth table0%0/3
A ||= B
A= $errstrB= $invokant->errstr
ABresult
1X1
011
000
120 if blessed $invokant && $invokant->err;
121  
122 0 ▶ if ( $errstr ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($errstr) { } 0 0 0
123 0 $errstr =~ s/^\s+|\s+$//g;
124  
125 0 my ($description) = split /\n/, $errstr, 2;
126 0 $description =~ s/ at \S+ line \d+\.$//a;
127  
128 0 $span->set_status( SPAN_STATUS_ERROR, $description );
129 }
130 else {
131 0 $span->set_status( SPAN_STATUS_OK );
132 }
133 }
134 0 };
135  
136 0 $CONNECT = \&DBI::connect;
137 0 ▶ install_modifier 'DBI' => around => connect => sub {
Subroutine __ANON__: not called CC=1 SCAR=6.9
138 0 my ( undef, undef, $dsn ) = @_;
139  
140 # this might fail and return an empty list which is ok, in that case keep
141 # continuing and don't populate the span attributes
142 0 my ( undef, $driver, undef, undef, $driver_dsn ) = DBI->parse_dsn($dsn);
143  
144 0 unshift @_, {
145 name => 'connect',
146 dbh => {
147 driver => $driver,
148 name => $driver_dsn,
149 },
150 };
151  
152 0 goto $wrapper;
153 0 };
154  
155 0 $EXECUTE = \&DBI::st::execute;
156 0 ▶ install_modifier 'DBI::st' => around => execute => sub {
Subroutine __ANON__: not called CC=1 SCAR=6.9
157 0 my ( undef, $sth ) = @_;
158 unshift @_, {
159 dbh => {
160 driver => $sth->{Database}{Driver}{Name},
161 name => $sth->{Database}{Name},
162 },
163 statement => $sth->{Statement},
164 0 };
165  
166 0 goto $wrapper;
167 0 };
168  
169 0 $DO = \&DBI::st::do;
170 0 ▶ install_modifier 'DBI::db' => around => do => sub {
Subroutine __ANON__: not called CC=1 SCAR=6.9
171 0 my ( undef, $dbh, $sql ) = @_;
172 unshift @_, {
173 dbh => {
174 driver => $dbh->{Driver}{Name},
175 name => $dbh->{Name},
176 },
177 0 statement => $sql,
178 };
179  
180 0 goto $wrapper;
181 0 };
182  
183 0 return $loaded = 1;
184 }
185  
186 1 1;
↑ Summary OpenTelemetry/Instrumentation.pm »