auxmoney/opentracingbundle-doctrine-dbal

Doctrine extension for the auxmoney/OpentracingBundle-core

auxmoney OpentracingBundle - Doctrine DBAL

This bundle adds automatic spanning for Doctrine DBAL connections to the OpentracingBundle.

Installation

Prerequisites

This bundle is only an additional plugin and should not be installed independently. See its documentation for more information on installing the OpentracingBundle first.

Require dependencies

After you have installed the OpentracingBundle:

• require the dependencies:

    composer req auxmoney/opentracing-bundle-doctrine-dbal

Enable the bundle

If you are using Symfony Flex, you are all set!

If you are not using it, you need to manually enable the bundle:

• add bundle to your application:

    # Symfony 3: AppKernel.php
    $bundles[] = new Auxmoney\OpentracingDoctrineDBALBundle\OpentracingDoctrineDBALBundle();

    # Symfony 4+: bundles.php
    Auxmoney\OpentracingDoctrineDBALBundle\OpentracingDoctrineDBALBundle::class => ['all' => true],

Configuration

You can optionally configure environment variables, however, the default configuration will run fine out of the box for most DBAL based applications. If you cannot change environment variables in your project, you can alternatively overwrite the container parameters directly.

environment variable	container parameter	type	default	description
AUXMONEY_OPENTRACING_DOCTRINE_FULL_STATEMENT	auxmoney_opentracing.doctrine.tag_full_statement	string	true	whether to add a tag with the full SQL statement to the span
AUXMONEY_OPENTRACING_DOCTRINE_PARAMETERS	auxmoney_opentracing.doctrine.tag_parameters	string	true	whether to add a tag with the statement parameters to the span
AUXMONEY_OPENTRACING_DOCTRINE_ROW_COUNT	auxmoney_opentracing.doctrine.tag_row_count	string	false	whether to add a tag with the affected / returned rows to the span; see limitations section
AUXMONEY_OPENTRACING_DOCTRINE_USER	auxmoney_opentracing.doctrine.tag_user	string	false	whether to add a tag with the connection username to the span

Hint: you can use true, on, yes or 1 to enable an environment variable.

Usage

When querying databases using Doctrine DBAL (or higher level packages like Doctrine ORM), spans reflecting these queries are automatically generated and added to the trace. The generated tags can contain:

tag name	contains
db.statement	the executed statement
db.parameters	the parameters of the executed statement, if present
db.row_count	affected / returned rows of the executed statement; see limitations section
db.user	the username of the decorated DBAL connection

Limitations

• db.row_count: the correctness of this value depends heavily on the implementation of the Doctrine\DBAL\Driver\Statement of the driver for the database. For example, if you are using a PDO driver, keep in mind: "For most databases, PDOStatement::rowCount() does not return the number of rows affected by a SELECT statement.". See the official PHP documentation for more information on this particular topic. If you are getting different results than expected, consult the documentation for the used driver.

Development

Be sure to run

    composer run-script quality

every time before you push code changes. The tools run by this script are also run in the CI pipeline.

opentracingbundle-doctrine-dbal's Issues

Support for doctrine/dbal 3

Currently it is not possible to install that bundle with doctrine/dbal 3. Can you add support for that?

- auxmoney/opentracing-bundle-doctrine-dbal v1.2.3 requires doctrine/dbal ^2.11 -> found doctrine/dbal[2.11.0, ..., 2.13.9] but the package is fixed to 3.6.2 (lock file version) by a partial update and that version does not match.

Factory initiates the connection instead of just creating it

Here the call to $connection->getWrappedConnection() initiates the connection, whereas the factory should only create it :

OpentracingBundle-Doctrine-DBAL/DBAL/TracingConnectionFactory.php

Lines 46 to 51 in b746433

	$driverConnection = new TracingDriverConnection(
	$connection->getWrappedConnection(),
	$this->tracing,
	$this->spanFactory,
	$connection->getUsername()
	);

This is an issue as a code creating a connection with invalid params should be safe until it uses it.
With this implementation it's not the case anymore, the createConnection method should delay connection later.

Here is the code of doctrine that initiates the connection :
https://github.com/doctrine/dbal/blob/01143c9cd4fc360a6e42017902fd9b591ca706bb/lib/Doctrine/DBAL/Connection.php#L1230-L1237

create spans only for statements running longer than x milliseconds

When using Doctrine ORM ind 3rd party frameworks like OroCRM, you can easily end up with hundreds of queries in older applications. Generating spans for all of these queries is possible, but not always desired.

Instead, having the possibility to ignore "faster" statements might sometimes help focusing on the issues that matter. Therefore, we would like to add a threshold for spans that run longer than a given time.

Unfortunately, due to jukylin/jaeger-php#85 , we are right now not able to implement this tracer agnostic. Depending on the outcome of the mentioned issue, we should revisit this feature request later.

Could you expose the inner statement ?

OpentracingBundle-Doctrine-DBAL/DBAL/TracingStatement.php

Line 19 in 853dd73

private $statement;

We would need to access the inner statement, as our code sometimes depends on the statement being a PDOStatetment.

Would it be ok to introduce a method to give access to the underlying statement ?

Of course the calls made directly to the underlying statement won't be traced.

Can i use core 0.6.2 with doctrine-dbal 0.2.2 ?

OpentracingBundle-Doctrine-DBAL/composer.json

Line 20 in 1edab8d

"auxmoney/opentracing-bundle-core": "^0.5",

@cawolf Sorry if this is a stupid question but is it possible to use core 0.6.2 with doctrine-dbal 0.2.2 ?

[BC Break] 2.10.1 to v2.10.2: PDOStatement::convertParamType() must be of the type int, null given

Hello

I am opening an issue on this repo due to this one doctrine/dbal#3976

We do have a bc break behaviour when upgrading doctrine/dbal from 2.10.1 to v2.10.2

But it occurs only when this bundle is enabled, otherwise code works fine

Do you know what can be the reason?

Many thanks