Add opcache instrumentation

Author: HeenaBansal20

.github/workflows/fossa.yml

@@ -12,7 +12,7 @@ jobs:
   fossa:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
 
       - uses: fossas/fossa-action@3ebcea1862c6ffbd5cf1b4d0bd6b3fe7bd6f2cac # v1.7.0
         with:

.github/workflows/ossf-scorecard.yml

@@ -19,7 +19,7 @@ jobs:
       # Needed for GitHub OIDC token if publish_results is true
       id-token: write
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
 
@@ -45,6 +45,6 @@ jobs:
       # Upload the results to GitHub's code scanning dashboard (optional).
       # Commenting out will disable upload of results to your repo's Code Scanning dashboard
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@51f77329afa6477de8c49fc9c7046c15b9a4e79d # v3.29.5
+        uses: github/codeql-action/upload-sarif@3c3833e0f8c1c83d449a7478aa59c036a9165498 # v3.29.5
         with:
           sarif_file: results.sarif

.github/workflows/php.yml

@@ -41,6 +41,7 @@ jobs:
           'Instrumentation/MySqli',
           'Instrumentation/OpenAIPHP',
           'Instrumentation/PDO',
+          'Instrumentation/Opcache',
           'Instrumentation/PostgreSql',
           # Sort PSRs numerically.
           'Instrumentation/Psr3',
@@ -50,6 +51,7 @@ jobs:
           'Instrumentation/Psr16',
           'Instrumentation/Psr18',
           'Instrumentation/ReactPHP',
+          'Instrumentation/Session', 
           'Instrumentation/Slim',
           'Instrumentation/Symfony',
           'Instrumentation/Yii',
@@ -62,6 +64,7 @@ jobs:
           'ResourceDetectors/Container',
           'ResourceDetectors/DigitalOcean',
           'Sampler/RuleBased',
+          'Sampler/Xray',
           'Shims/OpenTracing',
           'Symfony',
           'Utils/Test'
@@ -82,8 +85,11 @@ jobs:
             php-version: 8.1
           - project: 'Instrumentation/PostgreSql'
             php-version: 8.1
+          - project: 'Instrumentation/Opcache'
+          - project: 'Instrumentation/Session'
+            php-version: 8.1
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
     - name: Setup PHP
       uses: shivammathur/setup-php@v2

.github/workflows/update-dependabot-config.yml

@@ -18,7 +18,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Set up PHP
         uses: shivammathur/setup-php@v2

.gitsplit.yml

@@ -44,6 +44,8 @@ splits:
     target: "https://${GH_TOKEN}@github.com/opentelemetry-php/contrib-auto-openai.git"
   - prefix: "src/Instrumentation/PDO"
     target: "https://${GH_TOKEN}@github.com/opentelemetry-php/contrib-auto-pdo.git"
+  - prefix: "src/Instrumentation/opcache"
+    target: "https://${GH_TOKEN}@github.com/opentelemetry-php/contrib-auto-opcache.git"
   - prefix: "src/Instrumentation/PostgreSql"
     target: "https://${GH_TOKEN}@github.com/opentelemetry-php/contrib-auto-postgresql.git"
   - prefix: "src/Instrumentation/Psr3"
@@ -60,6 +62,8 @@ splits:
     target: "https://${GH_TOKEN}@github.com/opentelemetry-php/contrib-auto-psr18.git"
   - prefix: "src/Instrumentation/ReactPHP"
     target: "https://${GH_TOKEN}@github.com/opentelemetry-php/contrib-auto-reactphp.git"
+  - prefix: "src/Instrumentation/Session"
+    target: "https://${GH_TOKEN}@github.com/opentelemetry-php/contrib-auto-session.git"
   - prefix: "src/Instrumentation/Slim"
     target: "https://${GH_TOKEN}@github.com/opentelemetry-php/contrib-auto-slim.git"
   - prefix: "src/Instrumentation/Symfony"
@@ -88,6 +92,8 @@ splits:
     target: "https://${GH_TOKEN}@github.com/opentelemetry-php/contrib-detector-digitalocean.git"
   - prefix: "src/Sampler/RuleBased"
     target: "https://${GH_TOKEN}@github.com/opentelemetry-php/contrib-sampler-rulebased.git"
+  - prefix: "src/Sampler/Xray"
+    target: "https://${GH_TOKEN}@github.com/opentelemetry-php/contrib-sampler-aws-xray.git"
   - prefix: "src/Shims/OpenTracing"
     target: "https://${GH_TOKEN}@github.com/opentelemetry-php/contrib-shim-opentracing.git"
   - prefix: "src/Symfony"

composer.json

@@ -33,13 +33,15 @@
       "OpenTelemetry\\Contrib\\Instrumentation\\MySqli\\": "src/Instrumentation/MySqli/src",
       "OpenTelemetry\\Contrib\\Instrumentation\\OpenAIPHP\\": "src/Instrumentation/OpenAIPHP/src",
       "OpenTelemetry\\Contrib\\Instrumentation\\PDO\\": "src/Instrumentation/PDO/src",
+      "OpenTelemetry\\Contrib\\Instrumentation\\Opcache\\": "src/Instrumentation/Opcache/src",
       "OpenTelemetry\\Contrib\\Instrumentation\\Psr3\\": "src/Instrumentation/Psr3/src",
       "OpenTelemetry\\Contrib\\Instrumentation\\Psr6\\": "src/Instrumentation/Psr6/src",
       "OpenTelemetry\\Contrib\\Instrumentation\\Psr14\\": "src/Instrumentation/Psr14/src",
       "OpenTelemetry\\Contrib\\Instrumentation\\Psr15\\": "src/Instrumentation/Psr15/src",
       "OpenTelemetry\\Contrib\\Instrumentation\\Psr16\\": "src/Instrumentation/Psr16/src",
       "OpenTelemetry\\Contrib\\Instrumentation\\Psr18\\": "src/Instrumentation/Psr18/src",
       "OpenTelemetry\\Contrib\\Instrumentation\\ReactPHP\\": "src/Instrumentation/ReactPHP/src",
+      "OpenTelemetry\\Contrib\\Instrumentation\\Session\\": "src/Instrumentation/Session/src",
       "OpenTelemetry\\Contrib\\Instrumentation\\Slim\\": "src/Instrumentation/Slim/src",
       "OpenTelemetry\\Contrib\\Instrumentation\\Symfony\\": "src/Instrumentation/Symfony/src",
       "OpenTelemetry\\Contrib\\Instrumentation\\Wordpress\\": "src/Instrumentation/Wordpress/src",
@@ -74,13 +76,15 @@
       "src/Instrumentation/MySqli/_register.php",
       "src/Instrumentation/OpenAIPHP/_register.php",
       "src/Instrumentation/PDO/_register.php",
+      "src/Instrumentation/Opcache/_register.php",
       "src/Instrumentation/Psr3/_register.php",
       "src/Instrumentation/Psr6/_register.php",
       "src/Instrumentation/Psr14/_register.php",
       "src/Instrumentation/Psr15/_register.php",
       "src/Instrumentation/Psr16/_register.php",
       "src/Instrumentation/Psr18/_register.php",
       "src/Instrumentation/ReactPHP/_register.php",
+      "src/Instrumentation/Session/_register.php",
       "src/Instrumentation/Slim/_register.php",
       "src/Instrumentation/Symfony/_register.php",
       "src/Instrumentation/Wordpress/_register.php",
@@ -111,10 +115,12 @@
       "OpenTelemetry\\Tests\\Instrumentation\\MySqli\\": "src/Instrumentation/MySqli/tests",
       "OpenTelemetry\\Contrib\\Instrumentation\\OpenAIPHP\\Tests\\": "src/Instrumentation/OpenAIPHP/tests",
       "OpenTelemetry\\Tests\\Instrumentation\\PDO\\": "src/Instrumentation/PDO/tests",
+      "OpenTelemetry\\Tests\\Instrumentation\\Opcache\\": "src/Instrumentation/Opcache/tests",
       "OpenTelemetry\\Tests\\Instrumentation\\Psr6\\": "src/Instrumentation/Psr6/tests",
       "OpenTelemetry\\Instrumentation\\Psr14\\Tests\\": "src/Instrumentation/Psr14/tests",
       "OpenTelemetry\\Tests\\Instrumentation\\Psr16\\": "src/Instrumentation/Psr16/tests",
       "OpenTelemetry\\Tests\\Instrumentation\\ReactPHP\\": "src/Instrumentation/ReactPHP/tests",
+      "OpenTelemetry\\Tests\\Instrumentation\\Session\\": "src/Instrumentation/Session/tests",
       "OpenTelemetry\\Tests\\Instrumentation\\Slim\\": "src/Instrumentation/Slim/tests",
       "OpenTelemetry\\Tests\\Instrumentation\\Symfony\\tests\\": "src/Instrumentation/Symfony/tests",
       "OpenTelemetry\\Tests\\Instrumentation\\Wordpress\\": "src/Instrumentation/Wordpress/tests",
@@ -149,13 +155,15 @@
     "open-telemetry/opentelemetry-auto-mysqli": "self.version",
     "open-telemetry/opentelemetry-auto-openai-php": "self.version",
     "open-telemetry/opentelemetry-auto-pdo": "self.version",
+    "open-telemetry/opentelemetry-auto-opcache": "self.version",
     "open-telemetry/opentelemetry-auto-psr3": "self.version",
     "open-telemetry/opentelemetry-auto-psr6": "self.version",
     "open-telemetry/opentelemetry-auto-psr14": "self.version",
     "open-telemetry/opentelemetry-auto-psr15": "self.version",
     "open-telemetry/opentelemetry-auto-psr16": "self.version",
     "open-telemetry/opentelemetry-auto-psr18": "self.version",
     "open-telemetry/opentelemetry-auto-reactphp": "self.version",
+    "open-telemetry/opentelemetry-auto-php-session": "self.version",
     "open-telemetry/opentelemetry-auto-slim": "self.version",
     "open-telemetry/opentelemetry-auto-symfony": "self.version",
     "open-telemetry/opentelemetry-auto-wordpress": "self.version",

docker-compose.yaml

@@ -4,6 +4,7 @@ services:
     image: ghcr.io/open-telemetry/opentelemetry-php/opentelemetry-php-base:${PHP_VERSION}
     volumes:
     - ./:/usr/src/myapp
+    - ./docker/opcache/opcache.ini:/etc/php/${PHP_VERSION}/cli/conf.d/opcache.ini
     user: "${PHP_USER}:root"
     environment:
       XDEBUG_MODE: ${XDEBUG_MODE:-off}

docker/opcache/opcache.ini

@@ -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

src/Instrumentation/IO/README.md

@@ -22,11 +22,15 @@ following functions:
 - `file_put_contents`
 - `curl_init`
 - `curl_exec`
+- `ob_start`
+- `ob_clean`
+- `ob_flush`
+- `flush`
 
 ## Configuration
 
 The extension can be disabled via [runtime configuration](https://opentelemetry.io/docs/instrumentation/php/sdk/#configuration):
 
 ```shell
 OTEL_PHP_DISABLED_INSTRUMENTATIONS=io
-```
+```

src/Instrumentation/IO/src/IOInstrumentation.php

@@ -33,6 +33,12 @@ public static function register(): void
         self::_hook($instrumentation, null, 'file_get_contents', 'file_get_contents');
         self::_hook($instrumentation, null, 'file_put_contents', 'file_put_contents');
 
+        // Output buffer functions
+        self::_hook($instrumentation, null, 'ob_start', 'ob_start');
+        self::_hook($instrumentation, null, 'ob_clean', 'ob_clean');
+        self::_hook($instrumentation, null, 'ob_flush', 'ob_flush');
+        self::_hook($instrumentation, null, 'flush', 'flush');
+  
         self::_hook($instrumentation, null, 'curl_init', 'curl_init');
         self::_hook($instrumentation, null, 'curl_exec', 'curl_exec');
     }
@@ -109,6 +115,19 @@ private static function addParams(SpanBuilderInterface $builder, string $functio
             case 'file_put_contents':
                 $builder->setAttribute('code.params.filename', $params[0]);
 
+                break;
+            case 'ob_start':
+                if (isset($params[0]) && is_callable($params[0])) {
+                    // We can't directly serialize the callback, so we'll just note that one was provided
+                    $builder->setAttribute('code.params.has_callback', true);
+                }
+                if (isset($params[1])) {
+                    $builder->setAttribute('code.params.chunk_size', $params[1]);
+                }
+                if (isset($params[2])) {
+                    $builder->setAttribute('code.params.flags', $params[2]);
+                }
+
                 break;
         }
     }