Skip to content

[improve] [pip] PIP-375 Expose the Admin client configs: readTimeout, requestTimeout, and connectionTimeout #23222

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

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

[improve] [pip] PIP-375 Expose the Admin client configs: readTimeout, requestTimeout, and connectionTimeout #23222

Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2f6cb46
[improve] [pip] Expose the Admin client configs: readTimeout, request…
poorbarcode Aug 26, 2024
0b81edb
Update pip-374.md
poorbarcode Aug 26, 2024
4d22c4b
-
poorbarcode Aug 26, 2024
d7fb486
Update pip-375.md
poorbarcode Aug 26, 2024
0a1b795
Update pip-375.md
poorbarcode Aug 28, 2024
ac10910
Update pip-375.md
poorbarcode Aug 28, 2024
05f8959
Update pip-375.md
poorbarcode Aug 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions pip/pip-375.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# PIP-375: Expose the Admin client configs: readTimeout, requestTimeout, connectionTimeout

# Background knowledge

- `pulsar-admin sinks create` will upload files to brokers, but if the file is large and the network is slow, it may cost a long time.
- The default value of `requestTimeout` of Admin API is `60s`, after the fix https://github.com/apache/pulsar/pull/23128, it was changed to `300s`.

# Motivation

We'd better to expose the following configs to users:
Copy link
Member

Choose a reason for hiding this comment

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

Why is it better?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

See https://github.com/apache/pulsar/pull/23222/files#diff-be84b11fa7ada15d3ef3a329b5ec3b0cd798c9d50d70d2d8c73e77714592d547R5

Copy link
Member

Choose a reason for hiding this comment

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

It would be good to update this information in the PIP document.

- `readTimeout`
- `requestTimeout`
- `connectionTimeout`
Copy link
Member

Choose a reason for hiding this comment

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

Please add a short definition of these configuration parameters.

One reason is that there has been misconceptions about readTimeout and requestTimeout as described in #23128.

There's also a possibility for confusion about "connection timeout". One has to think whether it means "connect timeout" or "connection idle timeout", or something else. Based on the javadoc it means a "connect timeout".

Copy link
Member

Choose a reason for hiding this comment

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

+1

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added description


# Goals

Expose the Admin client configs: `readTimeout`, `requestTimeout` and `connectionTimeout` to users.

# Detailed Design

### CLI

**client.conf**
```properties
adminReadTimeoutInSeconds=300
adminRequestTimeoutInSeconds=300
adminConnectionTimeoutInSeconds=300
```

# Links
* Mailing List discussion thread:
* Mailing List voting thread: