-
Notifications
You must be signed in to change notification settings - Fork 92
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Following on from Laravel's readme updates, apply the same to other readme files. Add some badges, and a note to make clear that people are probably looking at a read-only subtree split. In passing, update wordpress dockerfile and metapackage to use RC
- Loading branch information
Showing
18 changed files
with
225 additions
and
424 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,10 @@ | ||
| [](https://github.com/opentelemetry-php/context-swoole/releases) | ||
| [](https://github.com/open-telemetry/opentelemetry-php/issues) | ||
| [](https://github.com/open-telemetry/opentelemetry-php-contrib/tree/main/src/Context/Swoole) | ||
| [](https://github.com/opentelemetry-php/context-swoole) | ||
| [](https://packagist.org/packages/open-telemetry/context-swoole/) | ||
| [](https://packagist.org/packages/open-telemetry/context-swoole/) | ||
|
|
||
| This is a read-only subtree split of https://github.com/open-telemetry/opentelemetry-php-contrib. | ||
|
|
||
| # OpenTelemetry Swoole context |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,50 +1,29 @@ | ||
| # OpenTelemetry HTTPlug async auto-instrumentation | ||
| [](https://github.com/opentelemetry-php/contrib-auto-http-async/releases) | ||
| [](https://github.com/open-telemetry/opentelemetry-php/issues) | ||
| [](https://github.com/open-telemetry/opentelemetry-php-contrib/tree/main/src/Instrumentation/HttpAsyncClient) | ||
| [](https://github.com/opentelemetry-php/contrib-auto-http-async) | ||
| [](https://packagist.org/packages/open-telemetry/opentelemetry-auto-http-async/) | ||
| [](https://packagist.org/packages/open-telemetry/opentelemetry-auto-http-async/) | ||
|
|
||
| **Preferred and simplest way to install auto-instrumentation (c extension plus instrumentation libraries) is to use [opentelemetry-instrumentation-installer](https://github.com/open-telemetry/opentelemetry-php-contrib/tree/main/src/AutoInstrumentationInstaller).** | ||
| **The same process can be done manually by installing [c extension](https://github.com/open-telemetry/opentelemetry-php-instrumentation#installation) plus all needed instrumentation libraries like [HttpAsyncClient](#Installation-via-composer)** | ||
| This is a read-only subtree split of https://github.com/open-telemetry/opentelemetry-php-contrib. | ||
|
|
||
| ## Requirements | ||
| # OpenTelemetry HTTPlug async auto-instrumentation | ||
|
|
||
| * OpenTelemetry extension | ||
| * OpenTelemetry SDK an exporter (required to actually export traces) | ||
| * An HTTPlug async client | ||
| * (optional) OpenTelemetry [SDK Autoloading](https://github.com/open-telemetry/opentelemetry-php/blob/main/examples/autoload_sdk.php) configured | ||
| Please read https://opentelemetry.io/docs/instrumentation/php/automatic/ for instructions on how to | ||
| install and configure the extension and SDK. | ||
|
|
||
| ## Overview | ||
| Auto-instrumentation hooks are registered via composer, which will: | ||
|
|
||
| * create spans automatically for each async request that is sent | ||
|
|
||
| ## Manual configuration | ||
| If you are not using SDK autoloading, you will need to create and register a `TracerProvider` early in your application's lifecycle: | ||
|
|
||
| ```php | ||
| <?php | ||
| require_once 'vendor/autoload.php'; | ||
|
|
||
| $tracerProvider = /*create tracer provider*/; | ||
| $scope = \OpenTelemetry\API\Instrumentation\Configurator::create() | ||
| ->withTracerProvider($tracerProvider) | ||
| ->activate(); | ||
|
|
||
| $client->sendAsyncRequest($request); | ||
|
|
||
| $scope->detach(); | ||
| $tracerProvider->shutdown(); | ||
| ``` | ||
| ## Installation via composer | ||
|
|
||
| ```bash | ||
| $ composer require open-telemetry/opentelemetry-auto-http-async | ||
| ``` | ||
| * create spans automatically for each async HTTP request that is sent | ||
| * add a `traceparent` header to the request to facilitate distributed tracing | ||
|
|
||
| ## Configuration | ||
|
|
||
| Parts of this auto-instrumentation library can be configured, more options are available throught the | ||
| [General SDK Configuration](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/sdk-environment-variables.md#general-sdk-configuration): | ||
| The extension can be disabled via [runtime configuration](https://opentelemetry.io/docs/instrumentation/php/sdk/#configuration): | ||
|
|
||
| | Name | Default value | Values | Example | Description | | ||
| |-------------------------------------|---------------|-------------------------|-------------------|---------------------------------------------------------------------------------| | ||
| | OTEL_PHP_DISABLED_INSTRUMENTATIONS | [] | Instrumentation name(s) | http-async-client | Disable one or more installed auto-instrumentations, names are comma seperated. | | ||
| ```shell | ||
| OTEL_PHP_DISABLED_INSTRUMENTATIONS=http-async-client | ||
| ``` | ||
|
|
||
| Configurations can be provided as environment variables, or via `php.ini` (or a file included by `php.ini`) | ||
| Request headers can be added as span attributes, if the header's name is found in the `php.ini` variable: `otel.instrumentation.http.request_headers` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,62 +1,24 @@ | ||
| # OpenTelemetry Laravel auto-instrumentation | ||
| [](https://github.com/opentelemetry-php/contrib-auto-laravel/releases) | ||
| [](https://github.com/open-telemetry/opentelemetry-php/issues) | ||
| [](https://github.com/open-telemetry/opentelemetry-php-contrib/tree/main/src/Instrumentation/Laravel) | ||
| [](https://github.com/opentelemetry-php/contrib-auto-laravel) | ||
| [](https://packagist.org/packages/open-telemetry/opentelemetry-auto-laravel/) | ||
| [](https://packagist.org/packages/open-telemetry/opentelemetry-auto-laravel/) | ||
|
|
||
| **Preferred and simplest way to install auto-instrumentation (c extension plus instrumentation libraries) is to use [opentelemetry-instrumentation-installer](https://github.com/open-telemetry/opentelemetry-php-contrib/tree/main/src/AutoInstrumentationInstaller).** | ||
| **The same process can be done manually by installing [c extension](https://github.com/open-telemetry/opentelemetry-php-instrumentation#installation) plus all needed instrumentation libraries like [Laravel](#Installation-via-composer)** | ||
| This is a read-only subtree split of https://github.com/open-telemetry/opentelemetry-php-contrib. | ||
|
|
||
| ## Requirements | ||
| # OpenTelemetry Laravel auto-instrumentation | ||
|
|
||
| * OpenTelemetry extension | ||
| * OpenTelemetry SDK and exporters (required to actually export traces) | ||
| Please read https://opentelemetry.io/docs/instrumentation/php/automatic/ for instructions on how to | ||
| install and configure the extension and SDK. | ||
|
|
||
| ## Overview | ||
| Currently only root span creation is supported (Illuminate\Foundation\Http\Kernel::handle hook). | ||
|
|
||
| To export spans, you will need to create and register a `TracerProvider` early in your application's | ||
| lifecycle. This can be done either manually or using SDK autoloading. | ||
|
|
||
| ### Using SDK autoloading | ||
|
|
||
| See https://github.com/open-telemetry/opentelemetry-php#sdk-autoloading | ||
|
|
||
| ### Manual setup | ||
|
|
||
| ```php | ||
| <?php | ||
| require_once 'vendor/autoload.php'; | ||
|
|
||
| $tracerProvider = /*create tracer provider*/; | ||
| $scope = \OpenTelemetry\API\Instrumentation\Configurator::create() | ||
| ->withTracerProvider($tracerProvider) | ||
| ->activate(); | ||
|
|
||
| //your application runs here | ||
|
|
||
| $scope->detach(); | ||
| $tracerProvider->shutdown(); | ||
| ``` | ||
|
|
||
| ## Installation via composer | ||
|
|
||
| ```bash | ||
| $ composer require open-telemetry/opentelemetry-auto-laravel | ||
| ``` | ||
|
|
||
| ## Installing dependencies and executing tests | ||
|
|
||
| From Laravel subdirectory: | ||
|
|
||
| ```bash | ||
| $ composer install | ||
| $ ./vendor/bin/phpunit tests | ||
| ``` | ||
| Auto-instrumentation hooks are registered via composer, and spans will automatically be created. | ||
|
|
||
| ## Configuration | ||
|
|
||
| Parts of this auto-instrumentation library can be configured, more options are available throught the | ||
| [General SDK Configuration](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/sdk-environment-variables.md#general-sdk-configuration): | ||
| The extension can be disabled via [runtime configuration](https://opentelemetry.io/docs/instrumentation/php/sdk/#configuration): | ||
|
|
||
| | Name | Default value | Values | Example | Description | | ||
| |-------------------------------------|---------------|-------------------------|---------|---------------------------------------------------------------------------------| | ||
| | OTEL_PHP_DISABLED_INSTRUMENTATIONS | [] | Instrumentation name(s) | laravel | Disable one or more installed auto-instrumentations, names are comma seperated. | | ||
|
|
||
| Configurations can be provided as environment variables, or via `php.ini` (or a file included by `php.ini`) | ||
| ```shell | ||
| OTEL_PHP_DISABLED_INSTRUMENTATIONS=laravel | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,64 +1,25 @@ | ||
| # OpenTelemetry MongoDB auto-instrumentation | ||
| [](https://github.com/opentelemetry-php/contrib-auto-mongodb/releases) | ||
| [](https://github.com/open-telemetry/opentelemetry-php/issues) | ||
| [](https://github.com/open-telemetry/opentelemetry-php-contrib/tree/main/src/Instrumentation/MongoDB) | ||
| [](https://github.com/opentelemetry-php/contrib-auto-mongodb) | ||
| [](https://packagist.org/packages/open-telemetry/opentelemetry-auto-mongodb/) | ||
| [](https://packagist.org/packages/open-telemetry/opentelemetry-auto-mongodb/) | ||
|
|
||
| **Preferred and simplest way to install auto-instrumentation (c extension plus instrumentation libraries) is to use [opentelemetry-instrumentation-installer](https://github.com/open-telemetry/opentelemetry-php-contrib/tree/main/src/AutoInstrumentationInstaller).** | ||
| **To run only this instrumentation, [install via composer](#Installation-via-composer)** | ||
| This is a read-only subtree split of https://github.com/open-telemetry/opentelemetry-php-contrib. | ||
|
|
||
| ## Requirements | ||
| # OpenTelemetry MongoDB auto-instrumentation | ||
|
|
||
| - OpenTelemetry extension | ||
| - OpenTelemetry SDK and exporters (required to actually export traces) | ||
| Please read https://opentelemetry.io/docs/instrumentation/php/automatic/ for instructions on how to | ||
| install and configure the extension and SDK. | ||
|
|
||
| ## Overview | ||
|
|
||
| Auto-instrumentation hooks are registered via composer, and spans will automatically be created for all MongoDB | ||
| operations like `find` or `aggregate`. | ||
|
|
||
| To export spans, you will need to create and register a `TracerProvider` early in your application's | ||
| lifecycle. This can be done either manually or using SDK autoloading. | ||
|
|
||
| ### Using SDK autoloading | ||
|
|
||
| See https://github.com/open-telemetry/opentelemetry-php#sdk-autoloading | ||
|
|
||
| ### Manual setup | ||
|
|
||
| ```php | ||
| <?php | ||
| require_once 'vendor/autoload.php'; | ||
|
|
||
| $tracerProvider = /*create tracer provider*/; | ||
| $scope = \OpenTelemetry\API\Instrumentation\Configurator::create() | ||
| ->withTracerProvider($tracerProvider) | ||
| ->activate(); | ||
|
|
||
| //your application runs here | ||
|
|
||
| $scope->detach(); | ||
| $tracerProvider->shutdown(); | ||
| ``` | ||
|
|
||
| ## Installation via composer | ||
|
|
||
| ```bash | ||
| $ composer require open-telemetry/opentelemetry-auto-mongodb | ||
| ``` | ||
|
|
||
| ## Installing dependencies and executing tests | ||
|
|
||
| From MongoDB subdirectory: | ||
|
|
||
| ```bash | ||
| $ composer install | ||
| $ ./vendor/bin/phpunit tests | ||
| ``` | ||
|
|
||
| ## Configuration | ||
|
|
||
| Parts of this auto-instrumentation library can be configured, more options are available throught the | ||
| [General SDK Configuration](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/sdk-environment-variables.md#general-sdk-configuration): | ||
| The extension can be disabled via [runtime configuration](https://opentelemetry.io/docs/instrumentation/php/sdk/#configuration): | ||
|
|
||
| | Name | Default value | Values | Example | Description | | ||
| | ---------------------------------- | ------------- | ----------------------- | ------- | ------------------------------------------------------------------------------- | | ||
| | OTEL_PHP_DISABLED_INSTRUMENTATIONS | [] | Instrumentation name(s) | mongodb | Disable one or more installed auto-instrumentations, names are comma seperated. | | ||
|
|
||
| Configurations can be provided as environment variables, or via `php.ini` (or a file included by `php.ini`) | ||
| ```shell | ||
| OTEL_PHP_DISABLED_INSTRUMENTATIONS=mongodb | ||
| ``` |
Oops, something went wrong.