raven

Documentation

Overview

Package raven is a client and library for sending messages and exceptions to Sentry: http://getsentry.com

Usage:

Create a new client using the NewClient() function. The value for the DSN parameter can be obtained from the project page in the Sentry web interface. After the client has been created use the CaptureMessage method to send messages to the server.

client, err := raven.NewClient(dsn)
...
id, err := client.CaptureMessage("some text")

If you want to have more finegrained control over the send event, you can create the event instance yourself

client.Capture(&raven.Event{Message: "Some Text", Logger:"auth"})

Index

• type Client
  • func NewClient(dsn string) (client *Client, err error)
  • func (client Client) Capture(ev *Event) error
  • func (client Client) CaptureMessage(message ...string) (result string, err error)
  • func (client Client) CaptureMessagef(format string, a ...interface{}) (result string, err error)
• type Event

Types

type Client

type Client struct {
	URL       *url.URL
	PublicKey string
	SecretKey string
	Project   string
	// contains filtered or unexported fields
}

func NewClient

func NewClient(dsn string) (client *Client, err error)

NewClient creates a new client for a server identified by the given dsn A dsn is a string in the form:

{PROTOCOL}://{PUBLIC_KEY}:{SECRET_KEY}@{HOST}/{PATH}{PROJECT_ID}

eg:

http://abcd:efgh@sentry.example.com/sentry/project1

func (Client) Capture

func (client Client) Capture(ev *Event) error

Sends the given event to the sentry servers after encoding it into a byte slice.

func (Client) CaptureMessage

func (client Client) CaptureMessage(message ...string) (result string, err error)

CaptureMessage sends a message to the Sentry server. The resulting string is an event identifier.

func (Client) CaptureMessagef

func (client Client) CaptureMessagef(format string, a ...interface{}) (result string, err error)

CaptureMessagef is similar to CaptureMessage except it is using Printf like parameters for formatting the message

type Event

type Event struct {
	EventId   string `json:"event_id"`
	Project   string `json:"project"`
	Message   string `json:"message"`
	Timestamp string `json:"timestamp"`
	Level     string `json:"level"`
	Logger    string `json:"logger"`
}