Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOCS] Maintenance windows #157806

Merged
merged 9 commits into from
May 17, 2023
Merged

[DOCS] Maintenance windows #157806

merged 9 commits into from
May 17, 2023

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented May 15, 2023 •
edited by kibanamachine
Loading

Summary

Relates to #152032

This PR creates a new page in the Kibana Guide to briefly summarize the maintenance window feature. It also adds a link to the documentation link service and uses that link in the Stack Management > Maintenance Windows app.

@lcawl lcawl added Feature:Alerting release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) docs backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) v8.8.0 v8.9.0 labels May 15, 2023
@github-actions
Copy link

Documentation preview:

@apmmachine
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@lcawl lcawl mentioned this pull request May 15, 2023
Closed
31 tasks
@lcawl lcawl mentioned this pull request May 15, 2023
Merged
@lcawl lcawl marked this pull request as ready for review May 16, 2023 14:24
@lcawl lcawl requested review from a team as code owners May 16, 2023 14:24
@elasticmachine
Copy link
Contributor

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

@lcawl lcawl requested a review from doakalexi May 16, 2023 15:15
doakalexi
doakalexi approved these changes May 16, 2023
View reviewed changes
Copy link
Contributor

@doakalexi doakalexi left a comment

Choose a reason for hiding this comment

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

LGTM!

JiaweiWu
JiaweiWu reviewed May 16, 2023
View reviewed changes
Copy link
Contributor

@JiaweiWu JiaweiWu left a comment

Choose a reason for hiding this comment

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

Just curious, but we do want to mention that for alerts that are suppressed by maintenance windows, we attach the maintenance window IDs that are affecting the alert in a new alert field called maintenance_window_ids, might be useful if users are curious to know which alerts were affected by maintenance windows.

@nastasha-solomon nastasha-solomon mentioned this pull request May 16, 2023
Closed
@lcawl
Copy link
Contributor Author

lcawl commented May 17, 2023

Just curious, but we do want to mention that for alerts that are suppressed by maintenance windows, we attach the maintenance window IDs that are affecting the alert in a new alert field called maintenance_window_ids, might be useful if users are curious to know which alerts were affected by maintenance windows.

You're right that it's a useful bit of information to see that column in the alert tables. I'll create a subsequent PR to try to summarize that and see if I can capture an automated screenshot.

@lcawl lcawl enabled auto-merge (squash) May 17, 2023 17:07
KOTungseth
KOTungseth approved these changes May 17, 2023
View reviewed changes
Copy link
Contributor

@KOTungseth KOTungseth 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 merged commit 93b15b1 into elastic:main May 17, 2023
@kibana-ci
Copy link
Collaborator

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
alerting 183.3KB 183.3KB +13.0B
lists 158.9KB 158.9KB +50.0B
total +63.0B

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id before after diff
core 365.4KB 365.5KB +50.0B
Unknown metric groups

ESLint disabled line counts

id before after diff
enterpriseSearch 19 21 +2
securitySolution 400 404 +4
total +6

Total ESLint disabled count

id before after diff
enterpriseSearch 20 22 +2
securitySolution 480 484 +4
total +6

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@kibanamachine kibanamachine mentioned this pull request May 17, 2023
Merged
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request May 17, 2023
@lcawl
[DOCS] Maintenance windows (elastic#157806)
ea46f45 
(cherry picked from commit 93b15b1)
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
✅ 8.8

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

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request May 17, 2023
@kibanamachine @lcawl
[8.8] [DOCS] Maintenance windows (#157806) (#158019)
a4c256b 
# Backport

This will backport the following commits from `main` to `8.8`:
- [[DOCS] Maintenance windows
(#157806)](#157806)

<!--- Backport version: 8.9.7 -->

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

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2023-05-17T18:01:40Z","message":"[DOCS]
Maintenance windows
(#157806)","sha":"93b15b14e519c42877ce03472409ce7cc017e0b1","branchLabelMapping":{"^v8.9.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Alerting","release_note:skip","Team:ResponseOps","docs","backport:prev-minor","v8.8.0","v8.9.0"],"number":157806,"url":"https://github.com/elastic/kibana/pull/157806","mergeCommit":{"message":"[DOCS]
Maintenance windows
(#157806)","sha":"93b15b14e519c42877ce03472409ce7cc017e0b1"}},"sourceBranch":"main","suggestedTargetBranches":["8.8"],"targetPullRequestStates":[{"branch":"8.8","label":"v8.8.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.9.0","labelRegex":"^v8.9.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/157806","number":157806,"mergeCommit":{"message":"[DOCS]
Maintenance windows
(#157806)","sha":"93b15b14e519c42877ce03472409ce7cc017e0b1"}}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
@lcawl lcawl deleted the maint-windows branch May 18, 2023 22:15
This was referenced May 19, 2023
Merged
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JiaweiWu JiaweiWu JiaweiWu left review comments

@KOTungseth KOTungseth KOTungseth approved these changes

@doakalexi doakalexi doakalexi approved these changes

Assignees
No one assigned
Labels
backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) docs Feature:Alerting release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v8.8.0 v8.9.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@lcawl @apmmachine @elasticmachine @kibana-ci @kibanamachine @KOTungseth @JiaweiWu @doakalexi