查阅开发者日志

开发者日志命令行工具提供了一个简单且舒适的方法来访问详细的日志信息,这些日志信息包括应用程序与 Kii Cloud 交互时所发生的各种事件和行为。这将能够帮助你更快速地直接分析和概括应用程序对 Kii Cloud 的使用情况。

安装

查阅 这里 了解更多关于如何安装命令行工具的信息。

用法

使用如下命令从终端(Terminal)启动开发者日志命令行工具:

node bin/kii-logs.js -t \
  --site cn \
  --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:所要使用的令牌。可以被用于替代 client-id 和 client-secret。
  • -t--tail:保持空闲状态并显示最近的日志。且保持会话能够接收实时的日志。
  • -n--num:历史日志最大行数。你可以设置最多1500行,默认值为100。如果使用了 -t 则该参数无效。如果未指定日期时间过滤条件,则按指定数量显示最新的日志。
  • --site:指定应用程序所在服务器的位置。可以是 usjp, cn3, sgeu 中的一个。
  • --use-utc:将输出和起始、截止日期参数中所用时间戳的格式设置为 UTC。默认使用当地时间。
  • --http-proxy:指定 Http 代理,适用于客户端运行在防火墙后或者无法直接连接到 Kii Cloud API 的情况。例如:https://my.proxy:8080

必填参数:--site--app-id--app-key--client-id 以及 -- client-secret。你可以从开发者平台上获取应用程序的这些必填数据(详见 这里 )。

但是,如果使用了参数 --token,ClientID 和 ClientSecret 将没有必要填写。关于如何获取应用程序的管理员令牌,请务必查阅 管理员功能

以下是输出示例,日志中时间戳的格式为 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 :当你只希望看到特定用户的日志时使用。
  • --level :当你只希望看到指定级别的日志时使用。例如,DEBUG、INFO、ERROR。
  • --date-from :当你只希望看到指定日期的日志时使用。例如,2014-01-01、2014-01-01:14:05:30。
  • --date-to :当你只希望看到指定日期的日志时使用。例如,2014-01-31、2014-01-31:14:05:30。

日期的格式应为 ISO 8601 或 YYYY-MM-DD HH:mm:ss。如果在命令行中指定了 --use-utc,则 --date-from--date-to 中的值将被解读为 UTC 时间。

node bin/kii-logs.js \
  --site cn \
  --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>

输出

工具将输出如下事件:

  • 用户(User)的注册、创建、更新、删除、邮件/电话验证、第三方整合
  • 群组(Group)的创建、更新、删除、添加成员、删除成员
  • Bucket 的创建、删除、更新、查询
  • Bucket 中 Object 的创建、更新、删除
  • Bucket 中 Object Body
    • 上传成功
    • 取消上传
    • 发布
  • 分配/撤销 ACL
    • 对应用程序(CR:创建新 Bucket,CT:创建新 Topic)
    • 对 Bucket(C:创建 Object,Q:查询,D:撤销 Bucket)
    • 对 Bucket 中的 Object(R:读,W:写)
    • 对 Topic(ST:订阅 Topic,MT:在 Topic 中发送消息)
  • 安装推送,订阅、发送消息到 Bucket/Topic
  • 安装、更新、执行服务端代码
  • 通过 console.log 查看服务端代码的内部日志报表

开发者日志的大小

Kii Cloud 为每个应用程序保留最多 16 MB 的开发者日志。大约相当于 50,000 行日志(实际数量取决于日志的内容)。

如果日志超限了,则旧日志将被删除。