-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
[improve][broker] PIP-192: Implement broker version filter for new load manager #19023
Merged
Technoboy-
merged 2 commits into
apache:master
from
Demogorgon314:Demogorgon314/Implement_broker_filter
Feb 4, 2023
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
147 changes: 147 additions & 0 deletions
147
...main/java/org/apache/pulsar/broker/loadbalance/extensions/filter/BrokerVersionFilter.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,147 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.apache.pulsar.broker.loadbalance.extensions.filter; | ||
|
|
||
| import com.github.zafarkhaja.semver.Version; | ||
| import java.util.Iterator; | ||
| import java.util.Map; | ||
| import lombok.extern.slf4j.Slf4j; | ||
| import org.apache.pulsar.broker.ServiceConfiguration; | ||
| import org.apache.pulsar.broker.loadbalance.BrokerFilterBadVersionException; | ||
| import org.apache.pulsar.broker.loadbalance.BrokerFilterException; | ||
| import org.apache.pulsar.broker.loadbalance.extensions.LoadManagerContext; | ||
| import org.apache.pulsar.broker.loadbalance.extensions.data.BrokerLookupData; | ||
|
|
||
| /** | ||
| * Filter by broker version. | ||
| */ | ||
| @Slf4j | ||
| public class BrokerVersionFilter implements BrokerFilter { | ||
|
|
||
| public static final String FILTER_NAME = "broker_version_filter"; | ||
|
|
||
|
|
||
| /** | ||
| * From the given set of available broker candidates, filter those old brokers using the version numbers. | ||
| * | ||
| * @param brokers The currently available brokers that have not already been filtered. | ||
| * @param context The load manager context. | ||
| * | ||
| */ | ||
| @Override | ||
| public Map<String, BrokerLookupData> filter(Map<String, BrokerLookupData> brokers, LoadManagerContext context) | ||
| throws BrokerFilterException { | ||
| ServiceConfiguration conf = context.brokerConfiguration(); | ||
| if (!conf.isPreferLaterVersions() || brokers.isEmpty()) { | ||
| return brokers; | ||
| } | ||
|
|
||
| Version latestVersion; | ||
| try { | ||
| latestVersion = getLatestVersionNumber(brokers); | ||
| if (log.isDebugEnabled()) { | ||
| log.debug("Latest broker version found was [{}]", latestVersion); | ||
| } | ||
| } catch (Exception ex) { | ||
| log.warn("Disabling PreferLaterVersions feature; reason: " + ex.getMessage()); | ||
| throw new BrokerFilterBadVersionException("Cannot determine newest broker version: " + ex.getMessage()); | ||
| } | ||
|
|
||
| int numBrokersLatestVersion = 0; | ||
| int numBrokersOlderVersion = 0; | ||
|
|
||
| Iterator<Map.Entry<String, BrokerLookupData>> brokerIterator = brokers.entrySet().iterator(); | ||
| while (brokerIterator.hasNext()) { | ||
| Map.Entry<String, BrokerLookupData> next = brokerIterator.next(); | ||
| String brokerId = next.getKey(); | ||
| String version = next.getValue().brokerVersion(); | ||
| Version brokerVersionVersion = Version.valueOf(version); | ||
| if (brokerVersionVersion.equals(latestVersion)) { | ||
| log.debug("Broker [{}] is running the latest version ([{}])", brokerId, version); | ||
| numBrokersLatestVersion++; | ||
| } else { | ||
| log.info("Broker [{}] is running an older version ([{}]); latest version is [{}]", | ||
| brokerId, version, latestVersion); | ||
| numBrokersOlderVersion++; | ||
| brokerIterator.remove(); | ||
| } | ||
| } | ||
| if (numBrokersOlderVersion == 0) { | ||
| log.info("All {} brokers are running the latest version [{}]", numBrokersLatestVersion, latestVersion); | ||
| } | ||
| return brokers; | ||
| } | ||
|
|
||
| /** | ||
| * Get the most recent broker version number from the broker lookup data of all the running brokers. | ||
| * The version number is from the build artifact in the pom and got added to the package when it was built by Maven | ||
| * | ||
| * @param brokerMap | ||
| * The BrokerId -> BrokerLookupData Map. | ||
| * @return The most recent broker version | ||
| * @throws BrokerFilterBadVersionException | ||
| * If the most recent version is undefined (e.g., a bad broker version was encountered or a broker | ||
| * does not have a version string in its lookup data. | ||
| */ | ||
| public Version getLatestVersionNumber(Map<String, BrokerLookupData> brokerMap) | ||
| throws BrokerFilterBadVersionException { | ||
|
|
||
| if (brokerMap.size() == 0) { | ||
| throw new BrokerFilterBadVersionException( | ||
| "Unable to determine latest version since broker version map was empty"); | ||
| } | ||
|
|
||
| Version latestVersion = null; | ||
| for (Map.Entry<String, BrokerLookupData> entry : brokerMap.entrySet()) { | ||
| String brokerId = entry.getKey(); | ||
| String version = entry.getValue().brokerVersion(); | ||
| if (null == version || version.length() == 0) { | ||
| log.warn("No version string in lookup data for broker [{}]; disabling PreferLaterVersions feature", | ||
| brokerId); | ||
| // Trigger the load manager to reset all the brokers to the original set | ||
| throw new BrokerFilterBadVersionException("No version string in lookup data for broker \"" | ||
| + brokerId + "\""); | ||
| } | ||
| Version brokerVersionVersion; | ||
| try { | ||
| brokerVersionVersion = Version.valueOf(version); | ||
| } catch (Exception x) { | ||
| log.warn("Invalid version string in lookup data for broker [{}]: [{}];" | ||
| + " disabling PreferLaterVersions feature", | ||
| brokerId, version); | ||
| // Trigger the load manager to reset all the brokers to the original set | ||
| throw new BrokerFilterBadVersionException("Invalid version string in lookup data for broker \"" | ||
| + brokerId + "\": \"" + version + "\")"); | ||
| } | ||
|
|
||
| if (latestVersion == null) { | ||
| latestVersion = brokerVersionVersion; | ||
| } else if (Version.BUILD_AWARE_ORDER.compare(latestVersion, brokerVersionVersion) < 0) { | ||
| latestVersion = brokerVersionVersion; | ||
| } | ||
| } | ||
|
|
||
| return latestVersion; | ||
| } | ||
|
|
||
| @Override | ||
| public String name() { | ||
| return FILTER_NAME; | ||
| } | ||
| } | ||
140 changes: 140 additions & 0 deletions
140
.../java/org/apache/pulsar/broker/loadbalance/extensions/filter/BrokerVersionFilterTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.apache.pulsar.broker.loadbalance.extensions.filter; | ||
|
|
||
| import static org.mockito.Mockito.doReturn; | ||
| import static org.mockito.Mockito.mock; | ||
| import static org.testng.Assert.assertEquals; | ||
| import static org.testng.Assert.assertTrue; | ||
|
|
||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import org.apache.pulsar.broker.ServiceConfiguration; | ||
| import org.apache.pulsar.broker.loadbalance.BrokerFilterBadVersionException; | ||
| import org.apache.pulsar.broker.loadbalance.BrokerFilterException; | ||
| import org.apache.pulsar.broker.loadbalance.extensions.LoadManagerContext; | ||
| import org.apache.pulsar.broker.loadbalance.extensions.data.BrokerLookupData; | ||
| import org.apache.pulsar.policies.data.loadbalancer.AdvertisedListener; | ||
| import org.testng.annotations.Test; | ||
|
|
||
| /** | ||
| * Unit test for {@link BrokerVersionFilter}. | ||
| */ | ||
| @Test(groups = "broker") | ||
| public class BrokerVersionFilterTest { | ||
|
|
||
|
|
||
| @Test | ||
| public void testFilterEmptyBrokerList() throws BrokerFilterException { | ||
| BrokerVersionFilter brokerVersionFilter = new BrokerVersionFilter(); | ||
| Map<String, BrokerLookupData> result = brokerVersionFilter.filter(new HashMap<>(), getContext()); | ||
| assertTrue(result.isEmpty()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testDisabledFilter() throws BrokerFilterException { | ||
| LoadManagerContext context = getContext(); | ||
| ServiceConfiguration configuration = new ServiceConfiguration(); | ||
| configuration.setPreferLaterVersions(false); | ||
| doReturn(configuration).when(context).brokerConfiguration(); | ||
|
|
||
| Map<String, BrokerLookupData> originalBrokers = Map.of( | ||
| "localhost:6650", getLookupData("2.10.0"), | ||
| "localhost:6651", getLookupData("2.10.1") | ||
| ); | ||
| Map<String, BrokerLookupData> brokers = new HashMap<>(originalBrokers); | ||
| BrokerVersionFilter brokerVersionFilter = new BrokerVersionFilter(); | ||
| Map<String, BrokerLookupData> result = brokerVersionFilter.filter(brokers, context); | ||
| assertEquals(result, originalBrokers); | ||
| } | ||
|
|
||
| @Test | ||
| public void testFilter() throws BrokerFilterException { | ||
| Map<String, BrokerLookupData> originalBrokers = Map.of( | ||
| "localhost:6650", getLookupData("2.10.0"), | ||
| "localhost:6651", getLookupData("2.10.1"), | ||
| "localhost:6652", getLookupData("2.10.1"), | ||
| "localhost:6653", getLookupData("2.10.1") | ||
| ); | ||
| BrokerVersionFilter brokerVersionFilter = new BrokerVersionFilter(); | ||
| Map<String, BrokerLookupData> result = brokerVersionFilter.filter(new HashMap<>(originalBrokers), getContext()); | ||
| assertEquals(result, Map.of( | ||
| "localhost:6651", getLookupData("2.10.1"), | ||
| "localhost:6652", getLookupData("2.10.1"), | ||
| "localhost:6653", getLookupData("2.10.1") | ||
| )); | ||
|
|
||
| originalBrokers = Map.of( | ||
| "localhost:6650", getLookupData("2.10.0"), | ||
| "localhost:6651", getLookupData("2.10.1-SNAPSHOT"), | ||
| "localhost:6652", getLookupData("2.10.1"), | ||
| "localhost:6653", getLookupData("2.10.1") | ||
| ); | ||
| result = brokerVersionFilter.filter(new HashMap<>(originalBrokers), getContext()); | ||
|
|
||
| assertEquals(result, Map.of( | ||
| "localhost:6652", getLookupData("2.10.1"), | ||
| "localhost:6653", getLookupData("2.10.1") | ||
| )); | ||
|
|
||
| originalBrokers = Map.of( | ||
| "localhost:6650", getLookupData("2.10.0"), | ||
| "localhost:6651", getLookupData("2.10.1-SNAPSHOT"), | ||
| "localhost:6652", getLookupData("2.10.1"), | ||
| "localhost:6653", getLookupData("2.10.2-SNAPSHOT") | ||
| ); | ||
|
|
||
| result = brokerVersionFilter.filter(new HashMap<>(originalBrokers), getContext()); | ||
| assertEquals(result, Map.of( | ||
| "localhost:6653", getLookupData("2.10.2-SNAPSHOT") | ||
| )); | ||
|
|
||
| } | ||
|
|
||
| @Test(expectedExceptions = BrokerFilterBadVersionException.class) | ||
| public void testInvalidVersionString() throws BrokerFilterException { | ||
| Map<String, BrokerLookupData> originalBrokers = Map.of( | ||
| "localhost:6650", getLookupData("xxx") | ||
| ); | ||
| BrokerVersionFilter brokerVersionFilter = new BrokerVersionFilter(); | ||
| brokerVersionFilter.filter(new HashMap<>(originalBrokers), getContext()); | ||
| } | ||
|
|
||
| public LoadManagerContext getContext() { | ||
| LoadManagerContext mockContext = mock(LoadManagerContext.class); | ||
| ServiceConfiguration configuration = new ServiceConfiguration(); | ||
| configuration.setPreferLaterVersions(true); | ||
| doReturn(configuration).when(mockContext).brokerConfiguration(); | ||
| return mockContext; | ||
| } | ||
|
|
||
| public BrokerLookupData getLookupData(String version) { | ||
| String webServiceUrl = "http://localhost:8080"; | ||
| String webServiceUrlTls = "https://localhoss:8081"; | ||
| String pulsarServiceUrl = "pulsar://localhost:6650"; | ||
| String pulsarServiceUrlTls = "pulsar+ssl://localhost:6651"; | ||
| Map<String, AdvertisedListener> advertisedListeners = new HashMap<>(); | ||
| Map<String, String> protocols = new HashMap<>(){{ | ||
| put("kafka", "9092"); | ||
| }}; | ||
| return new BrokerLookupData( | ||
| webServiceUrl, webServiceUrlTls, pulsarServiceUrl, | ||
| pulsarServiceUrlTls, advertisedListeners, protocols, true, true, version); | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If an exception is thrown here, do we skip this filter?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, we should handle the exception when using the filter.