open-telemetry
/
opentelemetry.io
mirror of https://github.com/open-telemetry/opentelemetry.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update "Instrumenting Libraries" wording (#1897)

This commit is contained in:
Severin Neumann 2022-10-24 16:19:24 +02:00 committed by GitHub
parent f0c658851d
commit 4a23da10a3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
content/en/docs/concepts/instrumenting-library.md
View File

@ -6,7 +6,7 @@ weight: 40
--- ---
OpenTelemetry provides OpenTelemetry provides
[automatic instrumentation](/docs/concepts/instrumenting#automatic-instrumentation) [instrumentation libraries][]
for many libraries, which is typically done through library hooks or for many libraries, which is typically done through library hooks or
monkey-patching library code. monkey-patching library code.
@ -48,9 +48,9 @@ are a good places to start!
## When **not** to instrument ## When **not** to instrument
Some libraries are thin clients wrapping network calls. Chances are that Some libraries are thin clients wrapping network calls. Chances are that
OpenTelemetry has auto-instrumentation for the underlying RPC client (check out OpenTelemetry has an instrumentation library for the underlying RPC client (check out
the [registry](/registry/)). In this case, library instrumentation may not be the [registry](/registry/)). In this case, instrumenting the wrapper library
necessary. may not be necessary.
Don't instrument if: Don't instrument if:
@ -415,4 +415,5 @@ class TestExporter implements SpanExporter {
} }
``` ```
[instrumentation libraries]: /docs/reference/specification/overview/#instrumentation-libraries
[span events]: /docs/reference/specification/trace/api/#add-events [span events]: /docs/reference/specification/trace/api/#add-events