package module
v0.3.1 Latest Latest

This package is not in the latest version of its module.

Go to latest
Published: Jul 1, 2024 License: Apache-2.0 Imports: 14 Imported by: 136


Error Reporting API

Go Reference

Go Client Library for Error Reporting API.


go get


The stability of this module is indicated by SemVer.

However, a v1+ module may have breaking changes in two scenarios:

  • Packages with alpha or beta in the import path
  • The GoDoc has an explicit stability disclaimer (for example, for an experimental feature).

Go Version Support

See the Go Versions Supported section in the root directory's README.


See the Authorization section in the root directory's README.


Contributions are welcome. Please, see the CONTRIBUTING document for details.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See Contributor Code of Conduct for more information.



Package errorreporting is a Google Cloud Error Reporting library.

Any provided stacktraces must match the format produced by or as per for language specific stacktrace formats.

This package is still experimental and subject to change.

See for more information.

package main

import (


func main() {
	// Create the client.
	ctx := context.Background()
	ec, err := errorreporting.NewClient(ctx, "my-gcp-project", errorreporting.Config{
		ServiceName:    "myservice",
		ServiceVersion: "v1.0",
	if err != nil {
		// TODO: handle error
	defer func() {
		if err := ec.Close(); err != nil {
			log.Printf("failed to report errors to Cloud Error Reporting: %v", err)

	// Report an error.
	err = doSomething()
	if err != nil {
			Error: err,

func doSomething() error {
	return errors.New("something went wrong")




This section is empty.


This section is empty.


This section is empty.


type Client

type Client struct {
	// contains filtered or unexported fields

Client represents a Google Cloud Error Reporting client.

func NewClient

func NewClient(ctx context.Context, projectID string, cfg Config, opts ...option.ClientOption) (*Client, error)

NewClient returns a new error reporting client. Generally you will want to create a client on program initialization and use it through the lifetime of the process.

func (*Client) Close

func (c *Client) Close() error

Close calls Flush, then closes any resources held by the client. Close should be called when the client is no longer needed.

func (*Client) Flush

func (c *Client) Flush()

Flush blocks until all currently buffered error reports are sent.

If any errors occurred since the last call to Flush, or the creation of the client if this is the first call, then Flush reports the error via the Config.OnError handler.

func (*Client) Report

func (c *Client) Report(e Entry)

Report writes an error report. It doesn't block. Errors in writing the error report can be handled via Config.OnError.

func (*Client) ReportSync

func (c *Client) ReportSync(ctx context.Context, e Entry) error

ReportSync writes an error report. It blocks until the entry is written.

type Config

type Config struct {
	// ServiceName identifies the running program and is included in the error reports.
	// Optional.
	ServiceName string

	// ServiceVersion identifies the version of the running program and is
	// included in the error reports.
	// Optional.
	ServiceVersion string

	// OnError is the function to call if any background
	// tasks errored. By default, errors are logged.
	OnError func(err error)

Config is additional configuration for Client.

type Entry

type Entry struct {
	Error error
	Req   *http.Request // if error is associated with a request.
	User  string        // an identifier for the user affected by the error

	// Stack specifies the stacktrace and call sequence correlated with
	// the error. Stack's content must match the format specified by
	// or at least for Go programs, it must match the format produced
	// by
	// If Stack is blank, the result of runtime.Stack will be used instead.
	Stack []byte

Entry holds information about the reported error.


Path Synopsis
Package errorreporting is an auto-generated package for the Error Reporting API.
Package errorreporting is an auto-generated package for the Error Reporting API.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL