Skip to content

Commit 977b137

Browse files
authored
Concepts > Instr libs: copyedits (open-telemetry#1208)
1 parent d2fcfce commit 977b137

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

content/en/docs/concepts/instrumenting-library.md

+15-4
Original file line numberDiff line numberDiff line change
@@ -135,13 +135,22 @@ WARNING: Generic solution to avoid duplication is under construction 🚧.
135135

136136
### Events
137137

138-
Traces is one of the signals you may emit. Events (or logs) and traces complement, not duplicate, each other. Whenever you have something that should have a verbosity, logs are a better choice than traces.
138+
Traces are one kind of signal that your apps can emit. Events (or logs) and
139+
traces complement, not duplicate, each other. Whenever you have something that
140+
should have a verbosity, logs are a better choice than traces.
139141

140-
Chances are your library uses logs or some similar mechanism already. Check out [OpenTelemetry registry](/registry/) to see if OpenTelemetry has integration with it. Integrations usually stamps active trace context on all logs, so users can correlate them.
142+
Chances are that your app uses logging or some similar module already. Your
143+
module might already have OpenTelemetry integration -- to find out, see the
144+
[registry](/registry/). Integrations usually stamp active trace context on all
145+
logs, so users can correlate them.
141146

142-
If your language and ecosystem don't have common logging libraries, use span events for additional details you want to share with users. [Events]({{< relref "/docs/reference/specification/trace/api#add-events" >}}) maybe more convenient when you want to add attributes as well.
147+
If your language and ecosystem don't have common logging support, use [span
148+
events][] to share additional app details. Events maybe more convenient if you
149+
want to add attributes as well.
143150

144-
As a rule of thumb, use events or logs for verbose data instead of spans. Always attach events to the instance of span, your instrumentation created, avoid using active span if you can, as you don't control what it refers to.
151+
As a rule of thumb, use events or logs for verbose data instead of spans. Always
152+
attach events to the span instance that your instrumentation created. Avoid
153+
using the active span if you can, since you don't control what it refers to.
145154

146155
## Context propagation
147156

@@ -287,3 +296,5 @@ class TestExporter implements SpanExporter {
287296
...
288297
}
289298
```
299+
300+
[span events]: {{< relref "/docs/reference/specification/trace/api#add-events" >}}

0 commit comments

Comments
 (0)