アーリーアクセス招待制です。SDK はまだ公開されていません。招待をリクエスト
本文へスキップ
ドキュメント

イベント

1 つのイベントは、起きた 1 つの出来事です。変わらない名前、レベル、領域、そして絞り込みに使うフィールドを持ちます。

Lyrelog ではすべてがイベントです。イベントは、何が起きたか(message)、どれくらい深刻か(level)、アプリのどの部分か(category)、誰に起きたか(user_id、session_id、install_id)を表し、絞り込みやグラフに使う小さなフィールド(attrs)と、必要なら開いたときにだけ読む大きなデータ(payload)を持ちます。

{
  "event_id": "6f1b2c3d-5a1e-4c1f-9e7a-0a1b2c3d4e5f",
  "ts": "2026-11-18T10:00:00.123Z",
  "level": "error",
  "category": "checkout",
  "message": "payment_declined",
  "user_id": "user-1",
  "attrs": { "code": 51, "attempt": 2, "method": "card" },
  "payload": { "response": "..." }
}

message は変わらない名前

message は文章ではなく、イベント名として書きます。payment_declined、checkout_done、http_request_failed のようにです。変わらない名前なら、数え、グラフにし、ファネルに入れ、エラーとしてまとめられます。変わる値(ID、所要時間、コード)は attrs に入れてください。

良い例悪い例
payment_declined と attrs: { code: 51 }"Payment declined with code 51 for user-1"

message は最大 2,048 バイトです。

レベル

静かなものから順に、trace、debug、info(デフォルト)、notice、warning、error、critical です。ダッシュボードはレベルごとに色を付け、エクスプローラーのグラフではエラーを軸の下側に描き、error と critical のイベントを Errors ページにまとめます。

SDK は minimumLevel(デフォルトは debug)未満のイベントを、キューに入れる前に破棄します。

category:アプリの領域

category(ダッシュボードでは Area と表示)は、イベントが属するアプリの部分です。checkout、sync、onboarding、network などです。OSLog の category と同じように働きます。ダッシュボードはこれで絞り込み、集計します。任意で、最大 64 バイトです。どの SDK にも領域ごとのロガーがあるので、毎回書く必要はありません。

属性と payload

attrspayload
用途絞り込み、内訳、グラフに使うフィールドイベントを 1 件開いたときに読む詳細
例ID、所要時間、ステータスコード、フラグサーバーのレスポンス、スタックトレース
絞り込み可能。パスと値で指定(attr=payment.method:card)不可(圧縮して保存)
上限リーフ 200 個、文字列は 1,024 バイトまで、文字列の配列は 64 要素まで、オブジェクトのネストは 4 階層までシリアライズ後 64 KiB までの任意の JSON

属性の値には、文字列、数値、真偽値、null、文字列の配列、ネストしたオブジェクトが使えます。名前にドットは使えず(代わりにオブジェクトをネストします)、_ で始めることもできません。

数値は数値としてログに残してください("412" ではなく latency_ms: 412)。そうすれば Insights で平均、中央値、p95 をグラフにできます。

SDK はキューに入れる前に、すべてのイベントをこれらの上限に収めます。長い文字列は文字の境界で切り詰め、大きすぎる payload は {"lyrelog_truncated": true, "bytes": N, "preview": "..."} に置き換えます。preview には payload の先頭が入ります。

コンテキスト

各イベントは resource も持ちます。アプリ ID、バージョンとビルド、OS とそのバージョン、デバイスのモデル、ロケール、SDK、環境、プラットフォームです。これらは SDK が自動で埋めます。国はサーバーが付け加えます。

ID と重複

すべてのイベントは event_id を持ちます。ログを記録したときに一度だけ作られる UUID です。配信は at-least-once です。バッチが 2 回送られても、event_id と ts が同じイベントは 1 回だけ保存されます。