More than 3 years have passed since last update.

GASのWebアプリを作成する時に GCPを使ってデバッグを簡単にする[Cloud Logging、Error Reporting]

Last updated at 2020-05-29Posted at 2020-05-29

#0-0. GASでWebアプリを作りたいけどデバッグしづらい

最近GASでdoPost関数などを利用したLineボットですとか、Webアプリケーションを作成することが良くあります。
その中でエラーが発生したとき、GoogleAppsコンソール画面[ https://script.google.com/home/executions ]では、エラーの詳細がなんかよくわかりません。

スクリプト中のConsole.log()の出力もできないのでスプレッドシートに出力する処理を作らなければいけなかったり、デバッグしづらいと思いました。そこで、Google Cloud Pratform（GCP）の[Cloud Logging]と[ErrorReporting]の2つを使ったらデバッグがとっても捗りました。

この記事は、この2つのサービスをGASで利用するための手順について纏めたものです。
GCP初心者の私は、意図せぬ課金が怖かったので、無料枠だけで利用するためのテクニックについても少し触れます。

#1-0. GCPのCloud Loggingを使おう

##1-1.GCPとCloud Logging概要
GCPはGoogleがクラウド上で提供するサービス群です。
色々なサービスがある中で今回は、[Cloud Logging]と[ErrorReporting]の2つを使います。

（公式）GCPの概要
https://cloud.google.com/docs/overview?hl=ja
（公式）GCPスタートガイド
https://cloud.google.com/gcp/getting-started?hl=ja
（公式）Cloud Loggingの概要
https://cloud.google.com/logging/?hl=ja
（公式）Error Reportingの概要
https://cloud.google.com/error-reporting?hl=ja

##1-2.GCP無料トライアル期間と無料使用枠
GCPは従量課金制の有料サービスですが、初年1年間の無料トライアル期間（300ドルクレジット付き）と、月単位の無料枠が用意されています。ちょっとした業務効率化ツールを作る程度でしたら十分無料枠だけで利用できるかと思います。

（公式）GCP無料枠
https://cloud.google.com/free/docs/gcp-free-tier?hl=ja
（公式）Cloud Loggingの料金
https://cloud.google.com/stackdriver/pricing?hl=ja#logging-costs

##1-3. 必要なもの

支払いに使用するクレジットカード、デビットカード、または銀行口座
- 無料枠だけで使う予定でも登録が必要になります。
Googleアカウント

#2-0.GCPの設定方法
GCPをGASで利用する最小手順は下記です。

GCPアカウントの登録
GCPプロジェクトの登録
GCPプロジェクトのOAuthの同意画面設定
GASプロジェクトをGCPプロジェクトに変更

##2-1.GCPアカウントの登録
下記の記事などを参考にGCPに無料トライアル登録します。

（いつも隣にITのお仕事）Google Cloud Platform（GCP）に無料トライアル登録をする方法
https://tonari-it.com/google-cloud-platform-free-trial/

##2-2. GCPプロジェクトの設定
GCPのサービスを利用するには、なにをするにもプロジェクトの作成が必要です。
プロジェクトに利用するサービスを有効化しながら使います。
GCPの利用料の支払いもプロジェクト単位で請求されます。

###2-2-1.GCPプロジェクトの新規作成
GCPプロジェクトを作成していきます。

GCPコンソール画面を開きます。https://console.cloud.google.com/?hl=ja

画面上部の▼をクリックします。（ひとつもプロジェクトが無い状態ですと、画像の画面と若干異なるかもしれません。）

新しいプロジェクトをクリックします。

プロジェクト名を入力します。

作成したプロジェクトがプロジェクトリストに表示されますので作成したプロジェクトをクリックします。

新規GCPプロジェクトのトップ画面に遷移します。画像の赤枠のところにあるプロジェクト番号をコピ-します。後程必要になります。

###2-2-2. OAuthの同意画面の設定
GASと紐づけるにはOAuthの同意画面の設定を行う必要がありますので設定します。

コンソール画面左上のAPIとサービス⇒OAuthの同意画面

OAuthの同意画面に遷移しますので、Usertypeを選択して作成をクリックします。

アプリケーション名を入力します。ここで入力するのはGASのスクリプトファイルのプロジェクト名となります。

###2-3-1.GASプロジェクトをGCPプロジェクトに変更

GASのスクリプトファイルを開きます。リソース→CloudPratformプロジェクトをクリックします。

先ほどコピーしたGCPプロジェクト番号をテキストボックスに張り付け[プロジェクトを設定]をクリックします。

確認画面が表示されますので確認して閉じます。[GCP管理設定を1度行ってしまうとappsScriptの管理に戻すことはできないようです。]
別のGCPプロジェクトに管理プロジェクトを変更することはできます。

#3-0 GCPでのログの確認
ここまでGASでGCPを利用する設定が出来ました。
実際に確認してみたいと思います。

今回はGASで作ったChatwork Botで試していきます。
Chatwork Botにメッセージを送ってエラーを発生させてみました。またスクリプト中にConsole.log('hoge')の一文を加えてログで確認できるか試します。

##3-1 Cloud Loggingの確認

GASを開き、表示→StackdriverLoggingをクリックします。

図のように、いくつかログ出力結果を確認することが出来ました！Console.log()の引数に渡した"hoge"も確認出来ました！

##3-2-1 Error Reportingの確認

GASを開き、表示→StackdriverErrorReportingをクリックします。

こちらはErrorReportingの画面です。エラーが表示されます。

エラーステータスを変更できたり、発生回数を見れます。デバッグに便利です。

###3-2-2 Error Reportingの通知設定
エラー発生時にメール通知を受け取ることが出来ます。

#4-0.課金管理

##4-1.意図せぬ課金対策と無料枠で頑張る方法

予算アラートを設定しましょう
- 予算アラートを設定すると設定した費用を超えそうな場合・超えた場合にメール通知を受け取ることが出来ます。
支払いレポートを確認する
- GCPプロジェクトがどれくらいの費用になっているか支払いレポートを定期チェックしましょう。
GCPプロジェクトを作りまくらない
- 課金はプロジェクト単位で発生しますので、プロジェクトが増えると管理が難しくなります。不要になったプロジェクトは削除したり、一つにまとめること出来るものはまとめましょう。
ログをエクスポートする。ログレベルを下げる
- Cloud Loggingはログ容量で課金されていきます。増えてきたらエクスポートする、とか、出力するログレベルを下げてログ出力を抑えたりすることにより費用を抑えるテクニックがあるようです。