開発者ログの閲覧

サーバー上の開発者ログ閲覧は、コマンドラインツールで行います。

インストール

コマンドラインのインストール方法は こちら をご参照ください。

開発者ログの閲覧

開発者ログを閲覧するには、次のようなコマンドを実行します。

node bin/kii-logs.js -t \
  --site jp \
  --app-id <your_app_id> \
  --app-key <your_app_key> \
  --client-id <your_client_id> \
  --client-secret <your_client_secret>

指定可能なオプションは次のとおりです。

  • -h、--help:ヘルプを表示。
  • --app-id:AppID。
  • --app-key:AppKey。
  • --client-id:ClientID。
  • --client-secret:ClientSecret。
  • --token:管理者トークン(CilentID と ClientSecret の代わりとして利用可能)
  • -t、--tail:待機状態にして出力の最後を監視し、新しいログが追加される度にこれを表示。
  • -n、--num:出力するログ数。最大値は 1500 行。指定のない場合のデフォルト値は 100。-t と同時に使用すると無視される。日時フィルタの指定がない場合、新しい方から指定件数だけ出力。
  • --site:サーバーの設置場所(usjpcn3sg、または eu
  • --use-utc:ログのタイムスタンプおよび日時フィルター(date-from、date-to)を UTC 時間として処理する。省略時はローカルタイムとして処理される。
  • --http-proxy:使用する HTTP プロクシ(例:https://my.proxy:8080 )。ファイアウォールの内側など直接 Kii Cloud API にアクセスできない場合に利用。

必ず開発者ポータルで取得した値を --site--app-id--app-key--client-id および -- client-secret に設定してください(取得方法については こちら をご参照ください)。また ClientID と ClientSecret を指定する代わりに、アプリケーション管理者のトークンを --token オプションで指定することもできます(アプリケーション開発者のトークンの取得方法は アプリ管理者向け機能 を参照してください)。

ログは以下のように出力されます。タイムスタンプは ISO 8601 形式 で出力されます。

2014-04-09T10:36:00.215+09:00 [INFO] group.create description:New Group created groupID:Lannisters
2014-04-09T10:36:10.837+09:00 [INFO] user.register description:New user registered userID:114ebed2-08f7-4168-b916-ac5f6bf236c3 login-name:Cersei
2014-04-09T10:36:11.081+09:00 [DEBUG] user.login description:User logged in userID:114ebed2-08f7-4168-b916-ac5f6bf236c3 login-name:Cersei
2014-04-09T10:36:11.934+09:00 [INFO] bucket.user.object.create description:Bucket Object created userID:114ebed2-08f7-4168-b916-ac5f6bf236c3 bucketID:Joffrey bucket-type:rw objectID:17c92e3a-39d2-458b-9c29-64d228ff40e5 data-type:application/json; charset=UTF-8
2014-04-09T10:36:12.778+09:00 [DEBUG] bucket.user.acl.grant description:Granted ACL on Bucket userID:114ebed2-08f7-4168-b916-ac5f6bf236c3 bucketID:Joffrey bucket-type:rw verb:Q type:BUCKET
2014-04-09T10:36:12.899+09:00 [DEBUG] bucket.user.acl.grant description:Granted ACL on Bucket userID:114ebed2-08f7-4168-b916-ac5f6bf236c3 bucketID:Joffrey bucket-type:rw verb:C type:BUCKET
2014-04-09T11:45:46.000+09:00 [INFO] user.register description:New user registered userID:caa16ea6-151d-4df9-9fc7-d9c3ce1b90d9 login-name:Jaime

フィルター

必要な情報を効率的に確認するために、閲覧対象ログにフィルターをかけられます。

コマンドラインツールにおいて使用可能なフィルターには以下のものがあります。

  • --user-id:ユーザー ID でフィルターをかける。
  • --level:ログレベル(DEBUG、INFO、WARN、ERROR 等)でフィルターをかける。
  • --date-from、--date-to:日時でフィルターをかける(例:2013-01-01、2013-01-01 14:05:30)。

日時は ISO 8601 形式または YYYY-MM-DD HH:mm:ss 形式で指定してください。デフォルトではローカルタイムとして日時を処理します。UTC(協定世界時)として処理する場合は --use-utc オプションを指定してください。

フィルターを指定して開発者ログにフィルターをかける例を以下に挙げます。

node bin/kii-logs.js \
  --site jp \
  --user-id f9609a8e-d379-4106-af1b-2e2f092991f2 \
  --level INFO \
  --use-utc \
  --date-from 2014-01-01 \
  --date-to 2014-01-31 \
  --app-id <your_app_id> \
  --app-key <your_app_key> \
  --client-id <your_client_id> \
  --client-secret <your_client_secret>

開発者ログに表示される内容

開発者ログには以下の内容が出力されます。

  • ユーザーの作成、更新、削除、メール/電話番号認証、別サービスアカウントによる認証
  • グループの作成、更新、削除、メンバー追加/削除
  • Bucket の作成、検索、クエリ、削除
  • Object の作成、更新、削除
  • Object Body のアップロード完了/キャンセル、公開
  • 各種 ACL の付与、剥奪
    • アプリケーション(CR:新規 Bucket 作成、CT:新規トピック作成)
    • Bucket(C:新規 Object 作成、Q:検索、D:削除)
    • Object(R:読み込み、W:書き込み)
    • トピック(ST:トピック購読、MT:トピックへのメッセージ送信)
  • プッシュ通知のデバイスインストール、Bucket/トピック購読、メッセージ送信
  • Server Code の設置、更新、実行
  • Server Code 内で console.log による任意のログ出力

開発者ログのサイズ

Kii Cloud では 1 アプリケーションあたり 16 MB まで開発者ログを保存します。サイズを超過した場合は、古いログから削除されます。

出力されるログの内容にもよりますが、50,000 行程度のログが保存できることを想定しています。