‫Google משתמשת בטכנולוגיית AI כדי לתרגם תוכן לשפה המועדפת עליך. בתרגומים כאלו עשויות להיות שגיאות.

הגדרה ב-Compute Engine

‫Error Reporting מאפשר לכם לצבור קריסות ולאבחן חריגות בזמן ריצה מהאפליקציות שלכם ב-Compute Engine. אפשר לשלוח נתוני שגיאות על ידי הזרמת יומנים אל Cloud Logging או על ידי קריאה ישירה אל Error Reporting API. אם אתם משתמשים ב-Logging, רשומות היומן צריכות לעמוד בדרישות הפורמט.

שימוש ברישום ביומן לדיווח על שגיאות

כדי לקשר את האפליקציות שלכם ב-Compute Engine אל Error Reporting, אתם יכולים לשלוח את החריגים או שגיאות אחרות אל Logging באמצעות אחד מהסוכנים הבאים:

Ops Agent
Legacy Logging agent

סוכן תפעול

כדי להגדיר את Error Reporting לשימוש בסוכן תפעול, מבצעים את השלבים הבאים:

מתקינים את סוכן תפעול בהתאם לסביבה. הוראות מפורטות מופיעות במאמר בנושא התקנת סוכן התפעול.
מגדירים את סוכן תפעול לאיסוף יומני האפליקציות ולעיצוב שלהם בצורה נכונה.
- באפליקציות נתמכות של צד שלישי: סוכן התפעול מספק מקלטי רישום ביומן שהוגדרו מראש, שתופסים ומנתחים באופן אוטומטי רשומות ביומן לפורמטים מובנים שמוכרים על ידי Error Reporting. מידע על אפליקציות נתמכות של צד שלישי זמין במאמר בנושא מעקב אחרי אפליקציות של צד שלישי.
- באפליקציות בהתאמה אישית: מגדירים מקלט לרישום ביומן כדי לציין את המיקומים של קובצי היומן, ומשייכים אותו לאחד מהמעבדים הבאים:
  - אם האפליקציה כותבת מעקב אחר מחסנית (stack trace) של טקסט פשוט בכמה שורות, צריך להשתמש במעבד parse_multiline.
  - משתמשים בparse_json מעבד אם האפליקציה כותבת יומנים כמחרוזות JSON.
  הוראות מפורטות זמינות במאמר בנושא הגדרת סוכן תפעול.
אם האפליקציה לא יוצרת עקבות מחסנית רגילים, צריך לשנות את האפליקציה כך שהיא תתעד חריגים ואת עקבות המחסנית שלהם ב-Cloud Logging.

צריך לכלול את כל המידע על שגיאה או חריגה יחידה באותו רשומה ביומן, כולל כל המסגרות של כל דוח קריסות. אם כל המידע לא נמצא ביחד, יכול להיות ש-Error Reporting לא יזהה את השגיאה. אתם יכולים להשתמש בפורמט JSON מובנה עבור מטען הייעודי (payload) של רשומות ביומן כדי לכלול סוגים שונים של מידע לכל שגיאה.

סוכן Logging מדור קודם

כדי להגדיר את Error Reporting לשימוש בסוכן Logging מדור קודם, מבצעים את השלבים הבאים:

מתקינים את סוכן Logging google-fluentd בהתאם לסביבה שלכם. הוראות מפורטות מופיעות במאמר בנושא התקנת סוכן Logging.
משנים את האפליקציה כך שהיא תתעד חריגים ואת עקבות המחסנית שלהם ב-Logging.

צריך לכלול את כל המידע לגבי שגיאה או חריג אחד באותו רשומה ביומן, כולל כל המסגרות של כל דוח קריסות. אם כל המידע לא נמצא יחד, יכול להיות שהתכונה 'דיווח על שגיאות' לא תזהה את השגיאה. אתם יכולים להשתמש בפורמט JSON מובנה עבור מטען הייעודי (payload) של רשומות היומן כדי לכלול סוגים שונים של מידע לכל שגיאה.

Java

מוסיפים לקובץ pom.xml את הנתונים הבאים:

<dependency>
  <groupId>org.fluentd</groupId>
  <artifactId>fluent-logger</artifactId>
  <version>0.3.4</version>
</dependency>

לאחר מכן משתמשים בקוד כמו זה שבהמשך כדי לשלוח את נתוני החריגה:

public class ExceptionUtil {
  private static FluentLogger ERRORS = FluentLogger.getLogger("myapp");

  public static void main(String[] args) {
    try {
      throw new Exception("Generic exception for testing Stackdriver");
    } catch (Exception e) {
      report(e);
    }
  }

  public static void report(Throwable ex) {
    StringWriter exceptionWriter = new StringWriter();
    ex.printStackTrace(new PrintWriter(exceptionWriter));
    Map<String, Object> data = new HashMap<>();
    data.put("message", exceptionWriter.toString());
    Map<String, String> serviceContextData = new HashMap<>();
    serviceContextData.put("service", "myapp");
    data.put("serviceContext", serviceContextData);
    // ... add more metadata
    ERRORS.log("errors", data);
  }
}

Python

קודם כול, מתקינים את ספריית fluent-logger-python:

sudo pip install fluent-logger

לאחר מכן משתמשים בקוד כמו זה שבהמשך כדי לשלוח את נתוני החריגה:

import traceback

import fluent.event
import fluent.sender


def simulate_error():
    fluent.sender.setup("myapp", host="localhost", port=24224)

    def report(ex):
        data = {}
        data["message"] = "{0}".format(ex)
        data["serviceContext"] = {"service": "myapp"}
        # ... add more metadata
        fluent.event.Event("errors", data)

    # report exception data using:
    try:
        # simulate calling a method that's not defined
        raise NameError
    except Exception:
        report(traceback.format_exc())

Node.js

קודם כול, מתקינים את ספריית fluent-logger-node:

npm install fluent-logger

לאחר מכן משתמשים בקוד כמו זה שבהמשך כדי לשלוח את נתוני החריגה:

const structuredLogger = require('fluent-logger').createFluentSender('myapp', {
  host: 'localhost',
  port: 24224,
  timeout: 3.0,
});

const report = (err, req) => {
  const payload = {
    serviceContext: {
      service: 'myapp',
    },
    message: err.stack,
    context: {
      httpRequest: {
        url: req.originalUrl,
        method: req.method,
        referrer: req.header('Referer'),
        userAgent: req.header('User-Agent'),
        remoteIp: req.ip,
        responseStatusCode: 500,
      },
    },
  };
  structuredLogger.emit('errors', payload);
};

// Handle errors (the following uses the Express framework)
// eslint-disable-next-line no-unused-vars
app.use((err, req, res, next) => {
  report(err, req);
  res.status(500).send(err.response || 'Something broke!');
});

המשך

קודם כול, מתקינים את החבילה fluent-logger-golang:

go get github.com/fluent/fluent-logger-golang/

אחר כך משתמשים בקוד כמו זה שבהמשך כדי לשלוח נתוני שגיאות:


package main

import (
	"log"
	"net/http"
	"os"
	"runtime"

	"github.com/fluent/fluent-logger-golang/fluent"
)

var logger *fluent.Fluent

func main() {
	var err error
	logger, err = fluent.New(fluent.Config{
		FluentHost: "localhost",
		FluentPort: 24224,
	})
	if err != nil {
		log.Fatal(err)
	}

	http.HandleFunc("/demo", demoHandler)

	port := os.Getenv("PORT")
	if port == "" {
		port = "8080"
	}
	log.Printf("Listening on port %s", port)
	if err := http.ListenAndServe(":"+port, nil); err != nil {
		log.Fatal(err)
	}
}

func report(stackTrace string, r *http.Request) {
	payload := map[string]interface{}{
		"serviceContext": map[string]interface{}{
			"service": "myapp",
		},
		"message": stackTrace,
		"context": map[string]interface{}{
			"httpRequest": map[string]interface{}{
				"method":    r.Method,
				"url":       r.URL.String(),
				"userAgent": r.UserAgent(),
				"referrer":  r.Referer(),
				"remoteIp":  r.RemoteAddr,
			},
		},
	}
	if err := logger.Post("myapp.errors", payload); err != nil {
		log.Print(err)
	}
}

// Handler for the incoming requests.
func demoHandler(w http.ResponseWriter, r *http.Request) {
	// How to handle a panic.
	defer func() {
		if e := recover(); e != nil {
			stack := make([]byte, 1<<16)
			stackSize := runtime.Stack(stack, true)
			report(string(stack[:stackSize]), r)
		}
	}()

	// Panic is triggered.
	x := 0
	log.Println(100500 / x)
}

שימוש ב-Error Reporting API כדי לכתוב שגיאות

‫Error Reporting API מספק נקודת קצה report לכתיבת מידע על שגיאות לשירות.

מפעילים את Error Reporting API, אם הוא עדיין לא מופעל.
תפקידים שנדרשים להפעלת ממשקי API
כדי להפעיל ממשקי API, נדרשת ההרשאה serviceusage.services.enable. אם יצרתם את הפרויקט, סביר להניח שכבר יש לכם את ההרשאה הזו דרך התפקיד 'בעלים' (roles/owner). אחרת, תוכלו לקבל את ההרשאה הזו דרך התפקיד 'אדמין בממשק Service Usage' (roles/serviceusage.serviceUsageAdmin). איך מקצים תפקידים
להפעלת ה-API
אפשר לדווח על שגיאות ל-API באמצעות API בארכיטקטורת REST או ספריית לקוח.
- ‫API בארכיטקטורת REST
  
  מידע על ה-API מופיע במאמרי העזרה.
- שימוש בספריות לקוח
  
  יש ספריות במספר מוגבל של שפות שיכולות לעזור לכם לקרוא ל-Error Reporting API מהאפליקציה:
  - ASP.NET
  - Go
  - Java
  - Node.js
  - Ruby
  - Python
  - PHP

דוגמאות

ASP.NET

חבילת ASP.NET NuGet מדווחת על חריגים שלא נתפסו מאפליקציות אינטרנט של ASP.NET אל Error Reporting.

התקנת חבילת NuGet

כדי להתקין את חבילת Stackdriver ASP.NET NuGet ב-Visual Studio:

לוחצים לחיצה ימנית על הפתרון ובוחרים באפשרות Manage NuGet packages for solution (ניהול חבילות NuGet לפתרון).
מסמנים את תיבת הסימון Include prerelease (הכללת גרסת טרום-הפצה).
מחפשים את החבילה בשם Google.Cloud.Diagnostics.AspNet ומתקינים אותה.

Usage

אחרי שמתקינים את חבילת Stackdriver ASP.NET NuGet, מוסיפים את ההצהרה הבאה לקוד האפליקציה כדי להתחיל לשלוח שגיאות ל-Stackdriver:

using Google.Cloud.Diagnostics.AspNet;

כדי להפעיל את הדיווח על חריגים, מוסיפים את הקוד HttpConfiguration הבא לשיטה Register של אפליקציית האינטרנט שלכם ב-‎.NET אחרי שמחליפים את your-project-id במזהה הפרויקט בפועל:

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));
    // ...
}

אחרי שמוסיפים את השיטה הזו לאפליקציית ASP.NET, אפשר לראות את כל החריגים שלא נתפסו שמתרחשים בזמן שהם מדווחים ל- Google Cloudבקטע Error Reporting במסוף Google Cloud .

C#‎

הדוגמה הבאה מופיעה במאגר GoogleCloudPlatform/dotnet-docs-samples. כדי להשתמש בו, אחרי שיוצרים את הפרויקט, מציינים את מזהה הפרויקט:

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

חשוב להחליף את [YOUR_PROJECT_ID] בערך הנכון מהמסוףGoogle Cloud .

לאחר מכן, שולחים נתוני חריגים באמצעות קוד שדומה לקוד הבא:

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();
    }
}

הצגת קבוצות של שגיאות

נכנסים לדף Error Reporting במסוף Google Cloud :

עבור אל Error Reporting

אפשר גם להשתמש בסרגל החיפוש כדי למצוא את הדף הזה.

הגדרה ב-Compute Engine קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

שימוש ברישום ביומן לדיווח על שגיאות

סוכן תפעול

סוכן Logging מדור קודם

Java

Python

Node.js

המשך

שימוש ב-Error Reporting API כדי לכתוב שגיאות

דוגמאות

ASP.NET

התקנת חבילת NuGet

Usage

C#‎

המשך

Java

Node.js

Ruby

Python

PHP

הצגת קבוצות של שגיאות

הגדרה ב-Compute Engine