Skip to content

Commit 7c0e4db

Browse files
authored
Editorial changes to Concepts > Signals (#6067)
1 parent b1b96db commit 7c0e4db

File tree

11 files changed

+56
-41
lines changed

11 files changed

+56
-41
lines changed
+18-10
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
---
22
title: Signals
33
description: Learn about the categories of telemetry supported by OpenTelemetry
4-
aliases:
5-
- /docs/concepts/data-sources
6-
- /docs/concepts/otel-concepts
4+
aliases: [./data-sources, ./otel-concepts]
75
weight: 11
86
---
97

10-
The purpose of OpenTelemetry is to collect, process, and export **[signals][]**.
8+
The purpose of OpenTelemetry is to collect, process, and export [signals].
119
Signals are system outputs that describe the underlying activity of the
1210
operating system and applications running on a platform. A signal can be
1311
something you want to measure at a specific point in time, like temperature or
@@ -16,11 +14,21 @@ system that you'd like to trace. You can group different signals together to
1614
observe the inner workings of the same piece of technology under different
1715
angles.
1816

19-
OpenTelemetry currently supports [traces](/docs/concepts/signals/traces),
20-
[metrics](/docs/concepts/signals/metrics), [logs](/docs/concepts/signals/logs)
21-
and [baggage](/docs/concepts/signals/baggage). _Events_ are a specific type of
22-
log, and
23-
[_profiles_ are being worked on](https://github.com/open-telemetry/opentelemetry-specification/blob/main/oteps/profiles/0212-profiling-vision.md)
24-
by the Profiling Working Group.
17+
OpenTelemetry currently supports:
2518

19+
- [Traces](traces)
20+
- [Metrics](metrics)
21+
- [Logs](logs)
22+
- [Baggage](baggage)
23+
24+
Also under development or at the [proposal] stage:
25+
26+
- [Events], a specific type of [log](logs)
27+
- [Profiles] are being worked on by the Profiling Working Group.
28+
29+
[Events]: /docs/specs/otel/logs/data-model/#events
30+
[Profiles]:
31+
https://github.com/open-telemetry/opentelemetry-specification/blob/main/oteps/profiles/0212-profiling-vision.md
32+
[proposal]:
33+
https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/#readme
2634
[signals]: /docs/specs/otel/glossary/#signals

content/en/docs/concepts/signals/baggage.md

+14-16
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,12 @@ description: Contextual information that is passed between signals.
66

77
In OpenTelemetry, Baggage is contextual information that resides next to
88
context. Baggage is a key-value store, which means it lets you
9-
[propagate](/docs/concepts/context-propagation/#propagation) any data you like
10-
alongside [context](/docs/concepts/context-propagation/#context).
9+
[propagate](../../context-propagation/#propagation) any data you like alongside
10+
[context](../../context-propagation/#context).
1111

1212
Baggage means you can pass data across services and processes, making it
13-
available to add to [traces](/docs/concepts/signals/traces/),
14-
[metrics](/docs/concepts/signals/metrics/), or
15-
[logs](/docs/concepts/signals/logs/) in those services.
13+
available to add to [traces](../traces/), [metrics](../metrics/), or
14+
[logs](../logs/) in those services.
1615

1716
## Example
1817

@@ -24,13 +23,12 @@ another service, and some logs along the way. Because the trace may span
2423
multiple services, you need some way to propagate that data without copying the
2524
`clientId` across many places in your codebase.
2625

27-
By using
28-
[Context Propagation](/docs/concepts/signals/traces/#context-propagation) to
29-
pass baggage across these services, the `clientId` is available to add to any
30-
additional spans, metrics, or logs. Additionally, instrumentations automatically
31-
propagate baggage for you.
26+
By using [Context Propagation](../traces/#context-propagation) to pass baggage
27+
across these services, the `clientId` is available to add to any additional
28+
spans, metrics, or logs. Additionally, instrumentations automatically propagate
29+
baggage for you.
3230

33-
![OTel Baggage](/img/otel-baggage.svg)
31+
![OTel Baggage](../otel-baggage.svg)
3432

3533
## What should OTel Baggage be used for?
3634

@@ -45,7 +43,7 @@ like "which users are experiencing the slowest database calls?" You can also log
4543
information about a downstream operation and include that same User ID in the
4644
log data.
4745

48-
![OTel Baggage](/img/otel-baggage-2.svg)
46+
![OTel Baggage](../otel-baggage-2.svg)
4947

5048
## Baggage security considerations
5149

@@ -70,10 +68,10 @@ To add baggage entries to attributes, you need to explicitly read the data from
7068
baggage and add it as attributes to your spans, metrics, or logs.
7169

7270
Because a common use cases for Baggage is to add data to
73-
[Span Attributes](/docs/concepts/signals/traces/#attributes) across a whole
74-
trace, several languages have Baggage Span Processors that add data from baggage
75-
as attributes on span creation.
71+
[Span Attributes](../traces/#attributes) across a whole trace, several languages
72+
have Baggage Span Processors that add data from baggage as attributes on span
73+
creation.
7674

77-
> For more information, see the [baggage specification][].
75+
> For more information, see the [baggage specification].
7876
7977
[baggage specification]: /docs/specs/otel/overview/#baggage-signal

content/en/docs/concepts/signals/logs.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ OpenTelemetry does not define a bespoke API or SDK to create logs. Instead,
1616
OpenTelemetry logs are the existing logs you already have from a logging
1717
framework or infrastructure component. OpenTelemetry SDKs and
1818
autoinstrumentation utilize several components to automatically correlate logs
19-
with [traces](/docs/concepts/signals/traces).
19+
with [traces](../traces).
2020

2121
OpenTelemetry's support for logs is designed to be fully compatible with what
2222
you already have, providing capabilities to wrap those logs with additional
@@ -25,7 +25,7 @@ across many different sources.
2525

2626
### OpenTelemetry logs in the OpenTelemetry Collector
2727

28-
The [OpenTelemetry Collector](/docs/collector) provides several tools to work
28+
The [OpenTelemetry Collector](/docs/collector/) provides several tools to work
2929
with logs:
3030

3131
- Several receivers which parse logs from specific, known sources of log data.

content/en/docs/concepts/signals/metrics.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -91,10 +91,10 @@ aggregation for each instrument which can be overridden using the Views. The
9191
OpenTelemetry project aims to provide default aggregations that are supported by
9292
visualizers and telemetry backends.
9393

94-
Unlike [request tracing](/docs/concepts/signals/traces/), which is intended to
95-
capture request lifecycles and provide context to the individual pieces of a
96-
request, metrics are intended to provide statistical information in aggregate.
97-
Some examples of use cases for metrics include:
94+
Unlike [request tracing](../traces/), which is intended to capture request
95+
lifecycles and provide context to the individual pieces of a request, metrics
96+
are intended to provide statistical information in aggregate. Some examples of
97+
use cases for metrics include:
9898

9999
- Reporting the total number of bytes read by a service, per protocol type.
100100
- Reporting the total number of bytes read and the bytes per request.
File renamed without changes.

content/en/docs/concepts/signals/traces.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -160,8 +160,7 @@ source or vendor backend of your choice.
160160
Context Propagation is the core concept that enables Distributed Tracing. With
161161
Context Propagation, Spans can be correlated with each other and assembled into
162162
a trace, regardless of where Spans are generated. To learn more about this
163-
topic, see the concept page on
164-
[Context Propagation](/docs/concepts/context-propagation).
163+
topic, see the concept page on [Context Propagation](../../context-propagation).
165164

166165
## Spans
167166

@@ -231,8 +230,7 @@ Span context is an immutable object on every span that contains the following:
231230
information
232231

233232
Span context is the part of a span that is serialized and propagated alongside
234-
[Distributed Context](#context-propagation) and
235-
[Baggage](/docs/concepts/signals/baggage).
233+
[Distributed Context](#context-propagation) and [Baggage](../baggage).
236234

237235
Because Span Context contains the Trace ID, it is used when creating
238236
[Span Links](#span-links).

content/en/docs/contributing/style-guide.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ the site.
3838
| OpenTelemetry | OpenTelemetry should always be capitalized. Don't use Open-Telemetry. |
3939
| OTel | OTel is the accepted short form of OpenTelemetry. Don't use OTEL. |
4040
| Collector | When referring to the OpenTelemetry Collector, always capitalize Collector. Write "The Collector" or "The Opentelemetry Collector" if you're starting a sentence. Write "the Collector" or "the OpenTelemetry Collector" in the middle or end of a sentence. Use just "Collector" if you are using Collector as an adjective (for example, "Collector configuration").|
41-
| OTEP | OpenTelemetry Enhancement Proposal. Write "OTEPs" as plural form. Don't write "OTep" or "otep". |
41+
| OTEP | [OpenTelemetry Enhancement Proposal]. Write "OTEPs" as plural form. Don't write "OTep" or "otep". |
4242
| OpAMP | Open Agent Management Protocol. Don't write "OPAMP" or "opamp" in descriptions or instructions. |
4343
<!-- prettier-ignore-end -->
4444

@@ -116,3 +116,6 @@ submitting a PR, or run it afterwards and push an additional commit.
116116
All file names should be in
117117
[kebab case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case). Run
118118
`npm run fix:filenames` to automatically rename your files.
119+
120+
[OpenTelemetry Enhancement Proposal]:
121+
https://github.com/open-telemetry/opentelemetry-specification/blob/main/oteps/README.md

content/ja/docs/concepts/signals/baggage.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ OpenTelemetryでは、バゲッジ(Baggage)はコンテキストの隣にあ
2222
[コンテキスト伝搬](/docs/concepts/signals/traces/#context-propagation)を使用して、これらのサービス間でバゲッジを渡すことで、 `clientId` を追加のスパン、メトリクス、またはログに追加できます。
2323
さらに、計装は自動的にバゲッジを伝搬してくれます。
2424

25-
![OTel Baggage](/img/otel-baggage.svg)
25+
![OTel Baggage](../otel-baggage.svg)
2626

2727
## OTelバゲッジの使い道 {#what-should-otel-baggage-be-used-for}
2828

@@ -33,7 +33,7 @@ OpenTelemetryでは、バゲッジ(Baggage)はコンテキストの隣にあ
3333
たとえば、データベース呼び出しを追跡するスパンにユーザーIDのような情報を含めると、「どのユーザーがもっとも遅いデータベース呼び出しを経験しているか」のような質問に、より簡単に答えられます。
3434
また、下流の操作に関する情報をログに記録し、同じユーザーIDをログデータに含めることもできます。
3535

36-
![OTel Baggage](/img/otel-baggage-2.svg)
36+
![OTel Baggage](../otel-baggage-2.svg)
3737

3838
## バゲッジのセキュリティに関する懸念事項 {#baggage-security-considerations}
3939

content/pt/docs/concepts/signals/baggage.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Usando a
3232
para passar a bagagem entre esses serviços, o `clientId` estará disponível para
3333
ser adicionado a quaisquer trechos, métricas ou logs. Além disso, as
3434
instrumentações automaticamente propagam a Bagagem para você.
35-
![OTel Baggage](/img/otel-baggage.svg)
35+
![OTel Baggage](../otel-baggage.svg)
3636

3737
## Para que a Bagagem do OTel deve ser usada?
3838

@@ -49,7 +49,7 @@ enfrentando as chamadas de banco de dados mais lentas?". Você também pode
4949
registrar informações sobre uma operação posterior e incluir esse mesmo ID de
5050
usuário nos dados do log.
5151

52-
![OTel Baggage](/img/otel-baggage-2.svg)
52+
![OTel Baggage](../otel-baggage-2.svg)
5353

5454
## Considerações de segurança da Bagagem
5555

static/refcache.json

+8
Original file line numberDiff line numberDiff line change
@@ -11239,6 +11239,10 @@
1123911239
"StatusCode": 206,
1124011240
"LastSeen": "2025-01-17T16:51:50.076193-05:00"
1124111241
},
11242+
"https://github.com/open-telemetry/opentelemetry-specification/blob/main/oteps/README.md": {
11243+
"StatusCode": 206,
11244+
"LastSeen": "2025-01-24T07:05:45.681053-05:00"
11245+
},
1124211246
"https://github.com/open-telemetry/opentelemetry-specification/blob/main/oteps/profiles/0212-profiling-vision.md": {
1124311247
"StatusCode": 206,
1124411248
"LastSeen": "2025-01-17T16:51:52.507046-05:00"
@@ -11375,6 +11379,10 @@
1137511379
"StatusCode": 200,
1137611380
"LastSeen": "2024-01-30T15:25:05.874801-05:00"
1137711381
},
11382+
"https://github.com/open-telemetry/opentelemetry-specification/tree/main/oteps/#readme": {
11383+
"StatusCode": 206,
11384+
"LastSeen": "2025-01-24T07:06:27.879024-05:00"
11385+
},
1137811386
"https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/README.md": {
1137911387
"StatusCode": 206,
1138011388
"LastSeen": "2025-01-17T16:52:05.751476-05:00"

0 commit comments

Comments
 (0)