[FTR] Collapse Alerting API Helpers Impl #192216

wayneseymour · 2024-09-05T19:10:24Z

Summary

Resolves: #192201

Expose TryWithRetriesOptions
- Tune timeouts to pass ci
Add attempt count debug info to retry/retry_for_success.ts
- Helps with tuning timeout params
Move exposure of AlertingApiProvider from x-pack/test_serverless/api_integration/services/index.ts -> x-pack/test_serverless/shared/services/deployment_agnostic_services.ts
- This exposes the alerting api under Deployment Agnostic Services (DA), and DA is exposed within x-pack/test_serverless/functional/services/index.ts (Shared Services [Serverless])
Collapse helper script functions into just another object literal stanza within AlertingApiProvider
Update all references
Refactor alerting api to use retry service, instead of p-retry (following this pr)

Additional debug logging

Run in debug mode (add -v):

node scripts/functional_tests \
  --config x-pack/test_serverless/api_integration/test_suites/search/common_configs/config.group1.ts \
  --grep "Summary actions" 
  -v

After

       │ sill retry.tryWithRetries('Alerting API - waitForDocumentInIndex, retryOptions: {"retryCount":5,"retryDelay":200}', [object AsyncFunction], [object Object])
         │ debg --- retry.tryWithRetries error: index_not_found_exception
         │      	Root causes:
         │      		index_not_found_exception: no such index [alert-action-es-query] - Attempt #: 1
         │ sill es.search([object Object])
         │ debg --- retry.tryWithRetries failed again with the same message... - Attempt #: 2
         │ sill es.search([object Object])
         │ debg --- retry.tryWithRetries failed again with the same message... - Attempt #: 3
         │ sill es.search([object Object])
         │ debg --- retry.tryWithRetries failed again with the same message... - Attempt #: 4
         │ sill es.search([object Object])
         │ debg --- retry.tryWithRetries failed again with the same message... - Attempt #: 5
         
...
// Msg after all attempts fail:

       │   Error: retry.tryWithRetries reached the limit of attempts waiting for 'Alerting API - waitForDocumentInIndex, retryOptions: {"retryCount":5,"retryDelay":200}': 5 out of 5
       │   ResponseError: index_not_found_exception
       │   	Root causes:
       │   		index_not_found_exception: no such index [alert-action-es-query]
       │       at SniffingTransport._request (node_modules/@elastic/transport/src/Transport.ts:601:17)
       │       at processTicksAndRejections (node:internal/process/task_queues:95:5)
       │       at /Users/trezworkbox/dev/main.worktrees/cleanup-alerting-api/node_modules/@elastic/transport/src/Transport.ts:704:22
       │       at SniffingTransport.request (node_modules/@elastic/transport/src/Transport.ts:701:14)
       │       at Proxy.SearchApi (node_modules/@elastic/elasticsearch/src/api/api/search.ts:96:10)
       │       at alerting_api.ts:123:28
       │       at runAttempt (retry_for_success.ts:30:15)
       │       at retryForSuccess (retry_for_success.ts:99:21)
       │       at Proxy.tryWithRetries (retry.ts:113:12)
       │       at Object.waitForDocumentInIndex (alerting_api.ts:120:14)
       │       at Context.<anonymous> (summary_actions.ts:146:20)
       │       at Object.apply (wrap_function.js:74:16)
       │       at Object.apply (wrap_function.js:74:16)
       │       at onFailure (retry_for_success.ts:18:9)
       │       at retryForSuccess (retry_for_success.ts:75:7)
       │       at Proxy.tryWithRetries (retry.ts:113:12)
       │       at Object.waitForDocumentInIndex (alerting_api.ts:120:14)
       │       at Context.<anonymous> (summary_actions.ts:146:20)
       │       at Object.apply (wrap_function.js:74:16)
       │       at Object.apply (wrap_function.js:74:16)

Notes

Was put back in draft to additional scope detailed in issue linked above.

wayneseymour · 2024-09-09T12:18:48Z

/ci

wayneseymour · 2024-09-09T12:58:50Z

/ci

wayneseymour · 2024-09-09T13:23:41Z

/ci

wayneseymour · 2024-09-09T13:25:53Z

/ci

Resolves: elastic#192201

wayneseymour · 2024-09-09T15:03:29Z

/ci

elasticmachine · 2024-09-09T15:04:04Z

Pinging @elastic/appex-qa (Team:QA)

dmlemeshko · 2024-09-10T11:11:31Z

x-pack/test_serverless/functional/services/index.ts

@@ -17,6 +16,7 @@ import { SvlCasesServiceProvider } from '../../api_integration/services/svl_case
 import { MachineLearningProvider } from './ml';
 import { LogsSynthtraceProvider } from './log';
 import { UISettingsServiceProvider } from './ui_settings';
+import { services as SvlApiIntegrationSvcs } from '../../api_integration/services';


since it is shared by api integration and functional tests, lets move straight to x-pack/test_serverless//shared/services?

dmlemeshko

LGTM, left suggestion about moving it to shared services

…g-api

…rom deployment agnostic (DA).

This reverts commit 9d22e8c.

…x-pack/test/api_integration/deployment_agnostic` (#193975) ## Summary Follow up of [this pr](#192216), per [this discussion](#192216 (comment)). Also, switch from `svlCommonApi` to `samlAuth` for internal headers. --------- Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: Dzmitry Lemechko <dzmitry.lemechko@elastic.co>

kibanamachine · 2024-10-25T10:18:07Z

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/11516349219

kibanamachine · 2024-10-25T10:18:23Z

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/11516354456

kibanamachine · 2024-10-25T10:18:24Z

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/11516354504

kibanamachine · 2024-10-25T10:22:50Z

💚 All backports created successfully

Status	Branch	Result
✅	8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine · 2024-10-25T10:23:00Z

💚 All backports created successfully

Status	Branch	Result
✅	8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

## Summary Resolves: elastic#192201 - Expose `TryWithRetriesOptions` - Tune timeouts to pass ci - Add attempt count debug info to `retry/retry_for_success.ts` - Helps with tuning timeout params - Move exposure of `AlertingApiProvider` from `x-pack/test_serverless/api_integration/services/index.ts` -> `x-pack/test_serverless/shared/services/deployment_agnostic_services.ts` - This exposes the alerting api under Deployment Agnostic Services (DA), and DA is exposed within `x-pack/test_serverless/functional/services/index.ts` (Shared Services [Serverless]) - Collapse helper script functions into just another object literal stanza within `AlertingApiProvider` - Update all references - Refactor alerting api to use `retry` service, instead of p-retry (following [this pr](elastic#178660)) ### Additional debug logging Run in debug mode (add `-v`): ``` node scripts/functional_tests \ --config x-pack/test_serverless/api_integration/test_suites/search/common_configs/config.group1.ts \ --grep "Summary actions" -v ``` #### After ``` │ sill retry.tryWithRetries('Alerting API - waitForDocumentInIndex, retryOptions: {"retryCount":5,"retryDelay":200}', [object AsyncFunction], [object Object]) │ debg --- retry.tryWithRetries error: index_not_found_exception │ Root causes: │ index_not_found_exception: no such index [alert-action-es-query] - Attempt #: 1 │ sill es.search([object Object]) │ debg --- retry.tryWithRetries failed again with the same message... - Attempt #: 2 │ sill es.search([object Object]) │ debg --- retry.tryWithRetries failed again with the same message... - Attempt #: 3 │ sill es.search([object Object]) │ debg --- retry.tryWithRetries failed again with the same message... - Attempt #: 4 │ sill es.search([object Object]) │ debg --- retry.tryWithRetries failed again with the same message... - Attempt #: 5 ... // Msg after all attempts fail: │ Error: retry.tryWithRetries reached the limit of attempts waiting for 'Alerting API - waitForDocumentInIndex, retryOptions: {"retryCount":5,"retryDelay":200}': 5 out of 5 │ ResponseError: index_not_found_exception │ Root causes: │ index_not_found_exception: no such index [alert-action-es-query] │ at SniffingTransport._request (node_modules/@elastic/transport/src/Transport.ts:601:17) │ at processTicksAndRejections (node:internal/process/task_queues:95:5) │ at /Users/trezworkbox/dev/main.worktrees/cleanup-alerting-api/node_modules/@elastic/transport/src/Transport.ts:704:22 │ at SniffingTransport.request (node_modules/@elastic/transport/src/Transport.ts:701:14) │ at Proxy.SearchApi (node_modules/@elastic/elasticsearch/src/api/api/search.ts:96:10) │ at alerting_api.ts:123:28 │ at runAttempt (retry_for_success.ts:30:15) │ at retryForSuccess (retry_for_success.ts:99:21) │ at Proxy.tryWithRetries (retry.ts:113:12) │ at Object.waitForDocumentInIndex (alerting_api.ts:120:14) │ at Context.<anonymous> (summary_actions.ts:146:20) │ at Object.apply (wrap_function.js:74:16) │ at Object.apply (wrap_function.js:74:16) │ at onFailure (retry_for_success.ts:18:9) │ at retryForSuccess (retry_for_success.ts:75:7) │ at Proxy.tryWithRetries (retry.ts:113:12) │ at Object.waitForDocumentInIndex (alerting_api.ts:120:14) │ at Context.<anonymous> (summary_actions.ts:146:20) │ at Object.apply (wrap_function.js:74:16) │ at Object.apply (wrap_function.js:74:16) ``` ### Notes Was put back in draft to additional scope detailed in issue linked above. --------- Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> (cherry picked from commit 9d22e8c)

kibanamachine · 2024-10-25T10:23:06Z

💚 All backports created successfully

Status	Branch	Result
✅	8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

# Backport This will backport the following commits from `main` to `8.x`: - [[FTR] Collapse Alerting API Helpers Impl (#192216)](#192216)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Tre <wayne.seymour@elastic.co>

…x-pack/test/api_integration/deployment_agnostic` (elastic#193975) ## Summary Follow up of [this pr](elastic#192216), per [this discussion](elastic#192216 (comment)). Also, switch from `svlCommonApi` to `samlAuth` for internal headers. --------- Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: Dzmitry Lemechko <dzmitry.lemechko@elastic.co> (cherry picked from commit 10c3373) # Conflicts: # x-pack/test_serverless/shared/services/alerting_api.ts

wayneseymour added Team:QA Team label for QA Team release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting labels Sep 5, 2024

wayneseymour self-assigned this Sep 5, 2024

wayneseymour force-pushed the cleanup-alerting-api branch from 9a8ef08 to 6e9c32d Compare September 9, 2024 09:37

wayneseymour force-pushed the cleanup-alerting-api branch from bf80a43 to c2df265 Compare September 9, 2024 13:25

[FTR] Collapse Alerting API Helpers

4dcabbc

Resolves: elastic#192201

wayneseymour force-pushed the cleanup-alerting-api branch from c2df265 to 4dcabbc Compare September 9, 2024 15:03

wayneseymour marked this pull request as ready for review September 9, 2024 15:04

wayneseymour requested review from a team as code owners September 9, 2024 15:04

adcoelho approved these changes Sep 10, 2024

View reviewed changes

shahzad31 approved these changes Sep 10, 2024

View reviewed changes

dmlemeshko reviewed Sep 10, 2024

View reviewed changes

Merge branch 'main' of github.com:elastic/kibana into cleanup-alertin…

8f4bd88

…g-api

wayneseymour changed the title ~~[FTR] Collapse Alerting API Helpers~~ [FTR] Collapse Alerting API Helpers Impl Sep 11, 2024

Merge branch 'main' of github.com:elastic/kibana into cleanup-alertin…

9c7ab3a

…g-api

wayneseymour marked this pull request as draft September 11, 2024 10:50

wayneseymour added 2 commits September 11, 2024 11:54

Re-home alerting api under shared services such that it's available f…

591081e

…rom deployment agnostic (DA).

drop p-retry

aeafdba

wayneseymour merged commit 9d22e8c into elastic:main Sep 16, 2024
20 checks passed

kibanamachine added the v9.0.0 label Sep 16, 2024

jbudz added a commit to jbudz/kibana that referenced this pull request Sep 16, 2024

Revert "[FTR] Collapse Alerting API Helpers Impl (elastic#192216)"

b77b9e1

This reverts commit 9d22e8c.

wayneseymour mentioned this pull request Sep 18, 2024

[FTR] Merge alerting apis from srvr less shared/services to deployment agnostic #193315

Closed

wayneseymour mentioned this pull request Sep 25, 2024

[FTR] Merge Alerting Apis from x-pack/test_serverless/shared into x-pack/test/api_integration/deployment_agnostic #193975

Merged

kibanamachine added the backport:skip This commit does not require backporting label Oct 25, 2024

wayneseymour added backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) and removed backport:skip This commit does not require backporting labels Oct 25, 2024

kibanamachine mentioned this pull request Oct 25, 2024

[8.x] [FTR] Collapse Alerting API Helpers Impl (#192216) #197794

Merged

kibanamachine added the v8.17.0 label Oct 25, 2024

This was referenced Nov 8, 2024

[APM] Migrate apm alerts tests to deployment agnostic #199097

Merged

[FTR][Tech Debt] Too many alerting api helpers, can they be reduced? #199619

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FTR] Collapse Alerting API Helpers Impl #192216

[FTR] Collapse Alerting API Helpers Impl #192216

wayneseymour commented Sep 5, 2024 •

edited by kibanamachine

Loading

wayneseymour commented Sep 9, 2024

wayneseymour commented Sep 9, 2024

wayneseymour commented Sep 9, 2024

wayneseymour commented Sep 9, 2024

wayneseymour commented Sep 9, 2024

elasticmachine commented Sep 9, 2024

dmlemeshko Sep 10, 2024 •

edited

Loading

wayneseymour Sep 11, 2024

dmlemeshko left a comment

kibanamachine commented Oct 25, 2024

kibanamachine commented Oct 25, 2024

kibanamachine commented Oct 25, 2024

kibanamachine commented Oct 25, 2024

kibanamachine commented Oct 25, 2024

kibanamachine commented Oct 25, 2024

[FTR] Collapse Alerting API Helpers Impl #192216

[FTR] Collapse Alerting API Helpers Impl #192216

Conversation

wayneseymour commented Sep 5, 2024 • edited by kibanamachine Loading

Summary

Additional debug logging

After

Notes

wayneseymour commented Sep 9, 2024

wayneseymour commented Sep 9, 2024

wayneseymour commented Sep 9, 2024

wayneseymour commented Sep 9, 2024

wayneseymour commented Sep 9, 2024

elasticmachine commented Sep 9, 2024

dmlemeshko Sep 10, 2024 • edited Loading

Choose a reason for hiding this comment

wayneseymour Sep 11, 2024

Choose a reason for hiding this comment

dmlemeshko left a comment

Choose a reason for hiding this comment

kibanamachine commented Oct 25, 2024

kibanamachine commented Oct 25, 2024

kibanamachine commented Oct 25, 2024

kibanamachine commented Oct 25, 2024

💚 All backports created successfully

Questions ?

kibanamachine commented Oct 25, 2024

💚 All backports created successfully

Questions ?

kibanamachine commented Oct 25, 2024

💚 All backports created successfully

Questions ?

wayneseymour commented Sep 5, 2024 •

edited by kibanamachine

Loading

dmlemeshko Sep 10, 2024 •

edited

Loading