shopware/opentelemetry

OpenTelemetry auto-instrumentation for Shopware

0.1.4 2024-04-25 11:59 UTC

Requires

• php: ^8.1
• ext-opentelemetry: *
• monolog/monolog: 2.* || 3.*
• open-telemetry/api: ^1.0.0beta10
• open-telemetry/sem-conv: ^1.22
• shopware/core: *
• symfony/http-client-contracts: *
• symfony/http-kernel: *

Requires (Dev)

• open-telemetry/opentelemetry-logger-monolog: *

Suggests

• open-telemetry/exporter-otlp: OTLP exporter for OpenTelemetry
• open-telemetry/opentelemetry-logger-monolog: Monolog logger for OpenTelemetry
• open-telemetry/transport-grpc: gRPC transport for OpenTelemetry

Apache-2.0

• shopware
• instrumentation
• tracing
• opentelemetry
• open-telemetry
• otel

README

Requirements

• ext-opentelemetry PHP extension
• Optional: ext-grpc when using the gRPC exporter

Installation

composer require shopware/opentelemetry

Configuration

Enable open telemetry with the following environment variables:

OTEL_PHP_AUTOLOAD_ENABLED=true
OTEL_SERVICE_NAME=shopware # or any other name

You will need to configure the exporter to send the data to a collector.

Here is an example with OTLP over gRPC:

OTEL_TRACES_EXPORTER=otlp
OTEL_EXPORTER_OTLP_PROTOCOL=grpc
OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317

You will need to install also composer packages: open-telemetry/transport-grpc and open-telemetry/exporter-otlp.

Enabling Shopware custom tracing

To enable tracing for Shopware, you need to add the following config:

# config/packages/opentelemetry.yaml

shopware:
    profiler:
        integrations:
            - OpenTelemetry

Adding custom spans

This spans are working with all profilers (Symfony Profiler bar, Tideways, ...) and are not exclusive to OpenTelemetry.

use Shopware\Core\Profiling\Profiler;

$value = Profiler::trace('<name>', function () {
    return $myFunction();
});

Forward logs to OpenTelemetry

You can forward logs to OpenTelemetry with the following configuration:

# config/packages/opentelemetry.yaml

monolog:
    handlers:
        main:
            type: service
            id: monolog.handler.open_telemetry
        elasticsearch:
            type: service
            id: monolog.handler.open_telemetry