-
Notifications
You must be signed in to change notification settings - Fork 113
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Index Management Action Metrics (#1195)
* Initial integration of TelemetryAwarePlugin to ISM Signed-off-by: harycash <harycash@amazon.com> * Initial integration of TelemetryAwarePlugin to ISM Signed-off-by: harycash <harycash@amazon.com> * Initial integration of TelemetryAwarePlugin to ISM with Rollover Step Integration Signed-off-by: harycash <harycash@amazon.com> * Initial integration of TelemetryAwarePlugin to ISM with Rollover Step Integration Signed-off-by: harycash <harycash@amazon.com> * Additional actions metrics with requested changes from previous commit Signed-off-by: harycash <harycash@amazon.com> * Fixed Build Issues Signed-off-by: harycash <harycash@amazon.com> * Fixed Build Issues Signed-off-by: harycash <harycash@amazon.com> * Fixed Build Issues, Added new metric : Cumulative Latency Signed-off-by: harycash <harycash@amazon.com> * Fixed Build Issues, Added new metric : Cumulative Latency Signed-off-by: harycash <harycash@amazon.com> * Requested Changes and Addition of Metrics to all the remaining Actions Signed-off-by: harycash <harycash@amazon.com> * Updates on Action Metrics Signed-off-by: harycash <harycash@amazon.com> * Updates on Action Metrics Signed-off-by: harycash <harycash@amazon.com> * Build issues fixed Signed-off-by: harycash <harycash@amazon.com> * Build issues fixed Signed-off-by: harycash <harycash@amazon.com> --------- Signed-off-by: harycash <harycash@amazon.com> Co-authored-by: harycash <harycash@amazon.com>
- Loading branch information
1 parent
52f331f
commit c5425a5
Showing
28 changed files
with
1,339 additions
and
73 deletions.
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
116 changes: 116 additions & 0 deletions
116
...nsearch.indexmanagement.spi/indexstatemanagement/metrics/IndexManagementActionsMetrics.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,116 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package org.opensearch.indexmanagement.spi.indexstatemanagement.metrics | ||
|
|
||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.metrics.actionmetrics.AliasActionMetrics | ||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.metrics.actionmetrics.AllocationActionMetrics | ||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.metrics.actionmetrics.CloseActionMetrics | ||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.metrics.actionmetrics.DeleteActionMetrics | ||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.metrics.actionmetrics.ForceMergeActionMetrics | ||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.metrics.actionmetrics.MoveShardActionMetrics | ||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.metrics.actionmetrics.NotificationActionMetrics | ||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.metrics.actionmetrics.OpenActionMetrics | ||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.metrics.actionmetrics.ReplicaCountActionMetrics | ||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.metrics.actionmetrics.RolloverActionMetrics | ||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.metrics.actionmetrics.SetIndexPriorityActionMetrics | ||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.metrics.actionmetrics.SetReadOnlyActionMetrics | ||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.metrics.actionmetrics.ShrinkActionMetrics | ||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.metrics.actionmetrics.SnapshotActionMetrics | ||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.metrics.actionmetrics.TransitionActionMetrics | ||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.model.StepContext | ||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.model.StepMetaData | ||
| import org.opensearch.telemetry.metrics.MetricsRegistry | ||
| import org.opensearch.telemetry.metrics.tags.Tags | ||
|
|
||
| abstract class ActionMetrics { | ||
| abstract val actionName: String | ||
|
|
||
| fun createTags(context: StepContext): Tags { | ||
| val tags = Tags.create() | ||
| .addTag("index_name", context.metadata.index) | ||
| .addTag("policy_id", context.metadata.policyID) | ||
| .addTag("node_id", context.clusterService.nodeName ?: "") | ||
| .addTag("index_uuid", context.metadata.indexUuid) | ||
| return tags | ||
| } | ||
|
|
||
| abstract fun emitMetrics( | ||
| context: StepContext, | ||
| indexManagementActionsMetrics: IndexManagementActionsMetrics, | ||
| stepMetaData: StepMetaData?, | ||
| ) | ||
| } | ||
|
|
||
| class IndexManagementActionsMetrics private constructor() { | ||
| private lateinit var metricsRegistry: MetricsRegistry | ||
| private lateinit var actionMetricsMap: Map<String, ActionMetrics> | ||
|
|
||
| companion object { | ||
| val instance: IndexManagementActionsMetrics by lazy { HOLDER.instance } | ||
|
|
||
| const val ROLLOVER = "rollover" | ||
| const val NOTIFICATION = "notification" | ||
| const val FORCE_MERGE = "force_merge" | ||
| const val DELETE = "delete" | ||
| const val REPLICA_COUNT = "replica_count" | ||
| const val TRANSITION = "transition" | ||
| const val CLOSE = "close" | ||
| const val SET_INDEX_PRIORITY = "set_index_priority" | ||
| const val OPEN = "open" | ||
| const val MOVE_SHARD = "move_shard" | ||
| const val SET_READ_ONLY = "set_read_only" | ||
| const val SHRINK = "shrink" | ||
| const val SNAPSHOT = "snapshot" | ||
| const val ALIAS_ACTION = "alias_action" | ||
| const val ALLOCATION = "allocation" | ||
|
|
||
| private object HOLDER { | ||
| val instance = IndexManagementActionsMetrics() | ||
| } | ||
| } | ||
|
|
||
| fun initialize(metricsRegistry: MetricsRegistry) { | ||
| this.metricsRegistry = metricsRegistry | ||
|
|
||
| RolloverActionMetrics.instance.initializeCounters(metricsRegistry) | ||
| NotificationActionMetrics.instance.initializeCounters(metricsRegistry) | ||
| ForceMergeActionMetrics.instance.initializeCounters(metricsRegistry) | ||
| DeleteActionMetrics.instance.initializeCounters(metricsRegistry) | ||
| ReplicaCountActionMetrics.instance.initializeCounters(metricsRegistry) | ||
| TransitionActionMetrics.instance.initializeCounters(metricsRegistry) | ||
| CloseActionMetrics.instance.initializeCounters(metricsRegistry) | ||
| SetIndexPriorityActionMetrics.instance.initializeCounters(metricsRegistry) | ||
| OpenActionMetrics.instance.initializeCounters(metricsRegistry) | ||
| MoveShardActionMetrics.instance.initializeCounters(metricsRegistry) | ||
| SetReadOnlyActionMetrics.instance.initializeCounters(metricsRegistry) | ||
| ShrinkActionMetrics.instance.initializeCounters(metricsRegistry) | ||
| SnapshotActionMetrics.instance.initializeCounters(metricsRegistry) | ||
| AliasActionMetrics.instance.initializeCounters(metricsRegistry) | ||
| AllocationActionMetrics.instance.initializeCounters(metricsRegistry) | ||
|
|
||
| actionMetricsMap = mapOf( | ||
| ROLLOVER to RolloverActionMetrics.instance, | ||
| NOTIFICATION to NotificationActionMetrics.instance, | ||
| FORCE_MERGE to ForceMergeActionMetrics.instance, | ||
| DELETE to DeleteActionMetrics.instance, | ||
| REPLICA_COUNT to ReplicaCountActionMetrics.instance, | ||
| TRANSITION to TransitionActionMetrics.instance, | ||
| CLOSE to CloseActionMetrics.instance, | ||
| SET_INDEX_PRIORITY to SetIndexPriorityActionMetrics.instance, | ||
| OPEN to OpenActionMetrics.instance, | ||
| MOVE_SHARD to MoveShardActionMetrics.instance, | ||
| SET_READ_ONLY to SetReadOnlyActionMetrics.instance, | ||
| SHRINK to ShrinkActionMetrics.instance, | ||
| SNAPSHOT to SnapshotActionMetrics.instance, | ||
| ALIAS_ACTION to AliasActionMetrics.instance, | ||
| ALLOCATION to AllocationActionMetrics.instance, | ||
| ) | ||
| } | ||
|
|
||
| fun getActionMetrics(actionName: String): ActionMetrics? { | ||
| return actionMetricsMap[actionName] | ||
| } | ||
| } |
53 changes: 53 additions & 0 deletions
53
...arch.indexmanagement.spi/indexstatemanagement/metrics/actionmetrics/AliasActionMetrics.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,53 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package org.opensearch.indexmanagement.spi.indexstatemanagement.metrics.actionmetrics | ||
|
|
||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.Step.StepStatus | ||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.metrics.ActionMetrics | ||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.metrics.IndexManagementActionsMetrics | ||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.model.StepContext | ||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.model.StepMetaData | ||
| import org.opensearch.telemetry.metrics.Counter | ||
| import org.opensearch.telemetry.metrics.MetricsRegistry | ||
|
|
||
| class AliasActionMetrics private constructor() : ActionMetrics() { | ||
| override val actionName: String = IndexManagementActionsMetrics.ALIAS_ACTION | ||
| lateinit var successes: Counter | ||
| lateinit var failures: Counter | ||
| lateinit var cumulativeLatency: Counter | ||
|
|
||
| fun initializeCounters(metricsRegistry: MetricsRegistry) { | ||
| successes = metricsRegistry.createCounter("${actionName}_successes", "Alias Action Successes", "count") | ||
| failures = metricsRegistry.createCounter("${actionName}_failures", "Alias Action Failures", "count") | ||
| cumulativeLatency = metricsRegistry.createCounter("${actionName}_cumulative_latency", "Cumulative Latency of Alias Actions", "milliseconds") | ||
| } | ||
|
|
||
| companion object { | ||
| val instance: AliasActionMetrics by lazy { HOLDER.instance } | ||
| } | ||
|
|
||
| private object HOLDER { | ||
| val instance = AliasActionMetrics() | ||
| } | ||
|
|
||
| override fun emitMetrics( | ||
| context: StepContext, | ||
| indexManagementActionsMetrics: IndexManagementActionsMetrics, | ||
| stepMetaData: StepMetaData?, | ||
| ) { | ||
| val aliasActionMetrics = indexManagementActionsMetrics.getActionMetrics(IndexManagementActionsMetrics.ALIAS_ACTION) as AliasActionMetrics | ||
| val stepStatus = stepMetaData?.stepStatus | ||
| if (stepStatus == StepStatus.COMPLETED) { | ||
| aliasActionMetrics.successes.add(1.0, context.let { aliasActionMetrics.createTags(it) }) | ||
| } | ||
| if (stepStatus == StepStatus.FAILED) { | ||
| aliasActionMetrics.failures.add(1.0, context.let { aliasActionMetrics.createTags(it) }) | ||
| } | ||
| val endTime = System.currentTimeMillis() | ||
| val latency = endTime - (context.metadata.stepMetaData?.startTime ?: endTime) | ||
| aliasActionMetrics.cumulativeLatency.add(latency.toDouble(), context.let { aliasActionMetrics.createTags(it) }) | ||
| } | ||
| } |
53 changes: 53 additions & 0 deletions
53
...indexmanagement.spi/indexstatemanagement/metrics/actionmetrics/AllocationActionMetrics.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,53 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package org.opensearch.indexmanagement.spi.indexstatemanagement.metrics.actionmetrics | ||
|
|
||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.Step.StepStatus | ||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.metrics.ActionMetrics | ||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.metrics.IndexManagementActionsMetrics | ||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.model.StepContext | ||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.model.StepMetaData | ||
| import org.opensearch.telemetry.metrics.Counter | ||
| import org.opensearch.telemetry.metrics.MetricsRegistry | ||
|
|
||
| class AllocationActionMetrics private constructor() : ActionMetrics() { | ||
| override val actionName: String = IndexManagementActionsMetrics.ALLOCATION | ||
| lateinit var successes: Counter | ||
| lateinit var failures: Counter | ||
| lateinit var cumulativeLatency: Counter | ||
|
|
||
| fun initializeCounters(metricsRegistry: MetricsRegistry) { | ||
| successes = metricsRegistry.createCounter("${actionName}_successes", "Allocation Action Successes", "count") | ||
| failures = metricsRegistry.createCounter("${actionName}_failures", "Allocation Action Failures", "count") | ||
| cumulativeLatency = metricsRegistry.createCounter("${actionName}_cumulative_latency", "Cumulative Latency of Allocation Actions", "milliseconds") | ||
| } | ||
|
|
||
| companion object { | ||
| val instance: AllocationActionMetrics by lazy { HOLDER.instance } | ||
| } | ||
|
|
||
| private object HOLDER { | ||
| val instance = AllocationActionMetrics() | ||
| } | ||
|
|
||
| override fun emitMetrics( | ||
| context: StepContext, | ||
| indexManagementActionsMetrics: IndexManagementActionsMetrics, | ||
| stepMetaData: StepMetaData?, | ||
| ) { | ||
| val allocationActionMetrics = indexManagementActionsMetrics.getActionMetrics(IndexManagementActionsMetrics.ALLOCATION) as AllocationActionMetrics | ||
| val stepStatus = stepMetaData?.stepStatus | ||
| if (stepStatus == StepStatus.COMPLETED) { | ||
| allocationActionMetrics.successes.add(1.0, context.let { allocationActionMetrics.createTags(it) }) | ||
| } | ||
| if (stepStatus == StepStatus.FAILED) { | ||
| allocationActionMetrics.failures.add(1.0, context.let { allocationActionMetrics.createTags(it) }) | ||
| } | ||
| val endTime = System.currentTimeMillis() | ||
| val latency = endTime - (context.metadata.stepMetaData?.startTime ?: endTime) | ||
| allocationActionMetrics.cumulativeLatency.add(latency.toDouble(), context.let { allocationActionMetrics.createTags(it) }) | ||
| } | ||
| } |
53 changes: 53 additions & 0 deletions
53
...arch.indexmanagement.spi/indexstatemanagement/metrics/actionmetrics/CloseActionMetrics.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,53 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package org.opensearch.indexmanagement.spi.indexstatemanagement.metrics.actionmetrics | ||
|
|
||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.Step.StepStatus | ||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.metrics.ActionMetrics | ||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.metrics.IndexManagementActionsMetrics | ||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.model.StepContext | ||
| import org.opensearch.indexmanagement.spi.indexstatemanagement.model.StepMetaData | ||
| import org.opensearch.telemetry.metrics.Counter | ||
| import org.opensearch.telemetry.metrics.MetricsRegistry | ||
|
|
||
| class CloseActionMetrics private constructor() : ActionMetrics() { | ||
| override val actionName: String = IndexManagementActionsMetrics.CLOSE | ||
| lateinit var successes: Counter | ||
| lateinit var failures: Counter | ||
| lateinit var cumulativeLatency: Counter | ||
|
|
||
| fun initializeCounters(metricsRegistry: MetricsRegistry) { | ||
| successes = metricsRegistry.createCounter("${actionName}_successes", "Close Action Successes", "count") | ||
| failures = metricsRegistry.createCounter("${actionName}_failures", "Close Action Failures", "count") | ||
| cumulativeLatency = metricsRegistry.createCounter("${actionName}_cumulative_latency", "Cumulative Latency of Close Actions", "milliseconds") | ||
| } | ||
|
|
||
| companion object { | ||
| val instance: CloseActionMetrics by lazy { HOLDER.instance } | ||
| } | ||
|
|
||
| private object HOLDER { | ||
| val instance = CloseActionMetrics() | ||
| } | ||
|
|
||
| override fun emitMetrics( | ||
| context: StepContext, | ||
| indexManagementActionsMetrics: IndexManagementActionsMetrics, | ||
| stepMetaData: StepMetaData?, | ||
| ) { | ||
| val closeActionMetrics = indexManagementActionsMetrics.getActionMetrics(IndexManagementActionsMetrics.CLOSE) as CloseActionMetrics | ||
| val stepStatus = stepMetaData?.stepStatus | ||
| if (stepStatus == StepStatus.COMPLETED) { | ||
| closeActionMetrics.successes.add(1.0, context.let { closeActionMetrics.createTags(it) }) | ||
| } | ||
| if (stepStatus == StepStatus.FAILED) { | ||
| closeActionMetrics.failures.add(1.0, context.let { closeActionMetrics.createTags(it) }) | ||
| } | ||
| val endTime = System.currentTimeMillis() | ||
| val latency = endTime - (context.metadata.stepMetaData?.startTime ?: endTime) | ||
| closeActionMetrics.cumulativeLatency.add(latency.toDouble(), context.let { closeActionMetrics.createTags(it) }) | ||
| } | ||
| } |
Oops, something went wrong.