-
Notifications
You must be signed in to change notification settings - Fork 104
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
QueryIndex rollover when field mapping limit is reached #725
Merged
sbcd90
merged 19 commits into
opensearch-project:main
from
petardz:percolate-index-rollover
Dec 31, 2022
Merged
Changes from all commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
4d163d7
initial commit
petardz 1dd3134
refactored to use metadata instead of monitor to store queryIndex sou…
petardz cb42b15
metadata fixes; refactor
petardz b9cbff2
added licence headers; added more tests; small refactor
petardz 72daba8
fixed IT
petardz 9173705
bwc handling; fixed monitorMetadata parsing; updated scheduled-job sc…
petardz 3dd83f9
incremented schema version
petardz 63b8e4c
fixed schema verify version for scheduled-job to expect ver 6
petardz d4673e7
schema version fix
petardz 1a704b7
added bwc test
petardz 5fb8ab0
reverted accessing fields by this
petardz 5472c53
added TODO
petardz a19f46d
added expand_wildcards to _refresh call in ITs
petardz b4e6335
flaky test fix
petardz ced5111
fixed comments in tests
petardz c8e8233
test name change
petardz ffc8228
renamed method
petardz 0618056
removed unused code
petardz c688613
refactored DeleteMonitor API; fixed IndexMonitor bug
petardz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
245 changes: 245 additions & 0 deletions
245
alerting/src/main/kotlin/org/opensearch/alerting/MonitorMetadataService.kt
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 |
|---|---|---|
| @@ -0,0 +1,245 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package org.opensearch.alerting | ||
|
|
||
| import kotlinx.coroutines.CoroutineName | ||
| import kotlinx.coroutines.CoroutineScope | ||
| import kotlinx.coroutines.Dispatchers | ||
| import kotlinx.coroutines.SupervisorJob | ||
| import org.apache.logging.log4j.LogManager | ||
| import org.opensearch.ExceptionsHelper | ||
| import org.opensearch.OpenSearchSecurityException | ||
| import org.opensearch.action.DocWriteRequest | ||
| import org.opensearch.action.DocWriteResponse | ||
| import org.opensearch.action.admin.indices.get.GetIndexRequest | ||
| import org.opensearch.action.admin.indices.get.GetIndexResponse | ||
| import org.opensearch.action.admin.indices.stats.IndicesStatsAction | ||
| import org.opensearch.action.admin.indices.stats.IndicesStatsRequest | ||
| import org.opensearch.action.admin.indices.stats.IndicesStatsResponse | ||
| import org.opensearch.action.get.GetRequest | ||
| import org.opensearch.action.get.GetResponse | ||
| import org.opensearch.action.index.IndexRequest | ||
| import org.opensearch.action.index.IndexResponse | ||
| import org.opensearch.action.support.WriteRequest | ||
| import org.opensearch.alerting.model.MonitorMetadata | ||
| import org.opensearch.alerting.opensearchapi.suspendUntil | ||
| import org.opensearch.alerting.settings.AlertingSettings | ||
| import org.opensearch.alerting.util.AlertingException | ||
| import org.opensearch.client.Client | ||
| import org.opensearch.cluster.service.ClusterService | ||
| import org.opensearch.common.settings.Settings | ||
| import org.opensearch.common.unit.TimeValue | ||
| import org.opensearch.common.xcontent.LoggingDeprecationHandler | ||
| import org.opensearch.common.xcontent.NamedXContentRegistry | ||
| import org.opensearch.common.xcontent.ToXContent | ||
| import org.opensearch.common.xcontent.XContentFactory | ||
| import org.opensearch.common.xcontent.XContentHelper | ||
| import org.opensearch.common.xcontent.XContentParser | ||
| import org.opensearch.common.xcontent.XContentParserUtils | ||
| import org.opensearch.common.xcontent.XContentType | ||
| import org.opensearch.commons.alerting.model.DocLevelMonitorInput | ||
| import org.opensearch.commons.alerting.model.Monitor | ||
| import org.opensearch.commons.alerting.model.ScheduledJob | ||
| import org.opensearch.index.seqno.SequenceNumbers | ||
| import org.opensearch.rest.RestStatus | ||
| import org.opensearch.transport.RemoteTransportException | ||
|
|
||
| private val log = LogManager.getLogger(MonitorMetadataService::class.java) | ||
|
|
||
| object MonitorMetadataService : | ||
| CoroutineScope by CoroutineScope(SupervisorJob() + Dispatchers.Default + CoroutineName("MonitorMetadataService")) { | ||
|
|
||
| private lateinit var client: Client | ||
| private lateinit var xContentRegistry: NamedXContentRegistry | ||
| private lateinit var clusterService: ClusterService | ||
| private lateinit var settings: Settings | ||
|
|
||
| @Volatile private lateinit var indexTimeout: TimeValue | ||
|
|
||
| fun initialize( | ||
| client: Client, | ||
| clusterService: ClusterService, | ||
| xContentRegistry: NamedXContentRegistry, | ||
| settings: Settings | ||
| ) { | ||
| this.clusterService = clusterService | ||
| this.client = client | ||
| this.xContentRegistry = xContentRegistry | ||
| this.settings = settings | ||
| this.indexTimeout = AlertingSettings.INDEX_TIMEOUT.get(settings) | ||
| this.clusterService.clusterSettings.addSettingsUpdateConsumer(AlertingSettings.INDEX_TIMEOUT) { indexTimeout = it } | ||
| } | ||
|
|
||
| @Suppress("ComplexMethod", "ReturnCount") | ||
| suspend fun upsertMetadata(metadata: MonitorMetadata, updating: Boolean): MonitorMetadata { | ||
| try { | ||
| val indexRequest = IndexRequest(ScheduledJob.SCHEDULED_JOBS_INDEX) | ||
| .setRefreshPolicy(WriteRequest.RefreshPolicy.IMMEDIATE) | ||
| .source(metadata.toXContent(XContentFactory.jsonBuilder(), ToXContent.MapParams(mapOf("with_type" to "true")))) | ||
| .id(metadata.id) | ||
| .routing(metadata.monitorId) | ||
| .setIfSeqNo(metadata.seqNo) | ||
| .setIfPrimaryTerm(metadata.primaryTerm) | ||
| .timeout(indexTimeout) | ||
|
|
||
| if (updating) { | ||
| indexRequest.id(metadata.id).setIfSeqNo(metadata.seqNo).setIfPrimaryTerm(metadata.primaryTerm) | ||
| } else { | ||
| indexRequest.opType(DocWriteRequest.OpType.CREATE) | ||
| } | ||
| val response: IndexResponse = client.suspendUntil { index(indexRequest, it) } | ||
| when (response.result) { | ||
| DocWriteResponse.Result.DELETED, DocWriteResponse.Result.NOOP, DocWriteResponse.Result.NOT_FOUND, null -> { | ||
| val failureReason = "The upsert metadata call failed with a ${response.result?.lowercase} result" | ||
| log.error(failureReason) | ||
| throw AlertingException(failureReason, RestStatus.INTERNAL_SERVER_ERROR, IllegalStateException(failureReason)) | ||
| } | ||
| DocWriteResponse.Result.CREATED, DocWriteResponse.Result.UPDATED -> { | ||
| log.debug("Successfully upserted MonitorMetadata:${metadata.id} ") | ||
| } | ||
| } | ||
| return metadata.copy( | ||
| seqNo = response.seqNo, | ||
| primaryTerm = response.primaryTerm | ||
| ) | ||
| } catch (e: Exception) { | ||
| throw AlertingException.wrap(e) | ||
| } | ||
| } | ||
|
|
||
| suspend fun getOrCreateMetadata(monitor: Monitor, createWithRunContext: Boolean = true): Pair<MonitorMetadata, Boolean> { | ||
| try { | ||
| val created = true | ||
| val metadata = getMetadata(monitor) | ||
| return if (metadata != null) { | ||
| metadata to !created | ||
| } else { | ||
| val newMetadata = createNewMetadata(monitor, createWithRunContext = createWithRunContext) | ||
| upsertMetadata(newMetadata, updating = false) to created | ||
| } | ||
| } catch (e: Exception) { | ||
| throw AlertingException.wrap(e) | ||
| } | ||
| } | ||
|
|
||
| suspend fun getMetadata(monitor: Monitor): MonitorMetadata? { | ||
| try { | ||
| val metadataId = MonitorMetadata.getId(monitor) | ||
| val getRequest = GetRequest(ScheduledJob.SCHEDULED_JOBS_INDEX, metadataId).routing(monitor.id) | ||
|
|
||
| val getResponse: GetResponse = client.suspendUntil { get(getRequest, it) } | ||
| return if (getResponse.isExists) { | ||
| val xcp = XContentHelper.createParser( | ||
| xContentRegistry, LoggingDeprecationHandler.INSTANCE, | ||
| getResponse.sourceAsBytesRef, XContentType.JSON | ||
| ) | ||
| XContentParserUtils.ensureExpectedToken(XContentParser.Token.START_OBJECT, xcp.nextToken(), xcp) | ||
| MonitorMetadata.parse(xcp) | ||
| } else { | ||
| null | ||
| } | ||
| } catch (e: Exception) { | ||
| if (e.message?.contains("no such index") == true) { | ||
| return null | ||
| } else { | ||
| throw AlertingException.wrap(e) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| suspend fun recreateRunContext(metadata: MonitorMetadata, monitor: Monitor): MonitorMetadata { | ||
| try { | ||
| val monitorIndex = if (monitor.monitorType == Monitor.MonitorType.DOC_LEVEL_MONITOR) | ||
| (monitor.inputs[0] as DocLevelMonitorInput).indices[0] | ||
| else null | ||
| val runContext = if (monitor.monitorType == Monitor.MonitorType.DOC_LEVEL_MONITOR) | ||
| createFullRunContext(monitorIndex, metadata.lastRunContext as MutableMap<String, MutableMap<String, Any>>) | ||
| else null | ||
| if (runContext != null) { | ||
| return metadata.copy( | ||
| lastRunContext = runContext | ||
| ) | ||
| } else { | ||
| return metadata | ||
| } | ||
| } catch (e: Exception) { | ||
| throw AlertingException.wrap(e) | ||
| } | ||
| } | ||
|
|
||
| private suspend fun createNewMetadata(monitor: Monitor, createWithRunContext: Boolean): MonitorMetadata { | ||
| val monitorIndex = if (monitor.monitorType == Monitor.MonitorType.DOC_LEVEL_MONITOR) | ||
| (monitor.inputs[0] as DocLevelMonitorInput).indices[0] | ||
| else null | ||
| val runContext = | ||
| if (monitor.monitorType == Monitor.MonitorType.DOC_LEVEL_MONITOR && createWithRunContext) | ||
| createFullRunContext(monitorIndex) | ||
| else emptyMap() | ||
| return MonitorMetadata( | ||
| id = "${monitor.id}-metadata", | ||
| seqNo = SequenceNumbers.UNASSIGNED_SEQ_NO, | ||
| primaryTerm = SequenceNumbers.UNASSIGNED_PRIMARY_TERM, | ||
| monitorId = monitor.id, | ||
| lastActionExecutionTimes = emptyList(), | ||
| lastRunContext = runContext, | ||
| sourceToQueryIndexMapping = mutableMapOf() | ||
| ) | ||
| } | ||
|
|
||
| private suspend fun createFullRunContext( | ||
| index: String?, | ||
| existingRunContext: MutableMap<String, MutableMap<String, Any>>? = null | ||
| ): MutableMap<String, MutableMap<String, Any>> { | ||
| val lastRunContext = existingRunContext?.toMutableMap() ?: mutableMapOf() | ||
| try { | ||
| if (index == null) return mutableMapOf() | ||
| val getIndexRequest = GetIndexRequest().indices(index) | ||
| val getIndexResponse: GetIndexResponse = client.suspendUntil { | ||
| client.admin().indices().getIndex(getIndexRequest, it) | ||
| } | ||
| val indices = getIndexResponse.indices() | ||
|
|
||
| indices.forEach { indexName -> | ||
| if (!lastRunContext.containsKey(indexName)) { | ||
| lastRunContext[indexName] = createRunContextForIndex(index) | ||
| } | ||
| } | ||
| } catch (e: RemoteTransportException) { | ||
| val unwrappedException = ExceptionsHelper.unwrapCause(e) as Exception | ||
| throw AlertingException("Failed fetching index stats", RestStatus.INTERNAL_SERVER_ERROR, unwrappedException) | ||
| } catch (e: OpenSearchSecurityException) { | ||
| throw AlertingException( | ||
| "Failed fetching index stats - missing required index permissions: ${e.localizedMessage}", | ||
| RestStatus.INTERNAL_SERVER_ERROR, | ||
| e | ||
| ) | ||
| } catch (e: Exception) { | ||
| throw AlertingException("Failed fetching index stats", RestStatus.INTERNAL_SERVER_ERROR, e) | ||
| } | ||
| return lastRunContext | ||
| } | ||
|
|
||
| suspend fun createRunContextForIndex(index: String, createdRecently: Boolean = false): MutableMap<String, Any> { | ||
| val request = IndicesStatsRequest().indices(index).clear() | ||
| val response: IndicesStatsResponse = client.suspendUntil { execute(IndicesStatsAction.INSTANCE, request, it) } | ||
| if (response.status != RestStatus.OK) { | ||
| val errorMessage = "Failed fetching index stats for index:$index" | ||
| throw AlertingException(errorMessage, RestStatus.INTERNAL_SERVER_ERROR, IllegalStateException(errorMessage)) | ||
| } | ||
| val shards = response.shards.filter { it.shardRouting.primary() && it.shardRouting.active() } | ||
| val lastRunContext = HashMap<String, Any>() | ||
| lastRunContext["index"] = index | ||
| val count = shards.size | ||
| lastRunContext["shards_count"] = count | ||
|
|
||
| for (shard in shards) { | ||
| lastRunContext[shard.shardRouting.id.toString()] = | ||
| if (createdRecently) -1L | ||
| else shard.seqNoStats?.globalCheckpoint ?: SequenceNumbers.UNASSIGNED_SEQ_NO | ||
| } | ||
| return lastRunContext | ||
| } | ||
| } |
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.
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.
are these objects needed? looks like lot of
old alertingcode is refactored into these classes?