diff --git a/CHANGELOG.md b/CHANGELOG.md index b4d0432b7d3db..428cb6a8073d6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), - Introduce a setting to disable download of full cluster state from remote on term mismatch([#16798](https://github.com/opensearch-project/OpenSearch/pull/16798/)) - Added ability to retrieve value from DocValues in a flat_object filed([#16802](https://github.com/opensearch-project/OpenSearch/pull/16802)) - Improve performace of NumericTermAggregation by avoiding unnecessary sorting([#17252](https://github.com/opensearch-project/OpenSearch/pull/17252)) +- [Rule Based Auto-tagging] Add in-memory attribute value store ([#17342](https://github.com/opensearch-project/OpenSearch/pull/17342)) ### Dependencies - Bump `org.awaitility:awaitility` from 4.2.0 to 4.2.2 ([#17230](https://github.com/opensearch-project/OpenSearch/pull/17230)) diff --git a/plugins/workload-management/build.gradle b/plugins/workload-management/build.gradle index 2e8b0df468092..c73c63e84ed1f 100644 --- a/plugins/workload-management/build.gradle +++ b/plugins/workload-management/build.gradle @@ -19,4 +19,9 @@ opensearchplugin { } dependencies { + api 'org.apache.commons:commons-collections4:4.4' +} + +tasks.named("dependencyLicenses").configure { + mapping from: /commons-collections.*/, to: 'commons-collections' } diff --git a/plugins/workload-management/licenses/commons-collections-LICENSE.txt b/plugins/workload-management/licenses/commons-collections-LICENSE.txt new file mode 100644 index 0000000000000..d645695673349 --- /dev/null +++ b/plugins/workload-management/licenses/commons-collections-LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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. diff --git a/plugins/workload-management/licenses/commons-collections-NOTICE.txt b/plugins/workload-management/licenses/commons-collections-NOTICE.txt new file mode 100644 index 0000000000000..79e9484bd56a0 --- /dev/null +++ b/plugins/workload-management/licenses/commons-collections-NOTICE.txt @@ -0,0 +1,9 @@ +Apache Commons Collections +Copyright 2001-2025 The Apache Software Foundation + +This product includes software developed at +The Apache Software Foundation (https://www.apache.org/). + +The Java source file src/main/java/org/apache/commons/collections4/map/ConcurrentReferenceHashMap.java +is from https://github.com/hazelcast/hazelcast and the following notice applies: +Copyright (c) 2008-2020, Hazelcast, Inc. All Rights Reserved. diff --git a/plugins/workload-management/licenses/commons-collections4-4.4.jar.sha1 b/plugins/workload-management/licenses/commons-collections4-4.4.jar.sha1 new file mode 100644 index 0000000000000..6b4ed5ab62b44 --- /dev/null +++ b/plugins/workload-management/licenses/commons-collections4-4.4.jar.sha1 @@ -0,0 +1 @@ +62ebe7544cb7164d87e0637a2a6a2bdc981395e8 \ No newline at end of file diff --git a/plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/rule/package-info.java b/plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/rule/package-info.java new file mode 100644 index 0000000000000..85c0562dae5ee --- /dev/null +++ b/plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/rule/package-info.java @@ -0,0 +1,13 @@ +/* + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + */ + +package org.opensearch.plugin.wlm.rule; +/** + * This package holds constructs for the Rule's in-memory storage, processing and syncing the in-memory view + * with the index view + */ diff --git a/plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/rule/storage/AttributeValueStore.java b/plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/rule/storage/AttributeValueStore.java new file mode 100644 index 0000000000000..eb2ce8e4764ea --- /dev/null +++ b/plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/rule/storage/AttributeValueStore.java @@ -0,0 +1,47 @@ +/* + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + */ + +package org.opensearch.plugin.wlm.rule.storage; + +import java.util.Optional; + +/** + * This interface provides apis to store Rule attribute values + */ +public interface AttributeValueStore { + /** + * Adds the value to attribute value store + * @param key to be added + * @param value to be added + */ + void put(K key, V value); + + /** + * removes the key and associated value from attribute value store + * @param key to be removed + */ + void remove(K key); + + /** + * Returns the value associated with the key + * @param key in the data structure + * @return + */ + Optional get(K key); + + /** + * Clears all the keys and their associated values from the attribute value store + */ + void clear(); + + /** + * It returns the number of values stored + * @return count of key,val pairs in the store + */ + int size(); +} diff --git a/plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/rule/storage/DefaultAttributeValueStore.java b/plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/rule/storage/DefaultAttributeValueStore.java new file mode 100644 index 0000000000000..8b4c063f7ad1a --- /dev/null +++ b/plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/rule/storage/DefaultAttributeValueStore.java @@ -0,0 +1,101 @@ +/* + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + */ + +package org.opensearch.plugin.wlm.rule.storage; + +import org.apache.commons.collections4.trie.PatriciaTrie; + +import java.util.Map; +import java.util.Optional; + +/** + * This is a patricia trie based implementation of AttributeValueStore + * We are choosing patricia trie because it provides very fast search operations on prefix matches as well as range + * lookups. It provides a very efficient storage for strings + * ref: https://commons.apache.org/proper/commons-collections/javadocs/api-4.4/org/apache/commons/collections4/trie/PatriciaTrie.html + */ +public class DefaultAttributeValueStore implements AttributeValueStore { + PatriciaTrie trie; + + /** + * Default constructor + */ + public DefaultAttributeValueStore() { + this(new PatriciaTrie<>()); + } + + /** + * Main constructor + * @param trie A Patricia Trie + */ + public DefaultAttributeValueStore(PatriciaTrie trie) { + this.trie = trie; + } + + @Override + public void put(K key, V value) { + trie.put(key, value); + } + + @Override + public void remove(String key) { + trie.remove(key); + } + + @Override + public Optional get(String key) { + /** + * Since we are inserting prefixes into the trie and searching for larger strings + * It is important to find the largest matching prefix key in the trie efficiently + * Hence we can do binary search + */ + final String longestMatchingPrefix = findLongestMatchingPrefix(key); + + /** + * Now there are following cases for this prefix + * 1. There is a Rule which has this prefix as one of the attribute values. In this case we should return the + * Rule's label otherwise send empty + */ + for (Map.Entry possibleMatch : trie.prefixMap(longestMatchingPrefix).entrySet()) { + if (key.startsWith(possibleMatch.getKey())) { + return Optional.of(possibleMatch.getValue()); + } + } + + return Optional.empty(); + } + + private String findLongestMatchingPrefix(String key) { + int low = 0; + int high = key.length() - 1; + + while (low < high) { + int mid = (high + low + 1) / 2; + /** + * This operation has O(1) complexity because prefixMap returns only the iterator + */ + if (!trie.prefixMap(key.substring(0, mid)).isEmpty()) { + low = mid; + } else { + high = mid - 1; + } + } + + return key.substring(0, low); + } + + @Override + public void clear() { + trie.clear(); + } + + @Override + public int size() { + return trie.size(); + } +} diff --git a/plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/rule/storage/package-info.java b/plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/rule/storage/package-info.java new file mode 100644 index 0000000000000..6aa721ce22a00 --- /dev/null +++ b/plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/rule/storage/package-info.java @@ -0,0 +1,12 @@ +/* + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + */ + +/** + * This package contains interfaces and implementations for in memory rule storage mechanisms + */ +package org.opensearch.plugin.wlm.rule.storage; diff --git a/plugins/workload-management/src/test/java/org/opensearch/plugin/wlm/rule/storage/AttributeValueStoreTests.java b/plugins/workload-management/src/test/java/org/opensearch/plugin/wlm/rule/storage/AttributeValueStoreTests.java new file mode 100644 index 0000000000000..29c42e51efeb0 --- /dev/null +++ b/plugins/workload-management/src/test/java/org/opensearch/plugin/wlm/rule/storage/AttributeValueStoreTests.java @@ -0,0 +1,53 @@ +/* + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + */ + +package org.opensearch.plugin.wlm.rule.storage; + +import org.apache.commons.collections4.trie.PatriciaTrie; +import org.opensearch.test.OpenSearchTestCase; + +public class AttributeValueStoreTests extends OpenSearchTestCase { + + AttributeValueStore subjectUnderTest; + + public void setUp() throws Exception { + super.setUp(); + subjectUnderTest = new DefaultAttributeValueStore<>(new PatriciaTrie<>()); + } + + public void testPut() { + subjectUnderTest.put("foo", "bar"); + assertEquals("bar", subjectUnderTest.get("foo").get()); + } + + public void testRemove() { + subjectUnderTest.put("foo", "bar"); + subjectUnderTest.remove("foo"); + assertEquals(0, subjectUnderTest.size()); + } + + public void tesGet() { + subjectUnderTest.put("foo", "bar"); + assertEquals("bar", subjectUnderTest.get("foo").get()); + } + + public void testGetWhenNoProperPrefixIsPresent() { + subjectUnderTest.put("foo", "bar"); + subjectUnderTest.put("foodip", "sing"); + assertTrue(subjectUnderTest.get("foxtail").isEmpty()); + subjectUnderTest.put("fox", "lucy"); + + assertFalse(subjectUnderTest.get("foxtail").isEmpty()); + } + + public void testClear() { + subjectUnderTest.put("foo", "bar"); + subjectUnderTest.clear(); + assertEquals(0, subjectUnderTest.size()); + } +}