CASSANDRA-20854: Support low-overhead async profiling #4487

bbotella · 2025-11-20T18:40:10Z

This is a follow up PR on top of
#4255

conf/jvm-server.options

netudima · 2025-11-20T21:22:30Z

src/java/org/apache/cassandra/profiler/AsyncProfilerMBean.java

+
+public interface AsyncProfilerMBean
+{
+    void start(String event, String outputFormat, int timeout, String outputPath);


timeout - duration probably a better name for the parameter + a time unit as a a suffix would be helpful

outputPath - using a path is too dangerous from security point of view, a path to a data file or another file can be specified to cause a DoS (explicitly or using tricks like ../../.., so it is better to allow only a file name with explictly defined set of symbols to use (allowlist is safer than an denylist)

I left it at timeout, as it is what the actual async profiler is using.

For the outputPath, that makes sense. Changing.

Regarding timeout - yes, I mixed it up with -d option and what one is asprof option only.

I think that "duration" is better terminology here. I did it like that.

src/java/org/apache/cassandra/tools/profiler/AsyncProfilerService.java

test/unit/org/apache/cassandra/tools/AsyncProfilerServiceTest.java

test/unit/org/apache/cassandra/tools/AsyncProfilerTest.java

src/java/org/apache/cassandra/tools/nodetool/Profile.java

src/java/org/apache/cassandra/config/CassandraRelevantProperties.java

src/java/org/apache/cassandra/service/CassandraDaemon.java

src/java/org/apache/cassandra/profiler/AsyncProfilerMBean.java

src/java/org/apache/cassandra/tools/nodetool/Profile.java

src/java/org/apache/cassandra/tools/profiler/AsyncProfilerService.java

src/java/org/apache/cassandra/service/AsyncProfilerService.java

src/java/org/apache/cassandra/tools/profiler/AsyncProfilerService.java

src/java/org/apache/cassandra/profiler/AsyncProfilerUnsafe.java

src/java/org/apache/cassandra/service/AsyncProfilerService.java

Add enable/disable AsyncProfiler JVM flags Refactor Add output format option & initial tests Refactor & add tests Add tests for system properties & refactor Checkstyle fixes & switching airlift with picocli (CASSANDRA-17445) Add more tests Fix Picocli 'Profile' command integration Address feedback Changes.txt Remove not needed property Add missing licenses Apply feedback Fix help tests refactoring fix commands hardened validation and simplification of commands fix log dir fixed tests more fixes add purge command more hardening implement list and fetch Remove unused import more fixes added documentation fixed nodetool help output tests added status command introduced binary download of files in fetch command if necessary hardened code ability to specify duration in human format (e.g. 5m) improved error parsing ability to execute purge, list and fetch even with disabled profiler async-profiler is disabled by default added nodetool tests add startup check checking kernel parameters

netudima reviewed Nov 20, 2025

View reviewed changes

conf/jvm-server.options Outdated Show resolved Hide resolved

netudima reviewed Nov 20, 2025

View reviewed changes

src/java/org/apache/cassandra/tools/profiler/AsyncProfilerService.java Outdated Show resolved Hide resolved

netudima reviewed Nov 20, 2025

View reviewed changes

test/unit/org/apache/cassandra/tools/AsyncProfilerServiceTest.java Outdated Show resolved Hide resolved

netudima reviewed Nov 20, 2025

View reviewed changes

test/unit/org/apache/cassandra/tools/AsyncProfilerServiceTest.java Show resolved Hide resolved

netudima reviewed Nov 20, 2025

View reviewed changes

test/unit/org/apache/cassandra/tools/AsyncProfilerTest.java Outdated Show resolved Hide resolved

netudima reviewed Nov 20, 2025

View reviewed changes

src/java/org/apache/cassandra/tools/nodetool/Profile.java Outdated Show resolved Hide resolved