Configurazione su Google Kubernetes Engine

Puoi inviare errori dalle applicazioni Google Kubernetes Engine a Error Reporting in uno dei due seguenti modi:

• Effettuando il logging in Cloud Logging. Se utilizzi già Cloud Logging, l'unico requisito aggiuntivo è che le voci di log siano riconoscibili da Error Reporting. Per saperne di più sui requisiti di formattazione degli errori, consulta Errori di formattazione in Cloud Logging.

• Utilizzare l'API Error Reporting. L'applicazione può inviare richieste HTTP utilizzando l'API REST oppure può utilizzare librerie sperimentali in diversi linguaggi.

Utilizzo di Logging per segnalare errori

L'agente Logging predefinito di GKE fornisce una soluzione gestita per eseguire il deployment e gestire gli agenti che inviano i log per i tuoi cluster a Cloud Logging. La struttura dell'agente dipende dalla versione del cluster. Per informazioni su questo agente, consulta Gestione dei log di GKE.

Error Reporting richiede che le eccezioni o le analisi dello stack siano contenute in un'unica voce di log. La maggior parte degli agenti di logging è in grado di riconoscere che diverse righe di log (stack frame stampati ciascuna su una nuova riga) rappresentano un'analisi dello stack e la inviano a Cloud Logging come una singola voce di log. Se l'agente non è in grado di ricostruire più righe come un singolo errore, utilizza l'endpoint API projects.events.report, che ti consente di controllare i contenuti di un errore.

Utilizzo dell'API Error Reporting per scrivere errori

L'API Error Reporting fornisce un endpoint report per la scrittura di informazioni sull'errore nel servizio.

1. Attiva l'API Error Reporting.

   Abilita l'API

2. Segnala gli errori all'API utilizzando l'API REST o una libreria client.

   • API REST

     Consulta la documentazione di riferimento per informazioni sull'API.

   • Utilizzo delle librerie client

     Le librerie sono disponibili in un numero limitato di lingue per aiutarti a chiamare l'API Error Reporting dalla tua applicazione:

     • ASP.NET
     • Go
     • Java
     • Node.js
     • Ruby
     • Python
     • PHP

Esempi

ASP.NET

Il pacchetto NuGet ASP.NET segnala le eccezioni non rilevate dalle applicazioni web ASP.NET a Error Reporting.

Installa il pacchetto NuGet

Per installare il pacchetto NuGet di Stackdriver ASP.NET in Visual Studio:

1. Fai clic con il pulsante destro del mouse sulla soluzione e seleziona Gestisci pacchetti NuGet per soluzione.
2. Seleziona la casella di controllo Includi pre-release.
3. Cerca e installa il pacchetto denominato Google.Cloud.Diagnostics.AspNet.

Utilizzo

Dopo aver installato il pacchetto NuGet di Stackdriver ASP.NET, aggiungi la seguente istruzione al codice dell'applicazione per iniziare a inviare errori a Stackdriver:

using Google.Cloud.Diagnostics.AspNet;

Aggiungi il seguente codice HttpConfiguration al metodo Register dell'applicazione web .NET (sostituendo your-project-id con l'ID progetto effettivo per attivare la segnalazione delle eccezioni:

error-reporting/api/diagnostics/App_Start/WebApiConfig.cs

Visualizza su GitHub

public static void Register(HttpConfiguration config)
{
    string projectId = "YOUR-PROJECT-ID";
    string serviceName = "NAME-OF-YOUR-SERVICE";
    string version = "VERSION-OF-YOUR-SERVCICE";
    // ...
    // Add a catch all for the uncaught exceptions.
    config.Services.Add(typeof(IExceptionLogger),
        ErrorReportingExceptionLogger.Create(projectId, serviceName, version));
    // ...
}

Dopo aver aggiunto questo metodo all'applicazione ASP.NET, puoi visualizzare tutte le eccezioni non rilevate che si verificano quando vengono segnalate a Google Cloud nella sezione Error Reporting della console Google Cloud.

C#

Il seguente esempio è disponibile nel repository GoogleCloudPlatform/dotnet-docs-samples. Per utilizzarlo, dopo aver creato il progetto, specifica l'ID progetto:

C:\...\bin\Debug> set GOOGLE_PROJECT_ID=[YOUR_PROJECT_ID]

Assicurati di sostituire [YOUR_PROJECT_ID] con il valore corretto dalla console Google Cloud.

Quindi, invia dati di eccezione con un codice simile al seguente:

error-reporting/api/ErrorReportingSample.cs

Visualizza su GitHub

public class ErrorReportingSample
{
    public static void Main(string[] args)
    {
        try
        {
            throw new Exception("Generic exception for testing Stackdriver Error Reporting");
        }
        catch (Exception e)
        {
            report(e);
            Console.WriteLine("Stackdriver Error Report Sent");
        }
    }

    /// <summary>
    /// Create the Error Reporting service (<seealso cref="ClouderrorreportingService"/>)
    /// with the Application Default Credentials and the proper scopes.
    /// See: https://developers.google.com/identity/protocols/application-default-credentials.
    /// </summary>
    private static ClouderrorreportingService CreateErrorReportingClient()
    {
        // Get the Application Default Credentials.
        GoogleCredential credential = GoogleCredential.GetApplicationDefaultAsync().Result;

        // Add the needed scope to the credentials.
        credential.CreateScoped(ClouderrorreportingService.Scope.CloudPlatform);

        // Create the Error Reporting Service.
        ClouderrorreportingService service = new ClouderrorreportingService(new BaseClientService.Initializer
        {
            HttpClientInitializer = credential,
        });
        return service;
    }

    /// <summary>
    /// Creates a <seealso cref="ReportRequest"/> from a given exception.
    /// </summary>
    private static ReportRequest CreateReportRequest(Exception e)
    {
        // Create the service.
        ClouderrorreportingService service = CreateErrorReportingClient();

        // Get the project ID from the environement variables.
        string projectId = Environment.GetEnvironmentVariable("GOOGLE_PROJECT_ID");

        // Format the project id to the format Error Reporting expects. See:
        // https://cloud.google.com/error-reporting/reference/rest/v1beta1/projects.events/report
        string formattedProjectId = string.Format("projects/{0}", projectId);

        // Add a service context to the report.  For more details see:
        // https://cloud.google.com/error-reporting/reference/rest/v1beta1/projects.events#ServiceContext
        ServiceContext serviceContext = new ServiceContext()
        {
            Service = "myapp",
            Version = "8c1917a9eca3475b5a3686d1d44b52908463b989",
        };
        ReportedErrorEvent errorEvent = new ReportedErrorEvent()
        {
            Message = e.ToString(),
            ServiceContext = serviceContext,
        };
        return new ReportRequest(service, errorEvent, formattedProjectId);
    }

    /// <summary>
    /// Report an exception to the Error Reporting service.
    /// </summary>
    private static void report(Exception e)
    {
        // Create the report and execute the request.
        ReportRequest request = CreateReportRequest(e);
        request.Execute();
    }
}

Go

Consulta la sezione Configurare Error Reporting per Go.

Java

Consulta la sezione Configurazione di Error Reporting per Java.

Node.js

Consulta la sezione Configurazione di Error Reporting per Node.js.

Ruby

Consulta la sezione Configurazione di Error Reporting per Ruby.

Python

Consulta la sezione Configurazione di Error Reporting per Python.

PHP

Consulta la sezione Configurazione di Error Reporting per PHP.

Visualizza gruppi di errori

Nella console Google Cloud, seleziona Error Reporting oppure fai clic sul pulsante seguente e seleziona un progetto:

Vai a Error Reporting

Nota: se nella pagina Error Reporting viene visualizzato il messaggio "Configurazione di Error Reporting", significa che il progetto Google Cloud non ha gruppi di errori da visualizzare.