open-telemetry/opentelemetry-instrumentation-installer

OpenTelemetry auto-instrumentation installer

Maintainers

Details

github.com/opentelemetry-php/contrib-instrumentation-installer

Homepage

Source

Installs: 55 795

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 3

Forks: 1

0.0.6 2023-08-23 22:02 UTC

Requires (Dev)

Apache-2.0 411f54204dee15a930d1f98bf8c34b767b7f64f9

installerinstrumentationtracingopentelemetryopen-telemetryotel

This package is auto-updated.

Last update: 2024-12-05 01:54:13 UTC

README

This directory contains two scripts that helps install auto-instrumentation support and run application.

First script install-otel-instrumentation will install all needed dependencies for auto-instrumentation. Second run-with-otel-instrumentation is responsible for setting few environment variables (that are needed to export traces into backend) and running application.

Install script works in two modes:

  • basic (will install defaults)
  • advanced (interactive mode, you will control whole process)

Example workflow

This section shows how to install and run auto-instrumented application which uses Slim framework. To generate application, we follow steps described here: https://www.slimframework.com/.

    composer create-project slim/slim-skeleton:dev-master slimauto
    cd slimauto
    composer require open-telemetry/opentelemetry-instrumentation-installer
    ./vendor/bin/install-otel-instrumentation basic beta
    ./vendor/bin/run-with-otel-instrumentation php -S localhost:8080 -t public public/index.php