Merge pull request #271 from commercetools/opentelemetry-integration

DEVX-477 some fixes and new APM integration with open telemetry

Author: barbara79

README.md

@@ -67,7 +67,7 @@ The SDK consists of the following projects:
 * `lib/commercetools-history/src`: Contains all generated models and request builders to communicate with the [Change History API](https://docs.commercetools.com/api/history/change-history).
 
 In addition, the SDK has the following directories:
-* `examples/symfony-app` : it shows how the PHP SDK can be used in a Symfony application for a Docker environment with NewRelic monitoring enabled. 
+* `examples/` : One Dockerized Symfony app per APM (New Relic, Datadog, Dynatrace, OpenTelemetry) to demo PHP SDK usage. 
 * `test/integration` : Integration Tests for the SDK. A good way for anyone using the PHP SDK to understand it further.
 * `test/unit` : Unit Tests for 
 * `lib/commercetools-api-tests` : generated unit test for each class for the api folder
@@ -957,7 +957,17 @@ To migrate from the 1.x to the 2.x, there is a guideline below:
 
 ## Observability
 
-To monitor and observe the SDK, see the official documentation [Observability](https://docs.commercetools.com/sdk/observability), there is a [Demo application](https://github.com/commercetools/commercetools-sdk-php-v2/tree/master/examples/symfony-app) which shows how to monitor the PHP SDK with New Relic and Datadog.
+To monitor and observe the SDK, see the official documentation [Observability](https://docs.commercetools.com/sdk/observability), there is a [Demo application](https://github.com/commercetools/commercetools-sdk-php-v2/tree/master/examples/) which shows how to monitor the PHP SDK with New Relic, Datadog, Dynatrace and Open Telemetry.
+
+To monitor and observe the SDK, refer to the official documentation on [Observability](https://docs.commercetools.com/sdk/observability).
+
+The [Demo application](https://github.com/commercetools/commercetools-sdk-php-v2/tree/master/examples/) demonstrates how to monitor the PHP SDK with the following APMs:
+
+- [New Relic](https://github.com/commercetools/commercetools-sdk-php-v2/tree/master/examples/symfony-app-newrelic)
+- [Datadog](https://github.com/commercetools/commercetools-sdk-php-v2/tree/master/examples/symfony-app-datadog)
+- [Dynatrace](https://github.com/commercetools/commercetools-sdk-php-v2/tree/master/examples/symfony-app-dynatrace)
+- [OpenTelemetry](https://github.com/commercetools/commercetools-sdk-php-v2/tree/master/examples/symfony-app-opentelemetry) (configured to work with New Relic for distributed tracing)
+Each APM integration is implemented through configuration and can be easily enabled using the provided instructions in the demo app for each platform.
 
 ## Documentation
 

examples/symfony-app-datadog/docker-compose.yml

@@ -35,7 +35,7 @@ services:
     image: datadog/agent:latest
     environment:
       - DD_API_KEY=${DD_API_KEY}
-      - DD_SITE=datadoghq.com
+      - DD_SITE=${DD_SITE}
       - DD_APM_ENABLED=true
     ports:
       - "127.0.0.1:8126:8126/tcp"

examples/symfony-app-datadog/docker/php/.env.sample

@@ -26,7 +26,7 @@ DD_API_KEY=your datadog api key
 DD_APM_ENABLED=true
 DD_TRACE_CLI_ENABLED=true
 DD_TRACE_ENABLED=true
-DD_SITE=datadoghq.com
+DD_SITE=datadoghq.XXX  your datadog site
 
 # APP_NAME=PHP-SDK
 ###< symfony/framework-bundle ###

examples/symfony-app-datadog/src/Controller/IndexController.php

@@ -6,7 +6,6 @@
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Response;
 
-//added just because New Relic<->Symfony needed it
 class IndexController extends AbstractController
 {
     private $logger;

examples/symfony-app-dynatrace/docker/php/Dockerfile.dynatrace

@@ -1,4 +1,3 @@
-# Specify the appropriate platform for x86_64
 FROM php:8.2-fpm
 
 # Install necessary packages and PHP extensions

examples/symfony-app-dynatrace/src/Controller/IndexController.php

@@ -6,7 +6,6 @@
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Response;
 
-//added just because New Relic<->Symfony needed it
 class IndexController extends AbstractController
 {
     private $logger;

examples/symfony-app-newrelic/src/Controller/IndexController.php

@@ -6,7 +6,6 @@
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Response;
 
-//added just because New Relic<->Symfony needed it
 class IndexController extends AbstractController
 {
     private $logger;

examples/symfony-app-opentelemetry/.dockerignore

@@ -0,0 +1,30 @@
+**/*.log
+**/*.md
+**/*.php~
+**/*.dist.php
+**/*.dist
+**/*.cache
+**/._*
+**/.dockerignore
+**/.DS_Store
+**/.git/
+**/.gitattributes
+**/.gitignore
+**/.gitmodules
+**/docker-compose.*.yaml
+**/docker-compose.*.yml
+**/docker-compose.yaml
+**/docker-compose.yml
+**/Dockerfile
+**/Thumbs.db
+.github/
+docs/
+public/bundles/
+tests/
+var/
+vendor/
+.editorconfig
+.env.*.local
+docker/php/.env.sample
+.env.local.php
+.env.test

examples/symfony-app-opentelemetry/.editorconfig

@@ -0,0 +1,72 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+# Change these settings to your own preference
+indent_style = space
+indent_size = 4
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{js,html,ts,tsx}]
+indent_style = space
+indent_size = 2
+
+[*.json]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.php]
+indent_style = space
+indent_size = 4
+
+[*.sh]
+indent_style = tab
+indent_size = 4
+
+[*.xml{,.dist}]
+indent_style = space
+indent_size = 4
+
+[*.{yaml,yml}]
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = false
+
+[.github/workflows/*.yml]
+indent_style = space
+indent_size = 2
+
+[.gitmodules]
+indent_style = tab
+indent_size = 4
+
+[.php_cs{,.dist}]
+indent_style = space
+indent_size = 4
+
+[.travis.yml]
+indent_style = space
+indent_size = 2
+
+[composer.json]
+indent_style = space
+indent_size = 4
+
+[docker-compose{,.*}.{yaml,yml}]
+indent_style = space
+indent_size = 2
+
+[Dockerfile]
+indent_style = tab
+indent_size = 4

examples/symfony-app-opentelemetry/.gitattributes

@@ -0,0 +1,16 @@
+* text=auto eol=lf
+
+*.conf text eol=lf
+*.html text eol=lf
+*.ini text eol=lf
+*.js text eol=lf
+*.json text eol=lf
+*.md text eol=lf
+*.php text eol=lf
+*.sh text eol=lf
+*.yaml text eol=lf
+*.yml text eol=lf
+bin/console text eol=lf
+
+*.ico binary
+*.png binary