[ISSUE 9757][pulsar-admin] add cmd to get service url of the leader broker #9799

linlinnn · 2021-03-04T08:04:25Z

Motivation

see #9757 add cmd to get service url of the leader broker.

Modifications

add cmd parameter "leader-broker" in CmdBrokers, and provide "/admin/v2/brokers/leaderBroker" web endpoint to get service url of the leader broker.

Verifying this change

Make sure that the change passes the CI checks.

Documentation

Does this pull request introduce a new feature? yes
If yes, how is the feature documented? ( JavaDocs )

codelipenghui

Nice contribution!

codelipenghui · 2021-03-04T13:39:31Z

/pulsarbot run-failure-checks

wolfstudy

LGTM +1

315157973 · 2021-03-05T03:09:59Z

pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/impl/BrokersBase.java

+        try {
+            return pulsar().getLeaderElectionService().getCurrentLeader()
+                    .map(LeaderBroker::getServiceUrl)
+                    .orElse("None");


Nice contribution!

Now we will return null if we have no data. I think it is better to keep the same, otherwise the status returned by the Broker side will be more and more.

Thanks for your comment.
But maybe unclear semantics if we print "" on the console.

In CMD, we can handle the case of null, but the exposed REST API should be consistent

Thanks, i will take your advice.

eolivelli

Overall looks good to me.

I left a suggestion, thinking about future improvements to this API

Please take a look.
Once we publish an API we will have to maintain it basically forever

eolivelli · 2021-03-06T11:33:38Z

pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/impl/BrokersBase.java

+            value = {
+                    @ApiResponse(code = 401, message = "Authentication required"),
+                    @ApiResponse(code = 403, message = "This operation requires super-user access") })
+    public String getLeaderBroker() throws Exception {


What about returning a structure instead of a single String?
This way in the future we will be about to return more information .
If we return only one String we cannot extend this API in the future

Thanks for your suggestion.
What about returning LeaderBroker directly?

@eolivelli Good suggestion.

Yes, I think you can use the class LeaderBroker directly.

+1 to return LeaderBroker

linlinnn · 2021-03-08T08:50:41Z

pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/impl/BrokersBase.java

-                    .orElse(null);
+            LeaderBroker leaderBroker = pulsar().getLeaderElectionService().getCurrentLeader()
+                    .orElseThrow(() -> new RestException(Status.NOT_FOUND, "Couldn't find leader broker"));
+            BrokerInfo brokerInfo = new BrokerInfo();


I create BrokerInfo which is the same as LeaderBroker, Because I can not access LeaderBroker in module pulsar-client-admin.

@eolivelli Please help to review this PR.

eolivelli

Perfect

+1

Anonymitaet · 2021-03-08T10:16:36Z

site2/docs/admin-api-brokers.md

+```shell
+$ pulsar-admin brokers leader-broker
+```
+


If pulsar-admin brokers leader-broker has flags and descriptions, do not forget to add them to pulsar-admin docs.

To allow users to have more info (flags and descriptions), it is better to add the URL of the pulsar-admin brokers leader-broker command on pulsar-admin. Like For more information, see [here](xxx).

Thanks for your tip.
There is no more args for this command.

Anonymitaet · 2021-03-08T10:18:43Z

site2/docs/admin-api-brokers.md

+```java
+admin.brokers().getLeaderBroker()
+```
+


Better to add the Java admin URL to give more info to users?

The URL was contained in this doc.
The brokers method of the {@Inject: javadoc:PulsarAdmin:/admin/org/apache/pulsar/client/admin/PulsarAdmin.html} object in the Java API

Thanks for your explanations. Sorry I do not get you. I mean we can add a link w/ the line pointed to this command? Like https://github.com/apache/pulsar/blob/master/pulsar-client-admin/src/main/java/org/apache/pulsar/client/admin/internal/BrokersImpl.java#L80

Anonymitaet

Many thanks for adding docs! I've commented, PTAL.

linlinnn · 2021-03-09T14:52:35Z

/pulsarbot run-failure-checks

linlinnn · 2021-03-10T16:03:40Z

/pulsarbot run-failure-checks

codelipenghui · 2021-03-10T23:36:17Z

Thanks for the great work @linlinnn

### Motivation To keep consistent with the [Java client](apache/pulsar#9799). ### Modifications Add `GetLeaderBroker` interface.

[pulsar-admin] add cmd to get service url of the leader broker

5071492

codelipenghui approved these changes Mar 4, 2021

View reviewed changes

codelipenghui assigned linlinnn Mar 4, 2021

codelipenghui added this to the 2.8.0 milestone Mar 4, 2021

codelipenghui added release/2.7.2 type/enhancement The enhancements for the existing features or docs. e.g. reduce memory usage of the delayed messages labels Mar 4, 2021

codelipenghui requested review from sijie, rdhabalia, 315157973, hangc0276, jiazhai, merlimat and zymap March 4, 2021 13:39

wolfstudy approved these changes Mar 5, 2021

View reviewed changes

zymap approved these changes Mar 5, 2021

View reviewed changes

codelipenghui added the doc-required Your PR changes impact docs and you will update later. label Mar 5, 2021

315157973 reviewed Mar 5, 2021

View reviewed changes

linjunhua added 3 commits March 5, 2021 13:22

[doc] Add content for leader-broker cmd

61648ed

print NoLeader when leader broker not exists

5d720e3

fix test case

f21daf3

linlinnn requested a review from 315157973 March 6, 2021 11:09

eolivelli reviewed Mar 6, 2021

View reviewed changes

315157973 approved these changes Mar 6, 2021

View reviewed changes

linjunhua added 2 commits March 8, 2021 16:16

return broker info instead of single string

dd03672

update the desc of cmd 'leader-broker'

c6f5969

linlinnn commented Mar 8, 2021

View reviewed changes

eolivelli reviewed Mar 8, 2021

View reviewed changes

Anonymitaet reviewed Mar 8, 2021

View reviewed changes

Anonymitaet added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Mar 8, 2021

linjunhua added 3 commits March 8, 2021 19:16

update the content of cmd 'leader-broker'

6f81333

[doc] add the content of cmd 'leader-broker'

08dffb5

add asf license

8919825

linlinnn requested a review from Anonymitaet March 10, 2021 09:40

Anonymitaet approved these changes Mar 10, 2021

View reviewed changes

eolivelli approved these changes Mar 10, 2021

View reviewed changes

Merge remote-tracking branch 'apache/master' into issue-9757

c646a04

codelipenghui merged commit dd5c3b4 into apache:master Mar 10, 2021

codelipenghui removed the release/2.7.2 label Mar 23, 2021

Anonymitaet removed the doc-required Your PR changes impact docs and you will update later. label Apr 9, 2021

zhanghaou mentioned this pull request Jul 17, 2021

[Pulsar admin] Can not get leader broker in non-leader brokers. #11348

Closed

sijie mentioned this pull request Jul 17, 2021

ISSUE-11348: [Pulsar admin] Can not get leader broker in non-leader brokers. streamnative/pulsar-archived#2784

Closed

crossoverJie mentioned this pull request Apr 15, 2024

[Improve] Add admin api GetLeaderBroker apache/pulsar-client-go#1203

Merged

1 task

BewareMyPower pushed a commit to apache/pulsar-client-go that referenced this pull request Apr 22, 2024

[Improve] Add admin api GetLeaderBroker (#1203)

b4d45cd

### Motivation To keep consistent with the [Java client](apache/pulsar#9799). ### Modifications Add `GetLeaderBroker` interface.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ISSUE 9757][pulsar-admin] add cmd to get service url of the leader broker #9799

[ISSUE 9757][pulsar-admin] add cmd to get service url of the leader broker #9799

linlinnn commented Mar 4, 2021 •

edited by codelipenghui

Loading

codelipenghui left a comment

codelipenghui commented Mar 4, 2021

wolfstudy left a comment

315157973 Mar 5, 2021 •

edited

Loading

linlinnn Mar 5, 2021

315157973 Mar 5, 2021

linlinnn Mar 5, 2021

eolivelli left a comment •

edited

Loading

eolivelli Mar 6, 2021

linlinnn Mar 8, 2021 •

edited

Loading

codelipenghui Mar 8, 2021

sijie Mar 8, 2021

linlinnn Mar 8, 2021

linlinnn Mar 8, 2021

eolivelli left a comment

Anonymitaet Mar 8, 2021 •

edited

Loading

linlinnn Mar 8, 2021

Anonymitaet Mar 8, 2021 •

edited

Loading

linlinnn Mar 8, 2021

Anonymitaet Mar 9, 2021

linlinnn Mar 9, 2021

Anonymitaet left a comment

linlinnn commented Mar 9, 2021

linlinnn commented Mar 10, 2021

codelipenghui commented Mar 10, 2021

[ISSUE 9757][pulsar-admin] add cmd to get service url of the leader broker #9799

[ISSUE 9757][pulsar-admin] add cmd to get service url of the leader broker #9799

Conversation

linlinnn commented Mar 4, 2021 • edited by codelipenghui Loading

Motivation

Modifications

Verifying this change

Documentation

codelipenghui left a comment

Choose a reason for hiding this comment

codelipenghui commented Mar 4, 2021

wolfstudy left a comment

Choose a reason for hiding this comment

315157973 Mar 5, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eolivelli left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

linlinnn Mar 8, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eolivelli left a comment

Choose a reason for hiding this comment

Anonymitaet Mar 8, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Anonymitaet Mar 8, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Anonymitaet left a comment

Choose a reason for hiding this comment

linlinnn commented Mar 9, 2021

linlinnn commented Mar 10, 2021

codelipenghui commented Mar 10, 2021

linlinnn commented Mar 4, 2021 •

edited by codelipenghui

Loading

315157973 Mar 5, 2021 •

edited

Loading

eolivelli left a comment •

edited

Loading

linlinnn Mar 8, 2021 •

edited

Loading

Anonymitaet Mar 8, 2021 •

edited

Loading

Anonymitaet Mar 8, 2021 •

edited

Loading