Skip to content

[DOCS] Add minimal task manager health APIs#213862

Merged
lcawl merged 7 commits intoelastic:mainfrom
lcawl:task-mgr-docs
Mar 26, 2025
Merged

[DOCS] Add minimal task manager health APIs#213862
lcawl merged 7 commits intoelastic:mainfrom
lcawl:task-mgr-docs

Conversation

@lcawl
Copy link
Copy Markdown
Contributor

@lcawl lcawl commented Mar 11, 2025 •
edited by kibanamachine
Loading

Summary

Relates to #206243

This PR includes the task manager health API in OpenAPI document, since https://www.elastic.co/guide/en/kibana/current/task-manager-api-health.html will not exist in the narrative V9 docs.

In the long run, ideally this information would be generated from the code but this is a stop-gap.

NOTE:

  • I've split a serverless variation of the OpenAPI document, since in my tests the response contained less objects in that context.
  • The changes in the OpenAPI output related to the removal of the x-topics and the removal of the description for the alerting tag seem to be bugs in the overlay tool, which I've reported to Bump.sh

Preview

image

Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

  • Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
  • Documentation was added for features that require explanation or tutorials
  • Unit or functional tests were updated or added to match the most common scenarios
  • If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
  • This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The release_note:breaking label should be applied in these situations.
  • Flaky Test Runner was used on any tests changed
  • The PR description includes the appropriate Release Notes section, and the correct release_note:* label is applied per the guidelines

Identify risks

Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss.

Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging.

@lcawl lcawl added Feature:Task Manager Team:ResponseOps Platform ResponseOps team (formerly the Cases and Alerting teams) t// docs v9.1.0 v8.19.0 v8.18.1 v9.0.1 labels Mar 11, 2025
@lcawl lcawl mentioned this pull request Mar 11, 2025
Closed
9 tasks
@lcawl lcawl marked this pull request as ready for review March 11, 2025 07:13
@lcawl lcawl requested a review from a team as a code owner March 11, 2025 07:13
@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Mar 11, 2025

Pinging @elastic/response-ops (Team:ResponseOps)

@lcawl lcawl added release_note:skip Skip the PR/issue when compiling release notes backport:version Backport to applied version labels labels Mar 11, 2025
@lcawl lcawl marked this pull request as draft March 21, 2025 20:37
@lcawl lcawl marked this pull request as ready for review March 21, 2025 22:38
pmuellr
pmuellr approved these changes Mar 25, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@pmuellr pmuellr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@lcawl lcawl enabled auto-merge (squash) March 25, 2025 21:03
@lcawl lcawl merged commit c9bfa08 into elastic:main Mar 26, 2025
9 checks passed
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Mar 26, 2025

Starting backport for target branches: 8.18, 8.x, 9.0

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

@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Mar 26, 2025

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] x-pack/test/api_integration/deployment_agnostic/configs/serverless/oblt.serverless.config.ts / Serverless Observability - Deployment-agnostic API integration tests observability AI Assistant when calling the title_conversation function POST /internal/observability_ai_assistant/chat/complete sends the correct system message to the LLM for the title

Metrics [docs]

✅ unchanged

History

@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Mar 26, 2025

💔 All backports failed

Status Branch Result
❌ 8.18 Backport failed because of merge conflicts

You might need to backport the following PRs to 8.18:
- [Fleet] Fix fleet server policy creation with non es default output (#214590)
❌ 8.x Backport failed because of merge conflicts

You might need to backport the following PRs to 8.x:
- OpenAPI docs for APM UI APIs (#197946)
❌ 9.0 Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 213862

Questions ?

Please refer to the Backport tool documentation

@lcawl lcawl deleted the task-mgr-docs branch March 26, 2025 04:18
lcawl added a commit to lcawl/kibana that referenced this pull request Mar 26, 2025
@lcawl
[DOCS] Add minimal task manager health APIs (elastic#213862)
86ee0c7 
(cherry picked from commit c9bfa08)
This was referenced Mar 26, 2025
Merged
Merged
lcawl added a commit to lcawl/kibana that referenced this pull request Mar 26, 2025
@lcawl
[DOCS] Add minimal task manager health APIs (elastic#213862)
c33d6da 
(cherry picked from commit c9bfa08)
lcawl added a commit to lcawl/kibana that referenced this pull request Mar 26, 2025
@lcawl
[DOCS] Add minimal task manager health APIs (elastic#213862)
617f1ca 
(cherry picked from commit c9bfa08)
@lcawl lcawl mentioned this pull request Mar 26, 2025
Merged
@lcawl
Copy link
Copy Markdown
Contributor Author

lcawl commented Mar 26, 2025

💚 All backports created successfully

Status Branch Result
✅ 9.0
✅ 8.x
✅ 8.18

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

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit that referenced this pull request Mar 26, 2025
@lcawl @kibanamachine
[9.0] [DOCS] Add minimal task manager health APIs (#213862) (#215986)
07725fc 
# Backport

This will backport the following commits from `main` to `9.0`:
- [[DOCS] Add minimal task manager health APIs
(#213862)](#213862)

<!--- Backport version: 9.6.4 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2025-03-26T00:04:59Z","message":"[DOCS]
Add minimal task manager health APIs
(#213862)","sha":"c9bfa082a074a8bd1937acc5dc57d82ace306496","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Feature:Task
Manager","Team:ResponseOps","docs","backport:version","v9.1.0","v8.19.0","v8.18.1","v9.0.1"],"title":"[DOCS]
Add minimal task manager health
APIs","number":213862,"url":"https://github.com/elastic/kibana/pull/213862","mergeCommit":{"message":"[DOCS]
Add minimal task manager health APIs
(#213862)","sha":"c9bfa082a074a8bd1937acc5dc57d82ace306496"}},"sourceBranch":"main","suggestedTargetBranches":["8.x","8.18","9.0"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/213862","number":213862,"mergeCommit":{"message":"[DOCS]
Add minimal task manager health APIs
(#213862)","sha":"c9bfa082a074a8bd1937acc5dc57d82ace306496"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"9.0","label":"v9.0.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
lcawl added a commit that referenced this pull request Mar 26, 2025
@lcawl @kibanamachine
[8.x] [DOCS] Add minimal task manager health APIs (#213862) (#215987)
3be9169 
# Backport

This will backport the following commits from `main` to `8.x`:
- [[DOCS] Add minimal task manager health APIs
(#213862)](#213862)

<!--- Backport version: 9.6.4 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2025-03-26T00:04:59Z","message":"[DOCS]
Add minimal task manager health APIs
(#213862)","sha":"c9bfa082a074a8bd1937acc5dc57d82ace306496","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Feature:Task
Manager","Team:ResponseOps","docs","backport:version","v9.1.0","v8.19.0","v8.18.1","v9.0.1"],"title":"[DOCS]
Add minimal task manager health
APIs","number":213862,"url":"https://github.com/elastic/kibana/pull/213862","mergeCommit":{"message":"[DOCS]
Add minimal task manager health APIs
(#213862)","sha":"c9bfa082a074a8bd1937acc5dc57d82ace306496"}},"sourceBranch":"main","suggestedTargetBranches":["8.x","8.18","9.0"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/213862","number":213862,"mergeCommit":{"message":"[DOCS]
Add minimal task manager health APIs
(#213862)","sha":"c9bfa082a074a8bd1937acc5dc57d82ace306496"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"9.0","label":"v9.0.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
lcawl added a commit that referenced this pull request Mar 26, 2025
@lcawl @kibanamachine
[8.18] [DOCS] Add minimal task manager health APIs (#213862) (#215988)
23cf802 
# Backport

This will backport the following commits from `main` to `8.18`:
- [[DOCS] Add minimal task manager health APIs
(#213862)](#213862)

<!--- Backport version: 9.6.4 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2025-03-26T00:04:59Z","message":"[DOCS]
Add minimal task manager health APIs
(#213862)","sha":"c9bfa082a074a8bd1937acc5dc57d82ace306496","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Feature:Task
Manager","Team:ResponseOps","docs","backport:version","v9.1.0","v8.19.0","v8.18.1","v9.0.1"],"title":"[DOCS]
Add minimal task manager health
APIs","number":213862,"url":"https://github.com/elastic/kibana/pull/213862","mergeCommit":{"message":"[DOCS]
Add minimal task manager health APIs
(#213862)","sha":"c9bfa082a074a8bd1937acc5dc57d82ace306496"}},"sourceBranch":"main","suggestedTargetBranches":["8.x","8.18","9.0"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/213862","number":213862,"mergeCommit":{"message":"[DOCS]
Add minimal task manager health APIs
(#213862)","sha":"c9bfa082a074a8bd1937acc5dc57d82ace306496"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"9.0","label":"v9.0.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
cqliu1 pushed a commit to cqliu1/kibana that referenced this pull request Mar 31, 2025
@lcawl @cqliu1
[DOCS] Add minimal task manager health APIs (elastic#213862)
e646dfe
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pmuellr pmuellr pmuellr approved these changes

Assignees

No one assigned

Labels

backport:version Backport to applied version labels docs Feature:Task Manager release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Platform ResponseOps team (formerly the Cases and Alerting teams) t// v8.18.0 v8.18.1 v8.19.0 v9.0.0 v9.0.1 v9.1.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@lcawl @elasticmachine @kibanamachine @pmuellr