Skip to content

Commit

Permalink
docs: Update k8s + alloy setup docs (#3655)
Browse files Browse the repository at this point in the history
* docs: Update k8s + alloy setup docs

* Add link to alloy docs in setup-kubernetes.md

* Apply suggestions from code review

---------

Co-authored-by: Kim Nylander <[email protected]>
  • Loading branch information
Rperry2174 and knylander-grafana authored Nov 7, 2024
1 parent ecfaa40 commit 3527165
Showing 1 changed file with 12 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -137,3 +137,15 @@ To verify that the profiles are received by the Pyroscope server:
[kubectl]: https://kubernetes.io/docs/tasks/tools/install-kubectl/
[pyroscope-ds]: /docs/grafana/<GRAFANA_VERSION>/datasources/pyroscope/
[config-reference]: ../configuration/

## Considerations for profiling applications in containers

When profiling Python applications running in containers using the `pyroscope.ebpf` [component in Alloy](/docs/alloy/<ALLOY_VERSION>/reference/components/pyroscope/pyroscope.ebpf/), consider the following:

- **Kernel version**: Ensure that the host system's kernel version is >= 4.9, as required by eBPF. This is crucial for the profiler to function correctly

- **Container privileges**: The eBPF profiler requires certain privileges to access kernel features. Ensure that the container running the profiler has the necessary permissions. This typically involves setting the container to run in privileged mode or adjusting security contexts

- **Host PID namespace**: The profiler may need access to the host's PID namespace to correctly attach to processes. Ensure that the `hostPID` is set to `true` in your Kubernetes configuration

- **Network access**: Ensure that the container has network access to send profiling data to the Pyroscope server. This may involve configuring network policies or service accounts

0 comments on commit 3527165

Please sign in to comment.