feat: JFR events for open, HTTP range, segment decode/encode, chunk filtering and writer back-pressure
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 55/100
- Issue 类型
- 功能
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- java
- 领域
- backend, observability
调研方向
Start by reading the reader and writer entry points named in the issue: VortexReader.open, VortexHttpReader.open, SerializedArrayDecoder.decode, ScanIterator, and VortexWriter. Add the JFR event classes and wire them into those paths as specified, then use the named tests to check event fields, filtering counts, and back-pressure duration. Done when the event tests pass and the reference guide, how-to guide, changelog, and module map are updated.
由索引模型根据 Issue 内容生成。
描述
Goal
Emit JDK Flight Recorder events from the reader and writer, so a JFR recording shows where a read or write spends its time (file open/mapping, HTTP range fetches, per-segment decode/encode, chunk pruning, writer back-pressure) with no extra dependency and near-zero cost when recording is off.
Events
New package core/src/main/java/io/github/dfa1/vortex/core/jfr/ (with package-info.java). Each event is a public class extending jdk.jfr.Event, annotated @Name("io.github.dfa1.vortex.X"), @Label, @Category({"Vortex", …}), @Description and @StackTrace(false). Public fields get /// docs (doclint is all); byte sizes get @DataAmount.
| Class | Category | Fields |
|---|---|---|
FileOpenedEvent |
I/O | source, fileSize, formatVersion, segmentCount |
FileMappingEvent |
I/O | file, size |
HttpRangeEvent |
I/O | source, offset (-1 = tail), length, status (0 = no response) |
SegmentDecodedEvent |
Decode | encoding, rowCount, segmentSize |
ChunkFilterEvent |
Filter | totalChunks, chunksPruned, chunksWithoutMatch, chunksReturned, rowsReturned |
SegmentEncodedEvent |
Encode | encoding, bufferCount, encodedSize |
SegmentWaitEvent |
Pipeline | segmentsInFlight |
Reader wiring
Pattern: event.begin(), set fields, commit().
VortexReader.open(path, registry, layoutRegistry):FileOpenedspans the whole open and is committed after parse;FileMappingwrapschannel.map. A failed open emits noFileOpened.VortexHttpReader.open(uri, registry, layoutRegistry, client):FileOpenedbegins beforefetchTailand is committed after the reader is built.- New private
sendRange(req, client, uri, offset, length)wrapsclient.sendin try/finally and always commitsHttpRange, withstatus = 0on failure.fetchTailcalls it with offset-1andTAIL_SIZE.bytes();fetchRangewithfromandto - from + 1. - New package-private
static String describe(URI)returningscheme://host[:port]+ raw path. It drops user info, query and fragment, because presigned URLs carry credentials. Used for everysourcefield.
- New private
SerializedArrayDecoder.decode: begin at the top; afterregistry.decode(ctx)setencoding = node.encodingId().id(),rowCount,segmentSize = segLen, then commit. Covers both readers.ScanIterator:- New counters
chunksPruned,chunksWithoutMatch,chunksReturned. - In
hasNext(), splitcanPruneChunk(...) || !selectMatchingRows(...)into two branches that each count,chunkIndex++; continue. - Increment
chunksReturnedinnext(). close()callsemitChunkFilterEvent(), a no-op whenfilter == null || chunks == null.
- New counters
Writer wiring (VortexWriter)
encodeSegment: begin at the top; before returning,if (event.shouldCommit())fillencodingfromresult.rootNode().encodingId().id(),bufferCount,encodedSize, then commit. Failures emit nothing.drainSegments: replacepending.poll().join()with a staticawaitHead(head, pending.size() + 1). It joins directly ifhead.isDone(); otherwise begins aSegmentWaitEvent, joins in atry, commits in thefinally.- No change to the writer's default behavior. (The default executor runs tasks on the caller, so
SegmentWaitnever appears there.)
Tests
Given/When/Then throughout. For events committed on other threads, assert presence and field values, never exact counts.
core/src/test/.../core/testing/JfrRecorderTest.java: abstract base; aRecordingStreamwithsetReuse(false)starts in@BeforeEach; offersawaitEvents()andevents(name).- reader
VortexReaderJfrTest(fixtureprimitives.vortex):FileOpenedandFileMappingfields; a too-small file emits noFileOpened. - reader
VortexHttpReaderJfrTest(mockedHttpClient): tailHttpRange(offset -1, status 206);sourcehas no credentials or query; status 0 whensendthrowsIOException. - writer
JfrEventsTest(usesLegacyZoneMaps.OPTIONS, same package):SegmentEncodedpresent with non-negative sizes (avortex.sequencesegment has 0 buffers).- Default executor: no
SegmentWait. - Executor sleeping 200 ms before each task:
SegmentWaitduration > 50 ms andsegmentsInFlight> 0. - Chunks 1..50, 51..100, 101..150 with
eq(id, 75)→ totals 3/2/0/1 and 1 row. - Single chunk {1, 100} with
eq(id, 50)→ 1/0/1/0 and 0 rows. - Unfiltered scan emits no
ChunkFilter.
Docs (same commit)
docs/reference.md: "JFR events" section (event table) + TOC entry.docs/how-to.md: "Find where a read or write spends its time (JFR)".CHANGELOG.md:## [Unreleased]→ Added.AGENTS.md:core.jfrline in the module map.
Verify
./mvnw test -pl core,reader,writer -am./mvnw verify -DskipTests(Javadoc lint + checkstyle)
- 主要语言
- Java
- 星标
- 3
- 派生
- 2
- 平均合并
- 14 小时 59 分钟
- 30 天内合并 PR
- 137
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
dfa1/vortex-java 的其他 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 66/100
dfa1/vortex-java#636 ·
维护者通常 1 天内回复
-
bug
难度 4/5 3-5 天 新手友好度 35/100
dfa1/vortex-java#634 ·
维护者通常 1 天内回复
-
难度 5/5 一周以上 新手友好度 30/100
dfa1/vortex-java#583 ·
维护者通常 1 天内回复
-
enhancement
难度 5/5 一周以上 新手友好度 25/100
dfa1/vortex-java#567 ·
维护者通常 1 天内回复
-
enhancement
难度 4/5 3-5 天 新手友好度 45/100
dfa1/vortex-java#548 ·
维护者通常 1 天内回复
相似的 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 72/100
liberation-data/drivine4j#547 ·
维护者通常 1 天内回复
-
enhancement
难度 2/5 1-3 小时 新手友好度 70/100
-
BindingServiceProperties.bindings regressed to a non-thread-safe TreeMap in GH-3158: concurrent first use of binding names corrupts it可能已有人在做 @AkashB23 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 62/100
spring-cloud/spring-cloud-stream#3321 ·
维护者通常 1 天内回复
-
[Bug] 资源包列表 与 模组/数据包/世界 列表排列顺序不一致可能已有人在做 @fishdry1000 于 4 天前认领。 未关闭bug
难度 2/5 1-3 小时 新手友好度 62/100
维护者通常 1 天内回复
-
ai-driven-fuzzing bug claude Minor
难度 2/5 1-3 小时 新手友好度 72/100
linagora/twake-calendar-side-service#1333 ·
维护者通常 1 天内回复