Skip to content

Commit 1624836

Browse files
authored
Update signals concept page (open-telemetry#3657)
1 parent a4ebdf6 commit 1624836

File tree

5 files changed

+21
-3
lines changed

5 files changed

+21
-3
lines changed

content/en/docs/acknowledgements/_index.md

+2
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,5 @@ this site:
1616
3. [What is OpenTelemetry - Dynatrace](https://www.dynatrace.com/news/blog/what-is-opentelemetry-2/)
1717
4. [Understanding OpenTracing, OpenCensus, and OpenMetrics - BMC](https://www.bmc.com/blogs/opentracing-opencensus-openmetrics/)
1818
5. [Ask Miss O11y: Baggage in OTel - Honeycomb](https://www.honeycomb.io/blog/ask-miss-o11y-opentelemetry-baggage/)
19+
6. [Observability Whitepaper - CNCF Tag Observability](https://github.com/cncf/tag-observability/blob/whitepaper-v1.0.0/whitepaper.md)
20+
for content in [Signals](/docs/concepts/signals/)

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

+16-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,20 @@ aliases:
77
weight: 11
88
---
99

10-
In OpenTelemetry, a **[signal][]** refers to a category of telemetry. A brief
11-
introduction to the currently supported signals is provided in this section.
10+
The purpose of OpenTelemetry is to collect, process, and export **[signals][]**.
11+
Signals are system outputs that describe the underlying activity of the
12+
operating system and applications running on a platform. A signal can be
13+
something you want to measure at a specific point in time, like temperature or
14+
memory usage, or an event that goes through the components of your distributed
15+
system that you'd like to trace. You can group different signals together to
16+
observe the inner workings of the same piece of technology under different
17+
angles.
1218

13-
[signal]: /docs/specs/otel/glossary/#signals
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/oteps/blob/main/text/profiles/0212-profiling-vision.md)
24+
by the Profiling Working Group.
25+
26+
[signals]: /docs/specs/otel/glossary/#signals

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

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Baggage
33
weight: 4
4+
description: Contextual information that is passed between signals
45
---
56

67
In OpenTelemetry, Baggage is contextual information that’s passed between spans.

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

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Metrics
33
weight: 2
4+
description: A measurement captured at runtime
45
---
56

67
A **metric** is a **measurement** of a service captured at runtime. The moment

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

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: Traces
33
weight: 1
44
cSpell:ignore: Guten
5+
description: Understand the full path through your distributed application.
56
---
67

78
**Traces** give us the big picture of what happens when a request is made to an

0 commit comments

Comments
 (0)