Instrumenta apps de Go para Error Reporting

Puedes enviar informes de errores a Error Reporting desde aplicaciones de Go con el paquete de Error Reporting para Go. Usa el paquete de Error Reporting para Go para crear grupos de errores en los siguientes casos:

• Un bucket de registros que contiene tus entradas de registro tiene claves de encriptación administradas por el cliente (CMEK).
• El bucket de registro satisface una de las siguientes opciones:
  • El bucket de registros se almacena en el mismo proyecto en el que se originaron las entradas de registro.
  • Las entradas de registro se enrutaron a un proyecto, que luego almacenó esas entradas de registro en un bucket de registros de su propiedad.
• Deseas informar eventos de error personalizados.

Error Reporting está integrado en algunos servicios de Google Cloud, como Cloud Functions y App Engine, Compute Engine y Google Kubernetes Engine. Error Reporting muestra los errores que registran las aplicaciones que se ejecutan en esos servicios en Cloud Logging. Para obtener más información, ve a Se está ejecutando en Google Cloud en este .

También puedes enviar datos de errores a Error Reporting mediante Logging. Para obtener información sobre los requisitos de formato de datos, consulta Dale formato a los mensajes de error en Logging.

Antes de comenzar

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Error Reporting API .

   Enable the API

5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

6. Make sure that billing is enabled for your Google Cloud project.

7. Enable the Error Reporting API .

   Enable the API

Instala la biblioteca cliente

El paquete de Error Reporting para Go te permite supervisar y ver errores informados por Usa aplicaciones de Go que se ejecutan prácticamente en cualquier lugar.

1. Usa go get para instalar el paquete:

   go get cloud.google.com/go/errorreporting

Para obtener más información sobre la instalación, lee la documentación del paquete de Error Reporting para Go. También puedes informar problemas con la herramienta de seguimiento de errores.

Configura la biblioteca cliente

Puedes personalizar el comportamiento del paquete de Error Reporting para Go. Consulta godoc.

Ejecuta apps en Google Cloud

Para crear grupos de errores con projects.events.report, tu cuenta de servicio requiere la Rol de escritor de Error Reporting (roles/errorreporting.writer).

Algunos servicios de Google Cloud otorgan rol de escritor de Error Reporting (roles/errorreporting.writer) para el rol adecuado cuenta de servicio. Sin embargo, debes otorgar este rol al servicio correspondiente para algunos servicios.

Entorno flexible de App Engine

App Engine otorga la Rol de escritor de Error Reporting (roles/errorreporting.writer) automáticamente a tu cuenta de servicio predeterminada.

El paquete de Error Reporting para Go se puede usar sin necesidad de proporcionar credenciales de forma explícita.

Error Reporting se habilita de manera automática para las aplicaciones del entorno flexible de App Engine. No se requiere ninguna configuración adicional.

Nota: Error Reporting procesa de forma automática las entradas de registro de errores escritas en stderr, sin necesidad de usar el paquete de Error Reporting para Go directamente.

Google Kubernetes Engine

Para usar Error Reporting con Google Kubernetes Engine, haz lo siguiente:

1. Asegúrate de que la cuenta de servicio que usará tu contenedor se haya concedido el Función de escritor de Error Reporting (roles/errorreporting.writer).

   Puedes usar la cuenta de servicio predeterminada de Compute Engine o una personalizada.

   Para obtener información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

2. Crea tu clúster y otórgale los permisos cloud-platform: permiso de acceso.

   Por ejemplo, el siguiente comando create especifica el cloud-platform permiso de acceso y una cuenta de servicio:

   gcloud container clusters create CLUSTER_NAME --service-account  SERVICE_ACCT_NAME --scopes=cloud-platform
   

Nota: Después de crear un clúster, no puedes cambiar su cuenta de servicio.

Compute Engine

Para usar Error Reporting con instancias de VM de Compute Engine, haz lo siguiente:

1. Asegúrate de que la cuenta de servicio que utilizará tu instancia de VM esté concedido el Función de escritor de Error Reporting (roles/errorreporting.writer).

   Puedes usar la cuenta de servicio predeterminada de Compute Engine o una personalizada.

   Para obtener información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

2. En la consola de Google Cloud, ve a la página Instancias de VM.

   Ir a Instancias de VM

   Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Compute Engine.

3. Selecciona la instancia de VM a la que deseas que se le asigne el alcance de acceso cloud-platform.

4. Haz clic en Detener y, luego, en Editar.

5. En la sección Identidad y acceso a la API, selecciona una cuenta de servicio que tenga el rol de escritor de Error Reporting (roles/errorreporting.writer).

6. En la sección Permisos de acceso, Selecciona Permitir el acceso total a todas las APIs de Cloud y, luego, guarda los cambios.

7. Haz clic en Iniciar/Reanudar.

Cloud Functions

Las funciones de Cloud Run otorgan el rol de escritor de Error Reporting (roles/errorreporting.writer) a tu cuenta de servicio predeterminada automáticamente.

El paquete de Error Reporting para Go se puede usar sin necesidad de proporcionar credenciales de forma explícita.

Las funciones de Cloud Run están configuradas para usar Error Reporting de forma automática. No controlado Las excepciones de JavaScript aparecerán en Logging y se procesarán de Error Reporting sin necesidad de usar Paquete de Error Reporting para Go.

Nota: Las entradas de registro se procesan de forma automática si contienen un seguimiento de pila y no especifican gravedad de registro o una gravedad de registro de al menos ERROR, sin necesidad de usar el paquete de Error Reporting para Go.

Ejemplo

En el siguiente ejemplo, se muestra cómo usar la biblioteca cliente de Go para informar un evento de error personalizado:

// Sample errorreporting_quickstart contains is a quickstart
// example for the Google Cloud Error Reporting API.
package main

import (
	"context"
	"errors"
	"log"
	"os"

	"cloud.google.com/go/errorreporting"
)

var errorClient *errorreporting.Client

func main() {
	// Set your Google Cloud Platform project ID via environment or explicitly
	projectID := os.Getenv("GOOGLE_CLOUD_PROJECT")
	args := os.Args[1:]
	if len(args) > 0 && args[0] != "" {
		projectID = args[0]
	}

	ctx := context.Background()
	var err error
	errorClient, err = errorreporting.NewClient(ctx, projectID, errorreporting.Config{
		ServiceName:    "errorreporting_quickstart",
		ServiceVersion: "0.0.0",
		OnError: func(err error) {
			log.Printf("Could not report the error: %v", err)
		},
	})
	if err != nil {
		log.Fatal(err)
	}
	defer errorClient.Close()

	err = errors.New("something went wrong")
	if err != nil {
		logAndPrintError(err)
		return
	}
}

func logAndPrintError(err error) {
	/// Client autopopulates the error context of the error. For more details about the context see:
	/// https://cloud.google.com/error-reporting/reference/rest/v1beta1/ErrorContext
	errorClient.Report(errorreporting.Entry{
		Error: err,
	})
	log.Print(err)
}

Consulta godoc para obtener más ejemplos sobre cómo informar los errores y problemas importantes.

Ejecuta apps en un entorno de desarrollo local

Para usar el paquete de Error Reporting para Go en un entorno de desarrollo local, como ejecutar la biblioteca en tu propia estación de trabajo, debes proporcionarle a tu paquete de Error Reporting para Go las credenciales predeterminadas de la aplicación local. Para obtener más información, consulta Autentícate en Error Reporting.

Para usar las muestras de Go de esta página en un entorno de desarrollo local, instala e inicializa gcloud CLI y, luego, configura las credenciales predeterminadas de la aplicación con tus credenciales de usuario.

1. Install the Google Cloud CLI.

2. To initialize the gcloud CLI, run the following command:

   gcloud init

3. If you're using a local shell, then create local authentication credentials for your user account:

   gcloud auth application-default login

   You don't need to do this if you're using Cloud Shell.

   Note: If the gcloud CLI prints a warning that your account doesn't have the serviceusage.services.use permission, then some gcloud CLI commands and client libraries might not work. Ask an administrator to grant you the Service Usage Consumer IAM role (roles/serviceusage.serviceUsageConsumer), then run the following command:

   gcloud auth application-default set-quota-project PROJECT_ID

Para obtener más información, consulta Set up authentication for a local development environment.

El método projects.events.report también admite claves de API. Si deseas usar claves de API para la autenticación, no necesitas configurar un archivo local de credenciales predeterminadas de la aplicación. Para obtener más información, consulta Crea una clave de API en la documentación de autenticación de Google Cloud.

Ve informes de errores

En la consola de Google Cloud, ve a la página Error Reporting.

Ir a Error Reporting

También puedes usar la barra de búsqueda para encontrar esta página.

Para obtener más información, consulta Cómo visualizar errores.