Go 用の Error Reporting の設定

は、

アルファ版 です。

これは、Go 用 Stackdriver Error Reporting パッケージ のアルファ版リリースです。 これらのライブラリは下位互換性のない方法で変更される可能性があり、本番環境での使用はおすすめしません。 これ は、SLA または非推奨ポリシーの対象ではありません。

Go 用の Stackdriver Error Reporting パッケージを使用して、Go アプリケーションから Stackdriver Error Reporting にエラーレポートを送信できます。

Error Reporting は、App Engine、Compute Engine、Google Kubernetes Engine などの一部の Google Cloud Platform プロダクトに統合されています。Error Reporting は、それらのプロダクトで実行中のアプリケーションによって Stackdriver Logging に記録されたエラーを表示します。詳細については、Google Cloud Platform での実行をご覧ください。

Stackdriver Logging を使用してエラーデータを Error Reporting に送信することもできます。データのフォーマット要件については、Stackdriver Logging でのエラー メッセージのフォーマットをご覧ください。

始める前に

1. Google アカウントにログインします。

   Google アカウントをまだお持ちでない場合は、新しいアカウントを登録します。

2. GCP プロジェクトを選択または作成します。

   注: このチュートリアルで作成するリソースをそのまま保持する予定でない場合、既存のプロジェクトを選択するのではなく、新しいプロジェクトを作成してください。チュートリアルの完了後にそのプロジェクトを削除すれば、プロジェクトとチュートリアルに関連するすべてのリソースを削除できます。

   [リソースの管理] ページに移動

3. プロジェクトに対して課金が有効になっていることを確認します。

   課金を有効にする方法について

{% dynamic if "no_credentials" in setvar.task_params %}{% dynamic setvar credential_type %}NO_AUTH{% dynamic endsetvar %}{% dynamic if not setvar.redirect_url %}{% dynamic setvar redirect_url %}https://console.cloud.google.com{% dynamic endsetvar %}{% dynamic endif %}{% dynamic endif %}{% dynamic if setvar.in_henhouse_no_auth_whitelist %}{% dynamic if not setvar.credential_type %}{% dynamic setvar credential_type %}NO_AUTH{% dynamic endsetvar %}{% dynamic endif %}{% dynamic elif setvar.in_henhouse_service_account_whitelist %}{% dynamic if not setvar.credential_type %}{% dynamic setvar credential_type %}SERVICE_ACCOUNT{% dynamic endsetvar %}{% dynamic endif %}{% dynamic endif %}{% dynamic if not setvar.service_account_roles and setvar.credential_type == "SERVICE_ACCOUNT" %}{% dynamic setvar service_account_roles %}{% dynamic endsetvar %}{% dynamic endif %}{% dynamic setvar console %}{% dynamic if "no_steps" not in setvar.task_params %}
4. {% dynamic endif %}{% dynamic if setvar.api_list %}{% dynamic if setvar.in_henhouse_no_auth_whitelist or setvar.in_henhouse_service_account_whitelist %}GCP Console プロジェクトをセットアップします。

   プロジェクトをセットアップする

   クリックして、以下を行います。

   • プロジェクトを作成または選択します。
   • プロジェクトに{% dynamic if setvar.api_names %}{% dynamic print setvar.api_names %}{% dynamic else %}必要な{% dynamic endif %}{% dynamic if "," in setvar.api_list %} API{% dynamic elif "API" in setvar.api_names %}{% dynamic else %} API{% dynamic endif %} を有効にします。
   {% dynamic if setvar.credential_type == 'SERVICE_ACCOUNT' %}
   • サービス アカウントを作成します。
   • JSON として秘密鍵をダウンロードします。
   {% dynamic endif %}

   これらのリソースは、GCP Console でいつでも表示および管理できます。

   {% dynamic else %}{% dynamic if "no_text" not in setvar.task_params %}{% dynamic if setvar.api_names %}{% dynamic print setvar.api_names %}{% dynamic else %}必要な{% dynamic endif %}{% dynamic if "," in setvar.api_list %} API{% dynamic elif "API" in setvar.api_names %}{% dynamic else %} API{% dynamic endif %} を有効にします。 {% dynamic endif %}

   {% dynamic if "," in setvar.api_list %}API{% dynamic else %}API{% dynamic endif %}を有効にする

   {% dynamic endif %}{% dynamic endif %}{% dynamic if "no_steps" not in setvar.task_params %}
{% dynamic endif %}{% dynamic endsetvar %}{% dynamic print setvar.console %}

クライアント ライブラリのインストール

Go 用の Stackdriver Error Reporting パッケージを使用すると、ほとんどの場所で動作している Go アプリケーションから報告されるエラーをモニタリングして表示できます。

1. go get を使用してパッケージをインストールします。

   go get -u cloud.google.com/go/errorreporting

インストールの詳細については、Go 用 Stackdriver Error Reporting パッケージのドキュメントをご覧ください。公開バグトラッカーを使用して問題を報告することもできます。

クライアント ライブラリの構成

Go 用の Stackdriver Error Reporting パッケージの動作をカスタマイズできます。godoc をご覧ください。

エラーの報告

GitHub で表示 フィードバック

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

import (
	"context"
	"log"
	"net/http"

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

var errorClient *errorreporting.Client

func main() {
	ctx := context.Background()

	// Sets your Google Cloud Platform project ID.
	projectID := "YOUR_PROJECT_ID"

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

	resp, err := http.Get("not-a-valid-url")
	if err != nil {
		logAndPrintError(err)
		return
	}
	log.Print(resp.Status)
}

func logAndPrintError(err error) {
	errorClient.Report(errorreporting.Entry{
		Error: err,
	})
	log.Print(err)
}

パニックやエラーの報告方法のその他の例については、godoc をご覧ください。

Google Cloud Platform での実行

Go 用 Stackdriver Error Reporting パッケージを使用するには、Cloud IAM Error Reporting 書き込み役割が必要です。ほとんどの Google Cloud Platform コンピューティング プラットフォームでは、デフォルトでこの役割が提供されています。

App Engine フレキシブル環境

App Engine は、デフォルトで Error Reporting 書き込み役割を付与します。

Go 用の Stackdriver Error Reporting パッケージは、明示的に認証情報を提示しなくても使用できます。

App Engine のフレキシブル環境のアプリケーションでは、Error Reporting が自動的に有効になります。特別な設定は必要ありません。

注: stderr に書き込まれたエラーログは、Go 用 Stackdriver Error Reporting パッケージを直接使用しなくても、Error Reporting によって自動的に処理されます。

GKE

GKE では、次のコマンド例に示すように、クラスタの作成時に cloud-platform アクセス スコープを追加する必要があります。

gcloud container clusters create example-cluster-name --scopes https://www.googleapis.com/auth/cloud-platform

Compute Engine

Compute Engine VM インスタンスを使用する場合は、各インスタンスに cloud-platform アクセス スコープを追加します。Google Cloud Platform Console で新しいインスタンスを作成する場合は、[インスタンスの作成] パネルの [ID と API へのアクセス] セクションで行うことができます。Compute Engine のデフォルト サービス アカウントや別のサービス アカウントを使用して、[ID と API へのアクセス] セクションの [すべての Cloud API に完全アクセス権を許可] を選択します。どのサービス アカウントを選択する場合でも、GCP Console の [IAM と管理] セクションで、そのアカウントに Error Reporting 書き込み役割が付与されていることを確認してください。

ローカルやその他の場所での実行

Google Cloud Platform の外部で Go 用 Stackdriver Error Reporting ライブラリを使用するには、GCP プロジェクト ID と該当するサービス アカウント認証情報を Go 用 Stackdriver Error Reporting ライブラリに直接指定する必要があります。これは、ユーザー独自のワークステーション、データセンターのコンピュータ、または別のクラウド プロバイダの VM インスタンスでこのライブラリを実行する場合に適用されます。詳しくは、サービス アカウント認証情報の手動による取得と提供をご覧ください。

エラーレポートの表示

デプロイ後は、GCP Console の Error Reporting ダッシュボードでエラーレポートを表示できます。

Error Reporting ダッシュボードに移動

詳細については、エラーの表示をご覧ください。