Skip to content

Commit d656112

Browse files
committed
doc update
1 parent 90aa893 commit d656112

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

src/Instrumentation/ReactPHP/README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,22 @@ This is a read-only subtree split of https://github.com/open-telemetry/opentelem
99

1010
# OpenTelemetry ReactPHP HTTP Browser auto-instrumentation
1111

12+
This is an OpenTelemetry auto-instrumentation package for the [ReactPHP HTTP library](https://reactphp.org/http/). Currently only the Browser (client) component is instrumented.
13+
1214
Please read https://opentelemetry.io/docs/instrumentation/php/automatic/ for instructions on how to
1315
install and configure the extension and SDK.
1416

1517
## Overview
1618

17-
Auto-instrumentation hooks are registered via composer, which will:
19+
This library is provides the following:
1820

19-
* create spans automatically for each ReactPHP HTTP Browser request that is sent
20-
* add a `traceparent` header to the request to facilitate distributed tracing
21+
- OpenTelemetry Semantic Conventions v1.32.0:
22+
- [HTTP Client Spans](https://opentelemetry.io/docs/specs/semconv/http/http-spans/#http-client-span) - required and HTTP header (opt-in) attributes only
23+
- [HTTP Client Metrics](https://opentelemetry.io/docs/specs/semconv/http/http-metrics/#http-client) - required attributes only
24+
- W3C Trace Context:
25+
- [Trace Context HTTP Request Headers](https://www.w3.org/TR/trace-context/#trace-context-http-headers-format)
2126

22-
Note that span lifetime behavior differs based on how ReactPHP is utilized; see [examples/README.md](examples/README.md) for more information.
27+
> [!NOTE] HTTP Client Span lifetime behavior differs based on how ReactPHP is utilized; see [examples/README.md](examples/README.md) for more information.
2328
2429
## Configuration
2530

0 commit comments

Comments
 (0)