Go

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.

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.

Copied
import (
	"github.com/getsentry/sentry-go"
)

With or without Go Modules, to use the latest version of the SDK, run:

Copied
go get github.com/getsentry/sentry-go

Consult 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.

Copied
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:     "",
		// 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:

Copied
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!")
}

Or, by manually generating an event:

To capture an event in Go, you can pass any struct implementing an error interface to CaptureException(). If you use a 3rd party library instead of native errors package, we'll do our best to extract a stack trace.

The SDK is fully compatible with (but not limited to):

  • github.com/pkg/errors
  • github.com/go-errors/errors
  • github.com/pingcap/errors

If there is an errors package that's not working out of the box, let us know!

Copied
f, err := os.Open("filename.ext")
if err != nil {
	sentry.CaptureException(err)
}

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.

You can edit this page on GitHub.