Stackdriver Logging(Log Viewer)で見た目の良いログを出力するためのあれこれ


この記事は @chidakiyo さんの [GAE Flexible Environmentでアプリケーションのログを出力するためにやったこと。
](http://qiita.com/chidakiyo/items/1452ab1ea83279a8e485) が記事にしてくれたので、もう少しマニアックなところを載せようと思って書いたものです。

GAE FEでのログ出力に関しては上記記事を見ると良いと思います。

## GAEのログに憧れて

GAE FEや、Stackdriver Logging APIを利用して、Log Viewerでログを見れる状態にするとあることに気が付きます。

**GAEのログ**
![Kobito.vO8zuM.png](https://qiita-image-store.s3.amazonaws.com/0/2965/f004e8f3-5b94-1aa5-ddcf-6ea342c08652.png "Kobito.vO8zuM.png")

**GAE以外のログ**
![Kobito.116tC4.png](https://qiita-image-store.s3.amazonaws.com/0/2965/6c449355-3b9c-573a-5ed8-a6de778a2216.png "Kobito.116tC4.png")


そうです。 GAEのログには以下のような特徴があります。

1. 1リクエスト中のログをまとめられる
2. POSTやステータスコードなどHTTP Requestに関連した情報が表示される
3. msecまでしっかり出ている

超素敵ですね。 FEのログでも同じようなログが出したいですね！
今回はFEできれいなログを出せるようにゴニョゴニョしたいと思います。

## まとめ

先にまとめを書いておくときれいなログを出すためには

1. jsonPayloadを利用する
2. "@type": "type.googleapis.com/google.appengine.logging.v1.RequestLog" をつける
3. http系のプロパティを設定する
4. lineプロパティに配列でメッセージを入れる

できれいなログが出せます。


## FEできれいなログを出すための道のり

このセクションはきれいなログを出すためにアレコレした道のりです。
技術的にはあんまり情報無いので読まなくても良いです。

### LogFormatを探す
きれいな出すにはどうすれば良いのかと思いStackdriver Logging APIのドキュメントを見てみました。

https://cloud.google.com/logging/docs/view/logs_index

が....

ある程度ログのフォーマット(≒Strickdriver Logging APIのjsonフォーマット)については記載がありますが、どのようなログフォーマットでどのような見た目になるかの記載はありません。

そこでLog ViewerのGAEのログをもう一度見てます。

![Kobito.l2lrtT.png](https://qiita-image-store.s3.amazonaws.com/0/2965/3b53fe02-de64-bc75-2ad3-58b7a215a225.png "Kobito.l2lrtT.png")

上記のようにログフォーマットが表示されていますのでこれを修正してStackdriver Logging APIに投げて同じようなログがでるか試してみましょう。

表示されていたログ(一部修正)

```json:ログ.json
{
 "protoPayload": {
  "@type": "type.googleapis.com/google.appengine.logging.v1.RequestLog",
  "appId": "s~appid",
  "versionId": "1-34-6",
  "requestId": "111111",
  "ip": "104.155.110.139",
  "startTime": "2016-12-11T03:34:33.931996Z",
  "endTime": "2016-12-11T03:34:33.993449Z",
  "latency": "0.061453s",
  "megaCycles": "11",
  "method": "GET",
  "resource": "/hoge/fuga",
  "httpVersion": "HTTP/1.1",
  "status": 302,
  "responseSize": "325",
  "userAgent": "GoogleStackdriverMonitoring-UptimeChecks(https://cloud.google.com/monitoring",
  "urlMapEntry": "page.main.app",
  "host": "default.appid.appspot.com",
  "cost": 0.0000001,
  "instanceIndex": -1,
  "instanceId": "4444",
  "line": [
   {
    "time": "2016-12-11T03:34:33.991600Z",
    "severity": "INFO",
    "logMessage": "REDIECT URI : /en?"      
   }
  ],
  "appEngineRelease": "1.9.48",
  "traceId": "3333",
 },
 "insertId": "2016-12-10|19:34:36.536369-08|192.168.11.1|2013856561",
 "httpRequest": {
  "status": 302
 },
 "resource": {
  "type": "gae_app"    ,
  "labels": {
   "version_id": "1-34-6"     ,
   "module_id": "default"     ,
   "zone": "us2"     
  },
 },
 "timestamp": "2016-12-11T03:34:33.931996Z",
 "severity": "INFO"   ,
 "labels": {
  "appengine.googleapis.com/request_id": "111111"    ,
  "appengine.googleapis.com/clone_id": "222222"    ,
 },
 "logName": "projects/appid/logs/appengine.googleapis.com%2Frequest_log"   ,
 "operation": {
  "id": "111111"    ,
  "producer": "appengine.googleapis.com/request_id"    
 }
}
```

### GAEのログを修正してAPIを叩いてみる

ではまず上記のJSONを展開しAPIが受け取れる形にしてAPI Explorerを利用してStackdriver logging API v2 logging.entries.writeに投げてみます。

https://developers.google.com/apis-explorer/#search/log/logging/v2/logging.entries.write

投げるJSON ※実際に投げる場合はapp_idを変換してください。

```json:投げる.json
{
  "entries": 
  [
    {
 "protoPayload": {
  "@type": "type.googleapis.com/google.appengine.logging.v1.RequestLog",
  "appId": "s~appid",
  "versionId": "1-34-6",
  "requestId": "111111",
  "ip": "104.155.110.139",
  "startTime": "2016-12-11T03:34:33.931996Z",
  "endTime": "2016-12-11T03:34:33.993449Z",
  "latency": "0.061453s",
  "megaCycles": "11",
  "method": "GET",
  "resource": "/hoge/fuga",
  "httpVersion": "HTTP/1.1",
  "status": 302,
  "responseSize": "325",
  "userAgent": "GoogleStackdriverMonitoring-UptimeChecks(https://cloud.google.com/monitoring",
  "urlMapEntry": "page.main.app",
  "host": "default.appid.appspot.com",
  "cost": 0.0000001,
  "instanceIndex": -1,
  "instanceId": "4444",
  "line": [
   {
    "time": "2016-12-11T03:34:33.991600Z",
    "severity": "INFO",
    "logMessage": "REDIECT URI : /en?"      
   }
  ],
  "appEngineRelease": "1.9.48",
  "traceId": "3333",
 },
 "insertId": "2016-12-10|19:34:36.536369-08|192.168.11.1|2013856561",
 "httpRequest": {
  "status": 302
 },
 "resource": {
  "type": "gae_app"    ,
  "labels": {
   "version_id": "1-34-6"     ,
   "module_id": "default"     ,
   "zone": "us2"     
  },
 },
 "timestamp": "2016-12-11T03:34:33.931996Z",
 "severity": "INFO"   ,
 "labels": {
  "appengine.googleapis.com/request_id": "111111"    ,
  "appengine.googleapis.com/clone_id": "222222"    ,
 },
 "logName": "projects/appid/logs/appengine.googleapis.com%2Frequest_log"   ,
 "operation": {
  "id": "111111"    ,
  "producer": "appengine.googleapis.com/request_id"    
 }
}
  ]
}
```

では結果を見てみましょう。

![Kobito.5RXTyK.png](https://qiita-image-store.s3.amazonaws.com/0/2965/10ff72f6-c41d-32e7-9adb-e4f664f11de9.png "Kobito.5RXTyK.png")

見事にできてますね！

### FEでこのログを流してみる

では実際にこのログをFEで流しています。json形式のログを流す場合は 
ファイル名を`.json`にする必要があり、ファイル出力先は`/var/log/app_engine`の直下か`/var/log/app_engine/custom_logs`下にします。

今回はわざわざアプリケーションからやるのは大変なので直接sshで入ってファイルを作成して流してみたいと思います。

まずFEにSSHします。

FEへはCloud ConsoleからSSHできます。

![Kobito.6WGMq5.png](https://qiita-image-store.s3.amazonaws.com/0/2965/556bc1da-70ae-1cea-efba-21b7c95fce75.png "Kobito.6WGMq5.png")

次にアプリケーションのコンテナに入ります。

```bash:feのコンテナに入る
$ sudo docker exec -it gaeapp bash
```

適当にログを置きます。

```bash:feのコンテナ
$ vi /var/log/app_engine/custom_logs/test.log.json
```

以下を置きます。 ※app_idとかは適当に修正してください。 実際は1行です。

```json:出力する予定のjson
{
  "@type": "type.googleapis.com/google.appengine.logging.v1.RequestLog",
  "appId": "s~app_id",
  "versionId": "1-34-6",
  "requestId": "111111",
  "ip": "104.155.110.139",
  "startTime": "2016-12-11T03:34:33.931996Z",
  "endTime": "2016-12-21T03:34:33.993449Z",
  "latency": "0.061453s",
  "megaCycles": "11",
  "method": "GET",
  "resource": "/hoge/fuga",
  "httpVersion": "HTTP/1.1",
  "status": 302,
  "responseSize": "325",
  "userAgent": "GoogleStackdriverMonitoring-UptimeChecks(https://cloud.google.com/monitoring",
  "urlMapEntry": "page.main.app",
  "host": "default.app_id.appspot.com",
  "cost": 0.0000001,
  "instanceIndex": -1,
  "instanceId": "4444",
  "line": [
   {
    "time": "2016-12-21T03:34:33.991600Z",
    "severity": "INFO",
    "logMessage": "REDIECT URI : /en?"      
   }
  ],
  "appEngineRelease": "1.9.48",
  "traceId": "3333"
 }
```

少し待ったらログコンソールを見てみましょう！

![Kobito.rLrfW4.png](https://qiita-image-store.s3.amazonaws.com/0/2965/0af12b17-6b99-5852-5310-2cf3a92554b3.png "Kobito.rLrfW4.png")

以下のように新しいログが追加されています。

![Kobito.b5qgGd.png](https://qiita-image-store.s3.amazonaws.com/0/2965/7863c752-8f40-6207-0b77-76223c89dc00.png "Kobito.b5qgGd.png")

素晴らしい！

## ということできれいなログを出すためには

きれいなログを出すためには以下の様なログで1行で出力します。

```josn
{
  "@type": "type.googleapis.com/google.appengine.logging.v1.RequestLog",
  "appId": "s~app_id",
  "versionId": "1-34-6",
  "requestId": "111111",
  "ip": "104.155.110.139",
  "startTime": "2016-12-11T03:34:33.931996Z",
  "endTime": "2016-12-21T03:34:33.993449Z",
  "latency": "0.061453s",
  "megaCycles": "11",
  "method": "GET",
  "resource": "/hoge/fuga",
  "httpVersion": "HTTP/1.1",
  "status": 302,
  "responseSize": "325",
  "userAgent": "GoogleStackdriverMonitoring-UptimeChecks(https://cloud.google.com/monitoring",
  "urlMapEntry": "page.main.app",
  "host": "default.app_id.appspot.com",
  "cost": 0.0000001,
  "instanceIndex": -1,
  "instanceId": "4444",
  "line": [
   {
    "time": "2016-12-21T03:34:33.991600Z",
    "severity": "INFO",
    "logMessage": "REDIECT URI : /en?"      
   }
  ],
  "appEngineRelease": "1.9.48",
  "traceId": "3333"
 }
```

なお一部のプロパティなどは無くて良いはずです。`@type`が無いと見た目が崩れました。
また、`message`というプロパティが1階層目に含まているとtextログ扱いになってしまいします。(fluentd-google-cloud-pluginの仕様)

またlineに複数のログを詰めれば複数のログをまとめて出すことが可能ですが、
GAEの様に1リクエスト毎にログを出すためには、1リクエスト中のログをバッファリングしておき、リクエストの処理終了時にログを出力する必要があり、ちょい手間が必要です。

では良いFEライフを！