Skip to content

Commit

Permalink
Add missing using instrumentation libraries pages: PHP (#4370)
Browse files Browse the repository at this point in the history
Co-authored-by: Phillip Carter <[email protected]>
  • Loading branch information
theletterf and cartermp authored Apr 27, 2024
1 parent 01e59c5 commit 05a7dfa
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions content/en/docs/languages/php/libraries.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: Using instrumentation libraries
linkTitle: Libraries
weight: 40
cSpell:ignore: Packagist
---

{{% docs/languages/libraries-intro "PHP" %}}

## Use instrumentation libraries

If a library doesn't include OpenTelemetry support, you can use
[instrumentation libraries](/docs/specs/otel/glossary/#instrumentation-library)
to generate telemetry data for a library or framework.

The OpenTelemetry PHP extension includes instrumentation libraries for many
common PHP frameworks. For example,
[the Laravel instrumentation](https://github.com/open-telemetry/opentelemetry-php-contrib/tree/main/src/Instrumentation/Laravel)
automatically creates [spans](/docs/concepts/signals/traces/#spans) based on the
application activity.

## Setup

Each instrumentation library is a Composer package. To install it, run the
following command:

```sh
php composer.phar install {name-of-instrumentation}:{version-number}
```

Where `{name-of-instrumentation}` is the Packagist reference for the specific
instrumentation you want to use.

You can turn off any instrumentation by adding its identifier to the
`OTEL_PHP_DISABLED_INSTRUMENTATIONS` environment variable.

## Available instrumentation libraries

For a list of available instrumentations, see
[OpenTelemetry instrumentation packages](https://packagist.org/search/?query=open-telemetry&tags=instrumentation)
on Packagist.

## Next steps

After you've set up instrumentation libraries, you might want to add
[additional instrumentation](/docs/languages/php/instrumentation) to collect
custom telemetry data.

You might also want to configure an appropriate exporter to
[export your telemetry data](/docs/languages/php/exporters) to one or more
telemetry backends.

You can also check the
[automatic instrumentation for PHP](/docs/languages/php/automatic) for existing
library instrumentations.

0 comments on commit 05a7dfa

Please sign in to comment.