feat: add logging to ElasticsearchService for better error tracking and index existence checks

Author: mjabascal10

backend/src/main/java/com/park/utmstack/service/elasticsearch/ElasticsearchService.java

@@ -20,6 +20,7 @@
 import com.utmstack.opensearch_connector.types.IndexSort;
 import com.utmstack.opensearch_connector.types.SearchSqlResponse;
 import com.utmstack.opensearch_connector.types.SqlQueryRequest;
+import lombok.extern.slf4j.Slf4j;
 import org.opensearch.client.opensearch._types.SortOrder;
 import org.opensearch.client.opensearch._types.query_dsl.Query;
 import org.opensearch.client.opensearch.cat.indices.IndicesRecord;
@@ -47,6 +48,7 @@
  * @author Leonardo M. López
  */
 @Service
+@Slf4j
 public class ElasticsearchService {
     private static final String CLASSNAME = "ElasticsearchService";
     private final Logger log = LoggerFactory.getLogger(ElasticsearchService.class);
@@ -78,7 +80,7 @@ public List<String> getFieldValues(String keyword, String indexPattern) {
         final String ctx = CLASSNAME + ".getFieldValues";
         try {
             return new ArrayList<>(client.getClient().getFieldValues(keyword, indexPattern,
-                null, 10000, TermOrder.Count, SortOrder.Desc).keySet());
+                    null, 10000, TermOrder.Count, SortOrder.Desc).keySet());
         } catch (Exception e) {
             throw new RuntimeException(ctx + ": " + e.getLocalizedMessage());
         }
@@ -98,7 +100,7 @@ public Map<String, Long> getFieldValuesWithCount(String field, String index, Lis
         final String ctx = CLASSNAME + ".getFieldValuesWithCount";
         try {
             return client.getClient().getFieldValues(field, index, SearchUtil.toQuery(filters), top,
-                orderByCount ? TermOrder.Count : TermOrder.Key, sortAsc ? SortOrder.Asc : SortOrder.Desc);
+                    orderByCount ? TermOrder.Count : TermOrder.Key, sortAsc ? SortOrder.Asc : SortOrder.Desc);
         } catch (Exception e) {
             throw new RuntimeException(ctx + ": " + e.getLocalizedMessage());
         }
@@ -143,15 +145,17 @@ public <T> IndexResponse index(String index, T document) {
     public List<IndexPropertyType> getIndexProperties(String indexPattern) {
         final String ctx = CLASSNAME + ".getIndexProperties";
 
-        if (!indexExist(indexPattern))
-            throw new OpenSearchIndexNotFoundException(ctx  + ": Index [" + indexPattern + "] not found");
+        if (!indexExist(indexPattern)) {
+            log.info("{} Index pattern {} does not exist", ctx, indexPattern);
+            return Collections.emptyList();
+        }
 
         try {
             Map<String, String> properties = client.getClient().getIndexProperties(indexPattern);
             if (CollectionUtils.isEmpty(properties))
                 return Collections.emptyList();
             return properties.entrySet()
-                .stream().map(e -> new IndexPropertyType(e.getKey(), e.getValue())).collect(Collectors.toList());
+                    .stream().map(e -> new IndexPropertyType(e.getKey(), e.getValue())).collect(Collectors.toList());
         } catch (Exception e) {
             throw new RuntimeException(ctx + ": " + e.getMessage());
         }
@@ -167,7 +171,7 @@ public List<IndexPropertyType> getIndexProperties(String indexPattern) {
      * @throws UtmElasticsearchException In case of any error
      */
     public Page<IndicesRecord> getAllIndexes(boolean includeSystemIndex, String pattern, Pageable pageable) throws
-        UtmElasticsearchException {
+            UtmElasticsearchException {
         final String ctx = CLASSNAME + ".getAllIndexes";
         try {
             Assert.notNull(pageable, "Argument pageable can't be null");
@@ -179,7 +183,7 @@ public Page<IndicesRecord> getAllIndexes(boolean includeSystemIndex, String patt
 
             if (!includeSystemIndex)
                 indices = indices.stream().filter(index -> !index.index().startsWith("."))
-                    .collect(Collectors.toList());
+                        .collect(Collectors.toList());
 
             PagedListHolder<IndicesRecord> pageDefinition = new PagedListHolder<>();
             pageDefinition.setSource(indices);
@@ -198,7 +202,7 @@ private IndexSort from(Sort sort) {
                 return IndexSort.unSorted();
             IndexSort.Builder sortBuilder = IndexSort.builder();
             sort.forEach(order -> sortBuilder.with(IndexSortableProperty.fromJsonValue(order.getProperty()),
-                order.getDirection().isAscending() ? SortOrder.Asc : SortOrder.Desc));
+                    order.getDirection().isAscending() ? SortOrder.Asc : SortOrder.Desc));
             return sortBuilder.build();
         } catch (Exception e) {
             throw new RuntimeException(ctx + ": " + e.getLocalizedMessage());
@@ -239,14 +243,14 @@ public void preventSystemCrashBySpace() {
                     return;
 
                 UtmSpaceNotificationControl notificationControl = spaceNotificationControlService.findById(1L)
-                    .orElse(new UtmSpaceNotificationControl());
+                        .orElse(new UtmSpaceNotificationControl());
                 if (Objects.isNull(notificationControl.getId()))
                     notificationControl.setId(1L);
 
                 Instant now = LocalDateTime.now().toInstant(ZoneOffset.UTC);
 
                 if (Objects.isNull(notificationControl.getNextNotification()) ||
-                    now.isAfter(notificationControl.getNextNotification())) {
+                        now.isAfter(notificationControl.getNextNotification())) {
                     mailService.sendLowSpaceEmail(admins, clusterStatus);
                     notificationControl.setNextNotification(now.plus(24, ChronoUnit.HOURS));
                     spaceNotificationControlService.save(notificationControl);
@@ -266,7 +270,7 @@ private void deleteOldestIndices() {
         final String ctx = CLASSNAME + ".deleteOldestIndices";
         try {
             List<IndicesRecord> indices = client.getClient().getIndices(Constants.SYS_INDEX_PATTERN.get(SystemIndexPattern.LOGS), IndexSort.builder()
-                .with(IndexSortableProperty.CreationDate, SortOrder.Asc).build());
+                    .with(IndexSortableProperty.CreationDate, SortOrder.Asc).build());
 
             // If no index that match with log-* was found then te function is terminated
             if (CollectionUtils.isEmpty(indices))
@@ -278,10 +282,10 @@ private void deleteOldestIndices() {
                     // Delete oldest indices
                     deleteIndex(Collections.singletonList(index.index()));
                     eventService.createEvent(String.format("Index %1$s was deleted to avoid system crash by space:\n" +
-                            "Creation Date: %2$s\n" +
-                            "Docs Count: %3$s\n" +
-                            "Size: %4$s",
-                        index.index(), index.creationDateString(), index.docsCount(), index.storeSize()), ApplicationEventType.INFO);
+                                    "Creation Date: %2$s\n" +
+                                    "Docs Count: %3$s\n" +
+                                    "Size: %4$s",
+                            index.index(), index.creationDateString(), index.docsCount(), index.storeSize()), ApplicationEventType.INFO);
                 } catch (Exception e) {
                     String msg = String.format("%1$s: Fail to delete index: %2$s with message: %3$s", ctx, index.index(), e.getMessage());
                     eventService.createEvent(msg, ApplicationEventType.WARNING);