Skip to content

[Synthetics] Update infrastructure monitoring for k8s#6367

Open
alaudazzi wants to merge 8 commits intomainfrom
fix-1879
Open

[Synthetics] Update infrastructure monitoring for k8s#6367
alaudazzi wants to merge 8 commits intomainfrom
fix-1879

Conversation

@alaudazzi
Copy link
Copy Markdown
Member

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:

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 capabilities to dynamically monitor hosts and pods. Results appear in the {{uptime-app}}.
  • {{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.

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

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No

@alaudazzi alaudazzi requested review from eedugon and emilioalvap May 8, 2026 08:19
@alaudazzi alaudazzi self-assigned this May 8, 2026
@alaudazzi alaudazzi requested a review from a team as a code owner May 8, 2026 08:19
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 8, 2026

Elastic Docs AI PR menu

Check 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.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 8, 2026

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 8, 2026

✅ Vale Linting Results

No 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.

Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

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

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.md correctly omits a section-level applies_to override (the CCS/CCR section above it has stack: ga because 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 important admonition 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 via where the style guide prefers through (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: 0 because the default scope is docs-subtree (docs/), and these files live under solutions/. 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 / @emilioalvap whether 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

Comment thread solutions/observability/synthetics/index.md Outdated
Comment thread solutions/observability/synthetics/scale-architect-synthetics-deployment.md Outdated
Copy link
Copy Markdown
Contributor

@eedugon eedugon left a comment

Choose a reason for hiding this comment

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

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.

Comment thread solutions/observability/synthetics/index.md Outdated
Comment thread solutions/observability/synthetics/index.md Outdated
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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Comment thread solutions/observability/synthetics/scale-architect-synthetics-deployment.md Outdated
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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Comment thread solutions/observability/synthetics/scale-architect-synthetics-deployment.md Outdated
alaudazzi and others added 7 commits May 8, 2026 15:08
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Synthetics] Document infrastructure monitoring for k8s

2 participants