PHP: Updates to instrumentation docs #3855
Merged
Conversation
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
Signed-off-by: svrnm <[email protected]>
theletterf
reviewed
Jan 24, 2024
Comment on lines
37
to
39
| To highlight the difference between instrumenting a _library_ and a standalone | ||
| _app_, split out the dice rolling into a _library file_, which then will be | ||
| imported as a dependency by the _app file_. |
There was a problem hiding this comment.
I'd remove the italics here. Not needed.
| _app_, split out the dice rolling into a _library file_, which then will be | ||
| imported as a dependency by the _app file_. | ||
|
|
||
| Create the _library file_ named `dice.php` and add the following code to it: |
|
|
||
| The example also sets up the mandatory SDK default attribute `service.name`, | ||
| which holds the logical name of the service, and the optional (but highly | ||
| encouraged!) attribute `service.version`, which holds the version of the service |
There was a problem hiding this comment.
I think I've left similar comments in #3834 — we should sweep the docs everywhere to fix the issues...
brettmc
reviewed
Jan 24, 2024
brettmc
reviewed
Jan 24, 2024
| [`Tracer`](/docs/concepts/signals/traces/#tracer). | ||
| If a `TracerProvider` is not created, the OpenTelemetry APIs for tracing will | ||
| use a no-op implementation and fail to generate data. As explained next, modify | ||
| the `instrumentation.ts` (or `instrumentation.js`) file to include all the SDK |
There was a problem hiding this comment.
js/node/browser references here. The filename references probably need index.php...
There was a problem hiding this comment.
oh... let me double check on that
brettmc
reviewed
Jan 24, 2024
brettmc
reviewed
Jan 24, 2024
brettmc
reviewed
Jan 24, 2024
Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]> Co-authored-by: Brett McBride <[email protected]>
svrnm
commented
Jan 25, 2024
svrnm
commented
Jan 25, 2024
svrnm
commented
Jan 25, 2024
Signed-off-by: svrnm <[email protected]>
theletterf
approved these changes
Jan 30, 2024
brettmc
approved these changes
Jan 30, 2024
jaydeluca
pushed a commit
to jaydeluca/opentelemetry.io
that referenced
this pull request
Jan 31, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Contributes to #3229, this updates the tracing instructions to follow a similar path what we have for some other languages already (JS was the example I took for reference). Note that my PHP knowledge is a little bit outdated, so if there are better ways to inject tracers etc advice me accordingly.