Skip to content

Commit 8d7aa29

Browse files
authored
Concepts pages: copyedits for instrumentation pages (open-telemetry#4066)
1 parent 88a5246 commit 8d7aa29

File tree

3 files changed

+17
-20
lines changed

3 files changed

+17
-20
lines changed

content/en/docs/concepts/instrumentation/_index.md

+10-12
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: Instrumentation
3-
description: >-
4-
How OpenTelemetry instrumentations libraries and applications.
3+
description: How OpenTelemetry facilitates instrumentation
54
aliases: [instrumenting]
65
weight: 15
76
---
@@ -11,25 +10,24 @@ from the system's components must emit [traces](/docs/concepts/signals/traces/),
1110
[metrics](/docs/concepts/signals/metrics/), and
1211
[logs](/docs/concepts/signals/logs/).
1312

14-
OpenTelemetry has two primary ways to instrument.
13+
Using OpenTelemetry, you can instrument your code in two primary ways:
1514

1615
1. [Code-based solutions](/docs/concepts/instrumentation/code-based) via
17-
official APIs and SDKs for eleven languages.
18-
2. [Zero-code solutions](/docs/concepts/instrumentation/zero-code/) that, when
19-
installed, instrument libraries you use.
16+
official [APIs and SDKs for most languages](/docs/languages/)
17+
2. [Zero-code solutions](/docs/concepts/instrumentation/zero-code/)
2018

21-
Code-based solutions allow you to get rich telemetry from your application
22-
itself. They let you use the OpenTelemetry API to generate telemetry from your
23-
application, which acts as an essential complement to the telemetry generated by
24-
zero-code solutions.
19+
**Code-based** solutions allow you to get deeper insight and rich telemetry from
20+
your application itself. They let you use the OpenTelemetry API to generate
21+
telemetry from your application, which acts as an essential complement to the
22+
telemetry generated by zero-code solutions.
2523

26-
The Zero-code solutions are great for getting started, or when you can't modify
24+
**Zero-code** solutions are great for getting started, or when you can't modify
2725
the application you need to get telemetry out of. They provide rich telemetry
2826
from libraries you use and/or the environment your application runs in. Another
2927
way to think of it is that they provide information about what's happening _at
3028
the edges_ of your application.
3129

32-
It's generally recommended that you use both solutions when you can.
30+
You can use both solutions simultaneously.
3331

3432
## Additional OpenTelemetry Benefits
3533

content/en/docs/concepts/instrumentation/code-based.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
title: Code-based
3-
description: >-
4-
Learn about the essential steps to instrument your code base.
3+
description: Learn the essential steps in setting up code-based instrumentation
54
weight: 20
65
aliases: [manual]
7-
cSpell:ignore: legitimatebusiness proxying
6+
cSpell:ignore: proxying
87
---
98

109
## Import the OpenTelemetry API and SDK
@@ -24,10 +23,10 @@ single default provider for these objects. You'll then get a tracer or meter
2423
instance from that provider, and give it a name and version. The name you choose
2524
here should identify what exactly is being instrumented -- if you're writing a
2625
library, for example, then you should name it after your library (for example
27-
`com.legitimatebusiness.myLibrary`) as this name will namespace all spans or
28-
metric events produced. It is also recommended that you supply a version string
29-
(i.e., `semver:1.0.0`) that corresponds to the current version of your library
30-
or service.
26+
`com.example.myLibrary`) as this name will namespace all spans or metric events
27+
produced. It is also recommended that you supply a version string (i.e.,
28+
`semver:1.0.0`) that corresponds to the current version of your library or
29+
service.
3130

3231
## Configure the OpenTelemetry SDK
3332

content/en/docs/concepts/instrumentation/zero-code.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Zero-code
33
description: >-
44
Learn how to add observability to an application without the need to write
5-
more code
5+
code
66
weight: 10
77
aliases: [automatic]
88
---

0 commit comments

Comments
 (0)