[PROF-15616] Add JFR support and java_cpu_jfr scenario #156
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,153 @@ | ||
| // Package analysis — JFR support. | ||
| // | ||
| // This file adds the ability to read JFR (Java Flight Recorder) files and map | ||
| // JFR events directly into the analyzer's neutral ProfileSet. The mapping from | ||
| // event names to profile semantics intentionally lives here: prof-correctness is | ||
| // the consumer that knows which JDK / Datadog profiler events should satisfy a | ||
| // given expected_profile.json assertion. | ||
| package analysis | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "io" | ||
| "strings" | ||
|
|
||
| "github.com/grafana/jfr-parser/parser" | ||
| "github.com/grafana/jfr-parser/parser/types" | ||
| ) | ||
|
|
||
| // FromJFR builds a ProfileSet directly from Java Flight Recorder events. | ||
| func FromJFR(data []byte) (*ProfileSet, error) { | ||
| p := parser.NewParser(data, parser.Options{ | ||
| SymbolProcessor: parser.ProcessSymbols, | ||
| }) | ||
| ps := newProfileSet() | ||
|
|
||
| var cpuTotal int64 | ||
| var durationNanos uint64 | ||
| seenChunks := map[jfrChunkKey]bool{} | ||
|
|
||
| for { | ||
| event, err := p.ParseRawEvent() | ||
| if err == io.EOF { | ||
| break | ||
| } | ||
| if err != nil { | ||
| return nil, fmt.Errorf("jfr ParseRawEvent: %w", err) | ||
| } | ||
| if event.Type == nil { | ||
| continue | ||
| } | ||
|
|
||
| header := p.ChunkHeader() | ||
| chunk := jfrChunkKey{startNanos: header.StartNanos, durationNanos: header.DurationNanos} | ||
| if !seenChunks[chunk] { | ||
| seenChunks[chunk] = true | ||
| durationNanos += header.DurationNanos | ||
| } | ||
|
|
||
| switch event.Type.Name { | ||
| case "jdk.ExecutionSample", "datadog.ExecutionSample": | ||
| fields, err := p.DecodeRawEventFields(event) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("jfr decode %s: %w", event.Type.Name, err) | ||
| } | ||
| cpuTotal += addJFRCPU(ps, p, fields) | ||
| } | ||
| } | ||
|
|
||
| if cpuTotal > 0 && durationNanos > 0 { | ||
| ps.addProfileDuration("cpu", cpuTotal, float64(durationNanos)/1e9) | ||
| } | ||
|
|
||
| return ps.finalize(), nil | ||
|
r1viollet marked this conversation as resolved.
|
||
| } | ||
|
|
||
| type jfrChunkKey struct { | ||
| startNanos uint64 | ||
| durationNanos uint64 | ||
| } | ||
|
|
||
| func addJFRCPU(ps *ProfileSet, p *parser.Parser, fields map[string]parser.RawField) int64 { | ||
| stackField, ok := jfrField(fields, "stackTrace") | ||
| if !ok { | ||
| return 0 | ||
| } | ||
|
|
||
| // Match jfr-parser/pprof's CPU semantics: execution samples from sleeping | ||
| // threads do not count as CPU samples. If the state is absent, keep the | ||
| // sample rather than silently dropping producer-specific events. | ||
| if state, ok := jfrField(fields, "state"); ok { | ||
| if ts := p.GetThreadState(types.ThreadStateRef(state.Uint64)); ts != nil && ts.Name == "STATE_SLEEPING" { | ||
| return 0 | ||
| } | ||
| } | ||
|
|
||
| folded := foldJFRStack(p, types.StackTraceRef(stackField.Uint64)) | ||
| if folded == "" { | ||
| return 0 | ||
| } | ||
|
|
||
| val := int64(1) | ||
| if weight, ok := jfrField(fields, "weight"); ok && weight.Uint64 > 0 { | ||
| val = int64(weight.Uint64) | ||
| } | ||
|
|
||
| ps.add("cpu", StackSample{Stack: folded, Val: val, Labels: executionSampleLabels(fields)}) | ||
| return val | ||
| } | ||
|
|
||
| func executionSampleLabels(fields map[string]parser.RawField) map[string][]string { | ||
| labels := map[string][]string{} | ||
| if spanID, ok := jfrField(fields, "spanId"); ok && spanID.Uint64 != 0 { | ||
| labels[LabelSpanID] = []string{fmt.Sprintf("%d", spanID.Uint64)} | ||
| } | ||
| if localRootSpanID, ok := jfrField(fields, "localRootSpanId"); ok && localRootSpanID.Uint64 != 0 { | ||
| labels[LabelLocalRootSID] = []string{fmt.Sprintf("%d", localRootSpanID.Uint64)} | ||
| } | ||
| traceHi, traceHiOK := jfrField(fields, "traceIdHi") | ||
| traceLo, traceLoOK := jfrField(fields, "traceIdLo") | ||
| if (traceHiOK || traceLoOK) && (traceHi.Uint64 != 0 || traceLo.Uint64 != 0) { | ||
| labels[LabelTraceID] = []string{fmt.Sprintf("%016x%016x", traceHi.Uint64, traceLo.Uint64)} | ||
| } | ||
| return labels | ||
| } | ||
|
|
||
| func jfrField(fields map[string]parser.RawField, name string) (parser.RawValue, bool) { | ||
| field, ok := fields[name] | ||
| if !ok { | ||
| return parser.RawValue{}, false | ||
| } | ||
| return field.First() | ||
| } | ||
|
|
||
| func foldJFRStack(p *parser.Parser, stackRef types.StackTraceRef) string { | ||
| st := p.GetStacktrace(stackRef) | ||
| if st == nil || len(st.Frames) == 0 { | ||
| return "" | ||
| } | ||
| // JFR frames are leaf-first. The analyzer uses root-first folded stacks, | ||
| // matching FromPprof and the historical expected_profile.json captures. | ||
| frames := make([]string, 0, len(st.Frames)) | ||
| for i := len(st.Frames) - 1; i >= 0; i-- { | ||
| name := jfrFrameName(p, st.Frames[i].Method) | ||
| if name != "" { | ||
| frames = append(frames, name) | ||
| } | ||
| } | ||
| return strings.Join(frames, ";") | ||
| } | ||
|
|
||
| func jfrFrameName(p *parser.Parser, methodRef types.MethodRef) string { | ||
| m := p.GetMethod(methodRef) | ||
| if m == nil { | ||
| return "" | ||
| } | ||
| methodName := p.GetSymbolString(m.Name) | ||
| cls := p.GetClass(m.Type) | ||
| if cls == nil { | ||
| return methodName | ||
| } | ||
| clsName := strings.ReplaceAll(p.GetSymbolString(cls.Name), "/", ".") | ||
| return clsName + "." + methodName | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| FROM eclipse-temurin:21-jdk | ||
|
|
||
| WORKDIR /app | ||
|
|
||
| RUN apt-get update \ | ||
| && apt-get install -y --no-install-recommends curl ca-certificates \ | ||
| && rm -rf /var/lib/apt/lists/* | ||
|
|
||
| # Install the Datadog Java tracer, which carries the Datadog native Java | ||
| # profiler (ddprof). The profiler writes Datadog-specific JFR events such as | ||
| # datadog.ExecutionSample; this scenario validates that prof-correctness can | ||
| # consume those recordings directly. | ||
| RUN curl -fsSL -o /app/dd-java-agent.jar https://dtdg.co/latest-java-tracer | ||
|
|
||
| COPY ./scenarios/java_cpu_jfr/DummyApp.java . | ||
| RUN javac DummyApp.java | ||
|
|
||
| # EXECUTION_TIME_SEC is injected by the test harness; default to 60 s. | ||
| ENV EXECUTION_TIME_SEC=60 | ||
|
|
||
| # Run the app under the Datadog Java profiler and use the tracer's built-in | ||
| # debug dump path to persist the JFR snapshot locally. The prof-correctness | ||
| # harness finds the timestamped dd-profiler-debug-*.jfr file by regex. | ||
| CMD sh -eu -c '\ | ||
| mkdir -p /app/data/dumps /app/data/tmp; \ | ||
| java \ | ||
| -javaagent:/app/dd-java-agent.jar \ | ||
| -Ddd.service=prof-correctness-java-cpu-jfr \ | ||
| -Ddd.env=local \ | ||
| -Ddd.trace.enabled=false \ | ||
| -Ddd.profiling.enabled=true \ | ||
| -Ddd.profiling.ddprof.enabled=true \ | ||
| -Ddd.profiling.ddprof.cpu.enabled=true \ | ||
| -Ddd.profiling.ddprof.wall.enabled=false \ | ||
| -Ddd.profiling.upload.period=30 \ | ||
| -Ddd.profiling.upload.timeout=1 \ | ||
| -Ddd.profiling.start-force-first=true \ | ||
| -Ddd.profiling.tempdir=/app/data/tmp \ | ||
| -Ddd.profiling.debug.dump_path=/app/data/dumps \ | ||
| -Ddd.profiling.url=http://127.0.0.1:8126/ \ | ||
| -Ddd.telemetry.enabled=false \ | ||
| -Ddd.jmxfetch.enabled=false \ | ||
| DummyApp \ | ||
| ' |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I did not handle everything here, this is mainly to have an example