Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/auxmoney/opentracingbundle-doctrine-dbal
Doctrine extension for the auxmoney/OpentracingBundle-core
https://github.com/auxmoney/opentracingbundle-doctrine-dbal
auxmoney dbal distributed-tracing doctrine opentracing opentracing-bundle symfony symfony-bundle
Last synced: about 2 months ago
JSON representation
Doctrine extension for the auxmoney/OpentracingBundle-core
- Host: GitHub
- URL: https://github.com/auxmoney/opentracingbundle-doctrine-dbal
- Owner: auxmoney
- License: mit
- Created: 2020-01-26T15:09:34.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-06T20:08:46.000Z (2 months ago)
- Last Synced: 2024-11-15T22:14:21.783Z (about 2 months ago)
- Topics: auxmoney, dbal, distributed-tracing, doctrine, opentracing, opentracing-bundle, symfony, symfony-bundle
- Language: PHP
- Size: 271 KB
- Stars: 3
- Watchers: 5
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# auxmoney OpentracingBundle - Doctrine DBAL
[](https://github.com/auxmoney/OpentracingBundle-Doctrine-DBAL/actions?query=workflow%3Atest)
[](https://github.com/auxmoney/OpentracingBundle-Doctrine-DBAL/releases/latest)
This bundle adds automatic spanning for Doctrine DBAL connections to the [OpentracingBundle](https://github.com/auxmoney/OpentracingBundle-core).
## Installation
### Prerequisites
This bundle is only an additional plugin and should not be installed independently. See
[its documentation](https://github.com/auxmoney/OpentracingBundle-core#installation) for more information on installing the OpentracingBundle first.
### Require dependencies
After you have installed the OpentracingBundle:
* require the dependencies:
```bash
composer req auxmoney/opentracing-bundle-doctrine-dbal
```
### Enable the bundle
If you are using [Symfony Flex](https://github.com/symfony/flex), you are all set!
If you are not using it, you need to manually enable the bundle:
* add bundle to your application:
```php
# Symfony 3: AppKernel.php
$bundles[] = new Auxmoney\OpentracingDoctrineDBALBundle\OpentracingDoctrineDBALBundle();
```
```php
# 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](#limitations) |
| 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](#limitations) |
| 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](https://www.php.net/manual/en/pdostatement.rowcount.php) 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
```bash
composer run-script quality
```
every time before you push code changes. The tools run by this script are also run in the CI pipeline.