跳转至

Getting Started

This page will show you how to get started with OpenTelemetry in PHP.

You will learn how you can instrument a simple PHP application automatically, in such a way that traces, metrics and logs are emitted to the console.

Prerequisites

Ensure that you have the following installed locally: open source

Before you get started make sure that you have both available in your shell:

1
2
$ php -v
$ composer -v

Example Application

The following example uses a basic Slim application. If you are not using Slim, that's ok — you can use OpenTelemetry PHP with other web frameworks as well, such as Wordpress, Symfony and Laravel. For a complete list of libraries for supported frameworks, see the registry.

Dependencies

In an empty directory create a minimal composer.json file in your directory:

1
echo '{"require": {}, "minimum-stability": "beta", "config": {"allow-plugins": {"php-http/discovery": true}}}' > composer.json

In an empty directory create a minimal composer.json file in your directory:

1
2
composer require slim/slim:"4.*"
composer require slim/psr7

Create and launch an HTTP Server

In that same directory, create a file called index.php

Export to Console

In your directory create a file called GettingStarted.php with the following content:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
<?php
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;
use Slim\Factory\AppFactory;

require __DIR__ . '/vendor/autoload.php';

$app = AppFactory::create();

$app->get('/rolldice', function (Request $request, Response $response, $args) {
    $response->getBody()->write(strval(random_int(1,6)));
    return $response;
});

$app->run();

Run the application with the following command and open http://localhost:8080/rolldice in your web browser to ensure it is working.

1
php -S localhost:8080

Instrumentation

Next, you’ll use the OpenTelemetry PHP extension to automatically instrument the application at launch time.

  1. Since the extension is built from source, you need to setup some build tools

{{< tabpane lang=shell persistLang=false >}}

{{< tab "Linux (apt)" >}}sudo apt-get install gcc make autoconf{{< /tab >}}

{{< tab "MacOS (homebrew)" >}}brew install gcc make autoconf{{< /tab >}}

{{< /tabpane >}}

  1. Build the extension with PECL:
1
$ pecl install opentelemetry-beta

{{% alert title="Note" color="warning" %}}If you want to pickle or the docker-specific use php-extension-installer to build/install the extension, read the instructions here. {{% /alert %}}

  1. Add the extension to your php.ini file:
1
2
[opentelemetry]
extension=opentelemetry.so
  1. Verify that the extension is installed and enabled:
1
$ php -m | grep opentelemetry
  1. Add additional dependencies to your application, which are required for the automatic instrumentation of your code:
1
$ composer require php-http/guzzle7-adapter open-telemetry/sdk open-telemetry/opentelemetry-auto-slim

With the OpenTelemetry PHP extension set up you can now run your application and automatically instrument it at launch time:

1
env OTEL_PHP_AUTOLOAD_ENABLED=true  OTEL_TRACES_EXPORTER=console OTEL_METRICS_EXPORTER=none OTEL_LOGS_EXPORTER=none php -S localhost:8080

Open http://localhost:8080/rolldice in your web browser and reload the page a few times. After a while you should see the spans printed to your console:

View example output 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
[
  {
    "name": "GET /rolldice",
    "context": {
      "trace_id": "16d7c6da7c021c574205736527816eb7",
      "span_id": "268e52331de62e33",
      "trace_state": ""
    },
    "resource": {
      "service.name": "__root__",
      "service.version": "1.0.0+no-version-set",
      "telemetry.sdk.name": "opentelemetry",
      "telemetry.sdk.language": "php",
      "telemetry.sdk.version": "1.0.0beta10",
      "telemetry.auto.version": "1.0.0beta5",
      "process.runtime.name": "cli-server",
      "process.runtime.version": "8.2.6",
      "process.pid": 24435,
      "process.executable.path": "/bin/php",
      "process.owner": "php",
      "os.type": "darwin",
      "os.description": "22.4.0",
      "os.name": "Darwin",
      "os.version": "Darwin Kernel Version 22.4.0: Mon Mar  6 20:59:28 PST 2023; root:xnu-8796.101.5~3/RELEASE_ARM64_T6000",
      "host.name": "OPENTELEMETRY-PHP",
      "host.arch": "arm64"
    },
    "parent_span_id": "",
    "kind": "KIND_SERVER",
    "start": 1684749478068582482,
    "end": 1684749478072715774,
    "attributes": {
      "code.function": "handle",
      "code.namespace": "Slim\\App",
      "code.filepath": "/vendor/slim/slim/Slim/App.php",
      "code.lineno": 197,
      "http.url": "http://localhost:8080/rolldice",
      "http.method": "GET",
      "http.request_content_length": "",
      "http.scheme": "http",
      "http.status_code": 200,
      "http.flavor": "1.1",
      "http.response_content_length": ""
    },
    "status": {
      "code": "Unset",
      "description": ""
    },
    "events": [],
    "links": []
  }
]

What's next?

For more: