Repository navigation
[APM] Complete contextual service map docs for 9.6 - #8732
Conversation
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. |
🔍 Preview links for changed docs⏳ Building and deploying preview... View progress This comment will be updated with preview links when the build is complete. |
✅ Elastic Docs Style Checker (Vale)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. |
|
@MiriamAparicio this is ready for your 👀 Could you confirm availability and licensing claims especially? The rest I tested locally so it should be fine (but please look just in case) |
There was a problem hiding this comment.
Docs review summary
Action required
- License and tier requirements need SME confirmation. The new
## Requirementssection insolutions/observability/apm/service-map.md(lines 21–26) says service maps, including embedded panels, require a Platinum or higher subscription on Stack and the Observability Complete feature tier on Serverless. The linked Kibana change (elastic/kibana#278413) appears to gate only the embedded/contextual maps on Platinum. I found no published page that states a license requirement for the standalone service map. The Observability feature tiers table lists only "APM" as Complete-only, not service maps. Verify both: an SME must confirm which map surfaces are gated, and on which tier, before merge. - Mobile availability mismatch. See the inline comment on
mobile-service-overview.md. The mobile section is tagged Stack-only, whileservice-map.mdlists mobile services under the Stack + Serverless tab.
Issue satisfaction
Issue #8719 is mostly satisfied. The contextual panel, Explore in Service map, and dashboard context sections are documented, and the old 9.0–9.5 guidance is preserved under separate applies_to tabs. Engineering confirmation of license and availability is still outstanding.
Follow-up outside this PR
None.
Review coverage
- Content type: Overview and reference-style APM UI pages. The new sections fit the existing structure.
- Checked: User focus, technical accuracy, applicability, maintainability, language, and style across the four changed pages. Existing Vale findings were not repeated.
- Not checked: The UI labels "Sync with dashboard filters" and "Explore in Service map" against Kibana source (the code search was rate-limited). Image content in the two new screenshots.
Generated from Docs review agent
There was a problem hiding this comment.
Docs review summary
Action required
- The new licensing and availability claims in
service-map.md(Platinum on Stack, Observability Complete tier on Serverless, Stack 9.6 and Serverless availability) and the filter-persistence claims in the new "Move between dashboards and the service map" section (which filters are copied, "Range and custom filters aren’t copied", Sync with dashboard filters behavior) have no engineering confirmation recorded in the PR. The PR description states none was requested. Published docs contain no page that states or contradicts these claims, so there is nothing to cross-check against. Get an SME to confirm them before merge.
Issue satisfaction
Partially satisfied — all five acceptance criteria in #8719 have corresponding changes, but the criterion to "confirm the exact Stack and Serverless requirements with engineering" has no evidence of confirmation (see Action required).
Review coverage
- Content type: overview and reference-style APM pages. Each change adds a short, scoped section that points to
service-map.mdfor licensing and controls, which fits the pages' existing pattern. - Checked: user focus, technical accuracy, applicability, maintainability, language, and style.
- Not checked: Vale findings were read but not repeated; the
mapped_pageswarnings are on untouched frontmatter.
Generated from Docs review agent
|
As for the Requirements issue raised during docs-review. Checked against Kibana source (main):
Not confirmed in source:
@MiriamAparicio could you please confirm both? |
mdbirnstiehl
left a comment
There was a problem hiding this comment.
One note about subscription levels, but otherwise LGTM
|
Hi @alexandra5000, |
Summary
Completes the contextual service map guidance for Stack 9.6 and Serverless. Adds mobile overview coverage and licensing requirements, explains which filters and highlighted services survive navigation between maps and dashboards, and expands the service overview and transaction details sections with screenshots.
Preserves earlier navigation guidance in separate 9.5 and 9.0–9.4 tabs. The mobile map uses the same controls, so no additional mobile screenshot is included.
Closes #8719.
Generative AI disclosure
Tool used: OpenAI Codex (GPT-6), for drafting, source verification. Reviewed and validated locally by the author. The availability and licensing claims still need human technical review; no engineering confirmation was requested.