Skip to content
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

docs: add Linux capabilities config for pyroscope.java #1788

Merged
merged 3 commits into from
Oct 9, 2024

Conversation

marcsanmi
Copy link
Contributor

PR Description

Update pyroscope.java documentation to include information on configuring Linux capabilities when running in Kubernetes environments. This addition helps users properly set up Alloy with the necessary permissions for Java process profiling in environments where Linux capabilities are enforced.

Which issue(s) this PR fixes

Closes #1616

Notes to the Reviewer

PR Checklist

  • CHANGELOG.md updated
  • Documentation added
  • Tests updated
  • Config converters updated

Copy link
Contributor

@knylander-grafana knylander-grafana left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for updating doc. Do we need to backport?

@marcsanmi
Copy link
Contributor Author

Thank you for updating doc. Do we need to backport?

Yes, I added the corresponding labels. Thanks!

@Rperry2174
Copy link

@marcsanmi can we also add this somewhere to a couple other places:

  1. Examples - this is often where I send people when they want something to just copy and paste.. I think having this information in the readme will be helpful for people who are looking to copy and paste from examples rather than using docs
  2. Pyroscope java docs - even though we are duplicating this to multiple places I thin its probably likely that many poeople expect everything they need to know will be on this page .. we should at least mention it

Again even though we are duplicating this in a couple places we often have many paths through which people enter the docs and having this key information at least mentioned everywhere is important

@knylander-grafana
Copy link
Contributor

@marcsanmi can we also add this somewhere to a couple other places:

  1. Examples - this is often where I send people when they want something to just copy and paste.. I think having this information in the readme will be helpful for people who are looking to copy and paste from examples rather than using docs
  2. Pyroscope java docs - even though we are duplicating this to multiple places I thin its probably likely that many poeople expect everything they need to know will be on this page .. we should at least mention it

Again even though we are duplicating this in a couple places we often have many paths through which people enter the docs and having this key information at least mentioned everywhere is important

Do we need to duplicate the exact documentation with no changes? If so, we can consider sharing content between repositories. For example, store the source doc in the Alloy repo and then include that source doc in one or more other locations using an include statement.

@marcsanmi
Copy link
Contributor Author

As discussed in grafana/pyroscope#3599 (comment), it doesn't make sense to add this documentation in pyroscope examples since this related to Alloy's chart configuration.

cc @Rperry2174 @knylander-grafana

@marcsanmi marcsanmi force-pushed the marcsanmi/update-pyroscope-java-permissions branch from f8ce01d to 4c1606c Compare October 4, 2024 08:02
Copy link
Contributor

@clayton-cornell clayton-cornell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One minor tweak - use of whitelist and it's good from my side :-)

@clayton-cornell
Copy link
Contributor

Is this one ready to be merged as-is?

@marcsanmi
Copy link
Contributor Author

Is this one ready to be merged as-is?

Yes 👍

@clayton-cornell clayton-cornell merged commit 7e8c153 into main Oct 9, 2024
18 checks passed
@clayton-cornell clayton-cornell deleted the marcsanmi/update-pyroscope-java-permissions branch October 9, 2024 16:58
github-actions bot pushed a commit that referenced this pull request Oct 9, 2024
Co-authored-by: Clayton Cornell <[email protected]>
(cherry picked from commit 7e8c153)
github-actions bot pushed a commit that referenced this pull request Oct 9, 2024
Co-authored-by: Clayton Cornell <[email protected]>
(cherry picked from commit 7e8c153)
github-actions bot pushed a commit that referenced this pull request Oct 9, 2024
Co-authored-by: Clayton Cornell <[email protected]>
(cherry picked from commit 7e8c153)
github-actions bot pushed a commit that referenced this pull request Oct 9, 2024
Co-authored-by: Clayton Cornell <[email protected]>
(cherry picked from commit 7e8c153)
github-actions bot pushed a commit that referenced this pull request Oct 9, 2024
Co-authored-by: Clayton Cornell <[email protected]>
(cherry picked from commit 7e8c153)
pbailhache pushed a commit to pbailhache/alloy that referenced this pull request Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Pyroscope Java profiling not working after following documentation (missing Linux capabilities)
6 participants