Slim and psr-15 auto-instrumentation (open-telemetry#81)

* slim and psr15 auto-instrumentation

Author: brettmc

.github/workflows/php.yml

@@ -15,9 +15,12 @@ jobs:
       matrix:
         operating-system: [ubuntu-latest]
         php-version: ['7.4', '8.0', '8.1']
-        project: ['Aws', 'Symfony']
-    # todo exclude some matrix combinations based on php version requirements
-    # https://docs.github.com/en/actions/using-jobs/using-a-matrix-for-your-jobs#excluding-matrix-configurations
+        project: ['Aws', 'Symfony', 'Instrumentation/Slim', 'Instrumentation/Psr15']
+        exclude:
+          - project: 'Instrumentation/Slim'
+            php-version: 7.4
+          - project: 'Instrumentation/Psr15'
+            php-version: 7.4
 
     steps:
     - uses: actions/checkout@v3
@@ -27,7 +30,7 @@ jobs:
       with:
         php-version: ${{ matrix.php-version }}
         coverage: xdebug
-        extensions: ast, grpc
+        extensions: ast, grpc, otel_instrumentation-open-telemetry/opentelemetry-php-instrumentation@main
 
     - name: Validate composer.json and composer.lock
       run: composer validate
@@ -79,10 +82,3 @@ jobs:
     - name: Code Coverage
       working-directory: src/${{ matrix.project }}
       run: bash <(curl -s https://codecov.io/bash) -F ${{ matrix.php-version }}
-
-  packages:
-    uses: opentelemetry-php/gh-workflows/.github/workflows/validate-packages.yml@main
-    needs: php
-    with:
-      matrix_extension: '["ast, json, grpc"]'
-      install_directory: '~/.test/.packages'

.gitsplit.yml

@@ -10,6 +10,10 @@ splits:
     target: "https://${GH_TOKEN}@github.com/opentelemetry-php/contrib-aws.git"
   - prefix: "src/Symfony"
     target: "https://${GH_TOKEN}@github.com/opentelemetry-php/contrib-sdk-bundle.git"
+  - prefix: "src/Instrumentation/Psr15"
+    target: "https://${GH_TOKEN}@github.com/opentelemetry-php/contrib-auto-psr15.git"
+  - prefix: "src/Instrumentation/Slim"
+    target: "https://${GH_TOKEN}@github.com/opentelemetry-php/contrib-auto-slim.git"
 
 # List of references to split (defined as regexp)
 origins:

.php-cs-fixer.php

@@ -2,7 +2,6 @@
 $finder = PhpCsFixer\Finder::create()
     ->exclude('vendor')
     ->exclude('var/cache')
-    ->exclude('proto')
     ->in(__DIR__);
 
 $config = new PhpCsFixer\Config();

Makefile

@@ -11,7 +11,9 @@ help: ## Show this help
 	@echo "example: PROJECT=Aws PHP_VERSION=8.1 make <command>"
 	@printf "\033[33m%s:\033[0m\n" 'Available commands'
 	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z0-9_-]+:.*?## / {printf "  \033[32m%-18s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)
-all: update style packages-composer phan psalm phpstan test ## Everything
+all: update style validate phan psalm phpstan test ## Everything
+build: ## Build image
+	$(DOCKER_COMPOSE) build --build-arg PHP_VERSION php
 install: ## Install dependencies
 	$(DC_RUN_PHP) env XDEBUG_MODE=off composer install
 update: ## Update dependencies
@@ -20,7 +22,7 @@ test: test-unit test-integration ## Run unit and integration tests
 test-unit: ## Run unit tests
 	$(DC_RUN_PHP) env XDEBUG_MODE=coverage vendor/bin/phpunit --testsuite unit --colors=always --coverage-text --testdox --coverage-clover coverage.clover --coverage-html=tests/coverage/html
 test-integration: ## Run integration tests
-	$(DC_RUN_PHP) env XDEBUG_MODE=off vendor/bin/phpunit --testsuite integration  --coverage-text --testdox --colors=always
+	$(DC_RUN_PHP) env XDEBUG_MODE=off vendor/bin/phpunit --testsuite integration  --testdox --colors=always
 test-coverage: ## Run unit tests and generate coverage
 	$(DC_RUN_PHP) env XDEBUG_MODE=coverage vendor/bin/phpunit --testsuite unit --coverage-html=tests/coverage/html
 phan: ## Run phan
@@ -31,12 +33,14 @@ psalm-info: ## Run psalm with info
 	$(DC_RUN_PHP) env XDEBUG_MODE=off vendor/bin/psalm --show-info=true --threads=1
 phpstan: ## Run phpstan
 	$(DC_RUN_PHP) env XDEBUG_MODE=off vendor/bin/phpstan analyse --memory-limit=256M
-packages-composer: ## Validate composer packages
+validate: ## Validate composer file
+	$(DC_RUN_PHP) env XDEBUG_MODE=off composer validate
+packages-composer: ## Validate all composer packages
 	$(DC_RUN) php env XDEBUG_MODE=off vendor/bin/otel packages:composer:validate
 bash: ## Bash shell
 	$(DC_RUN_PHP) bash
 style: ## Run php-cs-fixer
 	$(DC_RUN_PHP) env XDEBUG_MODE=off vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php --using-cache=no -vvv
 split: ## git-split dry run
-	docker-compose -f docker/gitsplit/docker-compose.yaml --env-file ./.env up
+	${DOCKER_COMPOSE} -f docker/gitsplit/docker-compose.yaml --env-file ./.env up
 FORCE:

composer.json

@@ -13,6 +13,14 @@
     "composer/xdebug-handler": "^2.0",
     "open-telemetry/dev-tools": "dev-main"
   },
+  "autoload": {
+    "psr-4": {
+      "OpenTelemetry\\Contrib\\Aws\\": "src/Aws/src",
+      "OpenTelemetry\\Contrib\\Symfony\\": "src/Symfony/src",
+      "OpenTelemetry\\Contrib\\Instrumentation\\Psr15\\": "src/Instrumentation/Psr15/src",
+      "OpenTelemetry\\Contrib\\Instrumentation\\Slim\\": "src/Instrumentation/Slim/src"
+    }
+  },
   "config": {
     "sort-packages": true,
     "allow-plugins": {

docker-compose.yaml

@@ -1,13 +1,18 @@
 version: '3.7'
 services:
   php:
-    image: ghcr.io/open-telemetry/opentelemetry-php/opentelemetry-php-base:${PHP_VERSION:-7.4}
+    build:
+      context: ./docker
+      dockerfile: Dockerfile
+      args:
+        - PHP_VERSION
     volumes:
     - ./:/usr/src/myapp
     user: "${PHP_USER}:root"
     environment:
       XDEBUG_MODE: ${XDEBUG_MODE:-off}
       XDEBUG_CONFIG: ${XDEBUG_CONFIG:-''}
+      PHP_IDE_CONFIG: ${PHP_IDE_CONFIG:-''}
   zipkin:
     image: openzipkin/zipkin-slim
     ports:

docker/Dockerfile

@@ -0,0 +1,33 @@
+ARG PHP_VERSION=7.4
+FROM php:${PHP_VERSION}-cli-alpine as php_build
+
+ADD https://github.com/mlocati/docker-php-extension-installer/releases/latest/download/install-php-extensions /usr/local/bin/
+
+RUN chmod +x /usr/local/bin/install-php-extensions; \
+    apk add --update binutils; \
+    install-php-extensions \
+        ast \
+        xdebug \
+        zip \
+        pcntl \
+        intl \
+        @composer \
+        open-telemetry/opentelemetry-php-instrumentation@main \
+    ; \
+    # strip debug symbols from extensions to reduce size
+    find /usr/local/lib/php/extensions -name "*.so" -exec strip --strip-debug {} \;;
+
+FROM php_build
+
+WORKDIR /usr/src/myapp
+
+RUN   apk add --no-cache bash git; \
+      find /usr/local/lib/php/extensions -type d -exec chmod +x -R {} \;; \
+      addgroup -g "1000" -S php; \
+      adduser --system \
+        --gecos "" \
+        --ingroup "php" \
+        --uid "1000" \
+        "php";
+
+USER php

src/Aws/.php-cs-fixer.php

@@ -0,0 +1,44 @@
+<?php
+$finder = PhpCsFixer\Finder::create()
+    ->exclude('vendor')
+    ->exclude('var/cache')
+    ->exclude('proto')
+    ->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,
+    'function_typehint_space' => true,
+    'include' => true,
+    'lowercase_cast' => true,
+    'new_with_braces' => 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,
+    'single_blank_line_before_namespace' => true,
+    'single_quote' => true,
+    'trailing_comma_in_multiline' => true,
+    ])
+    ->setRiskyAllowed(true)
+    ->setFinder($finder);
+

src/Aws/.php-cs-fixer.php

@@ -0,0 +1,44 @@
+<?php
+$finder = PhpCsFixer\Finder::create()
+    ->exclude('vendor')
+    ->exclude('var/cache')
+    ->exclude('proto')
+    ->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,
+    'function_typehint_space' => true,
+    'include' => true,
+    'lowercase_cast' => true,
+    'new_with_braces' => 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,
+    'single_blank_line_before_namespace' => true,
+    'single_quote' => true,
+    'trailing_comma_in_multiline' => true,
+    ])
+    ->setRiskyAllowed(true)
+    ->setFinder($finder);
+

src/Instrumentation/Psr15/.php-cs-fixer.php

@@ -0,0 +1,26 @@
+# OpenTelemetry PSR-15 auto-instrumentation
+
+## Requirements
+
+* OpenTelemetry extension
+* OpenTelemetry SDK and exporters (required to actually export traces)
+
+## Overview
+Auto-instrumentation hooks are registered via composer, and spans will automatically be created for each PSR-15 middleware that is executed.
+
+To export spans, you will need to create and register a `TracerProvider` early in your application's lifecycle:
+
+```php
+<?php
+require_once 'vendor/autoload.php';
+
+$tracerProvider = /*create tracer provider*/;
+$scope = \OpenTelemetry\API\Common\Instrumentation\Configurator::create()
+    ->withTracerProvider($tracerProvider)
+    ->activate();
+
+//your application runs here
+
+$scope->detach();
+$tracerProvider->shutdown();
+```

src/Instrumentation/Psr15/README.md

@@ -0,0 +1,5 @@
+<?php
+
+declare(strict_types=1);
+
+\OpenTelemetry\Contrib\Instrumentation\Psr15\Psr15Instrumentation::register();

src/Instrumentation/Psr15/_register.php

@@ -0,0 +1,36 @@
+{
+  "name": "open-telemetry/opentelemetry-auto-psr15",
+  "description": "OpenTelemetry auto-instrumentation for psr15 middleware.",
+  "keywords": ["opentelemetry", "otel", "open-telemetry", "tracing", "psr15", "instrumentation"],
+  "type": "library",
+  "homepage": "https://opentelemetry.io/docs/php",
+  "readme": "./README.md",
+  "license": "Apache-2.0",
+  "minimum-stability": "dev",
+  "require": {
+    "php": "^8.0",
+    "ext-otel_instrumentation": "*",
+    "open-telemetry/api": "dev-main",
+    "psr/http-server-middleware": "^1"
+  },
+  "autoload": {
+    "psr-4": {
+      "OpenTelemetry\\Contrib\\Instrumentation\\Psr15\\": "src/"
+    },
+    "files": [
+      "_register.php"
+    ]
+  },
+  "require-dev": {
+    "friendsofphp/php-cs-fixer": "^3",
+    "nyholm/psr7": "*",
+    "phan/phan": "^5.0",
+    "php-http/mock-client": "*",
+    "phpstan/phpstan": "^1.1",
+    "phpstan/phpstan-phpunit": "^1.0",
+    "psalm/plugin-phpunit": "^0.16",
+    "open-telemetry/sdk": "dev-main",
+    "phpunit/phpunit": "^9.5",
+    "vimeo/psalm": "^4.0"
+  }
+}

src/Instrumentation/Psr15/composer.json

@@ -0,0 +1,9 @@
+includes:
+    - vendor/phpstan/phpstan-phpunit/extension.neon
+
+parameters:
+    tmpDir: var/cache/phpstan
+    level: 5
+    paths:
+        - src
+        - tests

src/Instrumentation/Psr15/phpstan.neon.dist

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

src/Instrumentation/Psr15/phpunit.xml.dist

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