Getting Started

Installation

Run the following command to install it in your application:

composer require friendsofopentelemetry/opentelemetry-bundle

Notes

OpenTelemetry SDK and tbachert/spi

The OpenTelemetry SDK uses tbachert/spi, a Composer plugin that registers services by loading files from the autoload configuration. This acts similarly to a container but is not the recommended approach for managing services in Symfony applications.

To ensure a clean and optimal setup:

• When prompted during installation, do not enable the tbachert/spi plugin.
• Install the mcaskill/composer-exclude-files Composer plugin and exclude OpenTelemetry files from the autoload process by adding the following configuration to your composer.json file:

{
  "extra": {
    "exclude-from-files": [
      "open-telemetry/*"
    ]
  }
}

HTTP PSR Discovery and php-http/discovery

You may also be prompted to enable the php-http/discovery Composer plugin. This plugin allows libraries to discover HTTP PSR implementations dynamically.

• Recommendation: Enable the plugin if your application requires it, but this is optional.

HTTP client for telemetry export transports

The bundle needs a PSR-18 HTTP client to export telemetry data over HTTP (OTLP, Zipkin). By default, it uses Symfony's Psr18Client if symfony/http-client is installed:

composer require symfony/http-client

You can use any PSR-18 compatible client by configuring the transport_http_client option:

open_telemetry:
  transport_http_client: app.my_custom_psr18_client

Supported Versions

There is no stable version yet, so you can use the dev version to install the bundle.

Usage

This bundle is not yet available using Symfony Flex, so you have to manually configure it.

In your config/bundles.php file, add the following line at the end of the array:

return [
    // ...
    FriendsOfOpenTelemetry\OpenTelemetryBundle::class => ['all' => true],
];

Then, create a new file config/packages/open_telemetry.yaml and add the following minimal configuration:

open_telemetry:
  service:
    namespace: 'MyCompany'
    name: 'MyApp'
    version: '1.0.0'
    environment: '%kernel.environment%'

For further details on the configuration, please refer to the Configuration page.