Skip to content

Commit decef3a

Browse files
committed
add newlines
Signed-off-by: Florian Lehner <[email protected]>
1 parent d7e8b28 commit decef3a

File tree

2 files changed

+28
-11
lines changed

2 files changed

+28
-11
lines changed

specification/profiles/README.md

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,28 +20,43 @@ path_base_for_github_subdir:
2020

2121
## Overview
2222

23-
Profiles are emerging as the fourth essential signal of observability, alongside logs, metrics, and traces. They offer unparalleled insights into system and application behavior, often uncovering performance bottlenecks overlooked by other signals.
23+
Profiles are emerging as the fourth essential signal of observability, alongside
24+
logs, metrics, and traces. They offer unparalleled insights into system and
25+
application behavior, often uncovering performance bottlenecks overlooked by
26+
other signals.
2427

25-
Profiling data provides granular, time-based views of resource consumption and code execution, encompassing:
28+
Profiling data provides granular, time-based views of resource consumption and
29+
code execution, encompassing:
2630

27-
* **Application-level profiling**: Reveals how software functions consume CPU, memory, and other resources, highlighting slow or inefficient code.
31+
* **Application-level profiling**: Reveals how software functions consume CPU,
32+
memory, and other resources, highlighting slow or inefficient code.
2833

29-
* **System-level profiling**: Offers a holistic view of infrastructure support, pinpointing issues in operating system calls, kernel operations, and I/O.
34+
* **System-level profiling**: Offers a holistic view of the infrastructure,
35+
pinpointing issues in operating system calls, kernel operations, and I/O.
3036

3137
This performance picture can lead to:
3238

33-
* **Faster Root Cause Analysis**: Quickly identifies the exact cause of performance degradation.
39+
* **Faster Root Cause Analysis**: Quickly identifies the exact cause of
40+
performance degradation.
3441
* **Proactive Optimization**: Identifies potential issues before user impact.
35-
* **Improved Resource Utilization**: Optimizes infrastructure for cost savings and efficiency.
36-
* **Enhanced Developer Productivity**: Helps developers validate code performance and prevent regressions.
42+
* **Improved Resource Utilization**: Optimizes infrastructure for cost savings
43+
and efficiency.
44+
* **Enhanced Developer Productivity**: Helps developers validate code performance
45+
and prevent regressions.
3746

38-
In essence, while logs, metrics, and traces show "what" and "how much/where," profiles explain "why" and "how efficiently," making them indispensable in modern observability.
47+
In essence, while logs, metrics, and traces show "what" and "how much/where,"
48+
profiles explain "why" and "how efficiently," making them indispensable in modern
49+
observability.
3950

4051
## Known values
4152

42-
[OpenTelemetry semantic conventions](https://opentelemetry.io/docs/specs/semconv/) are vital for Profiles to correlate with other OpenTelemetry signals, enabling unified analysis of traces, metrics, logs, and profiling data for a holistic system understanding.
53+
[OpenTelemetry semantic conventions](https://opentelemetry.io/docs/specs/semconv/)
54+
are vital for Profiles to correlate with other OpenTelemetry signals, enabling
55+
unified analysis of traces, metrics, logs, and profiling data for a holistic
56+
system understanding.
4357

44-
To enhance the compatibility of OpenTelemetry Profiles with existing profiling tools, known values are utilized.
58+
To enhance the compatibility of OpenTelemetry Profiles with existing profiling
59+
tools, known values are utilized.
4560

4661
| Profiles field | Known values |
4762
| -------------- | ------------ |

specification/profiles/pprof.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,6 @@
1010

1111
## Compatibility
1212

13-
Original [pprof](https://github.com/google/pprof/tree/main/proto) is forward compatible with OpenTelemetry Profiles in a sense that it can be transformed into OpenTelemetry Profiles without data los.
13+
Original [pprof](https://github.com/google/pprof/tree/main/proto) is forward
14+
compatible with OpenTelemetry Profiles in a sense that it can be transformed into
15+
OpenTelemetry Profiles without data los.

0 commit comments

Comments
 (0)