Skip to content

Conversation

@giortzisg
Copy link
Collaborator

DESCRIBE YOUR PR

The tracing page layout for Go docs is non intuitive. All integrations we support, can be automatically instrumented, but the only information provided under Tracing -> Instrumentation is manual instrumentation examples. This PR adds examples of automatic instrumentation for each integration to make it more intuitive to users, what we actually support. Some notes on the changes:

  • the http integrations refer to the quickstart page for more info on setting up automatic instrumentation to avoid duplication
  • the logging integrations provide more info on how to link traces to logs
  • the zerolog integration does not support Logs

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

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

@vercel
Copy link

vercel bot commented Jan 27, 2026

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

Project Deployment Review Updated (UTC)
sentry-docs Ready Ready Preview, Comment Jan 27, 2026 3:06pm
1 Skipped Deployment
Project Deployment Review Updated (UTC)
develop-docs Ignored Ignored Preview Jan 27, 2026 3:06pm

Request Review

@giortzisg giortzisg force-pushed the docs/go/tracing-ref branch from 8d77887 to f1fd32b Compare January 27, 2026 14:49
@giortzisg giortzisg self-assigned this Jan 27, 2026
@giortzisg giortzisg marked this pull request as ready for review January 27, 2026 14:50
@@ -0,0 +1,8 @@
The Sentry middleware for this framework **automatically creates transactions** for all incoming HTTP requests when tracing is enabled. Each transaction includes:
Copy link
Member

Choose a reason for hiding this comment

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

m: Is it not also capturing the incoming http body?


The `sentryecho` middleware provides automatic tracing and error capturing for Echo applications. The source can be found [on GitHub](https://github.com/getsentry/sentry-go/tree/master/echo).

For installation and configuration instructions, see the [Echo Getting Started](/platforms/go/guides/echo/) guide.
Copy link
Member

Choose a reason for hiding this comment

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

h: This is quite confusing. I am at platforms/go/guides/echo/tracing/instrumentation/echo/ and it displays just some text, no code snippets etc. The reference to the tracing setup in the alert is fine, but redirect to the Echo Getting Started guide doesn't make much sense because if a person is trying to adopt Echo instrumentation, they already read the Quick Start, navigate to the Tracing > Instrumentation > Echo Integration, just to be redirected back to the Quick Start.

As a user I would expect to get more details in the nested "Echo Integration" page. Not sure what the value of this page is. This applies to all integrations except the logging ones.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Well the problem is that the quickstart page already has the example of how to setup and verify that tracing instrumentation works for each integration, so it would be just duplication of the content.

As to the helpfulness of the page. The previous layout would be Echo -> Tracing -> Instrumentation, and then you would only see custom instrumentation in the sidebar, inferring that we don't auto instrument traces for echo. What do you feel that this page is missing/should have?

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.

3 participants