Refactor Exporters and Readers #210
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,55 +8,89 @@ | |
|
|
||
| package org.opensearch.plugin.insights.core.exporter; | ||
|
|
||
| import static org.opensearch.plugin.insights.core.utils.ExporterReaderUtils.generateLocalIndexDateHash; | ||
| import static org.opensearch.plugin.insights.settings.QueryInsightsSettings.DEFAULT_DELETE_AFTER_VALUE; | ||
|
|
||
| import java.io.IOException; | ||
| import java.nio.charset.Charset; | ||
| import java.time.ZoneOffset; | ||
| import java.time.ZonedDateTime; | ||
| import java.time.format.DateTimeFormatter; | ||
| import java.util.List; | ||
| import java.util.Objects; | ||
| import org.apache.logging.log4j.LogManager; | ||
| import org.apache.logging.log4j.Logger; | ||
| import org.opensearch.ExceptionsHelper; | ||
| import org.opensearch.ResourceAlreadyExistsException; | ||
| import org.opensearch.action.admin.indices.create.CreateIndexRequest; | ||
| import org.opensearch.action.admin.indices.create.CreateIndexResponse; | ||
| import org.opensearch.action.admin.indices.delete.DeleteIndexRequest; | ||
| import org.opensearch.action.bulk.BulkRequestBuilder; | ||
| import org.opensearch.action.bulk.BulkResponse; | ||
| import org.opensearch.action.index.IndexRequest; | ||
| import org.opensearch.client.Client; | ||
| import org.opensearch.cluster.ClusterState; | ||
| import org.opensearch.cluster.service.ClusterService; | ||
| import org.opensearch.common.settings.Settings; | ||
| import org.opensearch.common.unit.TimeValue; | ||
| import org.opensearch.common.xcontent.XContentFactory; | ||
| import org.opensearch.core.action.ActionListener; | ||
| import org.opensearch.core.xcontent.ToXContent; | ||
| import org.opensearch.index.IndexNotFoundException; | ||
| import org.opensearch.plugin.insights.core.metrics.OperationalMetric; | ||
| import org.opensearch.plugin.insights.core.metrics.OperationalMetricsCounter; | ||
| import org.opensearch.plugin.insights.rules.model.SearchQueryRecord; | ||
|
|
||
| /** | ||
| * Local index exporter for exporting query insights data to local OpenSearch indices. | ||
| */ | ||
| public class LocalIndexExporter implements QueryInsightsExporter { | ||
| /** | ||
| * Logger of the local index exporter | ||
| */ | ||
| private final Logger logger = LogManager.getLogger(); | ||
| private final Client client; | ||
| private final ClusterService clusterService; | ||
| private final String indexMapping; | ||
| private DateTimeFormatter indexPattern; | ||
| private int deleteAfter; | ||
| private final String id; | ||
| private static final int DEFAULT_NUMBER_OF_REPLICA = 1; | ||
| private static final int DEFAULT_NUMBER_OF_SHARDS = 1; | ||
| private static final List<String> DEFAULT_SORTED_FIELDS = List.of( | ||
| "measurements.latency.number", | ||
| "measurements.cpu.number", | ||
| "measurements.memory.number" | ||
| ); | ||
| private static final List<String> DEFAULT_SORTED_ORDERS = List.of("desc", "desc", "desc"); | ||
|
|
||
| /** | ||
| * Constructor of LocalIndexExporter | ||
| * | ||
| * @param client OS client | ||
| * @param clusterService cluster service | ||
| * @param indexPattern the pattern of index to export to | ||
| * @param indexMapping the index mapping file | ||
| * @param id id of the exporter | ||
| */ | ||
| public LocalIndexExporter( | ||
| final Client client, | ||
| final ClusterService clusterService, | ||
| final DateTimeFormatter indexPattern, | ||
| final String indexMapping, | ||
| final String id | ||
| ) { | ||
| this.indexPattern = indexPattern; | ||
| this.client = client; | ||
| this.clusterService = clusterService; | ||
| this.indexMapping = indexMapping; | ||
| this.deleteAfter = DEFAULT_DELETE_AFTER_VALUE; | ||
| this.id = id; | ||
| } | ||
|
|
||
| @Override | ||
| public String getId() { | ||
| return id; | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -73,7 +107,7 @@ public DateTimeFormatter getIndexPattern() { | |
| * | ||
| * @param indexPattern index pattern | ||
| */ | ||
| public void setIndexPattern(DateTimeFormatter indexPattern) { | ||
| this.indexPattern = indexPattern; | ||
| } | ||
|
|
||
|
|
@@ -89,28 +123,76 @@ public void export(final List<SearchQueryRecord> records) { | |
| } | ||
| try { | ||
| final String indexName = buildLocalIndexName(); | ||
| if (!checkIndexExists(indexName)) { | ||
| CreateIndexRequest createIndexRequest = new CreateIndexRequest(indexName); | ||
|
|
||
| createIndexRequest.settings( | ||
| Settings.builder() | ||
| .putList("index.sort.field", DEFAULT_SORTED_FIELDS) | ||
| .putList("index.sort.order", DEFAULT_SORTED_ORDERS) | ||
| .put("index.number_of_shards", DEFAULT_NUMBER_OF_SHARDS) | ||
| .put("index.number_of_replicas", DEFAULT_NUMBER_OF_REPLICA) | ||
| ); | ||
| createIndexRequest.mapping(readIndexMappings()); | ||
|
|
||
| client.admin().indices().create(createIndexRequest, new ActionListener<>() { | ||
| @Override | ||
| public void onResponse(CreateIndexResponse createIndexResponse) { | ||
| if (createIndexResponse.isAcknowledged()) { | ||
| try { | ||
| bulk(indexName, records); | ||
| } catch (IOException e) { | ||
| OperationalMetricsCounter.getInstance().incrementCounter(OperationalMetric.LOCAL_INDEX_EXPORTER_EXCEPTIONS); | ||
| logger.error("Unable to index query insights data: ", e); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void onFailure(Exception e) { | ||
| Throwable cause = ExceptionsHelper.unwrapCause(e); | ||
| if (cause instanceof ResourceAlreadyExistsException) { | ||
| try { | ||
| bulk(indexName, records); | ||
| } catch (IOException ex) { | ||
| OperationalMetricsCounter.getInstance().incrementCounter(OperationalMetric.LOCAL_INDEX_EXPORTER_EXCEPTIONS); | ||
| logger.error("Unable to index query insights data: ", e); | ||
| } | ||
| } else { | ||
| OperationalMetricsCounter.getInstance().incrementCounter(OperationalMetric.LOCAL_INDEX_EXPORTER_EXCEPTIONS); | ||
| logger.error("Unable to create query insights index: ", e); | ||
| } | ||
| } | ||
| }); | ||
| } else { | ||
| bulk(indexName, records); | ||
| } | ||
| } catch (final Exception e) { | ||
| OperationalMetricsCounter.getInstance().incrementCounter(OperationalMetric.LOCAL_INDEX_EXPORTER_EXCEPTIONS); | ||
| logger.error("Unable to index query insights data: ", e); | ||
| } | ||
| } | ||
|
|
||
| private void bulk(final String indexName, final List<SearchQueryRecord> records) throws IOException { | ||
| final BulkRequestBuilder bulkRequestBuilder = client.prepareBulk().setTimeout(TimeValue.timeValueMinutes(1)); | ||
| for (SearchQueryRecord record : records) { | ||
| bulkRequestBuilder.add( | ||
| new IndexRequest(indexName).id(record.getId()) | ||
| .source(record.toXContent(XContentFactory.jsonBuilder(), ToXContent.EMPTY_PARAMS)) | ||
| ); | ||
| } | ||
| bulkRequestBuilder.execute(new ActionListener<BulkResponse>() { | ||
| @Override | ||
| public void onResponse(BulkResponse bulkItemResponses) {} | ||
|
|
||
| @Override | ||
| public void onFailure(Exception e) { | ||
| OperationalMetricsCounter.getInstance().incrementCounter(OperationalMetric.LOCAL_INDEX_EXPORTER_BULK_FAILURES); | ||
| logger.error("Failed to execute bulk operation for query insights data: ", e); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Close the exporter sink | ||
| */ | ||
|
|
@@ -125,7 +207,8 @@ public void close() { | |
| * @return A string representing the index name in the format "top_queries-YYYY.MM.dd-01234". | ||
| */ | ||
| String buildLocalIndexName() { | ||
| ZonedDateTime currentTime = ZonedDateTime.now(ZoneOffset.UTC); | ||
| return indexPattern.format(currentTime) + "-" + generateLocalIndexDateHash(currentTime.toLocalDate()); | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -138,33 +221,58 @@ public void setDeleteAfter(final int deleteAfter) { | |
| } | ||
|
|
||
| /** | ||
| * Get local index exporter data retention period | ||
| * | ||
| * @return the number of days after which Top N local indices should be deleted | ||
| */ | ||
| public int getDeleteAfter() { | ||
| return deleteAfter; | ||
| } | ||
|
|
||
| /** | ||
| * Deletes the specified index and logs any failure that occurs during the operation. | ||
| * | ||
| * @param indexName The name of the index to delete. | ||
| * @param client The OpenSearch client used to perform the deletion. | ||
| */ | ||
| public void deleteSingleIndex(String indexName, Client client) { | ||
| Logger logger = LogManager.getLogger(); | ||
| client.admin().indices().delete(new DeleteIndexRequest(indexName), new ActionListener<>() { | ||
| @Override | ||
| // CS-SUPPRESS-SINGLE: RegexpSingleline It is not possible to use phrase "cluster manager" instead of master here | ||
| public void onResponse(org.opensearch.action.support.master.AcknowledgedResponse acknowledgedResponse) {} | ||
|
|
||
| @Override | ||
| public void onFailure(Exception e) { | ||
| Throwable cause = ExceptionsHelper.unwrapCause(e); | ||
| if (cause instanceof IndexNotFoundException) { | ||
| return; | ||
| } | ||
| OperationalMetricsCounter.getInstance().incrementCounter(OperationalMetric.LOCAL_INDEX_EXPORTER_DELETE_FAILURES); | ||
| logger.error("Failed to delete index '{}': ", indexName, e); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * check if index exists | ||
| * @return boolean | ||
| */ | ||
| private boolean checkIndexExists(String indexName) { | ||
| ClusterState clusterState = clusterService.state(); | ||
| return clusterState.getRoutingTable().hasIndex(indexName); | ||
|
There was a problem hiding this comment. Hope we don't need to handle any potential errors here There was a problem hiding this comment. Good point.. I saw the same patter is used in multiple places in OpenSearch. I think we should be good. |
||
| } | ||
|
|
||
| /** | ||
| * get correlation rule index mappings | ||
| * @return mappings of correlation rule index | ||
| * @throws IOException IOException | ||
| */ | ||
| private String readIndexMappings() throws IOException { | ||
| return new String( | ||
| Objects.requireNonNull(LocalIndexExporter.class.getClassLoader().getResourceAsStream(indexMapping)).readAllBytes(), | ||
| Charset.defaultCharset() | ||
| ); | ||
| } | ||
|
|
||
| } | ||
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
Oops, something went wrong.
Oops, something went wrong.
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.
Can there be a corner scenario where the cluster state does not have up to date information? Are we handling this?
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, In theory the cluster state should be most up to date but there are scenarios when 2 threads are trying to create / delete the same index for the same time. If you look into the code I already handled with something like