Add opcache instrumentation #440
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| ; OPcache configuration | ||
| [opcache] | ||
| opcache.enable=1 | ||
| opcache.enable_cli=1 | ||
| opcache.memory_consumption=128 | ||
| opcache.interned_strings_buffer=8 | ||
| opcache.max_accelerated_files=10000 | ||
| opcache.revalidate_freq=60 | ||
| opcache.validate_timestamps=1 | ||
| opcache.save_comments=1 | ||
| opcache.enable_file_override=0 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| * text=auto | ||
|
|
||
| *.md diff=markdown | ||
| *.php diff=php | ||
|
|
||
| /.gitattributes export-ignore | ||
| /.gitignore export-ignore | ||
| /.php-cs-fixer.php export-ignore | ||
| /phpstan.neon.dist export-ignore | ||
| /phpunit.xml.dist export-ignore | ||
| /psalm.xml.dist export-ignore | ||
| /tests export-ignore |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| /vendor/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| <?php | ||
| $finder = PhpCsFixer\Finder::create() | ||
| ->exclude('vendor') | ||
| ->exclude('var/cache') | ||
| ->in(__DIR__); | ||
|
|
||
| $config = new PhpCsFixer\Config(); | ||
| return $config->setRules([ | ||
| 'concat_space' => ['spacing' => 'one'], | ||
| 'declare_equal_normalize' => ['space' => 'none'], | ||
| 'is_null' => true, | ||
| 'modernize_types_casting' => true, | ||
| 'ordered_imports' => true, | ||
| 'php_unit_construct' => true, | ||
| 'single_line_comment_style' => true, | ||
| 'yoda_style' => false, | ||
| '@PSR2' => true, | ||
| 'array_syntax' => ['syntax' => 'short'], | ||
| 'blank_line_after_opening_tag' => true, | ||
| 'blank_line_before_statement' => true, | ||
| 'cast_spaces' => true, | ||
| 'declare_strict_types' => true, | ||
| 'type_declaration_spaces' => true, | ||
| 'include' => true, | ||
| 'lowercase_cast' => true, | ||
| 'new_with_parentheses' => true, | ||
| 'no_extra_blank_lines' => true, | ||
| 'no_leading_import_slash' => true, | ||
| 'echo_tag_syntax' => true, | ||
| 'no_unused_imports' => true, | ||
| 'no_useless_else' => true, | ||
| 'no_useless_return' => true, | ||
| 'phpdoc_order' => true, | ||
| 'phpdoc_scalar' => true, | ||
| 'phpdoc_types' => true, | ||
| 'short_scalar_cast' => true, | ||
| 'blank_lines_before_namespace' => true, | ||
| 'single_quote' => true, | ||
| 'trailing_comma_in_multiline' => true, | ||
| ]) | ||
| ->setRiskyAllowed(true) | ||
| ->setFinder($finder); | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| [](https://github.com/opentelemetry-php/contrib-auto-opcache/releases) | ||
| [](https://github.com/open-telemetry/opentelemetry-php/issues) | ||
| [](https://github.com/open-telemetry/opentelemetry-php-contrib/tree/main/src/Instrumentation/opcache) | ||
| [](https://github.com/opentelemetry-php/contrib-auto-opcache) | ||
| [](https://packagist.org/packages/open-telemetry/opentelemetry-auto-opcache/) | ||
| [](https://packagist.org/packages/open-telemetry/opentelemetry-auto-opcache/) | ||
|
|
||
| This is a read-only subtree split of https://github.com/open-telemetry/opentelemetry-php-contrib. | ||
|
|
||
| # OpenTelemetry PHP OPcache Instrumentation | ||
|
|
||
| Please read https://opentelemetry.io/docs/instrumentation/php/automatic/ for instructions on how to | ||
| install and configure the extension and SDK. | ||
|
|
||
| ## Overview | ||
|
|
||
| This instrumentation package captures PHP OPcache metrics and adds them as attributes to the active span. | ||
| It automatically registers a shutdown function to collect OPcache metrics at the end of the request. | ||
|
|
||
| The following OPcache metrics are captured: | ||
|
|
||
| ### Basic Status | ||
| - `opcache.enabled` - Whether OPcache is enabled | ||
| - `opcache.available` - Whether OPcache is available | ||
|
|
||
| ### Memory Usage | ||
| - `opcache.memory.used_bytes` - Memory used by OPcache in bytes | ||
| - `opcache.memory.free_bytes` - Free memory available to OPcache in bytes | ||
| - `opcache.memory.wasted_bytes` - Wasted memory in bytes | ||
| - `opcache.memory.used_percentage` - Percentage of total memory used | ||
| - `opcache.memory.wasted_percentage` - Percentage of total memory wasted | ||
|
|
||
| ### Cache Statistics | ||
| - `opcache.scripts.cached` - Number of cached scripts | ||
| - `opcache.hits.total` - Total number of cache hits | ||
| - `opcache.misses.total` - Total number of cache misses | ||
| - `opcache.hit_rate.percentage` - Cache hit rate percentage | ||
| - `opcache.keys.cached` - Number of cached keys | ||
| - `opcache.keys.max_cached` - Maximum number of cached keys | ||
|
|
||
| ### Restart Statistics | ||
| - `opcache.restarts.oom` - Number of out-of-memory restarts | ||
| - `opcache.restarts.hash` - Number of hash restarts | ||
| - `opcache.restarts.manual` - Number of manual restarts | ||
|
|
||
| ### Interned Strings | ||
| - `opcache.interned_strings.buffer_size` - Interned strings buffer size | ||
| - `opcache.interned_strings.used_memory` - Memory used by interned strings | ||
| - `opcache.interned_strings.free_memory` - Free memory for interned strings | ||
| - `opcache.interned_strings.strings_count` - Number of interned strings | ||
| - `opcache.interned_strings.usage_percentage` - Percentage of interned strings buffer used | ||
|
|
||
| ## Usage | ||
|
|
||
| The instrumentation is automatically registered via composer. No additional configuration is required. | ||
|
|
||
| You can also manually add OPcache metrics to the current active span: | ||
|
|
||
| ```php | ||
| use OpenTelemetry\Contrib\Instrumentation\opcache\opcacheInstrumentation; | ||
|
|
||
| // Add OPcache metrics to the current active span | ||
| opcacheInstrumentation::addOpcacheMetricsToRootSpan(); | ||
| ``` | ||
|
|
||
| ## Configuration | ||
|
|
||
| The extension can be disabled via [runtime configuration](https://opentelemetry.io/docs/instrumentation/php/sdk/#configuration): | ||
|
|
||
| ```shell | ||
| OTEL_PHP_DISABLED_INSTRUMENTATIONS=opcache | ||
| ``` | ||
|
|
||
| ## Requirements | ||
|
|
||
| - PHP 8.0 or higher | ||
| - OPcache extension | ||
| - OpenTelemetry extension |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,18 @@ | ||||||
| <?php | ||||||
|
|
||||||
| declare(strict_types=1); | ||||||
|
|
||||||
| use OpenTelemetry\Contrib\Instrumentation\Opcache\OpcacheInstrumentation; | ||||||
| use OpenTelemetry\SDK\Sdk; | ||||||
|
|
||||||
| if (class_exists(Sdk::class) && Sdk::isInstrumentationDisabled(OpcacheInstrumentation::NAME) === true) { | ||||||
| return; | ||||||
| } | ||||||
|
|
||||||
| if (extension_loaded('opentelemetry') === false) { | ||||||
| trigger_error('The opentelemetry extension must be loaded in order to autoload the OpenTelemetry IO auto-instrumentation', E_USER_WARNING); | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| return; | ||||||
| } | ||||||
|
|
||||||
| OpcacheInstrumentation::register(); | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| { | ||
| "name": "open-telemetry/opentelemetry-auto-opcache", | ||
| "description": "OpenTelemetry auto-instrumentation for PHP opcache", | ||
| "keywords": ["opentelemetry", "otel", "open-telemetry", "tracing", "opcache", "instrumentation"], | ||
| "type": "library", | ||
| "homepage": "https://opentelemetry.io/docs/php", | ||
| "readme": "./README.md", | ||
| "license": "Apache-2.0", | ||
| "minimum-stability": "dev", | ||
| "prefer-stable": true, | ||
| "require": { | ||
| "php": "^8.2", | ||
| "ext-opentelemetry": "*", | ||
| "open-telemetry/api": "^1.0", | ||
| "open-telemetry/sem-conv": "^1.32", | ||
| "ext-zend-opcache": "*" | ||
| }, | ||
| "require-dev": { | ||
| "friendsofphp/php-cs-fixer": "^3", | ||
| "phan/phan": "^5.0", | ||
| "php-http/mock-client": "*", | ||
| "phpstan/phpstan": "^1.1", | ||
| "phpstan/phpstan-phpunit": "^1.0", | ||
| "psalm/plugin-phpunit": "^0.19.2", | ||
| "open-telemetry/sdk": "^1.0", | ||
| "phpunit/phpunit": "^9.5", | ||
| "vimeo/psalm": "6.4.0", | ||
| "mockery/mockery": "^1.4" | ||
| }, | ||
| "autoload": { | ||
| "psr-4": { | ||
| "OpenTelemetry\\Contrib\\Instrumentation\\Opcache\\": "src/" | ||
| }, | ||
| "files": [ | ||
| "_register.php" | ||
| ] | ||
| }, | ||
| "autoload-dev": { | ||
| "psr-4": { | ||
| "OpenTelemetry\\Tests\\Instrumentation\\Opcache\\": "tests/" | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| includes: | ||
| - vendor/phpstan/phpstan-phpunit/extension.neon | ||
|
|
||
| parameters: | ||
| tmpDir: var/cache/phpstan | ||
| level: 5 | ||
| paths: | ||
| - src | ||
| - tests |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
|
|
||
| <phpunit | ||
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd" | ||
| backupGlobals="false" | ||
| backupStaticAttributes="false" | ||
| cacheResult="false" | ||
| colors="false" | ||
| convertErrorsToExceptions="true" | ||
| convertNoticesToExceptions="true" | ||
| convertWarningsToExceptions="true" | ||
| forceCoversAnnotation="false" | ||
| processIsolation="false" | ||
| stopOnError="false" | ||
| stopOnFailure="false" | ||
| stopOnIncomplete="false" | ||
| stopOnSkipped="false" | ||
| stopOnRisky="false" | ||
| timeoutForSmallTests="1" | ||
| timeoutForMediumTests="10" | ||
| timeoutForLargeTests="60" | ||
| verbose="true"> | ||
|
|
||
| <coverage processUncoveredFiles="true" disableCodeCoverageIgnore="false"> | ||
| <include> | ||
| <directory>src</directory> | ||
| </include> | ||
| </coverage> | ||
|
|
||
| <php> | ||
| <ini name="date.timezone" value="UTC" /> | ||
| <ini name="display_errors" value="On" /> | ||
| <ini name="display_startup_errors" value="On" /> | ||
| <ini name="error_reporting" value="E_ALL" /> | ||
| </php> | ||
|
|
||
| <testsuites> | ||
| <testsuite name="unit"> | ||
| <directory>tests/Unit</directory> | ||
| </testsuite> | ||
| <testsuite name="integration"> | ||
| <directory>tests/Integration</directory> | ||
| </testsuite> | ||
| </testsuites> | ||
|
|
||
| </phpunit> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| <?xml version="1.0"?> | ||
| <psalm | ||
| errorLevel="3" | ||
| cacheDirectory="var/cache/psalm" | ||
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xmlns="https://getpsalm.org/schema/config" | ||
| xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"> | ||
| <projectFiles> | ||
| <directory name="src"/> | ||
| <directory name="tests"/> | ||
| </projectFiles> | ||
| <plugins> | ||
| <pluginClass class="Psalm\PhpUnitPlugin\Plugin"/> | ||
| </plugins> | ||
| </psalm> |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this line excludes all versions. Since you're not actually hooking methods, you can just remove this line since it should work against 8.1