Skip to content

Commit 4648c3f

Browse files
kaushalmahi12kaushalmahi12
authored
[Rule based autotagging] Add attribute value store (#17342)
* [rule based autotagging] add attribute value store Signed-off-by: Kaushal Kumar <ravi.kaushal97@gmail.com> * add CHANGELOG entry Signed-off-by: Kaushal Kumar <ravi.kaushal97@gmail.com> * make the store interface generic Signed-off-by: Kaushal Kumar <ravi.kaushal97@gmail.com> * run spotless apply Signed-off-by: Kaushal Kumar <ravi.kaushal97@gmail.com> * add missing javadoc Signed-off-by: Kaushal Kumar <ravi.kaushal97@gmail.com> * improve javadoc for attribute value store Signed-off-by: Kaushal Kumar <ravi.kaushal97@gmail.com> * improve binary search bisecting expression Signed-off-by: Kaushal Kumar <ravi.kaushal97@gmail.com> * add licenses directory Signed-off-by: Kaushal Kumar <ravi.kaushal97@gmail.com> --------- Signed-off-by: Kaushal Kumar <ravi.kaushal97@gmail.com>
1 parent 5666982 commit 4648c3f

File tree

10 files changed

+444
-0
lines changed

10 files changed

+444
-0
lines changed

‎CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
1111
- Introduce a setting to disable download of full cluster state from remote on term mismatch([#16798](https://github.com/opensearch-project/OpenSearch/pull/16798/))
1212
- Added ability to retrieve value from DocValues in a flat_object filed([#16802](https://github.com/opensearch-project/OpenSearch/pull/16802))
1313
- Improve performace of NumericTermAggregation by avoiding unnecessary sorting([#17252](https://github.com/opensearch-project/OpenSearch/pull/17252))
14+
- [Rule Based Auto-tagging] Add in-memory attribute value store ([#17342](https://github.com/opensearch-project/OpenSearch/pull/17342))
1415

1516
### Dependencies
1617
- Bump `org.awaitility:awaitility` from 4.2.0 to 4.2.2 ([#17230](https://github.com/opensearch-project/OpenSearch/pull/17230))

‎plugins/workload-management/build.gradle

+5
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,9 @@ opensearchplugin {
1919
}
2020

2121
dependencies {
22+
api 'org.apache.commons:commons-collections4:4.4'
23+
}
24+
25+
tasks.named("dependencyLicenses").configure {
26+
mapping from: /commons-collections.*/, to: 'commons-collections'
2227
}

‎plugins/workload-management/licenses/commons-collections-LICENSE.txt

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎plugins/workload-management/licenses/commons-collections-NOTICE.txt

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Apache Commons Collections
2+
Copyright 2001-2025 The Apache Software Foundation
3+
4+
This product includes software developed at
5+
The Apache Software Foundation (https://www.apache.org/).
6+
7+
The Java source file src/main/java/org/apache/commons/collections4/map/ConcurrentReferenceHashMap.java
8+
is from https://github.com/hazelcast/hazelcast and the following notice applies:
9+
Copyright (c) 2008-2020, Hazelcast, Inc. All Rights Reserved.

‎plugins/workload-management/licenses/commons-collections4-4.4.jar.sha1

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
62ebe7544cb7164d87e0637a2a6a2bdc981395e8

‎plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/rule/package-info.java

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
/*
2+
* SPDX-License-Identifier: Apache-2.0
3+
*
4+
* The OpenSearch Contributors require contributions made to
5+
* this file be licensed under the Apache-2.0 license or a
6+
* compatible open source license.
7+
*/
8+
9+
package org.opensearch.plugin.wlm.rule;
10+
/**
11+
* This package holds constructs for the Rule's in-memory storage, processing and syncing the in-memory view
12+
* with the index view
13+
*/

‎plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/rule/storage/AttributeValueStore.java

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
/*
2+
* SPDX-License-Identifier: Apache-2.0
3+
*
4+
* The OpenSearch Contributors require contributions made to
5+
* this file be licensed under the Apache-2.0 license or a
6+
* compatible open source license.
7+
*/
8+
9+
package org.opensearch.plugin.wlm.rule.storage;
10+
11+
import java.util.Optional;
12+
13+
/**
14+
* This interface provides apis to store Rule attribute values
15+
*/
16+
public interface AttributeValueStore<K, V> {
17+
/**
18+
* Adds the value to attribute value store
19+
* @param key to be added
20+
* @param value to be added
21+
*/
22+
void put(K key, V value);
23+
24+
/**
25+
* removes the key and associated value from attribute value store
26+
* @param key to be removed
27+
*/
28+
void remove(K key);
29+
30+
/**
31+
* Returns the value associated with the key
32+
* @param key in the data structure
33+
* @return
34+
*/
35+
Optional<V> get(K key);
36+
37+
/**
38+
* Clears all the keys and their associated values from the attribute value store
39+
*/
40+
void clear();
41+
42+
/**
43+
* It returns the number of values stored
44+
* @return count of key,val pairs in the store
45+
*/
46+
int size();
47+
}

‎plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/rule/storage/DefaultAttributeValueStore.java

+101
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
/*
2+
* SPDX-License-Identifier: Apache-2.0
3+
*
4+
* The OpenSearch Contributors require contributions made to
5+
* this file be licensed under the Apache-2.0 license or a
6+
* compatible open source license.
7+
*/
8+
9+
package org.opensearch.plugin.wlm.rule.storage;
10+
11+
import org.apache.commons.collections4.trie.PatriciaTrie;
12+
13+
import java.util.Map;
14+
import java.util.Optional;
15+
16+
/**
17+
* This is a patricia trie based implementation of AttributeValueStore
18+
* We are choosing patricia trie because it provides very fast search operations on prefix matches as well as range
19+
* lookups. It provides a very efficient storage for strings
20+
* ref: https://commons.apache.org/proper/commons-collections/javadocs/api-4.4/org/apache/commons/collections4/trie/PatriciaTrie.html
21+
*/
22+
public class DefaultAttributeValueStore<K extends String, V> implements AttributeValueStore<K, V> {
23+
PatriciaTrie<V> trie;
24+
25+
/**
26+
* Default constructor
27+
*/
28+
public DefaultAttributeValueStore() {
29+
this(new PatriciaTrie<>());
30+
}
31+
32+
/**
33+
* Main constructor
34+
* @param trie A Patricia Trie
35+
*/
36+
public DefaultAttributeValueStore(PatriciaTrie<V> trie) {
37+
this.trie = trie;
38+
}
39+
40+
@Override
41+
public void put(K key, V value) {
42+
trie.put(key, value);
43+
}
44+
45+
@Override
46+
public void remove(String key) {
47+
trie.remove(key);
48+
}
49+
50+
@Override
51+
public Optional<V> get(String key) {
52+
/**
53+
* Since we are inserting prefixes into the trie and searching for larger strings
54+
* It is important to find the largest matching prefix key in the trie efficiently
55+
* Hence we can do binary search
56+
*/
57+
final String longestMatchingPrefix = findLongestMatchingPrefix(key);
58+
59+
/**
60+
* Now there are following cases for this prefix
61+
* 1. There is a Rule which has this prefix as one of the attribute values. In this case we should return the
62+
* Rule's label otherwise send empty
63+
*/
64+
for (Map.Entry<String, V> possibleMatch : trie.prefixMap(longestMatchingPrefix).entrySet()) {
65+
if (key.startsWith(possibleMatch.getKey())) {
66+
return Optional.of(possibleMatch.getValue());
67+
}
68+
}
69+
70+
return Optional.empty();
71+
}
72+
73+
private String findLongestMatchingPrefix(String key) {
74+
int low = 0;
75+
int high = key.length() - 1;
76+
77+
while (low < high) {
78+
int mid = (high + low + 1) / 2;
79+
/**
80+
* This operation has O(1) complexity because prefixMap returns only the iterator
81+
*/
82+
if (!trie.prefixMap(key.substring(0, mid)).isEmpty()) {
83+
low = mid;
84+
} else {
85+
high = mid - 1;
86+
}
87+
}
88+
89+
return key.substring(0, low);
90+
}
91+
92+
@Override
93+
public void clear() {
94+
trie.clear();
95+
}
96+
97+
@Override
98+
public int size() {
99+
return trie.size();
100+
}
101+
}

0 commit comments

Comments
 (0)