Zenn
🦕

Fedify 1.3.0: OpenTelemetry対応と強化されたメッセージキューを実装

2024/11/30に公開
JavaScript
TypeScript
fediverse
ActivityPub
tech

Fedify 1.3.0のリリースをお知らせします。本バージョンでは、可観測性、メッセージキューの設定、開発者体験に関して大幅な改善が行われました。フェデレーションサーバーアプリケーションの構築と監視をより簡単にする新機能と改善点が多数導入されています。

OpenTelemetryの統合

本リリースの目玉機能は、OpenTelemetryの包括的なサポートです。Fedifyは様々な操作を自動的にOpenTelemetryのスパンで計測し、アプリケーションの動作に関する詳細な洞察を提供します。この機能により以下が可能になります：

  • 詳細なタイミング情報を含むHTTPリクエストとレスポンスの追跡
  • アクターとコレクションのディスパッチの監視
  • インボックスとアウトボックスの操作の観察
  • 署名検証プロセスの分析
  • その他多数

FedifyアプリケーションでのOpenTelemetryのセットアップは簡単です。OpenTelemetry SDKを設定すると、Fedifyは自動的に様々な操作のスパンを作成します。以下は簡単な例です：

import { NodeSDK } from "@opentelemetry/sdk-node";
import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-proto";

const sdk = new NodeSDK({
  serviceName: "my-fedify-app",
  traceExporter: new OTLPTraceExporter({
    url: "http://localhost:4317",
  }),
});

sdk.start();

SentryのOpenTelemetryサポートとの統合も可能です：

import { createFederation } from "@fedify/fedify";
import { getClient } from "@sentry/node";

const federation = createFederation({
  tracerProvider: getClient()?.traceProvider,
  // ... その他のオプション
});

なお、SentryのOpenTelemetry統合は@sentry/node 8.0.0から利用可能ですが、2024年11月時点では@sentry/denoや@sentry/bunではまだ利用できません。

計測されるスパンとその属性の完全なリストについては、OpenTelemetryのドキュメントをご覧ください。

メッセージキュー設定の強化

Fedify 1.3.0では、受信アクティビティと送信アクティビティに対して異なるメッセージキューを設定できるようになりました。この機能により、異なる種類のアクティビティの処理においてより大きな柔軟性が得られます。以下が可能です：

  • 受信アクティビティと送信アクティビティに異なるメッセージキューを使用
  • 受信アクティビティのみにメッセージキューを使用
  • 送信アクティビティのみにメッセージキューを使用
  • またはそれらの任意の組み合わせ

設定例を示します：

受信と送信で異なるキューを使用する場合：

import { createFederation } from "@fedify/fedify";
import { RedisMessageQueue } from "@fedify/redis";
import { PostgresMessageQueue } from "@fedify/postgres";

const federation = createFederation({
  queue: {
    inbox: new PostgresMessageQueue(postgres("postgresql://...")),
    outbox: new RedisMessageQueue(redis),
  },
  // ... その他のオプション
});

受信アクティビティのみにメッセージキューを使用する場合：

const federation = createFederation({
  queue: {
    inbox: new PostgresMessageQueue(postgres("postgresql://...")),
    // outboxは指定なし - 送信アクティビティはキューイングされません
  },
  // ... その他のオプション
});

アクティビティの手動ルーティング

実際のHTTPリクエストなしでアクティビティをインボックスリスナーに手動でルーティングできるようになりました。これは特に、別のアクティビティ内に含まれるアクティビティオブジェクトを処理する必要がある場合に便利です。例：

federation.setInboxListeners("/users/{identifier}/inbox", "/inbox")
  .on(Announce, async (ctx, announce) => {
    const object = await announce.getObject();
    if (object instanceof Activity) {
      // 含まれているアクティビティを適切なインボックスリスナーにルーティング
      await ctx.routeActivity(ctx.recipient, object);
    }
  });

詳細については関連ドキュメントをご覧ください。

SvelteKitの統合

Jiyu Park氏（@robin_maki@planet.moe）の貢献により、FedifyはSvelteKitを新しい@fedify/fedify/x/sveltekitモジュールを通じて公式にサポートするようになりました。この統合により、SvelteKitを使用したフェデレーションアプリケーションの構築がより簡単になります：

import { createFederation } from "@fedify/fedify";
import { fedifyHook } from "@fedify/fedify/x/sveltekit";

const federation = createFederation({
  // ... 設定
});

export const handle = fedifyHook(federation, (req) => "context data");

詳細については関連ドキュメントをご覧ください。

HTTPリクエストの識別性の向上

Fedifyは作成するすべてのHTTPリクエストに適切なUser-Agentヘッダーを含めるようになりました。これにより、サーバーログ内でFedifyが生成したリクエストの識別と追跡が容易になります。デフォルトのフォーマットは以下の通りです：

Fedify/1.3.0 (Deno/2.1.2)

独自のユーザーエージェント文字列やオプションを提供してカスタマイズ可能です：

createFederation({
  userAgent: {
    software: "MyApp/1.0.0",
    url: "https://myinstance.com/"
  },
  // ... その他のオプション
});

その他の改善点

  • Context.sendActivity()とInboxContext.forwardActivity()メソッドが、タスクのエンキューに失敗した際に適切にエラーを返すようになりました
  • 様々なバグ修正とパフォーマンスの改善
  • ドキュメントと例の充実

1.3.0へのアップグレード

Fedify 1.3.0はJSRとnpmの両方で利用可能です。アップグレード方法：

JSR（Deno）の場合：

deno add jsr:@fedify/fedify@1.3.0

npm（Node.jsとBun）の場合：

npm  add @fedify/fedify@1.3.0
pnpm add @fedify/fedify@1.3.0
yarn add @fedify/fedify@1.3.0
bun  add @fedify/fedify@1.3.0

今後の展望

これらの新機能と改善点に私たちは大きな期待を寄せており、Fedifyを使用したフェデレーションアプリケーションの構築がより一層楽しいものになると確信しています。引き続き更新をお楽しみに！質問やフィードバックがございましたら、Matrixチャット （英語）やDiscordサーバー （日本語）にお気軽にご参加ください。

変更点の完全なリストについてはチェンジログをご覧ください。

Discussion