Amazon EC2 上の Error Reporting の設定

次のいずれかの方法で、エラーを EC2 アプリケーションから Stackdriver Error Reporting に送信できます。

Stackdriver Logging にロギングする。すでに Stackdriver Logging を使用している場合、追加設定は不要です。エラーのフォーマット要件について詳しくは、Stackdriver Logging でのフォーマットエラーをご覧ください。
Stackdriver Error Reporting API を使用する。アプリケーションでは、REST API を使用して HTTP リクエストを送信したり、試験運用版のライブラリを複数の言語で使用したりできます。

ロギングを使用してエラーを報告する

EC2 アプリケーションを Stackdriver Error Reporting に接続するには、例外やその他のエラーを Stackdriver Logging に送信します。その際、エラーログを他のログから区別するために、エラー専用のログ名を使用してください。次に例を示します。

Stackdriver Logging API を有効にします。
APIを有効にする
EC2 インスタンスに、google-fluentd という Stackdriver Logging エージェントをインストールします。通常、ログを Logging に送信するには、このエージェントが EC2 インスタンスにインストールされていなければなりません。
例外とそのスタックトレースを Stackdriver Logging のログに記録するようにアプリケーションを変更します。エラー情報を他のログ情報から区別できるようなログ名を選択してください。

単一のエラーまたは例外に関する情報は、スタックトレースのすべてのフレームを含め、すべて同じログエントリに格納する必要があります。すべての情報が 1 つにまとめられていないと、Error Reporting で情報を取得できない可能性があります。ログエントリのペイロードに構造化 JSON 形式を使用すると、各エラーに関するさまざまな情報を含めることができます。

Java

以下を pom.xml ファイルに追加します。

compute/error-reporting/pom.xml

GitHub で表示

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

次に、例外データを送信するために、次のようなコードを使用します。

compute/error-reporting/src/main/java/com/example/compute/errorreporting/ExceptionUtil.java

GitHub で表示

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

次に、例外データを送信するために、次のようなコードを使用します。

error_reporting/fluent_on_compute/main.py

GitHub で表示

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 --save fluent-logger

次に、例外データを送信するために、次のようなコードを使用します。

GitHub で表示

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!');
});

Go

まず始めに、fluent-logger-golang パッケージをインストールします。

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

次に、エラーデータを送信するために、次のようなコードを使用します。

docs/error-reporting/fluent/main.go

GitHub で表示

package main

import (
	"log"
	"net/http"
	"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)
	http.ListenAndServe(":8080", nil)
}

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 を使用してエラーを書き込む

Stackdriver Error Reporting API は、エラー情報をサービスに書き込むための report エンドポイントを提供します。

Stackdriver Error Reporting API を有効にします。
APIを有効にする
REST API またはクライアントライブラリのいずれかを使用して、API にエラーを報告します。
- REST API
  
  API については、リファレンスドキュメントをご覧ください。
- クライアントライブラリの使用
  
  ライブラリは、限られた言語に存在し、アプリケーションから Error Reporting API を呼び出すのに役立ちます。
  - ASP.NET
  - Go（アルファ版）
  - Java（アルファ版）
  - Node.js（ベータ版）
  - Ruby（ベータ版）
  - Python（ベータ版）

サンプル

ASP.NET

Stackdriver ASP.NET NuGet パッケージにより、捕捉されなかった例外が ASP.NET ウェブアプリケーションから Stackdriver Error Reporting に報告されます。

NuGet パッケージをインストールする

Stackdriver ASP.NET NuGet パッケージを Visual Studio にインストールするには:

ソリューションを右クリックして、[ソリューションの NuGet パッケージの管理] を選択します。
[プレリリースを含む] チェックボックスを選択します。
Google.Cloud.Diagnostics.AspNet という名前のパッケージを検索し、インストールします。

用途

Stackdriver ASP.NET NuGet パッケージをインストールしたら、次のステートメントをアプリケーションコードに追加して Stackdriver へのエラーの送信を開始します。

using Google.Cloud.Diagnostics.AspNet;

例外の報告を有効にするには、次の HttpConfiguration コードを .NET ウェブアプリの Register メソッドに追加します（your-project-id は実際のプロジェクト ID に置き換えます）。

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

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

このメソッドを ASP.NET アプリに追加すると、発生したけれども捕捉されなかった例外が GCP Console の Stackdriver Error Reporting セクションの Google Cloud に報告されるため、これらの例外を確認できるようになります。

C#

次の例は、GoogleCloudPlatform/dotnet-docs-samples リポジトリにあります。これを使用するには、プロジェクトのビルド後に次のようにプロジェクト ID を指定します。

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

[YOUR_PROJECT_ID] は GCP Console の正しい値に置き換えます。

その後、次のようなコードで例外データを送信します。

error-reporting/api/ErrorReportingSample.cs

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

ロギングを使用してエラーを報告する

Java

Python

Node.js

Go

Error Reporting API を使用してエラーを書き込む

サンプル

ASP.NET

NuGet パッケージをインストールする

用途

C#

Go

Java

Node.js

Ruby

Python

フィードバックを送信...