Skip to content

docs(android): Document standalone app start tracing and extend API#18667

Merged
buenaflor merged 12 commits into
masterfrom
buenaflor/docs/android-extend-app-start-api
Jul 13, 2026
Merged

docs(android): Document standalone app start tracing and extend API#18667
buenaflor merged 12 commits into
masterfrom
buenaflor/docs/android-extend-app-start-api

Conversation

@buenaflor

@buenaflor buenaflor commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Mirrors the Apple auto-instrumentation page for Android by documenting standalone app start tracing and the new extend-app-start API on the Android tracing auto-instrumentation page.

  • Add a Standalone App Start Tracing section to automatic instrumentation
  • Add an Extending the App Start subsection (available since 8.48.0) covering Sentry.extendAppStart(), Sentry.getExtendedAppStartSpan(), and Sentry.finishExtendedAppStart() in Java and Kotlin, with the standalone-tracing requirement called out

Refs sentry-java#5604

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

Mirror the Apple auto-instrumentation page for Android. Add a Standalone
App Start Tracing section with enablement (manifest and code) and an
app.start tracesSampler example, plus an Extending the App Start
subsection covering extendAppStart(), getExtendedAppStartSpan(), and
finishExtendedAppStart() in Java and Kotlin.

Co-Authored-By: Claude <noreply@anthropic.com>
@vercel

vercel Bot commented Jul 7, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview, Comment Jul 13, 2026 1:12pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Preview Jul 13, 2026 1:12pm

Request Review

@codeowner-assignment codeowner-assignment Bot requested a review from a team July 7, 2026 21:00
Document that the extended app start span auto-finishes after 30 seconds
(dropping the app start measurement) and that finishing before the first
frame falls back to the natural app start end.

Co-Authored-By: Claude <noreply@anthropic.com>
@buenaflor buenaflor marked this pull request as ready for review July 13, 2026 07:57
Copilot AI review requested due to automatic review settings July 13, 2026 07:57

Copilot AI 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.

Pull request overview

Adds Android documentation for standalone app start tracing and the new APIs for extending the app start window, aligning the Android tracing auto-instrumentation docs with the equivalent Apple guidance.

Changes:

  • Documented how to enable Standalone App Start Tracing (manifest meta-data and in-code configuration).
  • Added guidance and examples for sampling standalone app starts via tracesSampler using the app.start operation.
  • Added an Extending the App Start subsection documenting Sentry.extendAppStart(), Sentry.getExtendedAppStartSpan(), and Sentry.finishExtendedAppStart() (noted as available since 8.48.0), including the standalone-tracing requirement.

Comment thread docs/platforms/android/tracing/instrumentation/automatic-instrumentation.mdx Outdated
Comment thread docs/platforms/android/tracing/instrumentation/automatic-instrumentation.mdx Outdated
Use the page established indentation for the new XML, Java, and Kotlin snippets. Present the SDK version note with the existing inline convention.

Co-Authored-By: Claude <noreply@anthropic.com>
Distinguish the standalone app.start transaction from cold and warm app start spans. Explain that a deadline suppresses the measurement while preserving the transaction and spans.

Co-Authored-By: Claude <noreply@anthropic.com>
Comment thread docs/platforms/android/tracing/instrumentation/automatic-instrumentation.mdx Outdated
Place the Java and Kotlin examples in Application.onCreate so developers call the extension while the app start window is open. Clarify initialization order for automatic and manual setup.

Co-Authored-By: Claude <noreply@anthropic.com>
Finish extended app start tracing from an asynchronous completion callback so the examples demonstrate work that continues beyond the first frame.

Co-Authored-By: Claude <noreply@anthropic.com>
Use a synchronous preloadResources call while retaining the optional child span. Remove the invented asynchronous helper and callback to keep the example focused on the SDK flow.

Co-Authored-By: Claude <noreply@anthropic.com>
buenaflor and others added 2 commits July 13, 2026 11:56
Finish the extension span directly in the examples and document finishExtendedAppStart as the equivalent alternative. Clarify that child spans should finish before the extension.

Co-Authored-By: Claude <noreply@anthropic.com>
Keep the setup paragraph neutral about the completion method so it matches both the direct span finish example and the documented static API alternative.

Co-Authored-By: Claude <noreply@anthropic.com>
Use the static finish helper as the primary completion path in the examples while documenting direct span completion as an equivalent alternative.

Co-Authored-By: Claude <noreply@anthropic.com>
Comment thread docs/platforms/android/tracing/instrumentation/automatic-instrumentation.mdx Outdated
…umentation.mdx

Co-authored-by: Markus Hintersteiner <markus.hintersteiner@sentry.io>
@codeowner-assignment codeowner-assignment Bot requested a review from a team July 13, 2026 12:58
@buenaflor buenaflor merged commit d8856d5 into master Jul 13, 2026
22 of 23 checks passed
@buenaflor buenaflor deleted the buenaflor/docs/android-extend-app-start-api branch July 13, 2026 14:56
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.

4 participants