Package com.atlassian.jira.search.opensearch

Class BlueGreenReindexServiceImpl

java.lang.Object

com.atlassian.jira.search.opensearch.BlueGreenReindexServiceImpl

All Implemented Interfaces:

BlueGreenReindexService

public class BlueGreenReindexServiceImpl
extends Object
implements BlueGreenReindexService

Implementation of the BlueGreenReindexService that handles the reindexing process in a blue-green deployment setup. This service manages the creation of staging indices, repointing aliases, and cleaning up old indices.

Since:

11.0

Constructor Summary

Constructors

Constructor	Description
BlueGreenReindexServiceImpl(OpenSearchStagingIssueIndexFactory stagingIndexFactory, IndexReplayStrategyFactory rioStrategyFactory, FeatureManager featureManager, ArchivingLicenseCheck archivingLicenseCheck, org.opensearch.client.opensearch.OpenSearchClient openSearchClient, io.github.resilience4j.retry.RetryRegistry retryRegistry, OpenSearchConfigManager openSearchConfigManager)

Method Summary

Modifier and Type	Method	Description
IndexReplayStrategy.Transaction	createIndexReplayTransaction(OpenSearchStagingIssueIndex stagingIssueIndex)	Creates a transaction for replaying index operations to the staging index.
String	createStagingIndexName()	Creates a new staging index name based on the current timestamp.
OpenSearchStagingIssueIndex	createStagingIssueIndex(String stagingIndexName)	Creates a new staging issue index for the specified staging index name with all components required to read, write and search the new index.
void	deleteOldProdIndex(String prodIndexName, Context context)	Deletes the old production index after the new staging index has been successfully created and the alias has been repointed.
void	doIndexIssuesInBatchMode(IssueIndexer stagingIssueIndexer, Context context, IssueIndexingParams issueIndexingParams)	Indexes issues in batch mode into the staging index.
String	getCurrentProdIndexName()	Retrieves the current production index name.
OpenSearchIndexPerformanceTuner	getOpenSearchIndexPerformanceTuner()	Retrieves the OpenSearch index performance tuner for the current context.
void	optimizeIndex(IssueIndexer issueIndexer, Context context)	Optimizes the new staging index after all issues have been indexed and the journal has been synchronized.
void	releaseStagingIssueIndex(OpenSearchStagingIssueIndex stagingIssueIndex)	Releases the resources associated with the given staging issue indexer.
void	repointingIndexAlias(Context context, String stagingIndexName)	Repoints the index alias to the new staging index.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BlueGreenReindexServiceImpl

public BlueGreenReindexServiceImpl(OpenSearchStagingIssueIndexFactory stagingIndexFactory,
 IndexReplayStrategyFactory rioStrategyFactory,
 FeatureManager featureManager,
 ArchivingLicenseCheck archivingLicenseCheck,
 org.opensearch.client.opensearch.OpenSearchClient openSearchClient,
 io.github.resilience4j.retry.RetryRegistry retryRegistry,
 OpenSearchConfigManager openSearchConfigManager)

Method Details

getCurrentProdIndexName

@Nullable
public String getCurrentProdIndexName()
                               throws IndexOperationException

Description copied from interface: BlueGreenReindexService

Retrieves the current production index name. If the index alias does not exist, it will return null.

Specified by:

getCurrentProdIndexName in interface BlueGreenReindexService

Returns:

the name of the current production index

Throws:

IndexOperationException - if there is an error retrieving the index name

createStagingIssueIndex

public OpenSearchStagingIssueIndex createStagingIssueIndex(String stagingIndexName)
                                                    throws IndexOperationException

Description copied from interface: BlueGreenReindexService

Creates a new staging issue index for the specified staging index name with all components required to read, write and search the new index.

Specified by:

createStagingIssueIndex in interface BlueGreenReindexService

Parameters:

stagingIndexName - the name of the staging index

Returns:

an instance of OpenSearchStagingIssueIndex for the staging index

Throws:

IndexOperationException - if there is an error creating the index

releaseStagingIssueIndex

public void releaseStagingIssueIndex(OpenSearchStagingIssueIndex stagingIssueIndex)

Description copied from interface: BlueGreenReindexService

Releases the resources associated with the given staging issue indexer. This method should be called after the indexing process is complete to free up resources.

Specified by:

releaseStagingIssueIndex in interface BlueGreenReindexService

Parameters:

stagingIssueIndex - the staging issue indexer to be released

repointingIndexAlias

public void repointingIndexAlias(Context context,
 String stagingIndexName)
                          throws IndexOperationException

Description copied from interface: BlueGreenReindexService

Repoints the index alias to the new staging index. This operation updates the alias to point to the new staging index, making it the current production index.

Specified by:

repointingIndexAlias in interface BlueGreenReindexService

Parameters:

context - the context in which the operation is performed

stagingIndexName - the name of the new staging index to which the alias will be repointed

Throws:

IndexOperationException

deleteOldProdIndex

public void deleteOldProdIndex(String prodIndexName,
 Context context)

Description copied from interface: BlueGreenReindexService

Deletes the old production index after the new staging index has been successfully created and the alias has been repointed.

Specified by:

deleteOldProdIndex in interface BlueGreenReindexService

Parameters:

prodIndexName - the name of the old production index to be deleted

context - the context in which the operation is performed

doIndexIssuesInBatchMode

public void doIndexIssuesInBatchMode(IssueIndexer stagingIssueIndexer,
 Context context,
 IssueIndexingParams issueIndexingParams)

Description copied from interface: BlueGreenReindexService

Indexes issues in batch mode into the staging index. This method is responsible for indexing issues in batches to optimize performance during the reindexing process.

Specified by:

doIndexIssuesInBatchMode in interface BlueGreenReindexService

Parameters:

stagingIssueIndexer - the issue indexer for the staging index

context - the context in which the operation is performed

issueIndexingParams - parameters for indexing issues

createStagingIndexName

public String createStagingIndexName()

Description copied from interface: BlueGreenReindexService

Creates a new staging index name based on the current timestamp. The format is "issues-atlas-YYYYMMDDHHmmSS".

Specified by:

createStagingIndexName in interface BlueGreenReindexService

Returns:

the name of the new staging index

optimizeIndex

public void optimizeIndex(IssueIndexer issueIndexer,
 Context context)

Description copied from interface: BlueGreenReindexService

Optimizes the new staging index after all issues have been indexed and the journal has been synchronized. This method is responsible for performing any necessary optimizations to ensure the index is ready for production use.

Specified by:

optimizeIndex in interface BlueGreenReindexService

Parameters:

issueIndexer - the issue indexer for the staging index

context - the context in which the operation is performed

getOpenSearchIndexPerformanceTuner

public OpenSearchIndexPerformanceTuner getOpenSearchIndexPerformanceTuner()

Description copied from interface: BlueGreenReindexService

Retrieves the OpenSearch index performance tuner for the current context. This tuner is used to adjust index settings for optimal performance during reindexing operations.

Specified by:

getOpenSearchIndexPerformanceTuner in interface BlueGreenReindexService

Returns:

an instance of OpenSearchIndexPerformanceTuner

createIndexReplayTransaction

public IndexReplayStrategy.Transaction createIndexReplayTransaction(OpenSearchStagingIssueIndex stagingIssueIndex)

Description copied from interface: BlueGreenReindexService

Creates a transaction for replaying index operations to the staging index.

Specified by:

createIndexReplayTransaction in interface BlueGreenReindexService

Parameters:

stagingIssueIndex - the staging issue index for which the transaction is created

Returns:

an instance of IndexReplayStrategy.Transaction that can be used to manage the replay process