Skip to content

[docs] Update docs with support for SecurityManager #2908

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.

Sign up for GitHub

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 2 commits into from
Dec 6, 2022
Merged

[docs] Update docs with support for SecurityManager #2908

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
906311b
Update docs with support for SecurityManager
eyalkoren Dec 5, 2022
7f9df42
Fix asterik escaping
eyalkoren Dec 5, 2022
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
22 changes: 22 additions & 0 deletions docs/setup.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,28 @@ If {apm-guide-ref}/agent-tls.html[SSL/TLS communication] is enabled on the APM S

Learn how to set up AWS Lambda functions tracing in our <<aws-lambda, Lambda setup guide>>.

[float]
[[security-manager]]
=== Using with Security Manager enabled

The agent should work as expected on JVMs with an enabled `SecurityManager`, provided that it is granted with `java.security.AllPermission`.
Make sure that the following snippet is added to an effective* policy (replace with the real path** to the agent jar):
```
grant codeBase "file:</path/to/elastic-apm-agent.jar>" {
permission java.security.AllPermission;
};
```
If you see a `java.lang.SecurityException` exception (for example a - `java.security.AccessControlException`) after verifying the above
`grant` snippet is effectively applied, open an issue in our https://github.com/elastic/apm-agent-java[GitHub repo] with a description
and the full stack trace.

{empty}* it is possible to have multiple policy files taking effect at the same time on a single JVM. The policy entry above can be added
to an existing policy or can be appended through the `java.security.policy` system property. See
https://docs.oracle.com/javase/8/docs/technotes/guides/security/PolicyFiles.html[documentation] for more details.

{empty}** you can make use of the https://docs.oracle.com/javase/8/docs/technotes/guides/security/PolicyFiles.html#PropertyExp[property
expansion] capability for specifying the agent jar path.

[float]
[[supported-technologies]]
=== Supported technologies
Expand Down
3 changes: 0 additions & 3 deletions docs/supported-technologies.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -736,6 +736,3 @@ If you are seeing gaps in the span timeline and want to include additional metho
[[supported-technologies-caveats]]
=== Caveats
* Other JVM languages, like Scala, Kotlin and Groovy have not been tested yet.
* The agent does currently not support running on JVMs with an enabled `SecurityManager`.
You may see exceptions like this: `java.security.AccessControlException: access denied ("java.lang.RuntimePermission" "getProtectionDomain")`.
Try to grant `java.security.AllPermission` to the agent.