PPL Alerting: Models by toepkerd · Pull Request #1955 · opensearch-project/alerting

toepkerd · 2025-10-20T22:53:56Z

Description

Alerting core changes for PPL Alerting. This includes:

PPL Alerting Object Models

Related Issues

Check List

New functionality includes testing.
New functionality has been documented.
API changes companion pull request created.
Commits are signed per the DCO using --signoff.
Public documentation issue/PR created.

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.

lezzago · 2025-10-21T00:09:46Z

Please put the alerting data models in alerting subproject. Core is for the scheduled jobs models.

Reference before we moved data models to common-utils: https://github.com/opensearch-project/alerting/tree/1.3/alerting/src/main/kotlin/org/opensearch/alerting

toepkerd · 2025-10-21T22:51:21Z

Will move models to alerting subproject. The one thing that will stay in core (that isn't scheduled job related) is the PPL Plugin Transport Interface. This is needed in core to communicate with the PPL plugin, much like the existing code in core to communicate with the Notifications plugin.

lezzago · 2025-10-23T15:27:59Z

+// TODO: eventually change this to be called PPLSQLMonitor.
+//  A PPL Monitor and SQL Monitor


Why not rename it now since you have a check for sql and just throws the exception for now? We can just have the todo on the SQL part of the implementation

lezzago · 2025-10-23T15:31:40Z

+        @JvmStatic
+        @Throws(IOException::class)
+        fun readFrom(sin: StreamInput): TriggerRunResult {
+            return QueryLevelTriggerRunResult(sin)


Shouldn't this be PPLTriggerRunResult?

Good catch, thank you

Signed-off-by: Dennis Toepker <toepkerd@amazon.com>

* PPL Alerting Models Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * correcting readFrom in PPLTriggerRunResult Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * adding minutes to duration fields, changing name from PPLMonitor to PPLSQLMonitor Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * adjusting comment positions Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * adding description field to monitor Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * adding description javadoc Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * various refactors Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * making alert initiate its own parsing pointer Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * adding number of results value validations Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * adding full stops to error messages Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * adding another missing full stop Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * renaming customer exposed field name back to ppl_monitor Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * renaming PPL to PPL_SQL in certain places Signed-off-by: Dennis Toepker <toepkerd@amazon.com> --------- Signed-off-by: Dennis Toepker <toepkerd@amazon.com> Co-authored-by: Dennis Toepker <toepkerd@amazon.com> Signed-off-by: Dennis Toepker <toepkerd@amazon.com>

* PPL Alerting Models Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * correcting readFrom in PPLTriggerRunResult Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * adding minutes to duration fields, changing name from PPLMonitor to PPLSQLMonitor Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * adjusting comment positions Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * adding description field to monitor Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * adding description javadoc Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * various refactors Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * making alert initiate its own parsing pointer Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * adding number of results value validations Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * adding full stops to error messages Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * adding another missing full stop Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * renaming customer exposed field name back to ppl_monitor Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * renaming PPL to PPL_SQL in certain places Signed-off-by: Dennis Toepker <toepkerd@amazon.com> --------- Signed-off-by: Dennis Toepker <toepkerd@amazon.com> Co-authored-by: Dennis Toepker <toepkerd@amazon.com> (cherry picked from commit 497dea8) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* PPL Alerting Models * correcting readFrom in PPLTriggerRunResult * adding minutes to duration fields, changing name from PPLMonitor to PPLSQLMonitor * adjusting comment positions * adding description field to monitor * adding description javadoc * various refactors * making alert initiate its own parsing pointer * adding number of results value validations * adding full stops to error messages * adding another missing full stop * renaming customer exposed field name back to ppl_monitor * renaming PPL to PPL_SQL in certain places --------- (cherry picked from commit 497dea8) Signed-off-by: Dennis Toepker <toepkerd@amazon.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Dennis Toepker <toepkerd@amazon.com>

* PPL Alerting Models Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * correcting readFrom in PPLTriggerRunResult Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * adding minutes to duration fields, changing name from PPLMonitor to PPLSQLMonitor Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * adjusting comment positions Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * adding description field to monitor Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * adding description javadoc Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * various refactors Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * making alert initiate its own parsing pointer Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * adding number of results value validations Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * adding full stops to error messages Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * adding another missing full stop Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * renaming customer exposed field name back to ppl_monitor Signed-off-by: Dennis Toepker <toepkerd@amazon.com> * renaming PPL to PPL_SQL in certain places Signed-off-by: Dennis Toepker <toepkerd@amazon.com> --------- Signed-off-by: Dennis Toepker <toepkerd@amazon.com> Co-authored-by: Dennis Toepker <toepkerd@amazon.com>

* PPL Alerting Models * correcting readFrom in PPLTriggerRunResult * adding minutes to duration fields, changing name from PPLMonitor to PPLSQLMonitor * adjusting comment positions * adding description field to monitor * adding description javadoc * various refactors * making alert initiate its own parsing pointer * adding number of results value validations * adding full stops to error messages * adding another missing full stop * renaming customer exposed field name back to ppl_monitor * renaming PPL to PPL_SQL in certain places --------- Signed-off-by: Dennis Toepker <toepkerd@amazon.com> Co-authored-by: Dennis Toepker <toepkerd@amazon.com>

This reverts commit 497dea8. Signed-off-by: Thomas Hurney <hurneyt@amazon.com>

* [AUTO] Add release notes for 3.5.0 (#2014) * Add release notes for 3.5.0 Signed-off-by: opensearch-ci <opensearch-infra@amazon.com> * Add release notes for 3.5.0 Signed-off-by: opensearch-ci <opensearch-infra@amazon.com> --------- Signed-off-by: opensearch-ci <opensearch-infra@amazon.com> Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Revert "PPL Alerting: Execute Monitor and Monitor Stats (#1960)" This reverts commit 74aed08. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Revert "PPL Alerting: Get Alerts and Alert Lifecycle (#1972)" This reverts commit d9614ba Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Revert "PPL Alerting: Delete Monitor, More V1/V2 Separation (#1968)" This reverts commit fd151de. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Revert "PPL Alerting: Get and Search Monitors (#1966)" This reverts commit 819599f. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Revert "PPL Alerting: Create and Update Monitor V2 (#1961)" This reverts commit c911cfa Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Revert "PPL Alerting: Models (#1955)" This reverts commit 497dea8. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Fixed test role creation. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> --------- Signed-off-by: opensearch-ci <opensearch-infra@amazon.com> Signed-off-by: Thomas Hurney <hurneyt@amazon.com> Co-authored-by: opensearch-ci <83309141+opensearch-ci-bot@users.noreply.github.com>

* [AUTO] Add release notes for 3.5.0 (#2014) * Add release notes for 3.5.0 Signed-off-by: opensearch-ci <opensearch-infra@amazon.com> * Add release notes for 3.5.0 Signed-off-by: opensearch-ci <opensearch-infra@amazon.com> --------- Signed-off-by: opensearch-ci <opensearch-infra@amazon.com> Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Revert "PPL Alerting: Execute Monitor and Monitor Stats (#1960)" This reverts commit 74aed08. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Revert "PPL Alerting: Get Alerts and Alert Lifecycle (#1972)" This reverts commit d9614ba Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Revert "PPL Alerting: Delete Monitor, More V1/V2 Separation (#1968)" This reverts commit fd151de. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Revert "PPL Alerting: Get and Search Monitors (#1966)" This reverts commit 819599f. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Revert "PPL Alerting: Create and Update Monitor V2 (#1961)" This reverts commit c911cfa Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Revert "PPL Alerting: Models (#1955)" This reverts commit 497dea8. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Fixed test role creation. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> --------- Signed-off-by: opensearch-ci <opensearch-infra@amazon.com> Signed-off-by: Thomas Hurney <hurneyt@amazon.com> Co-authored-by: opensearch-ci <83309141+opensearch-ci-bot@users.noreply.github.com> (cherry picked from commit c39caca) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…oject#1969)" This reverts commit ef66ef8. Signed-off-by: Thomas Hurney <hurneyt@amazon.com>

…oject#1981)" This reverts commit 844954a. Signed-off-by: Thomas Hurney <hurneyt@amazon.com>

This reverts commit 497dea8. Signed-off-by: Thomas Hurney <hurneyt@amazon.com>

* Revert "PPL Alerting: Execute Monitor and Monitor Stats (#1960) (#1988)" This reverts commit 90dddfb. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Revert "PPL Alerting: Get Alerts and Alert Lifecycle (#1972) (#1985)" This reverts commit 0677625. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Revert "PPL Alerting: Delete Monitor, More V1/V2 Separation (#1968) (#1984)" This reverts commit 154fcb2. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Revert "PPL Alerting: Get and Search Monitors (#1966) (#1983)" This reverts commit 852eeee. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Revert "PPL Alerting: Create and Update Monitor V2 (#1961) (#1982)" This reverts commit f7b9b50. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Revert "PPL Alerting: Models (#1955) (#1981)" This reverts commit 844954a. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> --------- Signed-off-by: Thomas Hurney <hurneyt@amazon.com>

* Revert "PPL Alerting: Get Alerts and Alert Lifecycle (#1972) (#1989)" This reverts commit 859024f. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Revert "PPL Alerting: Delete Monitor, More V1/V2 Separation (#1968) (#1975)" This reverts commit 01d67ed. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Revert "PPL Alerting: Get and Search Monitors (#1966) (#1974)" This reverts commit d26378a. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Revert "PPL Alerting: Create and Update Monitor V2 (#1961) (#1973)" This reverts commit 04dfb42. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Revert "PPL Alerting: Models (#1955) (#1969)" This reverts commit ef66ef8. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Fix test workflow yml. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> --------- Signed-off-by: Thomas Hurney <hurneyt@amazon.com>

* Update logback dependencies to version 1.5.19 (#1996) (#2002) (cherry picked from commit 72f9fcf) Signed-off-by: Daniel Widdis <widdis@gmail.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Include alerting spi as part of the mavenlocal (#2003) (#2004) (cherry picked from commit 4550b44) Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Add release notes for 3.4.0 (#1999) Signed-off-by: opensearch-ci <opensearch-infra@amazon.com> Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Publish snapshots to Staging (#2005) (#2006) (cherry picked from commit 8a6bad3) Signed-off-by: Divya Madala <divyaasm@amazon.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Revert "PPL Alerting: Execute Monitor and Monitor Stats (#1960)" This reverts commit 74aed08. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Revert "PPL Alerting: Get Alerts and Alert Lifecycle (#1972)" This reverts commit d9614ba Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Revert "PPL Alerting: Delete Monitor, More V1/V2 Separation (#1968)" This reverts commit fd151de. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Revert "PPL Alerting: Get and Search Monitors (#1966)" This reverts commit 819599f. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Revert "PPL Alerting: Create and Update Monitor V2 (#1961)" This reverts commit c911cfa Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Revert "PPL Alerting: Models (#1955)" This reverts commit 497dea8. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> --------- Signed-off-by: Daniel Widdis <widdis@gmail.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Signed-off-by: Thomas Hurney <hurneyt@amazon.com> Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Signed-off-by: opensearch-ci <opensearch-infra@amazon.com> Signed-off-by: Divya Madala <divyaasm@amazon.com> Co-authored-by: opensearch-trigger-bot[bot] <98922864+opensearch-trigger-bot[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: opensearch-ci <83309141+opensearch-ci-bot@users.noreply.github.com>

* [AUTO] Add release notes for 3.5.0 (#2014) * Add release notes for 3.5.0 * Add release notes for 3.5.0 --------- * Revert "PPL Alerting: Execute Monitor and Monitor Stats (#1960)" This reverts commit 74aed08. * Revert "PPL Alerting: Get Alerts and Alert Lifecycle (#1972)" This reverts commit d9614ba * Revert "PPL Alerting: Delete Monitor, More V1/V2 Separation (#1968)" This reverts commit fd151de. * Revert "PPL Alerting: Get and Search Monitors (#1966)" This reverts commit 819599f. * Revert "PPL Alerting: Create and Update Monitor V2 (#1961)" This reverts commit c911cfa * Revert "PPL Alerting: Models (#1955)" This reverts commit 497dea8. * Fixed test role creation. --------- (cherry picked from commit c39caca) Signed-off-by: opensearch-ci <opensearch-infra@amazon.com> Signed-off-by: Thomas Hurney <hurneyt@amazon.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: opensearch-ci <83309141+opensearch-ci-bot@users.noreply.github.com>

toepkerd force-pushed the ppl-review-1 branch from 5c984dc to 6bd4c6f Compare October 20, 2025 22:54

toepkerd changed the title ~~sending core changes for review~~ PPL Alerting: Alerting Core Changes Oct 20, 2025

toepkerd force-pushed the ppl-review-1 branch from 6bd4c6f to 4e0f861 Compare October 20, 2025 23:54

toepkerd closed this Oct 21, 2025

toepkerd reopened this Oct 21, 2025

toepkerd force-pushed the ppl-review-1 branch 3 times, most recently from 46e45bd to 01a96ab Compare October 22, 2025 03:46

toepkerd changed the title ~~PPL Alerting: Alerting Core Changes~~ PPL Alerting: Models Oct 22, 2025

toepkerd force-pushed the ppl-review-1 branch 2 times, most recently from f047603 to d1041ec Compare October 22, 2025 04:15

toepkerd marked this pull request as ready for review October 22, 2025 18:16

toepkerd requested review from AWSHurneyt, amsiglan, bowenlan-amzn, eirsep, engechas, getsaurabh02, goyamegh, jowg-amazon, lezzago, praveensameneni, rishabhmaurya, riysaxen-amzn and sbcd90 as code owners October 22, 2025 18:16

lezzago reviewed Oct 23, 2025

View reviewed changes

toepkerd force-pushed the ppl-review-1 branch from 6b03f3d to 5370704 Compare October 24, 2025 01:00

renaming PPL to PPL_SQL in certain places

8eb0651

Signed-off-by: Dennis Toepker <toepkerd@amazon.com>

AWSHurneyt approved these changes Oct 27, 2025

View reviewed changes

toepkerd merged commit 497dea8 into opensearch-project:main Oct 27, 2025
17 of 18 checks passed

toepkerd deleted the ppl-review-1 branch October 27, 2025 18:56

toepkerd added backport 2.19 backport 3.3 labels Oct 31, 2025

opensearch-trigger-bot Bot mentioned this pull request Oct 31, 2025

[Backport 3.3] PPL Alerting: Models #1969

Merged

opensearch-trigger-bot Bot mentioned this pull request Oct 31, 2025

[Backport 2.19] PPL Alerting: Models #1970

Closed

toepkerd mentioned this pull request Nov 8, 2025

[Backport 2.19] PPL Alerting: Models #1981

Merged

AWSHurneyt added a commit to AWSHurneyt/OpenSearch-Alerting that referenced this pull request Feb 12, 2026

Revert "PPL Alerting: Models (opensearch-project#1955)"

ceea35e

This reverts commit 497dea8. Signed-off-by: Thomas Hurney <hurneyt@amazon.com>

AWSHurneyt added a commit to AWSHurneyt/OpenSearch-Alerting that referenced this pull request Feb 12, 2026

Revert "PPL Alerting: Models (opensearch-project#1955) (opensearch-pr…

e5fea0f

…oject#1969)" This reverts commit ef66ef8. Signed-off-by: Thomas Hurney <hurneyt@amazon.com>

AWSHurneyt added a commit to AWSHurneyt/OpenSearch-Alerting that referenced this pull request Feb 12, 2026

Revert "PPL Alerting: Models (opensearch-project#1955) (opensearch-pr…

1d05a4b

…oject#1981)" This reverts commit 844954a. Signed-off-by: Thomas Hurney <hurneyt@amazon.com>

AWSHurneyt added a commit to AWSHurneyt/OpenSearch-Alerting that referenced this pull request Feb 12, 2026

Revert "PPL Alerting: Models (opensearch-project#1955)"

7e1969f

This reverts commit 497dea8. Signed-off-by: Thomas Hurney <hurneyt@amazon.com>

Navigation Menu

Uh oh!

PPL Alerting: Models - #1955

PPL Alerting: Models#1955
toepkerd merged 13 commits into
opensearch-project:mainfrom
toepkerd:ppl-review-1

toepkerd commented Oct 20, 2025 •

edited

Loading

Uh oh!

lezzago commented Oct 21, 2025

Uh oh!

toepkerd commented Oct 21, 2025

Uh oh!

lezzago Oct 23, 2025

Uh oh!

toepkerd Oct 24, 2025

Uh oh!

lezzago Oct 23, 2025

Uh oh!

toepkerd Oct 24, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

		// TODO: eventually change this to be called PPLSQLMonitor.
		// A PPL Monitor and SQL Monitor

Uh oh!

Conversation

toepkerd commented Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Check List

Uh oh!

lezzago commented Oct 21, 2025

Uh oh!

toepkerd commented Oct 21, 2025

Uh oh!

lezzago Oct 23, 2025

Choose a reason for hiding this comment

Uh oh!

toepkerd Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

lezzago Oct 23, 2025

Choose a reason for hiding this comment

Uh oh!

toepkerd Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

toepkerd commented Oct 20, 2025 •

edited

Loading