Initial integration of TelemetryAwarePlugin with Rollover Step Integration

opensearch-project / index-management

🗃 Automate periodic data operations, such as deleting indices at a certain age or performing a rollover at a certain size

https://opensearch.org/docs/latest/im-plugin/index/

Apache License 2.0

52 stars 107 forks source link

Initial integration of TelemetryAwarePlugin with Rollover Step Integration #1186

Closed harshitakaushik-dev closed 2 weeks ago

harshitakaushik-dev commented 3 weeks ago

Description of changes:

Initialised TelemetryAwarePlugin in IndexManagementPlugin.kt
Created IndexManagementActionsMetrics.kt which defines a singleton class IndexManagementActionsMetrics that provides metrics for different OpenSearch Index Management actions (like rollover) by registering them with a metrics registry.

CheckList:

[ ] Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. For more information on following Developer Certificate of Origin and signing off your commits, please check here.

sarthakaggarwal97 commented 3 weeks ago

@harshitakaushik-dev thanks for iteration, would you please add some UTs to verify the behavior in the next iteration. Also, please check some lint related gradle tasks seem to be failing.

sarthakaggarwal97 commented 3 weeks ago

@bowenlan-amzn @Gaganjuneja it would be great if you guys can take a look!

The file diff id huge, but its mostly change in arguments of a function. The change for one action would somewhat look like this commit

bowenlan-amzn commented 3 weeks ago

@sarthakaggarwal97 commented on Jun 12, 2024, 10:23 PM PDT:

@bowenlan-amzn @Gaganjuneja it would be great if you guys can take a look!

The file diff id huge, but its mostly change in arguments of a function. The change for one action would somewhat look like this commit

Originally posted by @sarthakaggarwal97 in https://github.com/opensearch-project/index-management/issues/1186#issuecomment-2164408196

Really like this change, with metrics, user can setup alarm instead of only relying on the error notifications, which is a long-asking feature. I will go through this later. Before that, can we have a GitHub issue for this that's public facing and later on copied to documentation.

harshitakaushik-dev commented 2 weeks ago

@r1walz Made the requested changes in the new PR with additional action metrics. Request you to kindly review PR #1195