add known issues section to profiling docs (#4770) (#4776)

* add known issues section to profiling docs * update knwon issue for collector helm chart Signed-off-by: inge4pres <[email protected]> * improve readability --------- Signed-off-by: inge4pres <[email protected]> Co-authored-by: inge4pres <[email protected]> Co-authored-by: Francesco Gualazzi <[email protected]> (cherry picked from commit 7c9968e) Co-authored-by: Brandon Morelli <[email protected]>
elastic · Jan 21, 2025 · a07ce22 · a07ce22
1 parent 3a4dcc1
commit a07ce22
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/docs/en/observability/index.asciidoc b/docs/en/observability/index.asciidoc
@@ -162,6 +162,7 @@ include::profiling-troubleshooting.asciidoc[leveloffset=+3]
 include::profiling-self-managed.asciidoc[leveloffset=+3]
 include::profiling-self-managed-ops.asciidoc[leveloffset=+4]
 include::profiling-self-managed-troubleshooting.asciidoc[leveloffset=+4]
+include::profiling-known-issues.asciidoc[leveloffset=+3]
 
 // Tutorials
 include::monitor-k8s/monitor-k8s.asciidoc[leveloffset=+2]

diff --git a/docs/en/observability/profiling-known-issues.asciidoc b/docs/en/observability/profiling-known-issues.asciidoc
@@ -0,0 +1,22 @@
+[[profiling-known-issues]]
+= Known issues
+
+Universal Profiling has the following known issues:
+
+[discrete]
+== Helm chart `profiling-collector` faulty binary location
+
+_Affected: 8.16.0, 8.16.1, 8.16.2, 8.17.0_
+_Fixed in: 8.16.3+, 8.17.1+_
+
+The installation of Universal Profiling collector using the Helm chart `profiling-collector` produces a Deployment with
+the wrong binary path set in `spec.template.spec.containers['pf-elastic-collector'].command`.
+
+The correct path should be `/home/nonroot/pf-elastic-collector` while the `command` field references the deprecated path
+`/root/pf-elastic-collector`. This issue prevents the collector from starting and as a result, the Deployment has Pods
+in `CrashLoopBackoff` status.
+
+To fix this issue, a manual edit of the Deployment manifest should be performed, removing entirely the `command` field
+from the `spec` section.
+
+This can be performed by either manipulating the Deployment template emitted by Helm or by using the `kubectl edit` command.