Profiling 8.10 updates (#3234) (#3237)

updated contents and images (cherry picked from commit f189ecb) Co-authored-by: Israel Ogbole <[email protected]>
elastic · Sep 19, 2023 · 885a20e · 885a20e
1 parent 93fe6a4
commit 885a20e
Show file tree

Hide file tree

Showing 11 changed files with 16 additions and 11 deletions.
diff --git a/docs/en/observability/images/profiling-elastic-agent.png b/docs/en/observability/images/profiling-elastic-agent.png
diff --git a/docs/en/observability/images/profiling-flamegraph-detailed-view.png b/docs/en/observability/images/profiling-flamegraph-detailed-view.png
diff --git a/docs/en/observability/images/profiling-flamegraph-differential-view.png b/docs/en/observability/images/profiling-flamegraph-differential-view.png
diff --git a/docs/en/observability/images/profiling-flamegraph-view.png b/docs/en/observability/images/profiling-flamegraph-view.png
diff --git a/docs/en/observability/images/profiling-functions-default-view.png b/docs/en/observability/images/profiling-functions-default-view.png
diff --git a/docs/en/observability/images/profiling-functions-differential-view.png b/docs/en/observability/images/profiling-functions-differential-view.png
diff --git a/docs/en/observability/images/profiling-setup-popup.png b/docs/en/observability/images/profiling-setup-popup.png
diff --git a/docs/en/observability/profiling-no-kernel-version-check.asciidoc b/docs/en/observability/profiling-no-kernel-version-check.asciidoc
@@ -13,7 +13,7 @@ The following example shows how to configure the `-no-kernel-version-check` in t
 
 [source,bash]
 ----
-sudo pf-host-agent/pf-host-agent -no-kernel-version-check=true ...'
+sudo pf-host-agent/pf-host-agent -no-kernel-version-check=true
 ----
 
 
diff --git a/docs/en/observability/profiling-probabilistic-profiling.asciidoc b/docs/en/observability/profiling-probabilistic-profiling.asciidoc
@@ -24,5 +24,5 @@ The following example shows how to configure the Universal Profiling agent with
 
 [source,bash]
 ----
-sudo pf-host-agent/pf-host-agent -probabilistic-threshold=50 -probabilistic-interval=2m30s ...'
+sudo pf-host-agent/pf-host-agent -probabilistic-threshold=50 -probabilistic-interval=2m30s
 ----
diff --git a/docs/en/observability/profiling-upgrade.asciidoc b/docs/en/observability/profiling-upgrade.asciidoc
@@ -9,14 +9,18 @@
 [[profiling-upgrade-process]]
 == Upgrade process
 
-To upgrade Universal Profiling, you need to:
+To upgrade from all versions earlier than 8.10 (GA), you need to:
 
 . Perform a stack upgrade in {ecloud}
 . Stop profiling data ingestion
-. Delete existing profiling data
+. Delete existing profiling data 
 . Setup Universal Profiling from scratch
 . Start profiling data ingestion
 
+To upgrade from version 8.10 or later, you need to:
+
+. Perform a stack upgrade in {ecloud}
+
 [discrete]
 [[profiling-upgrade-in-cloud]]
 === Perform a stack upgrade in the {ecloud} console

diff --git a/docs/en/observability/universal-profiling.asciidoc b/docs/en/observability/universal-profiling.asciidoc
@@ -1,8 +1,8 @@
 [[universal-profiling]]
 = Universal Profiling
 
+Elastic Universal Profiling is a whole-system, always-on, continuous profiling solution that eliminates the need for code instrumentation, recompilation, on-host debug symbols and service restarts. Leveraging eBPF technology, Universal Profiling operates within the Linux kernel space, capturing only the needed data with minimal overhead in an unobtrusive manner. For a quick overview of Universal Profiling, see the https://www.elastic.co/observability/ebpf-continuous-code-profiling[Universal Profiling product page].
 
-Elastic Universal Profiling is a continuous profiling tool running on top of the {stack}. For a quick overview of Universal Profiling, see the https://www.elastic.co/observability/ebpf-continuous-code-profiling[Universal Profiling product page].
 
 On this page, you'll find information on:
 
@@ -128,7 +128,7 @@ You can use flamegraphs to:
 You can navigate a flamegraph on both the horizontal and vertical axes:
 
 * Horizontal axes: every process that is sampled has at least a rectangle under the `root` frame. In Universal Profiling flamegraphs, you will likely discover the existence of processes you don't control, but that are eating a significant portion of your CPU resources.
-* Vertical axes: traversing a process' call stack allow to identify which parts of the process are executing most frequently. This allows pinpointing functions or methods that _should_ be negligible but are instead a big portion of your call sites.
+* Vertical axes: traversing a process' call stack allows you to identify which parts of the process are executing most frequently. This allows pinpointing functions or methods that _should_ be negligible but are instead a big portion of your call sites.
 
 You can drag the graph up, down, right, or left to move the visible area.
 
@@ -138,13 +138,14 @@ The summary square in the bottom-left corner of the graph lets you shift the vis
 The position of the summary square in the bottom-right corner adjusts when you drag the flamegraph, and moving the summary square
 adjusts the visible area in the bigger panel.
 
-Enabling *Show information window* on the top right opens the *Frame information* window.
-Clicking a rectangle in the flamegraph highlights the frame's detail in the window.
+Hovering your mouse over a rectangle in the flamegraph displays the frame's details in the window. To see more frame information, click on the *Show more information* icon after pinning the tooltip.
+
 
 [role="screenshot"]
 image::images/profiling-flamegraph-detailed-view.png[]
 
-Below the graph area, a search bar allows to highlight specific text in the flamegraph; here you may search binaries, function or file names and move over the occurrences.
+Below the graph area, you can use the search bar to find specific text in the flamegraph; here you can search binaries, function or file names, and move over the occurrences.
+
 
 [discrete]
 [[profiling-functions-intro]]
@@ -182,14 +183,14 @@ or across multiple dimensions.
 When switching to *Differential flamegraph* or *Differential TopN functions* from the tabs at the top, you see two separate search bars and datetime pickers.
 The left-most filters represent the data you want to use as baseline for comparison, while the right-most filters represents the data that will be compared against the baseline.
 
-Hitting refresh on each of the data filters triggers a frequency comparison that highlights the CPU usage change.
+Hitting refresh on each data filter triggers a frequency comparison that highlights the CPU usage change.
 
 In differential functions, the right-most column of functions has green or orange score calculator that represents the relative difference of position as the heaviest CPU hitting functions.
 
 [role="screenshot"]
 image::images/profiling-functions-differential-view.png[]
 
-In differentials flamegraphs, the difference with the baseline is highlighted with color and hue. 
+In differential flamegraphs, the difference with the baseline is highlighted with color and hue. 
 A vivid green colored rectangle indicates that a frame has been seen in _less_ samples compared to the baseline, which means an improvement. 
 A vivid red colored rectangle indicates a frame has been seen in more samples being recorded on CPU, indicating a potential performance regression.