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

クイックスタート

プロジェクトを作り、インジェストキーをコピーし、最初のイベントを送って、ダッシュボードで確認します。

Lyrelog は招待制のアーリーアクセス中のホスト型サービスです。lyrelog.com からアクセスを申し込むと、届いた招待リンクからアカウントを作成できます。ダッシュボードは app.lyrelog.com にあり、アプリはイベントを https://ingest.lyrelog.com に送ります。

最初のプロジェクトに名前を付ける

アカウントを作成すると、ダッシュボードが Welcome ページで開きます。プロジェクトに名前を付け、イベントを送るものを選びます。iOS や macOS のアプリ、Web サイト、Node・Python・Go のサービス、または HTTP で送るその他のものです。ここでの選択によって、次に表示されるコードスニペットとプロジェクトのプラットフォームが決まります。

プロジェクトはアプリごとに 1 つ作ってください。アプリに Web サイトやバックエンドもある場合は、すべて同じプロジェクトに送れます(プラットフォーム を参照)。2 つ目以降のプロジェクトは Projects の New project から作成します。プロジェクトを作成できるのは組織のオーナーだけです。

インジェストキーをコピーする

プロジェクトを作成した直後に、Lyrelog はそのインジェストキー lyr_ing_... と、アプリに貼り付けるコードを表示します。キーは今すぐコピーしてください。 保存されるのはキーのハッシュだけなので、あとから再表示することはできません。なくした場合は、プロジェクトの API keys ページで新しいキーを作成してください。

インジェストキーはイベントを送ることしかできず、読むことはできないので、アプリに組み込んで配布しても安全です。詳しくは キー を参照してください。バックエンドからはサーバーキーで送ってください(API keys ページの Send events from a server)。サーバーキーで送ったイベントは 検証済み になります。

最初のイベントを送る

SDK はまだ公開されていません

Swift、Android、React Native、Flutter、JavaScript、Python、Go、JVM の SDK はまだインストールできません。当面は、最初のイベントを curl で送るか、任意の言語から HTTP API で送ってください。

macOS または Linux のターミナルで(uuidgen と date を使います)、lyr_ing_... を自分のキーに置き換えて実行します。

curl -X POST https://ingest.lyrelog.com/v1/events:batch \
  -H "Authorization: Bearer lyr_ing_..." \
  -H "Content-Type: application/x-ndjson" \
  --data-binary "{\"event_id\":\"$(uuidgen | tr A-Z a-z)\",\"ts\":\"$(date -u +%Y-%m-%dT%H:%M:%SZ)\",\"message\":\"hello_lyrelog\",\"resource\":{\"environment\":\"production\"}}"

どのイベントにも、event_id として新しい UUID を、ts として現在時刻を指定する必要があります。ts がプロジェクトの保持期間より古いイベントや、1 日以上先のイベントも失われることはありません。届いた時刻で保存され、送信時の時刻は属性 _lyrelog_ts_clamped に入ります。レスポンスには保存された行数が示されます。

{"accepted":1,"rejected":[]}

これ以外のレスポンスが返ってきた場合は、イベントが届かない を参照してください。

届いたことを確かめる

Welcome ページは最初のイベントを待ち受け、届くとそれを知らせます。そこからプロジェクトを開くと、Events ページに hello_lyrelog が表示されます。クリックするとイベント全体を確認できます。

表示されない場合

ダッシュボードは一度に 1 つの環境だけを表示し、最初はプロジェクトのデフォルトである production で開きます。SDK は、Xcode から実行したビルド、シミュレーター、localhost 上のページ、そして NODE_ENV=production が設定されていない Node からは development を送ります。そのため、SDK から送った最初のイベントは development に入ります。上部バーで development か All environments を選んでください。上の curl は "environment":"production" を指定しています。resource.environment なしで送られたイベントも production として保存されます。詳しくは 環境 を参照してください。

スクリプトから読む(任意)

プロジェクトの API keys ページで New key を選び、What it can do を Read events にして、lyr_read_... キーをコピーします。最後のサインインから 10 分以上たっている場合、読み取りキーを作成するときに再度サインインを求められます。このキーはプロジェクトのすべてのイベントを読めるので、サーバー上で管理してください。

export LYRELOG_READ_KEY=lyr_read_...
curl -s -G https://app.lyrelog.com/v1/events \
  -H "Authorization: Bearer $LYRELOG_READ_KEY" \
  --data-urlencode "message=hello_lyrelog"

詳しくは Read API を参照してください。

次のステップ