Go
Sentry's Go SDK enables reporting messages, errors, and panics.
Our Go SDK supports all recent versions of the language, and integrates well with a variety of popular frameworks and packages in the Go ecosystem. It gives developers helpful hints for where and why an error or panic might have occurred.
On this page, we get you up and running with Sentry's SDK, so that it will automatically report errors and exceptions in your application.
Using a framework?
Get started using a guide listed in the right sidebar.
Don't already have an account and Sentry project established? Head over to sentry.io, then return to this page.
Install
Sentry captures data by using an SDK within your application’s runtime.
When using Go Modules, you do not need to install anything to start using Sentry with your Go program. Import the SDK and the go tool will automatically download the latest version of the SDK when you next build your program.
import (
"github.com/getsentry/sentry-go"
)With or without Go Modules, to use the latest version of the SDK, run:
go get github.com/getsentry/sentry-goConsult the Go documentation on Modules for more information on how to manage dependencies.
Configure
Configuration should happen as early as possible in your application's lifecycle.
package main
import (
"log"
"time"
"github.com/getsentry/sentry-go"
)
func main() {
err := sentry.Init(sentry.ClientOptions{
// Either set your DSN here or set the SENTRY_DSN environment variable.
Dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
// Either set environment and release here or set the SENTRY_ENVIRONMENT
// and SENTRY_RELEASE environment variables.
Environment: "",
Release: "my-project-name@1.0.0",
// Enable printing of SDK debug messages.
// Useful when getting started or trying to figure something out.
Debug: true,
})
if err != nil {
log.Fatalf("sentry.Init: %s", err)
}
// Flush buffered events before the program terminates.
// Set the timeout to the maximum duration the program can afford to wait.
defer sentry.Flush(2 * time.Second)
}Verify
This snippet includes an intentional error, so you can test that everything is working as soon as you set it up:
package main
import (
"log"
"time"
"github.com/getsentry/sentry-go"
)
func main() {
err := sentry.Init(sentry.ClientOptions{
Dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
})
if err != nil {
log.Fatalf("sentry.Init: %s", err)
}
defer sentry.Flush(2 * time.Second)
sentry.CaptureMessage("It works!")
}Learn more about manually capturing an error or message in our Usage documentation.
To view and resolve the recorded error, log into sentry.io and open your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.
- Package:
- github:getsentry/sentry-go
- Version:
- 0.28.1
- Repository:
- https://github.com/getsentry/sentry-go/