Skip to content

Commit 249cff7

Browse files
authored
Add warning about configuring JFR profiles (#1596)
1 parent af1efdd commit 249cff7

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

agent/agent-profiler/docs/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,25 @@ The agent-profiler subsystem provides a system for:
2121

2222
# USAGE
2323

24+
## Warning
25+
26+
The JFR profiler by default executes the "profile" profile from JFRs inbuilt configurations. This configuration includes
27+
some potentially sensitive information such as environment variables, arguments provided to the JVM and processes
28+
running on the system. If you wish to remove these from profiles that are uploaded you can do this by editing
29+
the `lib/jfr/profile.jfc` file inside your Java installation. Profiles can also be generated/edited in the JDK Mission
30+
Control (JMC) user interface under the `Window->Flight Recording Template Manager` menu and control over individual
31+
flags is found inside `Edit->Advanced` of this user interface.
32+
33+
Some flags you may wish to disable are:
34+
35+
- jdk.JVMInformation
36+
- jdk.InitialSystemProperty
37+
- jdk.OSInformation
38+
- jdk.InitialEnvironmentVariable
39+
- jdk.SystemProcess
40+
41+
However, you should review all required flags.
42+
2443
## Requirements
2544

2645
- A JVM with JFR available.

0 commit comments

Comments
 (0)