Skip to content

docs(guides): Improve intro paragraph formatting and expand custom spans description #17169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jaffrepaul wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs(guides): Improve intro paragraph formatting and expand custom spans description #17169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5ccb70a
expand section describing custom vs auto instrumentation
jaffrepaul Mar 30, 2026
345b731
formatting consistency
jaffrepaul Mar 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/guides/custom-spans.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: "Add custom instrumentation for visibility beyond auto-instrumentat

You've got your Sentry SDK [auto-instrumentation](/product/explore/trace-explorer/) running. Now what?

Auto-instrumentation captures HTTP, database, and framework operations. But it can't see business logic, third-party APIs without auto-instrumentation, or background jobs. This guide shows you where to add custom spans to fill in those gaps.
Auto-instrumentation captures HTTP, database, and framework operations. But it can't see business logic, third-party APIs without auto-instrumentation, or background jobs. This guide shows you where to add custom spans to fill in those gaps. The custom spans in this guide add business context, logical groupings, and attributes that auto-instrumentation can't provide. In many cases, your custom spans will appear as parents of auto-generated child spans.

## Anatomy of a Span

Expand Down
4 changes: 3 additions & 1 deletion docs/guides/issues-errors.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ sidebar_order: 5
description: "Practical guidance on what errors to catch, how to search issues, and when to set alerts."
---

Your Sentry SDK is sending errors to [Sentry Issues](/product/issues/) out of the box. Now what? This guide covers the high-value error patterns that help you catch problems before they impact users and fix issues faster.
Your Sentry SDK is sending errors to [Sentry Issues](/product/issues/) out of the box. Now what?

This guide covers the high-value error patterns that help you catch problems before they impact users and fix issues faster.

## Anatomy of an Error

Expand Down
4 changes: 3 additions & 1 deletion docs/guides/logs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ sidebar_order: 10
description: "Practical guidance on what to log, how to search logs, and when to set alerts."
---

You've set up [Sentry Logs](/product/explore/logs/). Now what? This guide covers the high-value logging patterns that help you debug faster and catch problems before users report them.
You've set up [Sentry Logs](/product/explore/logs/). Now what?

This guide covers the high-value logging patterns that help you debug faster and catch problems before users report them.

## Anatomy of a Log

Expand Down
4 changes: 3 additions & 1 deletion docs/guides/metrics.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ sidebar_order: 15
description: "Practical guidance on what metrics to track, how to explore them, and when to set alerts."
---

You've set up [Sentry Metrics](/product/explore/metrics/). Now what? This guide covers the high-value metric patterns that give you visibility into application health and how to drill into traces when something looks off.
You've set up [Sentry Metrics](/product/explore/metrics/). Now what?

This guide covers the high-value metric patterns that give you visibility into application health and how to drill into traces when something looks off.

## Anatomy of a Metric

Expand Down
4 changes: 3 additions & 1 deletion docs/guides/querying-traces.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ sidebar_order: 20
description: "Find performance issues using data Sentry captures automatically and set up alerts."
---

You've enabled [Sentry Tracing](/product/explore/trace-explorer/). Now what? Sentry's auto-instrumentation captures a lot without custom code. This guide shows you how to query that data to find performance issues.
You've enabled [Sentry Tracing](/product/explore/trace-explorer/). Now what?

Sentry's auto-instrumentation captures a lot without custom code. This guide shows you how to query that data to find performance issues.

<Arcade src="https://demo.arcade.software/5W4Ra0nvz6eufKmnybix?embed" />

Expand Down
4 changes: 3 additions & 1 deletion docs/guides/session-replay.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ sidebar_order: 40
description: "Practical guidance on debugging errors and finding UX issues with Session Replay."
---

You've set up [Sentry Session Replay](/product/explore/session-replay/). Now what? Stack traces tell you _what_ broke. Replay shows you _how_ it broke. This guide covers how to use replay to debug errors and spot UX problems before users report them.
You've set up [Sentry Session Replay](/product/explore/session-replay/). Now what?

Stack traces tell you _what_ broke. Replay shows you _how_ it broke. This guide covers how to use replay to debug errors and spot UX problems before users report them.

## What Replay Captures

Expand Down
Loading