Skip to content

[8.17](backport #4770) add known issues section to profiling docs #4776

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/en/observability/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
22 changes: 22 additions & 0 deletions docs/en/observability/profiling-known-issues.asciidoc
Original file line number Diff line number Diff line change
@@ -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.
Loading