Merge pull request #22 from tidal/sf_bundle

Symfony Bundle (Part1 SdkBundle)

Author: bobstrecansky

.gitattributes

@@ -0,0 +1,12 @@
+/docker export-ignore
+/examples export-ignore
+/tests export-ignore
+/.* export-ignore
+/*dist export-ignore
+/code-of-conduct.md
+/CODEOWNERS export-ignore
+/CONTRIBUTING.md export-ignore
+/docker-compose* export-ignore
+/Makefile export-ignore
+
+/instrumentation/symfony/OtelSdkBundle/composer.json

.gitignore

@@ -6,7 +6,12 @@ vendor
 coverage.clover
 tests/coverage
 .php_cs.cache
+phpunit.xml
+psalm.xml
+phpstan.neon
+.php-cs-fixer.cache
 
 # W3C Test Service build artifacts
 tests/TraceContext/W3CTestService/test_app
 tests/TraceContext/W3CTestService/trace-context
+

README.md

@@ -1,2 +1,48 @@
-# opentelemetry-php-contrib
-opentelemetry-php-contrib
+# OpenTelemetry php contrib library
+
+## Current Project Status
+This project currently lives in a pre-alpha status.  Our current release is not production ready; it has been created in order to receive feedback from the community.
+
+For more information, please, consult the documentation of the main [OpenTelemetry php project](https://github.com/open-telemetry/opentelemetry-php).
+
+## Installation
+The recommended way to install the library is through [Composer](http://getcomposer.org):
+
+1.)  Install the composer package using [Composer's installation instructions](https://getcomposer.org/doc/00-intromd#installation-linux-unix-macos).
+
+2.)  Add
+```bash
+    "minimum-stability": "dev",
+    "prefer-stable": true,
+    "repositories": [
+        {
+            "type": "vcs",
+            "url": "https://github.com/open-telemetry/opentelemetry-php-contrib"
+        }
+    ],
+```
+
+To your project's `composer.json` file, as this utility has not reached a stable release status yet, 
+and is not yet registered on packagist.org
+
+3.)  Install the dependency with composer:
+
+```bash
+$ composer require open-telemetry/opentelemetry-php-contrib
+```
+
+## Usage/Examples
+
+### AWS
+- You can find examples on how to use the ASW classes in the  [examples directory](/examples/aws/README.md).
+
+### Symfony
+#### SdkBundle
+- The documentation for the Symfony SdkBundle can be found [here](/instrumentation/symfony/OtelSdkBundle/README.md).
+- An example symfony application using the SdkBundle can be found [here](https://github.com/tidal/otel-sdk-bundle-example-sf5).
+
+
+## Development
+
+Please, consult the documentation of the main [OpenTelemetry php project](https://github.com/open-telemetry/opentelemetry-php).
+

composer.json

@@ -3,6 +3,14 @@
     "description": "The contributor repo for opentelemetry-php",
     "type": "library",
     "license": "Apache-2.0",
+    "authors": [
+        {
+            "name": "Bob Strecansky",
+            "email": "[email protected]"
+        }
+    ],
+    "minimum-stability": "dev",
+    "prefer-stable": true,
     "repositories": [
         {
           "type": "vcs",
@@ -12,31 +20,34 @@
     "require": {
         "php": "^7.4 || ^8.0",
         "ext-json": "*",
-        "open-telemetry/opentelemetry": "dev-main"
+        "open-telemetry/opentelemetry": "dev-main",
+        "php-http/message": "^1.12",
+        "php-http/discovery": "^1.14"
+    },
+    "replace": {
+        "open-telemetry/otel-sdk-bundle": "self.version"
+    },
+    "conflict": {
+        "open-telemetry/opentelemetry": "<=0.0.3"
     },
-    "authors": [
-        {
-            "name": "Bob Strecansky",
-            "email": "[email protected]"
-        }
-    ],
     "autoload": {
+        "psr-4": {
+            "OpenTelemetry\\Instrumentation\\Symfony\\": "instrumentation/symfony"
+        },
         "classmap": [
             "detectors/",
             "exporters/",
             "instrumentation/",
-            "propagators/",
-            "examples/"
-        ] 
+            "propagators/"
+        ],
+        "exclude-from-classmap": ["instrumentation/symfony/OtelSdkBundle/vendor"]
     },
     "autoload-dev": {
-        "classmap": [
-            "detectors/",
-            "exporters/",
-            "instrumentation/",
-            "propagators/",
-            "examples/"
-        ] 
+        "psr-4": {
+            "OpenTelemetry\\Test\\Unit\\Symfony\\": "tests/unit/instrumentation/Symfony",
+            "OpenTelemetry\\Test\\Integration\\Symfony\\": "tests/integration/instrumentation/Symfony"
+        },
+        "classmap": ["examples/"]
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5",
@@ -49,7 +60,28 @@
         "psalm/plugin-phpunit": "^0.13.0",
         "guzzlehttp/guzzle": "^7.3",
         "guzzlehttp/psr7": "^2.0@RC",
-        "symfony/http-client": "^5.2",
-        "nyholm/psr7": "^1.4"
+        "symfony/http-client": "^5.3",
+        "nyholm/psr7": "^1.4",
+        "symfony/config": "^4.4|^5.0|^6.0",
+        "symfony/http-kernel": "^4.4|^5.3|^6.0",
+        "symfony/polyfill-php80": "^1.16",
+        "symfony/yaml": "^4.4|^5.3|^6.0",
+        "symfony/proxy-manager-bridge": "^4.4|^5.3|^6.0",
+        "symfony/options-resolver": "^4.4|^5.3|^6.0",
+        "dg/bypass-finals": "^1.3",
+        "kriswallsmith/buzz": "^1.2"
+    },
+    "suggest": {
+        "symfony/config": "Needed to use otel-sdk-bundle",
+        "symfony/dependency-injection": "Needed to use otel-sdk-bundle",
+        "symfony/options-resolver": "Needed to use otel-sdk-bundle"
+    },
+    "scripts": {
+        "post-install-cmd": [
+            "composer dump-autoload --optimize"
+        ],
+        "post-update-cmd": [
+            "composer dump-autoload --optimize"
+        ]
     }
 }

examples/README.md examples/aws/README.mdexamples/README.md renamed to examples/aws/README.md

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\Instrumentation\Symfony\OtelSdkBundle\DependencyInjection;
+
+interface ConfigMappings
+{
+    public const SAMPLERS = [
+        Configuration::ALWAYS_ON_SAMPLER => Samplers::ALWAYS_ON,
+        Configuration::ALWAYS_OFF_SAMPLER => Samplers::ALWAYS_OFF,
+        Configuration::TRACE_ID_RATIO_SAMPLER => Samplers::TRACE_ID_RATIO_BASED,
+        Configuration::PARENT_BASED_SAMPLER => Samplers::PARENT_BASED,
+    ];
+    public const SPAN_PROCESSORS = [
+        Configuration::SIMPLE_PROCESSOR => SpanProcessors::SIMPLE,
+        Configuration::BATCH_PROCESSOR => SpanProcessors::BATCH,
+        Configuration::NOOP_PROCESSOR => SpanProcessors::NOOP,
+        Configuration::MULTI_PROCESSOR => SpanProcessors::MULTI,
+    ];
+    public const SPAN_EXPORTERS = [
+        Configuration::JAEGER_EXPORTER => SpanExporters::JAEGER,
+        Configuration::ZIPKIN_EXPORTER => SpanExporters::ZIPKIN,
+        Configuration::NEWRELIC_EXPORTER => SpanExporters::NEWRELIC,
+        Configuration::OTLP_HTTP_EXPORTER => SpanExporters::OTLP_HTTP,
+        Configuration::OTLP_GRPC_EXPORTER => SpanExporters::OTLP_GRPC,
+        Configuration::ZIPKIN_TO_NEWRELIC_EXPORTER => SpanExporters::ZIPKIN_TO_NEWRELIC,
+    ];
+}