Skip to content

[APM] Complete contextual service map docs for 9.6 - #8732

Merged
alexandra5000 merged 5 commits into
elastic:mainfrom
alexandra5000:docs/8719-contextual-service-map
Oct 26, 2026
Merged

alexandra5000 merged 5 commits into
elastic:mainfrom
alexandra5000:docs/8719-contextual-service-map

Conversation

@alexandra5000

@alexandra5000 alexandra5000 commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

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

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

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.

@github-actions

github-actions Bot commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

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

github-actions Bot commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

🔍 Preview links for changed docs

⏳ Building and deploying preview... View progress

This comment will be updated with preview links when the build is complete.

@github-actions

github-actions Bot commented Oct 7, 2026

Copy link
Copy Markdown
Contributor

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

@alexandra5000
alexandra5000 marked this pull request as ready for review October 7, 2026 20:06
@alexandra5000
alexandra5000 requested review from a team as code owners October 7, 2026 20:06
@alexandra5000

Copy link
Copy Markdown
Contributor Author

@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)

@github-actions github-actions Bot left a comment

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.

Docs review summary

Action required

  • License and tier requirements need SME confirmation. The new ## Requirements section in solutions/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, while service-map.md lists 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

Comment thread solutions/observability/apm/mobile-service-overview.md
Comment thread solutions/observability/apm/mobile-service-overview.md Outdated
Comment thread solutions/observability/apm/mobile-service-overview.md Outdated

@github-actions github-actions Bot left a comment

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.

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.md for 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_pages warnings are on untouched frontmatter.

Generated from Docs review agent

Comment thread solutions/observability/apm/service-map.md
Comment thread solutions/observability/apm/service-map.md Outdated
Comment thread solutions/observability/apm/service-map.md Outdated
Comment thread solutions/observability/apm/mobile-service-overview.md Outdated
Comment thread solutions/observability/apm/mobile-service-overview.md Outdated
@alexandra5000

Copy link
Copy Markdown
Contributor Author

As for the Requirements issue raised during docs-review. Checked against Kibana source (main):

  • Platinum: both the standalone map and the contextual panel check isActivePlatinumLicense, so the Requirements section is correct. It covers embedded panels too.
  • Dashboard behavior: add_to_dashboard_button.tsx keeps only phrase, phrases, and exists filters and drops range and custom filters. Sync with dashboard filters defaults to off. The View in Service map link is built from the panel's own kuery only, so dashboard queries and synced filters aren't included.

Not confirmed in source:

  • The Serverless Complete tier claim. It follows from the feature tiers table listing APM as Complete-only.
  • Whether the mobile panel ships on Serverless.

@MiriamAparicio could you please confirm both?

@mdbirnstiehl mdbirnstiehl left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

One note about subscription levels, but otherwise LGTM

Comment thread solutions/observability/apm/service-map.md Outdated
@MiriamAparicio

Copy link
Copy Markdown

Hi @alexandra5000,
Sorry I missed the notification on this
Both confirmed:
Serverless: Service maps come with APM, which is on for Observability Complete and off for Logs Essentials. Linking to the feature tiers page is right. There is no separate service-map tier.
Mobile panel: It ships on Serverless Observability Complete, with the same checks as the service overview panel. The Stack-only tag matches the mobile overview page. Add serverless: ga on that section and page if the docs should match the product.

@alexandra5000
alexandra5000 added this pull request to the merge queue Oct 26, 2026
Merged via the queue into elastic:main with commit 90c81ff Oct 26, 2026
13 checks passed
@alexandra5000
alexandra5000 deleted the docs/8719-contextual-service-map branch October 26, 2026 15:06
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.

[APM][9.6] Complete contextual Service Map docs: mobile, licensing, filters, and screenshots

3 participants