Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add notification about close reader #13368

Merged
merged 12 commits into from
Feb 3, 2025
Merged

add notification about close reader #13368

merged 12 commits into from
Feb 3, 2025

Conversation

rekby
Copy link
Member

@rekby rekby commented Jan 14, 2025 •
edited
Loading

Changelog entry

...

Changelog category

  • Documentation (changelog entry is not required)

Additional information

...

@rekby rekby requested a review from a team as a code owner January 14, 2025 14:54
@github-actions github-actions bot added new-feature documentation Improvements or additions to documentation and removed new-feature labels Jan 14, 2025
@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 14, 2025 •
edited
Loading

⚪ 2025-01-14 14:58:47 UTC Pre-commit check linux-x86_64-relwithdebinfo for 46038d2 has started.
⚪ 2025-01-14 14:58:58 UTC Artifacts will be uploaded here
⚪ 2025-01-14 15:01:20 UTC ya make is running...
🟢 2025-01-14 15:02:45 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-01-14 15:02:51 UTC Build successful.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 14, 2025 •
edited
Loading

⚪ 2025-01-14 14:59:14 UTC Pre-commit check linux-x86_64-release-asan for 46038d2 has started.
⚪ 2025-01-14 14:59:25 UTC Artifacts will be uploaded here
⚪ 2025-01-14 15:01:46 UTC ya make is running...
🟢 2025-01-14 15:03:06 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-01-14 15:03:12 UTC Build successful.

@github-actions GitHub Actions
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

anton-bobkov
anton-bobkov reviewed Jan 15, 2025
View reviewed changes
rekby and others added 8 commits January 15, 2025 12:44
@rekby @anton-bobkov
Update ydb/docs/en/core/reference/ydb-sdk/topic.md
d6523d3 
Co-authored-by: anton-bobkov <anton-bobkov@ydb.tech>
@rekby @anton-bobkov
Update ydb/docs/en/core/reference/ydb-sdk/topic.md
f764c8d 
Co-authored-by: anton-bobkov <anton-bobkov@ydb.tech>
@rekby @anton-bobkov
Update ydb/docs/en/core/reference/ydb-sdk/topic.md
f76bc1b 
Co-authored-by: anton-bobkov <anton-bobkov@ydb.tech>
@rekby @anton-bobkov
Update ydb/docs/en/core/reference/ydb-sdk/topic.md
5737d2b 
Co-authored-by: anton-bobkov <anton-bobkov@ydb.tech>
@rekby @anton-bobkov
Update ydb/docs/ru/core/reference/ydb-sdk/topic.md
c68e2f2 
Co-authored-by: anton-bobkov <anton-bobkov@ydb.tech>
@rekby @anton-bobkov
Update ydb/docs/ru/core/reference/ydb-sdk/topic.md
7563940 
Co-authored-by: anton-bobkov <anton-bobkov@ydb.tech>
@rekby @anton-bobkov
Update ydb/docs/ru/core/reference/ydb-sdk/topic.md
6946874 
Co-authored-by: anton-bobkov <anton-bobkov@ydb.tech>
@rekby @anton-bobkov
Update ydb/docs/ru/core/reference/ydb-sdk/topic.md
05c5fea 
Co-authored-by: anton-bobkov <anton-bobkov@ydb.tech>
@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 15, 2025 •
edited
Loading

⚪ 2025-01-15 09:49:08 UTC Pre-commit check linux-x86_64-relwithdebinfo for a0977f1 has started.
⚪ 2025-01-15 09:49:13 UTC Artifacts will be uploaded here
⚪ 2025-01-15 09:51:33 UTC ya make is running...
🟢 2025-01-15 09:52:52 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-01-15 09:52:57 UTC Build successful.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 15, 2025 •
edited
Loading

⚪ 2025-01-15 09:50:28 UTC Pre-commit check linux-x86_64-release-asan for a0977f1 has started.
⚪ 2025-01-15 09:50:40 UTC Artifacts will be uploaded here
⚪ 2025-01-15 09:53:01 UTC ya make is running...
🟢 2025-01-15 09:53:06 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-01-15 09:53:12 UTC Build successful.

blinkov
blinkov previously requested changes Jan 17, 2025
View reviewed changes
ydb/docs/en/core/reference/ydb-sdk/topic.md Outdated
@@ -1382,6 +1382,8 @@ If a commit fails with an error, the application should log it and continue; it
}
```

The `Commit` call is fast by default, saving data into an internal buffer and returning control back to the caller. The real message to the server is sent in the background. To prevent losing the last commits, you should call the `Reader.Close()` method before exiting the program.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's also explain what people are supposed to do to guarantee that messages are not lost even if the client is abruptly terminated due to OOM, segfault, etc., and can't catch it to close the connection explicitly.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is reader description and messes stored on a server already. If a process will be killed before commit a message - the message will resend to other reader by server. The client does not have to do anything for this.

ydb/docs/en/core/reference/ydb-sdk/topic.md
@@ -1451,6 +1455,8 @@ If a commit fails with an error, the application should log it and continue; it
}
```

The `Commit` call is fast by default, saving data into an internal buffer and returning control back to the caller. The real message to the server is sent in the background. To prevent losing the last commits, you should call the `Reader.Close()` method before exiting the program.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'd better make it an {% include %} file instead of copypaste.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It has two paragraph and two copy of each in one file. I need two additional files and four include options for deduplicate of them. The paragraph doesn't need in other files and replace the text to include option make read the text difficult when read it.

I think about small copy-paste better, then a lot of small files and combine them by includes.

@rekby @blinkov
Update ydb/docs/en/core/reference/ydb-sdk/topic.md
78b135b 
Co-authored-by: Ivan Blinkov <ivan@blinkov.ru>
@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 17, 2025 •
edited
Loading

⚪ 2025-01-17 07:59:05 UTC Pre-commit check linux-x86_64-release-asan for fe84d24 has started.
⚪ 2025-01-17 07:59:34 UTC Artifacts will be uploaded here
⚪ 2025-01-17 08:02:37 UTC ya make is running...
⚫ 2025-01-17 08:03:11 UTC Check cancelled

@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 17, 2025 •
edited
Loading

⚪ 2025-01-17 07:59:15 UTC Pre-commit check linux-x86_64-relwithdebinfo for fe84d24 has started.
⚪ 2025-01-17 07:59:18 UTC Artifacts will be uploaded here
⚪ 2025-01-17 08:01:37 UTC ya make is running...
🟢 2025-01-17 08:02:57 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

@rekby @blinkov
Update ydb/docs/ru/core/reference/ydb-sdk/topic.md
34ce706 
Co-authored-by: Ivan Blinkov <ivan@blinkov.ru>
@github-actions GitHub Actions
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

@github-actions GitHub Actions
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 17, 2025 •
edited
Loading

⚪ 2025-01-17 08:11:29 UTC Pre-commit check linux-x86_64-relwithdebinfo for 1a18aa3 has started.
⚪ 2025-01-17 08:11:41 UTC Artifacts will be uploaded here
⚪ 2025-01-17 08:14:11 UTC ya make is running...
🟢 2025-01-17 08:15:46 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-01-17 08:15:52 UTC Build successful.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 17, 2025 •
edited
Loading

⚪ 2025-01-17 08:11:44 UTC Pre-commit check linux-x86_64-release-asan for 1a18aa3 has started.
⚪ 2025-01-17 08:11:56 UTC Artifacts will be uploaded here
⚪ 2025-01-17 08:14:26 UTC ya make is running...
🟢 2025-01-17 08:16:01 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-01-17 08:16:07 UTC Build successful.

@blinkov blinkov enabled auto-merge (squash) January 29, 2025 02:08
@blinkov blinkov merged commit 21c6640 into ydb-platform:main Feb 3, 2025
13 checks passed
azevaykin pushed a commit to azevaykin/ydb that referenced this pull request Feb 3, 2025
@rekby @anton-bobkov
@blinkov @azevaykin
add notification about close reader (ydb-platform#13368)
c16abab 
Co-authored-by: anton-bobkov <anton-bobkov@ydb.tech>
Co-authored-by: Ivan Blinkov <ivan@ydb.tech>
@GrigoriyPA GrigoriyPA mentioned this pull request Feb 11, 2025
Merged
lberserq pushed a commit to lberserq/ydb that referenced this pull request Feb 14, 2025
@rekby @anton-bobkov @blinkov
add notification about close reader (ydb-platform#13368)
148d0b4 
Co-authored-by: anton-bobkov <anton-bobkov@ydb.tech>
Co-authored-by: Ivan Blinkov <ivan@ydb.tech>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@anton-bobkov anton-bobkov anton-bobkov left review comments

@fomichev3000 fomichev3000 fomichev3000 approved these changes

@blinkov blinkov blinkov left review comments

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@rekby @blinkov @fomichev3000 @anton-bobkov