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.

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

Documentation: Add a feature/defaults chart for each official Client (e.g. Java, Go, Python etc.) so folks can compare/contrast #9723

Closed
frankjkelly opened this issue Feb 25, 2021 · 11 comments
Assignees
Labels
doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. type/enhancement The enhancements for the existing features or docs. e.g. reduce memory usage of the delayed messages
Milestone

Comments

@frankjkelly
Copy link
Contributor

Is your enhancement request related to a problem? Please describe.
As a microservices developer we have folks who use Java, some who use Go and some who use Python etc.
It appears that the clients are on a slightly different feature development timeline and/or have some different defaults.

Describe the solution you'd like
Create a matrix/chart of the clients and the various features that each chart supports e.g.

  1. The Java client default batch publish delay is 1ms but in Go it is 10ms. See https://github.com/apache/pulsar-client-go/blob/21541d6d40a6324db7b3952d9e1d392d872ce231/pulsar/producer_impl.go#L36 vs.
    checkArgument(delayInMs >= 1, "configured value for batch delay must be at least 1ms");
  2. The Go library does not yet support non-durable subscriptions Add Support for NonDurable subscriptions pulsar-client-go#468
  3. to my knowledge the Go and Python client do not yet support SNI (could be wrong).

Describe alternatives you've considered
Remain as is - creates a lot of onus on the developer as Pulsar (fortunately!) has so many awesome features and settings.

Additional context
N/A

@hpvd
Copy link

hpvd commented Feb 26, 2021

+1 on this.
A good start is already available but not that easy to find:
https://github.com/apache/pulsar/wiki/Client-Features-Matrix

@hpvd
Copy link

hpvd commented Feb 26, 2021

and there is something more detailled in work, see #5959 (comment)

  • it's till now only about comparing the big feature,
  • new is the topic harmonizing the default values
  • personal wish for mid-time: feature parity with especially catching up on websocket side

@Jennifer88huang-zz Jennifer88huang-zz added doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. triage/week-13 labels Mar 23, 2021
@Jennifer88huang-zz
Copy link
Contributor

@frankjkelly @hpvd Thank you for raising the issue, we've summarized the client matrix and Function Features in https://docs.google.com/spreadsheets/d/1iTzn6QnOpTYK8QQHxXRb6a25nvuTNGPPJDdUQHGBUS4/edit#gid=1784579914
I'll upload this sheet on the Client Feature Matrix page soon.

@Jennifer88huang-zz
Copy link
Contributor

If you find anything to be updated, feel free to comment in the google sheet directly. Thank you very much for your patience and support~

@hpvd
Copy link

hpvd commented Mar 23, 2021

@jennifer88huang awesome! Many thanks!
Great idea to split into code and doc :-)

Thinking this further one could directly link from matrix to the detail doc...

doing this, feature matrix is some kind of additional list of contents for doc.

@hpvd
Copy link

hpvd commented Mar 23, 2021

Having such a great overview, the feature matrix deserves a more prominent place to be found.
Or a least more links pointing to it...

@Jennifer88huang-zz
Copy link
Contributor

@hpvd I'm thinking about it. If you have any idea or suggestion, feel free to let me know. Thank you.

@frankjkelly
Copy link
Contributor Author

That is just wonderful news - thank you @jennifer88huang definitely worth sharing far and wide in Slack, Emails, links from doc. Will be super helpful for current and future developers! Thanks so much!

@Jennifer88huang-zz
Copy link
Contributor

@frankjkelly thank you for your advice, I'll share it in different channels so more people who care about it will know it.

@Jennifer88huang-zz Jennifer88huang-zz self-assigned this Mar 23, 2021
@Jennifer88huang-zz Jennifer88huang-zz added this to the 2.8.0 milestone Mar 23, 2021
@frankjkelly
Copy link
Contributor Author

@jennifer88huang I think this can be closed now - what do you think?

@Jennifer88huang-zz
Copy link
Contributor

@frankjkelly Yes, thank you for your reminder.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. type/enhancement The enhancements for the existing features or docs. e.g. reduce memory usage of the delayed messages
Projects
None yet
Development

No branches or pull requests

3 participants