feat(go): Modify docs to follow logger API changes #14260
+111
−101
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
Bundle ReportChanges will increase total bundle size by 9.27kB (0.04%) ⬆️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-client-array-pushAssets Changed:
view changes for bundle: sentry-docs-server-cjsAssets Changed:
|
AbhiPrasad
approved these changes
Jul 7, 2025
coolguyzone
reviewed
Jul 7, 2025
| @@ -11,149 +11,128 @@ With Sentry Structured Logs, you can send text based log information from your a | |||
|
|
|||
| ## Requirements | |||
|
|
|||
| Logs in Go are supported in Sentry Go SDK version `0.33.0` and above. | |||
| Logs in Go are supported in Sentry Go SDK version `0.33.0` and above. For using integrations of other log libraries, have a look at each specific page for more details on requirements. | |||
There was a problem hiding this comment.
Suggested change
| Logs in Go are supported in Sentry Go SDK version `0.33.0` and above. For using integrations of other log libraries, have a look at each specific page for more details on requirements. | |
| Logs in Go are supported in Sentry Go SDK version `0.33.0` and above. To use integrations with other logging libraries, check their specific documentation pages for detailed requirements. |
coolguyzone
reviewed
Jul 7, 2025
includes/logs/go-ctx-usage-alert.mdx
Outdated
| @@ -0,0 +1,4 @@ | |||
| ## Correlating Logs with Traces | |||
There was a problem hiding this comment.
Suggested change
| ## Correlating Logs with Traces | |
| ## Correlating Logs With Traces |
coolguyzone
reviewed
Jul 7, 2025
| ## Correlating Logs with Traces | ||
|
|
||
| In order to properly attach the correct trace with each log entry, a `context.Context` is required. | ||
| If you're using logs combined with tracing, you should pass the correct context to properly attach each trace with the appropriate logs. |
There was a problem hiding this comment.
Suggested change
| If you're using logs combined with tracing, you should pass the correct context to properly attach each trace with the appropriate logs. | |
| When using logs with tracing, make sure to pass the correct context so each log is properly associated with its trace. |
coolguyzone
reviewed
Jul 7, 2025
| ### LogHook | ||
|
|
||
| Use `sentrylogrus.NewLogHook()` to send structured logs to Sentry. This hook captures log entries and sends them to Sentry's structured logging system. | ||
| You have two ways to create a new `LogHook`. Either by using `sentrylogrus.NewLogHook()` and passing the `sentry.ClientOptions` or |
There was a problem hiding this comment.
Suggested change
| You have two ways to create a new `LogHook`. Either by using `sentrylogrus.NewLogHook()` and passing the `sentry.ClientOptions` or | |
| You have two ways to create a new `LogHook`. Either by using `sentrylogrus.NewLogHook()` and passing the `sentry.ClientOptions`, or |
coolguyzone
reviewed
Jul 7, 2025
| ``` | ||
|
|
||
| ### EventHook | ||
|
|
||
| Use `sentrylogrus.NewEventHook()` to send log entries as Sentry events. This is useful for error tracking and alerting. | ||
| You also have two ways to create a new `EventHook`. Either by using `sentrylogrus.NewEventHook()` and passing the `sentry.ClientOptions` or |
There was a problem hiding this comment.
Suggested change
| You also have two ways to create a new `EventHook`. Either by using `sentrylogrus.NewEventHook()` and passing the `sentry.ClientOptions` or | |
| You also have two ways to create a new `EventHook`. Either use `sentrylogrus.NewEventHook()` and passing the `sentry.ClientOptions`, or |
coolguyzone
reviewed
Jul 7, 2025
| "github.com/getsentry/sentry-go" | ||
| sentryslog "github.com/getsentry/sentry-go/slog" | ||
| ) | ||
| To integrate Sentry with slog, you need to set up a Sentry handler and configure the Sentry client. |
There was a problem hiding this comment.
Suggested change
| To integrate Sentry with slog, you need to set up a Sentry handler and configure the Sentry client. | |
| To integrate Sentry with slog, you need to set up a Sentry handler and configure the Sentry client: |
giortzisg
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
DESCRIBE YOUR PR
Changing the docs to adhere with the logging API signature changes in Go.