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.

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

Add a notice that Uptime will be off by default #3890

Merged
merged 3 commits into from
May 16, 2024

Conversation

paulb-elastic
Copy link
Contributor

We don't currently clarify on the Uptime page that this will not be shown in many cases, which came up recently.

I suspect the docs team may want to wordsmith what I've written (please do), but worth making it clear in the docs going back to 8.9 when this default behaviour was changed.

@paulb-elastic paulb-elastic added backport-8.9 Automated backport with mergify backport-8.10 Automated backport with mergify backport-8.11 Automated backport with mergify backport-8.12 Automated backport with mergify backport-8.13 Automated backport with mergify backport-8.14 Automated backport with mergify labels May 15, 2024
@paulb-elastic paulb-elastic requested a review from a team as a code owner May 15, 2024 13:28
Copy link
Contributor

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@dedemorton
Copy link
Contributor

Thanks for the contribution. I'll take a look!

This will close #3727.

@@ -13,6 +13,8 @@ infrastructure with {heartbeat} natively.
For browser-based monitors, a richer management and reporting experience,
and more capabilities such as triaging and responding to alerts, use the
<<monitor-uptime-synthetics,{synthetics-app}>> instead of the {uptime-app}.

Note that {uptime-app} is no longer shown by default if there is no recent Heartbeat data. If you do not see {uptime-app} in the Observability menu, this will need to be enabled. This can be done under Kibana Advanced Settings by switching on _Always show legacy Uptime app_ (`observability:enableLegacyUptimeApp`).
Copy link
Contributor

Choose a reason for hiding this comment

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

@paulb-elastic Quick question: Should the setting (observability:enableLegacyUptimeApp) also be documented in the Advanced Settings topic in the Kibana docs?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@dedemorton yes, indeed - this is an oversight on my part, I didn't know that existed. I'll create a Kibana PR for those docs. Thanks for the steer. I'll mention the PR here once it's created.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Co-authored-by: DeDe Morton <[email protected]>
Copy link
Contributor

@dedemorton dedemorton left a comment

Choose a reason for hiding this comment

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

LGTM!

@bmorelli25 bmorelli25 merged commit d9faa44 into elastic:main May 16, 2024
4 checks passed
mergify bot pushed a commit that referenced this pull request May 16, 2024
* Add a notice that Uptime will be off by default

* Updated copy

* Improved copy from DeDe

Co-authored-by: DeDe Morton <[email protected]>

---------

Co-authored-by: DeDe Morton <[email protected]>
(cherry picked from commit d9faa44)
mergify bot pushed a commit that referenced this pull request May 16, 2024
* Add a notice that Uptime will be off by default

* Updated copy

* Improved copy from DeDe

Co-authored-by: DeDe Morton <[email protected]>

---------

Co-authored-by: DeDe Morton <[email protected]>
(cherry picked from commit d9faa44)
mergify bot pushed a commit that referenced this pull request May 16, 2024
* Add a notice that Uptime will be off by default

* Updated copy

* Improved copy from DeDe

Co-authored-by: DeDe Morton <[email protected]>

---------

Co-authored-by: DeDe Morton <[email protected]>
(cherry picked from commit d9faa44)
mergify bot pushed a commit that referenced this pull request May 16, 2024
* Add a notice that Uptime will be off by default

* Updated copy

* Improved copy from DeDe

Co-authored-by: DeDe Morton <[email protected]>

---------

Co-authored-by: DeDe Morton <[email protected]>
(cherry picked from commit d9faa44)
mergify bot pushed a commit that referenced this pull request May 16, 2024
* Add a notice that Uptime will be off by default

* Updated copy

* Improved copy from DeDe

Co-authored-by: DeDe Morton <[email protected]>

---------

Co-authored-by: DeDe Morton <[email protected]>
(cherry picked from commit d9faa44)
mergify bot pushed a commit that referenced this pull request May 16, 2024
* Add a notice that Uptime will be off by default

* Updated copy

* Improved copy from DeDe

Co-authored-by: DeDe Morton <[email protected]>

---------

Co-authored-by: DeDe Morton <[email protected]>
(cherry picked from commit d9faa44)
bmorelli25 pushed a commit that referenced this pull request May 17, 2024
* Add a notice that Uptime will be off by default

* Updated copy

* Improved copy from DeDe

Co-authored-by: DeDe Morton <[email protected]>

---------

Co-authored-by: DeDe Morton <[email protected]>
(cherry picked from commit d9faa44)

Co-authored-by: Paul Bianciardi <[email protected]>
bmorelli25 pushed a commit that referenced this pull request May 17, 2024
* Add a notice that Uptime will be off by default

* Updated copy

* Improved copy from DeDe

Co-authored-by: DeDe Morton <[email protected]>

---------

Co-authored-by: DeDe Morton <[email protected]>
(cherry picked from commit d9faa44)

Co-authored-by: Paul Bianciardi <[email protected]>
bmorelli25 pushed a commit that referenced this pull request May 17, 2024
* Add a notice that Uptime will be off by default

* Updated copy

* Improved copy from DeDe

Co-authored-by: DeDe Morton <[email protected]>

---------

Co-authored-by: DeDe Morton <[email protected]>
(cherry picked from commit d9faa44)

Co-authored-by: Paul Bianciardi <[email protected]>
bmorelli25 pushed a commit that referenced this pull request May 17, 2024
* Add a notice that Uptime will be off by default

* Updated copy

* Improved copy from DeDe

Co-authored-by: DeDe Morton <[email protected]>

---------

Co-authored-by: DeDe Morton <[email protected]>
(cherry picked from commit d9faa44)

Co-authored-by: Paul Bianciardi <[email protected]>
bmorelli25 pushed a commit that referenced this pull request May 17, 2024
* Add a notice that Uptime will be off by default

* Updated copy

* Improved copy from DeDe

Co-authored-by: DeDe Morton <[email protected]>

---------

Co-authored-by: DeDe Morton <[email protected]>
(cherry picked from commit d9faa44)

Co-authored-by: Paul Bianciardi <[email protected]>
bmorelli25 pushed a commit that referenced this pull request May 17, 2024
* Add a notice that Uptime will be off by default

* Updated copy

* Improved copy from DeDe

Co-authored-by: DeDe Morton <[email protected]>

---------

Co-authored-by: DeDe Morton <[email protected]>
(cherry picked from commit d9faa44)

Co-authored-by: Paul Bianciardi <[email protected]>
paulb-elastic added a commit to elastic/kibana that referenced this pull request Jun 5, 2024
…#183613)

## Summary

Updates the [advanced settings
docs](https://www.elastic.co/guide/en/kibana/master/advanced-options.html)
to include the `observability:enableLegacyUptimeApp` option for enabling
the Uptime Kibana app by default (in conjunction with the Observability
doc updates in elastic/observability-docs#3890)

The list of options (under Observability, at least) don't seem to be
alphabetical, so I've put this in where seems to be a good place, but
feel free to move it somewhere else if more appropriate.
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Jun 5, 2024
…elastic#183613)

## Summary

Updates the [advanced settings
docs](https://www.elastic.co/guide/en/kibana/master/advanced-options.html)
to include the `observability:enableLegacyUptimeApp` option for enabling
the Uptime Kibana app by default (in conjunction with the Observability
doc updates in elastic/observability-docs#3890)

The list of options (under Observability, at least) don't seem to be
alphabetical, so I've put this in where seems to be a good place, but
feel free to move it somewhere else if more appropriate.

(cherry picked from commit 4182d87)
kibanamachine referenced this pull request in elastic/kibana Jun 5, 2024
… Uptime (#183613) (#184821)

# Backport

This will backport the following commits from `main` to `8.14`:
- [Updates the docs with the advanced setting option for enabling Uptime
(#183613)](#183613)

<!--- Backport version: 9.4.3 -->

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

<!--BACKPORT [{"author":{"name":"Paul
Bianciardi","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-06-05T10:59:54Z","message":"Updates
the docs with the advanced setting option for enabling Uptime
(#183613)\n\n## Summary\r\n\r\nUpdates the [advanced
settings\r\ndocs](https://www.elastic.co/guide/en/kibana/master/advanced-options.html)\r\nto
include the `observability:enableLegacyUptimeApp` option for
enabling\r\nthe Uptime Kibana app by default (in conjunction with the
Observability\r\ndoc updates in
https://github.com/elastic/observability-docs/pull/3890)\r\n\r\nThe list
of options (under Observability, at least) don't seem to
be\r\nalphabetical, so I've put this in where seems to be a good place,
but\r\nfeel free to move it somewhere else if more
appropriate.","sha":"4182d87d4a2edfed7762b48706b6ae885fa6896f","branchLabelMapping":{"^v8.15.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","docs","backport:all-open","v8.15.0"],"title":"Updates
the docs with the advanced setting option for enabling
Uptime","number":183613,"url":"https://github.com/elastic/kibana/pull/183613","mergeCommit":{"message":"Updates
the docs with the advanced setting option for enabling Uptime
(#183613)\n\n## Summary\r\n\r\nUpdates the [advanced
settings\r\ndocs](https://www.elastic.co/guide/en/kibana/master/advanced-options.html)\r\nto
include the `observability:enableLegacyUptimeApp` option for
enabling\r\nthe Uptime Kibana app by default (in conjunction with the
Observability\r\ndoc updates in
https://github.com/elastic/observability-docs/pull/3890)\r\n\r\nThe list
of options (under Observability, at least) don't seem to
be\r\nalphabetical, so I've put this in where seems to be a good place,
but\r\nfeel free to move it somewhere else if more
appropriate.","sha":"4182d87d4a2edfed7762b48706b6ae885fa6896f"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.15.0","branchLabelMappingKey":"^v8.15.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/183613","number":183613,"mergeCommit":{"message":"Updates
the docs with the advanced setting option for enabling Uptime
(#183613)\n\n## Summary\r\n\r\nUpdates the [advanced
settings\r\ndocs](https://www.elastic.co/guide/en/kibana/master/advanced-options.html)\r\nto
include the `observability:enableLegacyUptimeApp` option for
enabling\r\nthe Uptime Kibana app by default (in conjunction with the
Observability\r\ndoc updates in
https://github.com/elastic/observability-docs/pull/3890)\r\n\r\nThe list
of options (under Observability, at least) don't seem to
be\r\nalphabetical, so I've put this in where seems to be a good place,
but\r\nfeel free to move it somewhere else if more
appropriate.","sha":"4182d87d4a2edfed7762b48706b6ae885fa6896f"}}]}]
BACKPORT-->

Co-authored-by: Paul Bianciardi <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8.9 Automated backport with mergify backport-8.10 Automated backport with mergify backport-8.11 Automated backport with mergify backport-8.12 Automated backport with mergify backport-8.13 Automated backport with mergify backport-8.14 Automated backport with mergify
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Uptime]: Document that Uptime UI is only shown if Heartbeat data is available
3 participants