File Coverage

blib/lib/DBIx/OpenTracing/Constants.pm

Criterion	Covered	Total	%
statement	18	18	100.0
branch			n/a
condition			n/a
subroutine	6	6	100.0
pod			n/a
total	24	24	100.0

package DBIx::OpenTracing::Constants;
use strict;
use warnings;
use parent 'Exporter';
use Package::Constants;

use constant {
    DB_TAG_TYPE           => 'db.type',
    DB_TAG_SQL            => 'db.statement',
    DB_TAG_SQL_SUMMARY    => 'db.statement_summary',
    DB_TAG_BIND           => 'db.bind_values',
    DB_TAG_USER           => 'db.user',
    DB_TAG_DBNAME         => 'db.instance',
    DB_TAG_ROWS           => 'db.rows',
    DB_TAG_CALLER_SUB     => 'caller.subname',
    DB_TAG_CALLER_FILE    => 'caller.file',
    DB_TAG_CALLER_LINE    => 'caller.line',
    DB_TAG_CALLER_PACKAGE => 'caller.package',
};

use constant DB_TAGS_ALL => (
    DB_TAG_TYPE,
    DB_TAG_SQL,         DB_TAG_SQL_SUMMARY,
    DB_TAG_BIND,        DB_TAG_USER,
    DB_TAG_DBNAME,      DB_TAG_ROWS,
    DB_TAG_CALLER_SUB,  DB_TAG_CALLER_FILE,
    DB_TAG_CALLER_LINE, DB_TAG_CALLER_PACKAGE,
);

our @EXPORT_OK   = Package::Constants->list(__PACKAGE__);
our %EXPORT_TAGS = (ALL => \@EXPORT_OK);

1;
__END__
=pod

=head1 NAME

DBIx::OpenTracing::Constants - name for use with DBIx::OpenTracing

=head1 SYNOPSIS

    use DBIx::OpenTracing::Constants ':ALL';

    DBIx::OpenTracing->hide_tags(DB_TAG_SQL);

=head1 EXPORTED CONSTANTS

This module exports the following constants
(C<:ALL> tag is supported to get them all):

=over 4

=item DB_TAG_TYPE

The database type (usually "sql").

=item DB_TAG_SQL

The SQL statement of the current query.

=item DB_TAG_BIND

Bind values of the current query.

=item DB_TAG_USER

Username used to connect to database.

=item DB_TAG_DBNAME

The database name.

=item DB_TAG_ROWS

Number of rows returned by the query.

=item DB_TAGS_ALL

A list with all possible tag names.

=back

=cut