Skip to content
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.

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

doc: Link to the repository and official docs in doc.go #623

Merged
merged 1 commit into from Apr 11, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
62 changes: 2 additions & 60 deletions doc.go
@@ -1,64 +1,6 @@
/*
Package sentry is the official Sentry SDK for Go.
Package repository: https://github.com/getsentry/sentry-go/

Use it to report errors and track application performance through distributed
tracing.

For more information about Sentry and SDK features please have a look at the
documentation site https://docs.sentry.io/platforms/go/.

# Basic Usage

The first step is to initialize the SDK, providing at a minimum the DSN of your
Sentry project. This step is accomplished through a call to sentry.Init.

func main() {
err := sentry.Init(...)
...
}

A more detailed yet simple example is available at
https://github.com/getsentry/sentry-go/blob/master/_examples/basic/main.go.

# Error Reporting

The Capture* functions report messages and errors to Sentry.

sentry.CaptureMessage(...)
sentry.CaptureException(...)
sentry.CaptureEvent(...)

Use similarly named functions in the Hub for concurrent programs like web
servers.

# Performance Monitoring

You can use Sentry to monitor your application's performance. More information
on the product page https://docs.sentry.io/product/performance/.

The StartSpan function creates new spans.

span := sentry.StartSpan(ctx, "operation")
...
span.Finish()

# Integrations

The SDK has support for several Go frameworks, available as subpackages.

# Getting Support

For paid Sentry.io accounts, head out to https://sentry.io/support.

For all users, support channels include:

Forum: https://forum.sentry.io
Discord: https://discord.gg/Ww9hbqr (#go channel)

If you found an issue with the SDK, please report through
https://github.com/getsentry/sentry-go/issues/new/choose.

For responsibly disclosing a security issue, please follow the steps in
https://sentry.io/security/#vulnerability-disclosure.
For more information about Sentry and SDK features, please have a look at the official documentation site: https://docs.sentry.io/platforms/go/
*/
package sentry