auto-instrumentation registration

brettmc commented 1 month ago

porting Nevay's PoC registering auto-instrumentation packages via SPI with file-based config.
extend to support auto-loading:
- use the not-yet-released v0.3 of file-based configuration (which combines SDK and instrumentation config)
- The existence of the OTEL_EXPERIMENTAL_CONFIG_FILE defines where the SDK config file resides (relative to CWD), and also acts as a trigger to autoload via SPI rather than our current env-based version
- move single-use code (create hook manager + config parsing + actual registration) into classes
- support general instrumentation config (which is described in the file-based config spec)
- support map-based array-like config (which is used by instrumentation configuration)

todo:

[x] SDK autoloader should use noop hook manager if opentelemetry extension not available

codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 51.32075% with 129 lines in your changes missing coverage. Please review.

Project coverage is 74.27%. Comparing base (a822c45) to head (d1b1f6f).

Additional details and impacted files

[![Impacted file tree graph](https://app.codecov.io/gh/open-telemetry/opentelemetry-php/pull/1304/graphs/tree.svg?width=650&height=150&src=pr&token=OE661REHqm&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-telemetry)](https://app.codecov.io/gh/open-telemetry/opentelemetry-php/pull/1304?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-telemetry) ```diff @@ Coverage Diff @@ ## main #1304 +/- ## ============================================ - Coverage 74.54% 74.27% -0.27% - Complexity 2504 2563 +59 ============================================ Files 355 371 +16 Lines 7180 7383 +203 ============================================ + Hits 5352 5484 +132 - Misses 1828 1899 +71 ``` | [Flag](https://app.codecov.io/gh/open-telemetry/opentelemetry-php/pull/1304/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-telemetry) | Coverage Δ | | |---|---|---| | [8.1](https://app.codecov.io/gh/open-telemetry/opentelemetry-php/pull/1304/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-telemetry) | `73.92% <51.32%> (-0.38%)` | :arrow_down: | | [8.2](https://app.codecov.io/gh/open-telemetry/opentelemetry-php/pull/1304/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-telemetry) | `74.11% <51.32%> (-0.40%)` | :arrow_down: | | [8.3](https://app.codecov.io/gh/open-telemetry/opentelemetry-php/pull/1304/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-telemetry) | `74.11% <51.32%> (-0.40%)` | :arrow_down: | | [8.4](https://app.codecov.io/gh/open-telemetry/opentelemetry-php/pull/1304/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-telemetry) | `74.15% <51.32%> (-0.39%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-telemetry#carryforward-flags-in-the-pull-request-comment) to find out more. | [Files](https://app.codecov.io/gh/open-telemetry/opentelemetry-php/pull/1304?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-telemetry) | Coverage Δ | | |---|---|---| | [src/API/Globals.php](https://app.codecov.io/gh/open-telemetry/opentelemetry-php/pull/1304?src=pr&el=tree&filepath=src%2FAPI%2FGlobals.php&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-telemetry#diff-c3JjL0FQSS9HbG9iYWxzLnBocA==) | `100.00% <100.00%> (+5.88%)` | :arrow_up: | | [...tion/AutoInstrumentation/ConfigurationRegistry.php](https://app.codecov.io/gh/open-telemetry/opentelemetry-php/pull/1304?src=pr&el=tree&filepath=src%2FAPI%2FInstrumentation%2FAutoInstrumentation%2FConfigurationRegistry.php&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-telemetry#diff-c3JjL0FQSS9JbnN0cnVtZW50YXRpb24vQXV0b0luc3RydW1lbnRhdGlvbi9Db25maWd1cmF0aW9uUmVnaXN0cnkucGhw) | `100.00% <100.00%> (ø)` | | | [...PI/Instrumentation/AutoInstrumentation/Context.php](https://app.codecov.io/gh/open-telemetry/opentelemetry-php/pull/1304?src=pr&el=tree&filepath=src%2FAPI%2FInstrumentation%2FAutoInstrumentation%2FContext.php&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-telemetry#diff-c3JjL0FQSS9JbnN0cnVtZW50YXRpb24vQXV0b0luc3RydW1lbnRhdGlvbi9Db250ZXh0LnBocA==) | `100.00% <100.00%> (ø)` | | | [src/API/Logs/LateBindingLogger.php](https://app.codecov.io/gh/open-telemetry/opentelemetry-php/pull/1304?src=pr&el=tree&filepath=src%2FAPI%2FLogs%2FLateBindingLogger.php&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-telemetry#diff-c3JjL0FQSS9Mb2dzL0xhdGVCaW5kaW5nTG9nZ2VyLnBocA==) | `100.00% <100.00%> (ø)` | | | [src/API/Logs/LateBindingLoggerProvider.php](https://app.codecov.io/gh/open-telemetry/opentelemetry-php/pull/1304?src=pr&el=tree&filepath=src%2FAPI%2FLogs%2FLateBindingLoggerProvider.php&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-telemetry#diff-c3JjL0FQSS9Mb2dzL0xhdGVCaW5kaW5nTG9nZ2VyUHJvdmlkZXIucGhw) | `100.00% <100.00%> (ø)` | | | [src/API/Metrics/LateBindingMeterProvider.php](https://app.codecov.io/gh/open-telemetry/opentelemetry-php/pull/1304?src=pr&el=tree&filepath=src%2FAPI%2FMetrics%2FLateBindingMeterProvider.php&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-telemetry#diff-c3JjL0FQSS9NZXRyaWNzL0xhdGVCaW5kaW5nTWV0ZXJQcm92aWRlci5waHA=) | `100.00% <100.00%> (ø)` | | | [src/API/Trace/LateBindingTracer.php](https://app.codecov.io/gh/open-telemetry/opentelemetry-php/pull/1304?src=pr&el=tree&filepath=src%2FAPI%2FTrace%2FLateBindingTracer.php&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-telemetry#diff-c3JjL0FQSS9UcmFjZS9MYXRlQmluZGluZ1RyYWNlci5waHA=) | `100.00% <100.00%> (ø)` | | | [src/API/Trace/LateBindingTracerProvider.php](https://app.codecov.io/gh/open-telemetry/opentelemetry-php/pull/1304?src=pr&el=tree&filepath=src%2FAPI%2FTrace%2FLateBindingTracerProvider.php&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-telemetry#diff-c3JjL0FQSS9UcmFjZS9MYXRlQmluZGluZ1RyYWNlclByb3ZpZGVyLnBocA==) | `100.00% <100.00%> (ø)` | | | [.../Config/SDK/Configuration/ConfigurationFactory.php](https://app.codecov.io/gh/open-telemetry/opentelemetry-php/pull/1304?src=pr&el=tree&filepath=src%2FConfig%2FSDK%2FConfiguration%2FConfigurationFactory.php&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-telemetry#diff-c3JjL0NvbmZpZy9TREsvQ29uZmlndXJhdGlvbi9Db25maWd1cmF0aW9uRmFjdG9yeS5waHA=) | `100.00% <100.00%> (+25.49%)` | :arrow_up: | | [src/SDK/Registry.php](https://app.codecov.io/gh/open-telemetry/opentelemetry-php/pull/1304?src=pr&el=tree&filepath=src%2FSDK%2FRegistry.php&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-telemetry#diff-c3JjL1NESy9SZWdpc3RyeS5waHA=) | `71.91% <ø> (ø)` | | | ... and [12 more](https://app.codecov.io/gh/open-telemetry/opentelemetry-php/pull/1304?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-telemetry) | | ... and [6 files with indirect coverage changes](https://app.codecov.io/gh/open-telemetry/opentelemetry-php/pull/1304/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-telemetry) ------ [Continue to review full report in Codecov by Sentry](https://app.codecov.io/gh/open-telemetry/opentelemetry-php/pull/1304?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-telemetry). > **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-telemetry) > `Δ = absolute (impact)`, `ø = not affected`, `? = missing data` > Powered by [Codecov](https://app.codecov.io/gh/open-telemetry/opentelemetry-php/pull/1304?dropdown=coverage&src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-telemetry). Last update [a822c45...d1b1f6f](https://app.codecov.io/gh/open-telemetry/opentelemetry-php/pull/1304?dropdown=coverage&src=pr&el=lastupdated&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-telemetry). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-telemetry).

brettmc commented 4 days ago

@open-telemetry/php-approvers @Nevay I think I'm happy with this and it's ready for review!

NB that we should not merge until a new version of opentelemetry-config is tagged, which should be v0.3

open-telemetry / opentelemetry-php

auto-instrumentation registration #1304

Codecov Report