Add javadocs

Signed-off-by: Siddhant Deshmukh <deshsid@amazon.com>
opensearch-project · Oct 9, 2023 · 2634bfe · 2634bfe
1 parent 3a46da1
commit 2634bfe
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/server/src/main/java/org/opensearch/action/search/SearchQueryCategorizor.java b/server/src/main/java/org/opensearch/action/search/SearchQueryCategorizor.java
@@ -28,6 +28,10 @@
 import org.opensearch.telemetry.metrics.MetricsRegistry;
 import org.opensearch.telemetry.metrics.tags.Tags;
 
+/**
+ * Class to categorize the search queries based on the type and increment the relevant counters.
+ * Class also logs the query shape.
+ */
 public class SearchQueryCategorizor {
 
     private static final Logger log = LogManager.getLogger(SearchQueryCategorizor.class);

diff --git a/server/src/main/java/org/opensearch/action/search/SearchQueryCounters.java b/server/src/main/java/org/opensearch/action/search/SearchQueryCounters.java
@@ -11,6 +11,9 @@
 import org.opensearch.telemetry.metrics.Counter;
 import org.opensearch.telemetry.metrics.MetricsRegistry;
 
+/**
+ * Class contains all the Counters related to search query types.
+ */
 public class SearchQueryCounters {
     private final MetricsRegistry metricsRegistry;
 

diff --git a/server/src/main/java/org/opensearch/index/query/QueryShapeVisitor.java b/server/src/main/java/org/opensearch/index/query/QueryShapeVisitor.java
@@ -17,6 +17,9 @@
 import java.util.Locale;
 import java.util.Map;
 
+/**
+ * Class to traverse the QueryBuilder tree and capture the query shape
+ */
 public class QueryShapeVisitor implements QueryBuilderVisitor {
     private final SetOnce<String> queryType = new SetOnce<>();
     private final Map<BooleanClause.Occur, List<QueryShapeVisitor>> childVisitors = new EnumMap<>(BooleanClause.Occur.class);