You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@seatunnel.apache.org by "DanielCarter-stack (via GitHub)" <gi...@apache.org> on 2026/07/27 14:05:26 UTC
[PR] [Docs][Connector-V2] Improve ActiveMQ Web3j Sls Socket and EdgeSocket docs [seatunnel]
DanielCarter-stack opened a new pull request, #11575:
URL: https://github.com/apache/seatunnel/pull/11575
## Purpose
Improve documentation coverage and accuracy for five connectors whose
docs had gaps versus the underlying code, e2e tests, or current connector
behavior:
- **ActiveMQ** (sink) — add the `consumer_expiry_check_enabled` option,
which was defined in `ActivemqSinkOptions` but missing from the docs,
and add a streaming example alongside the existing BATCH example.
- **Web3j** (source) — clarify provider endpoint expectations, document
the single-split / non-parallel behavior, and add a streaming example
with `checkpoint.interval`.
- **Sls** (sink) — add a streaming example, document the JSON
serialization under the `content` log key, and remind users that
exactly-once is not supported by this sink.
- **Socket** (sink + source) — clarify that the sink writes one JSON
line with no delimiter, document `max_retries` (`-1` / `0` /
positive) semantics, and add a streaming example for the source.
- **EdgeSocket** (source) — add a Common Downstream Pattern section
showing the Sql transform + Jdbc sink arrangement that the bundled
e2e configs use.
## Changes
- 12 documentation files updated across English and Chinese.
- ActiveMQ: new `consumer_expiry_check_enabled` row + streaming-mode
configuration example with URI-embedded authentication.
- Web3j: new streaming-mode example with `Assert` sink and notes about
provider / authentication / row structure.
- Sls (sink): streaming-mode configuration, JSON serialization note,
retry/flush note about checkpoint vs `PutLogs` semantics.
- Socket (sink + source): clearer `max_retries` semantics, no-delimiter
note for sink JSON line, parallel subtask vs writer TCP connection
explanation, streaming example for source.
- EdgeSocket: new "Common Downstream Pattern" section between
"Quick Start" and "Schema Mode", with a realistic configuration that
matches the e2e configs.
- No code, configuration, or test files changed.
## Verification
- `git diff --check upstream/dev..HEAD` — no whitespace issues.
- `git diff --stat upstream/dev..HEAD` — 12 files changed,
440 insertions, 13 deletions, all under `docs/`.
- Pure markdown changes; no Java code touched.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [Docs][Connector-V2] Improve ActiveMQ Web3j Sls Socket and EdgeSocket docs [seatunnel]
Posted by "davidzollo (via GitHub)" <gi...@apache.org>.
davidzollo merged PR #11575:
URL: https://github.com/apache/seatunnel/pull/11575
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [Docs][Connector-V2] Improve ActiveMQ Web3j Sls Socket and EdgeSocket docs [seatunnel]
Posted by "DanielLeens (via GitHub)" <gi...@apache.org>.
DanielLeens commented on PR #11575:
URL: https://github.com/apache/seatunnel/pull/11575#issuecomment-5149754619
Thanks for your contribution for Apache SeaTunnel.
To facilitate focused communication among contributors, we’ve created a brand-new dedicated #contributors channel in official Slack workspace.
Slack workspace link: https://s.apache.org/seatunnel-slack
This channel is designed for technical discussions, feature design brainstorming, roadmap sync and direct communication with project core Contributors. Everyone who contributes code, docs, test cases or community ideas is warmly invited to join, share thoughts and collaborate together under The Apache Way. Welcome to join us😄
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [Docs][Connector-V2] Improve ActiveMQ Web3j Sls Socket and EdgeSocket docs [seatunnel]
Posted by "DanielLeens (via GitHub)" <gi...@apache.org>.
DanielLeens commented on PR #11575:
URL: https://github.com/apache/seatunnel/pull/11575#issuecomment-5149756447
Thanks for your contribution for Apache SeaTunnel.
To facilitate focused communication among contributors, we’ve created a brand-new dedicated #contributors channel in official Slack workspace.
Slack workspace link: https://s.apache.org/seatunnel-slack
This channel is designed for technical discussions, feature design brainstorming, roadmap sync and direct communication with project core Contributors. Everyone who contributes code, docs, test cases or community ideas is warmly invited to join, share thoughts and collaborate together under The Apache Way. Welcome to join us😄
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [Docs][Connector-V2] Improve ActiveMQ Web3j Sls Socket and EdgeSocket docs [seatunnel]
Posted by "zhangshenghang (via GitHub)" <gi...@apache.org>.
zhangshenghang commented on PR #11575:
URL: https://github.com/apache/seatunnel/pull/11575#issuecomment-5220999209
Thanks for the re-review. I have pushed commit 210416497 addressing the remaining feedback:
- Socket source (en + zh): reworded the "empty lines are skipped" sentence. SocketSourceReader.pollNext() unconditionally collects every record the buffer splits on, including empty records, so the new wording now states that empty lines produce a row with an empty-string payload rather than being skipped.
- Web3j source (en): tightened the streaming-mode intro so it no longer claims the connector "emits a row every time a new block number is observed." Web3jSourceReader.pollNext() emits a row on every poll regardless of whether the chain has produced a new block, so the new wording makes that explicit.
The two cosmetic nits (table padding in Activemq / Socket docs and Jdbc/jdbc casing in the EdgeSocket example) are not blocking, but I have left them alone here to keep this follow-up focused on the correctness items; happy to address them in a separate commit if you want them folded into this PR.
CI should re-run on the new head.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [Docs][Connector-V2] Improve ActiveMQ Web3j Sls Socket and EdgeSocket docs [seatunnel]
Posted by "DanielLeens (via GitHub)" <gi...@apache.org>.
DanielLeens commented on PR #11575:
URL: https://github.com/apache/seatunnel/pull/11575#issuecomment-5116946475
Quick follow-up on the gate state: the `Build` check I mentioned as still in progress has completed successfully on this head now.
That does not change the source/docs conclusion from my previous review: the Socket sink documentation still needs to be adjusted so it does not describe the current undelimited TCP byte stream as line-framed JSON. Once that wording is fixed, the CI side no longer looks like a blocker from Daniel's review path.
Thanks again for improving these docs. The remaining action from my side is just the Socket framing wording, plus the normal maintainer review/merge gate.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [Docs][Connector-V2] Improve ActiveMQ Web3j Sls Socket and EdgeSocket docs [seatunnel]
Posted by "DanielCarter-stack (via GitHub)" <gi...@apache.org>.
DanielCarter-stack commented on PR #11575:
URL: https://github.com/apache/seatunnel/pull/11575#issuecomment-5213343682
Thanks @DanielLeens for the careful review. I've addressed Issue 1 in commit `fa3bda3b`.
The Socket sink description no longer claims line framing. I verified the implementation first:
- `SocketSinkWriter` uses `JsonSerializationSchema`, whose `serialize()` returns `mapper.writeValueAsString(node).getBytes(charset)` — no trailing newline.
- `SocketClient.write()` only does `outputStream.write(msg); outputStream.flush()` — no delimiter is appended.
So multiple records are written as one continuous TCP byte stream of concatenated JSON objects, exactly as you described.
Both `docs/en/connectors/sink/Socket.md` and `docs/zh/connectors/sink/Socket.md` now:
- State that each row is serialized to a JSON object and that the connector does **not** append a newline or any delimiter between records.
- Explain that multiple records arrive as concatenated JSON objects (e.g. `{"a":1}{"a":2}{"a":3}`).
- Note that the peer must handle framing itself with a streaming JSON parser (e.g. Jackson's `MappingIterator`), not a line-oriented parser, and that `nc -l` only echoes the raw concatenated bytes.
- The task example output was updated to show concatenated records rather than a single line.
The `Build` check is re-running on the new head; `Notify test workflow` and `labeler` already pass. Happy to tweak the wording further if needed.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org