キー
インジェストキーは書き込み専用で、公開される前提で設計されています。サーバーキー、読み取りキー、管理キーはサーバーに置きます。
キー(key)は 1 つのプロジェクトに属し、4 つのスコープのどれか 1 つを持ちます。どのスコープかはプレフィックスでわかります。
| スコープ | プレフィックス | ダッシュボードでの名前 | できること | 置き場所 |
|---|---|---|---|---|
| Ingest | lyr_ing_ | Send events | イベントの追加のみ | アプリや Web ページの中 |
| Server | lyr_srv_ | Send events from a server | イベントの追加のみ。送ったイベントは検証済みになります。 | バックエンドのみ。秘密にしてください。 |
| Read | lyr_read_ | Read events | イベントのクエリ | サーバーやスクリプト。秘密にしてください。 |
| Admin | lyr_adm_ | Full access | 管理作業のためのイベントの送信とクエリ | サーバー。秘密にしてください。 |
読み取りキーは、読み取り API を通じてプロジェクトのイベントをクエリします。サーバー上のスクリプト、ノートブック、エージェントから使います。プロジェクトのすべてのデータを読めるので、アプリや Web ページには絶対に入れません。
サーバーキーはバックエンドからイベントを送ります。Node、Python、Go、JVM の SDK から、または curl で使います。インジェストキーと同じく読み取りはできませんが、秘密のキーです。これを持っているのは自分のサーバーだけなので、送ったイベントは検証済みとしてマークされ、1 アドレスあたりの 1 日の割り当ても適用されません。アプリや Web ページには絶対に入れません。アプリと Web ページではインジェストキーを使います。
インジェストキーを公開してよい理由
インジェストキーはアプリのバイナリや Web ページに含めて配布されるので、誰でも読めるものと考えてください。それでも問題ないのは、このキーにできるのはプロジェクトへのイベントの追加だけで、読み取り、変更、削除は一切できないからです。イベントがどのプロジェクトに入るかは常にキーで決まり、イベントの内容では決まりません。悪用を抑えるため、プロジェクトごとにレート制限があり(デフォルトで毎分 60,000 イベント)、上限を超えたバッチには 429 が返ります。さらに、1 つのアドレスからこのキーで送れるのは、組織の月間量の1 日の割り当てまでです。
その裏返しとして、インジェストキーを持っていれば誰でもアプリと同じようなイベントを送れるため、これらのイベントは検証済みになりません。例外は、Apple のアプリから送られ、Apple が App Attest で証明した場合と、Android のアプリから送られ、端末が Key Attestation で証明した場合です。こうしたイベントは 1 日の割り当てにも数えられません。
キーは一度だけ表示されます
Lyrelog が保存するのは各キーの SHA-256 ハッシュだけです。キーが表示されるのは作成時の一度きりなので、そのときにコピーしてください。なくしたキーは復元できません。新しく作成してください。
作成と失効
キーはプロジェクトの API keys ページにあります。Settings から API keys を開くか、⌘ K で API keys を選びます。キーを作成、失効できるのはオーナーだけです。
- 1 つのプロジェクトで有効なキーは最大 20 個です。新しく作るには 1 つ失効させてください。
- キーに有効期限はありません。失効させるか、プロジェクトを削除するまで使えます。
- Send events from a server、Read events、Full access のキーを作るには、最近(10 分以内)サインインしている必要があります。Send events のキーには不要です。
- 誰かが組織を抜けたり外されたりすると、その人が作った読み取りキーとフルアクセスキーは失効します。インジェストキーは残ります。すでに配布済みのアプリがそれで送信しているからです。サーバーキーも残ります。自分のサーバーがそれで送信しているからです。抜けた人がサーバーキーを見たことがあるなら、失効させて新しいものに差し替えてください。
- 組織の全員が、キーの一覧と各キーが最後に使われた日時を見られます。
失効したキーはすぐに使えなくなります(最大 1 分ほどかかることがあります)。401 または 403 を受け取った SDK は、アプリが再起動するまで送信を止め、キューにあるイベントは保持します。