migrate extension propagator cloudtrace

.github/dependabot.yml

@@ -91,6 +91,7 @@ updates:
       - "/src/Instrumentation/Yii"
       - "/src/Logs/Monolog"
       - "/src/MetaPackages/opentelemetry"
+      - "/src/Propagation/CloudTrace"
       - "/src/Propagation/Instana"
       - "/src/Propagation/ServerTiming"
       - "/src/Propagation/TraceResponse"

.github/workflows/php.yml

@@ -54,6 +54,7 @@ jobs:
           'Instrumentation/Symfony',
           'Instrumentation/Yii',
           'Logs/Monolog',
+          'Propagation/CloudTrace',
           'Propagation/Instana',
           'Propagation/ServerTiming',
           'Propagation/TraceResponse',

.gitsplit.yml

@@ -72,6 +72,8 @@ splits:
     target: "https://${GH_TOKEN}@github.com/opentelemetry-php/contrib-logger-monolog.git"
   - prefix: "src/MetaPackages/opentelemetry"
     target: "https://${GH_TOKEN}@github.com/opentelemetry-php/opentelemetry-meta.git"
+  - prefix: "src/Propagation/CloudTrace"
+    target: "https://${GH_TOKEN}@github.com/opentelemetry-php/extension-propagator-cloudtrace.git"
   - prefix: "src/Propagation/Instana"
     target: "https://${GH_TOKEN}@github.com/opentelemetry-php/contrib-propagator-instana.git"
   - prefix: "src/Propagation/ServerTiming"

composer.json

@@ -54,6 +54,7 @@
       "OpenTelemetry\\Contrib\\Sampler\\RuleBased\\": "src/Sampler/RuleBased/src",
       "OpenTelemetry\\Contrib\\Shim\\OpenTracing\\": "src/Shims/OpenTracing/src",
       "OpenTelemetry\\Contrib\\Symfony\\": "src/Symfony/src",
+      "OpenTelemetry\\Extension\\Propagator\\CloudTrace\\": "src/Propagation/CloudTrace/src",
       "OpenTelemetry\\TestUtils\\": "src/Utils/Test/src"
     },
     "files": [
@@ -84,6 +85,7 @@
       "src/Instrumentation/Symfony/_register.php",
       "src/Instrumentation/Wordpress/_register.php",
       "src/Instrumentation/Yii/_register.php",
+      "src/Propagation/CloudTrace/_register.php",
       "src/Propagation/Instana/_register.php",
       "src/ResourceDetectors/Azure/_register.php",
       "src/ResourceDetectors/Container/_register.php",
@@ -131,6 +133,7 @@
     "open-telemetry/detector-azure": "self.version",
     "open-telemetry/detector-container": "self.version",
     "open-telemetry/detector-digitalocean": "self.version",
+    "open-telemetry/extension-propagator-cloudtrace": "self.version",
     "open-telemetry/opentelemetry-auto-aws-sdk": "self.version",
     "open-telemetry/opentelemetry-auto-cakephp": "self.version",
     "open-telemetry/opentelemetry-auto-codeigniter": "self.version",

src/Propagation/CloudTrace/.gitattributes

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

src/Propagation/CloudTrace/.gitignore

@@ -0,0 +1 @@
+/vendor/

src/Propagation/CloudTrace/.php-cs-fixer.php

@@ -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);
+

src/Propagation/CloudTrace/README.md

@@ -0,0 +1,35 @@
+[![Releases](https://img.shields.io/badge/releases-purple)](https://github.com/opentelemetry-php/extension-propagator-cloudtrace/releases)
+[![Issues](https://img.shields.io/badge/issues-pink)](https://github.com/open-telemetry/opentelemetry-php/issues)
+[![Source](https://img.shields.io/badge/source-contrib-green)](https://github.com/open-telemetry/opentelemetry-php-contrib/tree/main/src/Propagation/CloudTrace)
+[![Mirror](https://img.shields.io/badge/mirror-opentelemetry--php--contrib-blue)](https://github.com/opentelemetry-php/extension-propagator-cloudtrace)
+[![Latest Version](http://poser.pugx.org/open-telemetry/extension-propagator-cloudtrace/v/unstable)](https://packagist.org/packages/open-telemetry/extension-propagator-cloudtrace/)
+[![Stable](http://poser.pugx.org/open-telemetry/extension-propagator-cloudtrace/v/stable)](https://packagist.org/packages/open-telemetry/extension-propagator-cloudtrace/)
+
+This is a read-only subtree split of https://github.com/open-telemetry/opentelemetry-php-contrib.
+
+# OpenTelemetry CloudTrace Propagator
+
+CloudTrace is a propagator that supports the specification for the header "x-cloud-trace-context" used for trace context propagation across
+service boundaries. (https://cloud.google.com/trace/docs/setup#force-trace). OpenTelemetry PHP CloudTrace Propagator Extension provides
+option to use it bi-directionally or one-way. One-way does not inject the header for downstream consumption, it only processes the incoming headers
+and returns the correct span context. It only attaches to existing X-Cloud-Trace-Context traces and does not create downstream ones.
+
+## Installation
+
+```sh
+composer require open-telemetry/extension-propagator-cloudtrace
+```
+
+## Usage
+
+For one-way CloudTrace:
+
+```
+$propagator = CloudTracePropagator::getOneWayInstance();
+```
+
+For bi-directional CloudTrace:
+
+```
+$propagator = CloudTracePropagator::getInstance();
+```

src/Propagation/CloudTrace/_register.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+use OpenTelemetry\Extension\Propagator\CloudTrace\CloudTracePropagator;
+use OpenTelemetry\SDK\Registry;
+
+if (!class_exists(Registry::class)) {
+    return;
+}
+
+Registry::registerTextMapPropagator(
+    'cloudtrace',
+    CloudTracePropagator::getInstance()
+);
+
+Registry::registerTextMapPropagator(
+    'cloudtrace-oneway',
+    CloudTracePropagator::getOneWayInstance()
+);

src/Propagation/CloudTrace/composer.json

@@ -0,0 +1,39 @@
+{
+  "name": "open-telemetry/extension-propagator-cloudtrace",
+  "description": "CloudTraceContext propagator extension for OpenTelemetry PHP.",
+  "keywords": ["opentelemetry", "otel", "tracing", "apm", "extension", "propagator", "cloudtrace"],
+  "type": "library",
+  "readme": "./README.md",
+  "license": "Apache-2.0",
+  "minimum-stability": "dev",
+  "prefer-stable": true,
+  "require": {
+    "php": "^8.1",
+    "open-telemetry/api": "^1.0",
+    "open-telemetry/context": "^1.0"
+  },
+  "autoload": {
+    "psr-4":{
+      "OpenTelemetry\\Extension\\Propagator\\CloudTrace\\": "src/"
+    },
+    "files":[
+      "_register.php"
+    ]
+  },
+  "require-dev": {
+    "friendsofphp/php-cs-fixer": "^3",
+    "phan/phan": "^5.0",
+    "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": "^4|^5|^6"
+  },
+  "config": {
+    "allow-plugins": {
+      "php-http/discovery": true,
+      "tbachert/spi": true
+    }
+  }
+}

src/Propagation/CloudTrace/phpstan.neon.dist

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

src/Propagation/CloudTrace/phpunit.xml.dist

@@ -0,0 +1,44 @@
+<?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>
+    </testsuites>
+
+</phpunit>

src/Propagation/CloudTrace/psalm.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>

src/Propagation/CloudTrace/src/CloudTraceFormatter.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\Extension\Propagator\CloudTrace;
+
+use OpenTelemetry\API\Trace\SpanContext;
+use OpenTelemetry\API\Trace\SpanContextInterface;
+
+/**
+ * This format using a human readable string encoding to propagate SpanContext.
+ * The current format of the header is `<trace-id>[/<span-id>][;o=<options>]`.
+ * The options are a bitmask of options. Currently the only option is the
+ * least significant bit which signals whether the request was traced or not
+ * (1 = traced, 0 = not traced).
+ */
+final class CloudTraceFormatter
+{
+    const CONTEXT_HEADER_FORMAT = '/([0-9a-fA-F]{32})(?:\/(\d+))?(?:;o=(\d+))?/';
+
+    /**
+     * Generate a SpanContext object from the Trace Context header
+     */
+    public static function deserialize(string $header) : SpanContextInterface
+    {
+        $matched = preg_match(self::CONTEXT_HEADER_FORMAT, $header, $matches);
+
+        if (!$matched) {
+            return SpanContext::getInvalid();
+        }
+        if (!array_key_exists(2, $matches) || empty($matches[2])) {
+            return SpanContext::getInvalid();
+        }
+        if (!array_key_exists(3, $matches)) {
+            return SpanContext::getInvalid();
+        }
+
+        return SpanContext::createFromRemoteParent(
+            strtolower($matches[1]),
+            Utils::leftZeroPad(Utils::decToHex($matches[2])),
+            (int) ($matches[3] === '1')
+        );
+    }
+
+    /**
+     * Convert a SpanContextInterface to header string
+     */
+    public static function serialize(SpanContextInterface $context) : string
+    {
+        $ret = $context->getTraceId();
+        if ($context->getSpanId()) {
+            $ret .= '/' . Utils::hexToDec($context->getSpanId());
+        }
+
+        return $ret . (';o=' . ($context->isSampled() ? '1' : '0'));
+    }
+}