PHPackages open-telemetry/opentelemetry-sqlcommenter - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Logging & Monitoring](/categories/logging) 4. / 5. open-telemetry/opentelemetry-sqlcommenter ActiveLibrary[Logging & Monitoring](/categories/logging) open-telemetry/opentelemetry-sqlcommenter ========================================= OpenTelemetry sqlcommenter. 0.2.0(1mo ago)08.2k—5.5%Apache-2.0PHPPHP ^8.1 Since Oct 5Pushed 1mo agoCompare [ Source](https://github.com/opentelemetry-php/contrib-sqlcommenter)[ Packagist](https://packagist.org/packages/open-telemetry/opentelemetry-sqlcommenter)[ Docs](https://opentelemetry.io/docs/languages/php/)[ RSS](/packages/open-telemetry-opentelemetry-sqlcommenter/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (2)Dependencies (28)Versions (3)Used By (0) [![Releases](https://camo.githubusercontent.com/46e38a504120203bf7615645011bcf2bb834e03e8eb0bc8e0f4864c729fd5baf/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f72656c65617365732d707572706c65)](https://github.com/opentelemetry-php/contrib-sqlcommenter/releases)[![Issues](https://camo.githubusercontent.com/b9b31135f113cdb6e2b662b4040276044ee0803567bc17688eaf4386f797ea50/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6973737565732d70696e6b)](https://github.com/open-telemetry/opentelemetry-php/issues)[![Source](https://camo.githubusercontent.com/e27dd1126a60abf1c26521d893d9f235ef342a76231c2428ddbc4651185bd626/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f736f757263652d636f6e747269622d677265656e)](https://github.com/open-telemetry/opentelemetry-php-contrib/tree/main/src/SqlCommenter)[![Mirror](https://camo.githubusercontent.com/2f9050293ab0c0d9471e618215bc7417a63b6873c960e1605bddb69b1911fa4c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6d6972726f722d6f70656e74656c656d657472792d2d7068702d2d636f6e747269622d626c7565)](https://github.com/opentelemetry-php/contrib-sqlcommenter)[![Latest Version](https://camo.githubusercontent.com/367ba31c4c710fc2dedd3c0bac32f65530c8683de2cf3e158e0d0b98d58cda52/687474703a2f2f706f7365722e707567782e6f72672f6f70656e2d74656c656d657472792f6f70656e74656c656d657472792d73716c636f6d6d656e7465722f762f756e737461626c65)](https://packagist.org/packages/open-telemetry/opentelemetry-sqlcommenter/)[![Stable](https://camo.githubusercontent.com/0729606f361934e5b29f607e399c4482a4b30b2a523b7f0eec0ddb88f436e5f6/687474703a2f2f706f7365722e707567782e6f72672f6f70656e2d74656c656d657472792f6f70656e74656c656d657472792d73716c636f6d6d656e7465722f762f737461626c65)](https://packagist.org/packages/open-telemetry/opentelemetry-sqlcommenter/) > **Note:** This is a read-only subtree split of [open-telemetry/opentelemetry-php-contrib](https://github.com/open-telemetry/opentelemetry-php-contrib). OpenTelemetry SQL Commenter =========================== [](#opentelemetry-sql-commenter) OpenTelemetry SQL Commenter for PHP provides a [SqlCommenter](https://opentelemetry.io/docs/specs/semconv/database/database-spans/#sql-commenter) implementation, enabling you to inject trace and context comments into SQL queries for enhanced observability and distributed tracing. Installation ------------ [](#installation) Install via Composer: ``` composer require open-telemetry/opentelemetry-sqlcommenter ``` Usage ----- [](#usage) Inject comments into your SQL query as follows: ``` use OpenTelemetry\SqlCommenter\SqlCommenter; $comments = [ 'traceparent' => '00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00', 'custom' => 'value', ]; $query = SqlCommenter::inject($query, $comments); ``` Configuration ------------- [](#configuration) - **Context Propagators** Set the propagators to use (comma-separated): ``` OTEL_PHP_SQLCOMMENTER_CONTEXT_PROPAGATORS=tracecontext ``` Default: `''` - **SQL Commenter Attribute** Add SQL comments to `DbAttributes::DB_QUERY_TEXT` in span attributes: ``` otel.sqlcommenter.attribute = true ``` or via environment variable: ``` OTEL_PHP_SQLCOMMENTER_ATTRIBUTE=true ``` Default: `false` - **Prepend Comments** Prepend comments to the query statement using either a configuration directive: ``` otel.sqlcommenter.prepend = true ``` or via environment variable: ``` OTEL_PHP_SQLCOMMENTER_PREPEND=true ``` Default: `false` Development ----------- [](#development) Install dependencies and run tests from the `SqlCommenter` subdirectory: ``` composer install ./vendor/bin/phpunit tests ``` ### Health Score 42 — FairBetter than 90% of packages Maintenance89 Actively maintained with recent releases Popularity26 Limited adoption so far Community11 Small or concentrated contributor base Maturity35 Early-stage or recently created project Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~170 days Total 2 Last Release 55d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/4978962?v=4)[Brett McBride](/maintainers/brettmc)[@brettmc](https://github.com/brettmc) ![](https://avatars.githubusercontent.com/u/4099109?v=4)[Bob Strecansky](/maintainers/bobstrecansky)[@bobstrecansky](https://github.com/bobstrecansky) --- Top Contributors [![bobstrecansky](https://avatars.githubusercontent.com/u/4099109?v=4)](https://github.com/bobstrecansky "bobstrecansky (1 commits)")[![jerrytfleung](https://avatars.githubusercontent.com/u/8791493?v=4)](https://github.com/jerrytfleung "jerrytfleung (1 commits)")[![pieterocp](https://avatars.githubusercontent.com/u/68863060?v=4)](https://github.com/pieterocp "pieterocp (1 commits)")[![renovate[bot]](https://avatars.githubusercontent.com/in/2740?v=4)](https://github.com/renovate[bot] "renovate[bot] (1 commits)") --- Tags opentelemetryotelopen-telemetrysqlcommenter ### Code Quality TestsPHPUnit Static AnalysisPHPStan, Psalm Code StylePHP CS Fixer Type Coverage Yes ### Embed Badge ![Health badge](/badges/open-telemetry-opentelemetry-sqlcommenter/health.svg) ``` [![Health](https://phpackages.com/badges/open-telemetry-opentelemetry-sqlcommenter/health.svg)](https://phpackages.com/packages/open-telemetry-opentelemetry-sqlcommenter) ``` ### Alternatives [open-telemetry/sdk SDK for OpenTelemetry PHP. 2322.9M248](/packages/open-telemetry-sdk)[open-telemetry/opentelemetry-auto-symfony OpenTelemetry auto-instrumentation for Symfony 551.2M1](/packages/open-telemetry-opentelemetry-auto-symfony)[open-telemetry/opentelemetry-auto-pdo OpenTelemetry auto-instrumentation for PDO 111.2M1](/packages/open-telemetry-opentelemetry-auto-pdo)[open-telemetry/opentelemetry-auto-wordpress OpenTelemetry auto-instrumentation for Wordpress 17166.0k](/packages/open-telemetry-opentelemetry-auto-wordpress) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)