ハニカム

ハニカムページプラグインは、分析と可観測性のために自動的にトレースをハニカムに送信します。

インストール

npm install @cloudflare/pages-plugin-honeycomb

使用法

以下の使用例では、Pagesプロジェクト設定で設定する必要がある環境変数を使用しています。

import honeycombPlugin from "@cloudflare/pages-plugin-honeycomb";

export const onRequest: PagesFunction<{
  HONEYCOMB_API_KEY: string;
  HONEYCOMB_DATASET: string;
}> = (context) => {
  return honeycombPlugin({
    apiKey: context.env.HONEYCOMB_API_KEY,
    dataset: context.env.HONEYCOMB_DATASET,
  })(context);
};

または、次の方法で設定をハードコーディングすることもできます（APIキーには推奨されません）：

import honeycombPlugin from "@cloudflare/pages-plugin-honeycomb";

export const onRequest = honeycombPlugin({
  apiKey: "YOUR_HONEYCOMB_API_KEY",
  dataset: "YOUR_HONEYCOMB_DATASET_NAME",
});

このプラグインは@cloudflare/workers-honeycomb-loggerに基づいており、同じ設定オプション ↗を受け入れます。

自動的にネストされたJSONを展開するオプションを有効にし、ハニカムデータセット設定で最大展開深度を5に設定してください。

追加のコンテキスト

data.honeycomb.tracerには、特定のトレースに関する追加情報を添付するための2つのメソッドがあります：

• data.honeycomb.tracer.logは、単一の引数（String）を取ります。
• data.honeycomb.tracer.addDataは、任意のデータのオブジェクトを取ります。

これらのメソッドに関する詳細は、@cloudflare/workers-honeycomb-loggerのドキュメント ↗で確認できます。

たとえば、addDataメソッドを使用してユーザー情報を添付したい場合：

import type { PluginData } from "@cloudflare/pages-plugin-honeycomb";

export const onRequest: PagesFunction<unknown, any, PluginData> = async ({
  data,
  next,
  request,
}) => {
  // リクエストからユーザーを認証し、ユーザーのメールアドレスを抽出します
  const email = await getEmailFromRequest(request);

  data.honeycomb.tracer.addData({ email });

  return next();
};