Conversation
Contributor
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
Contributor
🔍 Preview links for changed docs |
Contributor
✅ Vale Linting ResultsNo issues found on modified lines! The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
Contributor
There was a problem hiding this comment.
Docs review summary
Focus areas
- Style and clarity: Vale reported no findings (files were outside the default
docs/scope path). Manual review found minor issues — "Note that" filler and "via" where the style guide prefers "through". - Jargon:
{{heartbeat}},{{agent}},{{uptime-app}},{{k8s}},{{synthetics-app}}are all substitution variables; no unexplained jargon introduced. - Frontmatter and applies_to: Frontmatter is unchanged. The new section in
scale-architect-synthetics-deployment.mdcorrectly omits a section-levelapplies_tooverride (the CCS/CCR section above it hasstack: gabecause it's stateful-only; the new k8s section applies to both stack and serverless, matching the file-level frontmatter). - Content type fit: Both additions fit their context — an
importantadmonition in the index page and a parallel "Do not use" section in the scale/architect page, consistent with the existing CCS/CCR section pattern. - Parent issue satisfaction: Closes #1879. The PR adds the requested admonition to the index and a matching section to the scale/architect doc. Satisfied.
Nits
- Both changed files use
viawhere the style guide prefersthrough(e.g., "monitoring via autodiscovery" → "monitoring through autodiscovery"). - "Note that" appears in both bullets recommending the Uptime Monitors integration — inline suggestions posted above.
Notes
- The pre-fetched Vale data shows
eligible_count: 0because the default scope isdocs-subtree(docs/), and these files live undersolutions/. Review was performed manually as this repo's docs span the full repository. - The PR body already flags the Uptime app deprecation tension: both new sections link to the Uptime app while noting it's deprecated as of 8.15. Authors should confirm with
@eedugon/@emilioalvapwhether a non-deprecated landing page exists, or whether the link should be dropped entirely from the alternatives list.
Generated by Docs review agent for issue #6367 · ● 301.4K
eedugon
approved these changes
May 8, 2026
Contributor
eedugon
left a comment
There was a problem hiding this comment.
LGTM! I've suggested some small changes to make the note shorter, plus fixed some links.
Also the elastic agent suggestion links to autodiscover doc.
| For infrastructure or {{k8s}} uptime monitoring, use one of the following approaches instead: | ||
|
|
||
| * **{{heartbeat}} with autodiscovery**: Run {{heartbeat}} directly on your infrastructure and use its [autodiscovery](https://www.elastic.co/guide/en/beats/heartbeat/current/configuration-autodiscover.html) capabilities to dynamically monitor hosts and pods. Results appear in the [{{uptime-app}}](/solutions/observability/uptime/index.md). | ||
| * **{{agent}} with the Uptime Monitors integration**: Deploy a standalone {{agent}} and configure the Uptime Monitors ({{heartbeat}}) integration to collect availability data from your infrastructure. Note that the Uptime app is deprecated as of 8.15. |
Contributor
There was a problem hiding this comment.
Suggested change
| * **{{agent}} with the Uptime Monitors integration**: Deploy a standalone {{agent}} and configure the Uptime Monitors ({{heartbeat}}) integration to collect availability data from your infrastructure. Note that the Uptime app is deprecated as of 8.15. | |
| * **[{{agent}}](/reference/fleet/install-elastic-agents.md) with the Uptime Monitors ({{heartbeat}}) integration**: Deploy {{agent}} and configure the Uptime Monitors integration to collect infrastructure availability data. For [Kubernetes autodiscovery](/reference/fleet/elastic-agent-kubernetes-autodiscovery.md), hints-based autodiscovery requires standalone mode. Note that the Uptime app is deprecated as of 8.15. |
| For infrastructure or {{k8s}} uptime monitoring, use one of the following approaches instead: | ||
|
|
||
| * **{{heartbeat}} with autodiscovery**: Run {{heartbeat}} directly on your infrastructure and use its [autodiscovery](https://www.elastic.co/guide/en/beats/heartbeat/current/configuration-autodiscover.html) capabilities to dynamically monitor hosts and pods. Results appear in the [{{uptime-app}}](/solutions/observability/uptime/index.md). | ||
| * **{{agent}} with the Uptime Monitors integration**: Deploy a standalone {{agent}} and configure the Uptime Monitors ({{heartbeat}}) integration to collect availability data from your infrastructure. Note that the Uptime app is deprecated as of 8.15. |
Contributor
There was a problem hiding this comment.
Suggested change
| * **{{agent}} with the Uptime Monitors integration**: Deploy a standalone {{agent}} and configure the Uptime Monitors ({{heartbeat}}) integration to collect availability data from your infrastructure. Note that the Uptime app is deprecated as of 8.15. | |
| * **[{{agent}}](/reference/fleet/install-elastic-agents.md) with the Uptime Monitors ({{heartbeat}}) integration**: Deploy {{agent}} and configure the Uptime Monitors integration to collect infrastructure availability data. For [Kubernetes autodiscovery](/reference/fleet/elastic-agent-kubernetes-autodiscovery.md), hints-based autodiscovery requires standalone mode. Note that the Uptime app is deprecated as of 8.15. |
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
…deployment.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Edu González de la Herrán <25320357+eedugon@users.noreply.github.com>
Co-authored-by: Edu González de la Herrán <25320357+eedugon@users.noreply.github.com>
…deployment.md Co-authored-by: Edu González de la Herrán <25320357+eedugon@users.noreply.github.com>
…deployment.md Co-authored-by: Edu González de la Herrán <25320357+eedugon@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add a short "Not for infrastructure or Kubernetes monitoring" note/admonition to solutions/observability/synthetics/index.md. State clearly that the Synthetics app is designed for active synthetic checks of URLs and user journeys, not for host/pod availability monitoring via autodiscovery. Link to the Heartbeat / Elastic Agent alternatives.
Add a matching section to solutions/observability/synthetics/scale-architect-synthetics-deployment.md (alongside the existing CCS/CCR "do not use" section) documenting the k8s infra monitoring limitation and recommended alternatives.
Note for reviewers
@emilioalvap @eedugon can you confirm whether the recommended alternatives to document are correct:
The Uptime app (/solutions/observability/uptime/) is deprecated as of 8.15 and should not be promoted as the primary destination. I added a note about deprecation.
Closes #1879.
Generative AI disclosure