https://github.com/open-telemetry/opentelemetry-php-contrib
opentelemetry-php-contrib
https://github.com/open-telemetry/opentelemetry-php-contrib
Last synced: about 1 year ago
JSON representation
opentelemetry-php-contrib
- Host: GitHub
- URL: https://github.com/open-telemetry/opentelemetry-php-contrib
- Owner: open-telemetry
- License: apache-2.0
- Created: 2021-06-17T15:46:19.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-05-12T23:56:20.000Z (about 1 year ago)
- Last Synced: 2025-05-13T00:32:06.123Z (about 1 year ago)
- Language: PHP
- Homepage: https://opentelemetry.io
- Size: 1.92 MB
- Stars: 84
- Watchers: 21
- Forks: 103
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# OpenTelemetry php contrib library
[](https://codecov.io/gh/open-telemetry/opentelemetry-php-contrib)
## Current Project Status
For more information, please, consult the documentation of the main [OpenTelemetry PHP project][opentelemetry-php].
## Issues
Issues have been disabled for this repo in order to help maintain consistency between this repo and the main [opentelemetry-php] repo. If you have an issue you'd like to raise about this issue, please use the [OpenTelemetry PHP Issue section](https://github.com/open-telemetry/opentelemetry-php/issues/new/choose). Please prefix the title of the issue with [opentelemetry-php-contrib].
## Installation
### Install individual packages:
(This is the recommended way to install the components)
Refer to the documentation for the individual components on how to install them
- [AWS](/src/Aws/README.md)
- [Symfony SdkBundle](/src/Symfony/README.md)
## Usage/Examples
### Auto-instrumentation
Auto-instrumentation requires the [ext-opentelemetry] PHP extension, and
the installation of one or more packages from [src/Instrumentation](./src/Instrumentation)
### AWS
- You can find examples on how to use the AWS classes in the [examples directory](/examples/aws/README.md).
### Symfony
#### SdkBundle
- The documentation for the Symfony SdkBundle can be found [here](/src/Symfony/README.md).
- An example Symfony application using the SdkBundle can be found [here](https://github.com/opentelemetry-php/otel-sdk-bundle-example-sf5).
### Swoole
- The documentation for the Swoole context can be found [here](/src/Context/Swoole/README.md).
### Yii
- The documentation for Yii framework can be found [here](/src/Instrumentation/Yii/README.md).
## Development
Please, consult the documentation of the main [OpenTelemetry PHP project][opentelemetry-php].
### Subprojects
This repository is organized into multiple separate sub-projects, under `/src`.
Please remember to run all tests as you develop, the makefile supports a `PROJECTS` variable, which corresponds to the path of the project (relative to `src/`), eg
```
$ PROJECT=Symfony PHP_VERSION=8.1 make all
```
[opentelemetry-php]: https://github.com/open-telemetry/opentelemetry-php
[ext-opentelemetry]: https://pecl.php.net/package/opentelemetry