Skip to content

Commit 0a60ab3

Browse files
authored
Update SDKBundle README (#37)
1 parent 6ae7ac9 commit 0a60ab3

File tree

1 file changed

+3
-60
lines changed

1 file changed

+3
-60
lines changed

src/Symfony/OtelSdkBundle/README.md

Lines changed: 3 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -47,57 +47,7 @@ the host from `localhost` to `jaeger` in the configurations described below)
4747

4848
### 2.1. Install PHP library/SDK dependencies
4949

50-
The [PHP library](https://github.com/open-telemetry/opentelemetry-php) requires a PHP version of ^7.4 or ^8.0.
51-
52-
#### 2.1.1. Install PSR17/18 implementations
53-
54-
The [PHP library](https://github.com/open-telemetry/opentelemetry-php) has a dependency on both a [PSR17](https://www.php-fig.org/psr/psr-17/)
55-
and a [PSR18](https://www.php-fig.org/psr/psr-18/) implementation. To be on the safe side of possible future upgrades
56-
of the PHP library, you should consider installing a `php-http/async-client` implementation for PSR18. This will also give you greater
57-
control on how to configure/extend your http client by using [HTTPLUG/PHP-HTTP](https://docs.php-http.org/en/latest/index.html).
58-
You can find appropriate composer packages implementing given standards on [packagist.org](https://packagist.org/).
59-
Follow [this link](https://packagist.org/providers/psr/http-factory-implementation) to find a `PSR17 (HTTP factories)` implementation,
60-
and [this link](https://packagist.org/providers/php-http/async-client-implementation) to find a `php-http/async-client` implementation.
61-
62-
> Notice: if you already have the `symfony/http-client` package installed, you are already covered in terms of the
63-
> `php-http/async-client` implementation. A popular choice of a `PSR17 (HTTP factories)` implementation to use with
64-
> Symfony is `nyholm/psr7`, as it is both lightweight and automatically registers its factories as services in Symfony
65-
> (if you have `symfony/flex` installed and working, that is).
66-
67-
#### 2.1.1. Install PHP ext-grpc
68-
69-
The [PHP library](https://github.com/open-telemetry/opentelemetry-php) has a dependency on the PHP gRPC [extension](https://pecl.php.net/package/gRPC).
70-
71-
There are basically three ways to install the gRPC extension which will be described below. Keep in mind, that whatever way
72-
to install the extension you choose, the compilation can take up to 10-15 minutes. (As an alternative you can search for
73-
a pre-compiled extension binary for your OS and PHP version)
74-
75-
1. **Installation with pecl installer** (which should come with your PHP installation):
76-
77-
```bash
78-
[sudo] pecl install grpc
79-
```
80-
81-
2. **Installation with pickle installer** (which you can find [here](https://github.com/FriendsOfPHP/pickle)):
82-
83-
```bash
84-
[sudo] pickle install grpc
85-
```
86-
87-
3. **Manually compiling the extension**, which is not really complicated either, but you should know
88-
what you are doing, so we won't cover it here.
89-
90-
> Notice: The artifact of the gRPC extension can be as large as 100mb (!!!), there are 'hacks' to reduce that size,
91-
> which you can find [in this thread](https://github.com/grpc/grpc/issues/23626). Use at your own risk.
92-
93-
> Notice: A lot of providers and systems (OpenShift's S2I for PHP for example), etc. still regard the grpc extension
94-
> as kind of 'exotic', or in other words the extension is not or cannot be installed.
95-
> The [OpenTelemetry PHP library](https://github.com/open-telemetry/opentelemetry-php) (as for now) only needs this
96-
> extension, when you want to use the `OTLP gRPC Exporter`. If you use any of the current other (HTTP based exporters),
97-
> eg. jaeger or zipkin, you actually don't need the PHP grpc extension to be present. A 'trick' to install this bundle
98-
> and the SDK without the grpc extension is to add an `--ignore-platform-reqs=ext-grpc` option to all of your composer
99-
> calls, eg.: `composer update --ignore-platform-reqs=ext-grpc`. Another way is to add a `plaform` entry to your
100-
> composer.json file to 'pretend' the grpc extension is installed, which you can find in the [composer documentation](https://getcomposer.org/doc/06-config.md#platform).
50+
Take a look at the documentation of the [PHP library](https://github.com/open-telemetry/opentelemetry-php) on how to install its dependencies.
10151

10252
### 2.2. Install the Bundle
10353

@@ -112,18 +62,11 @@ The recommended way to install the library is through [Composer](http://getcompo
11262
```bash
11363
"minimum-stability": "dev",
11464
"prefer-stable": true,
115-
"repositories": [
116-
{
117-
"type": "vcs",
118-
"url": "https://github.com/open-telemetry/opentelemetry-php-contrib"
119-
}
120-
],
12165
```
12266

123-
To your project's `composer.json` file, as this utility has not reached a stable release status yet,
124-
and is not yet registered on packagist.org
67+
To your project's `composer.json` file, as this utility has not reached a stable release status yet.
12568

126-
3. Install the dependency with composer:
69+
3. Install the package with composer:
12770

12871
```bash
12972
$ composer require open-telemetry/opentelemetry-php-contrib

0 commit comments

Comments
 (0)