Skip to main content
Home
Browse packagesDocs
ImageSign In with GitHubImageSign In with GitLab

@fedify/debugger@2.1.2
Built and signed on GitHub Actions

latest
fedify-dev/fedify
Works with
This package works with Node.js, Deno, Bun
This package works with Node.js
This package works with Deno
This package works with Bun
•JSR Score100%•
License
MIT
•
Downloads2/wk
•
Publisheda day ago (2.1.2)

Embedded ActivityPub debug dashboard for Fedify

Functions

f
createFederationDebugger<TContextData>(
federation: Federation<TContextData>,
options?: FederationDebuggerSimpleOptions | FederationDebuggerOptions
): Federation<TContextData> & { sink: Sink; }
2 overloads

Wraps a Federation object with a debug dashboard.

Interfaces

I
FederationDebuggerOptions

Options for createFederationDebugger with an explicit exporter.

  • auth: FederationDebuggerAuth

    Authentication configuration for the debug dashboard. When omitted, the dashboard is accessible without authentication.

  • exporter: FedifySpanExporter

    The FedifySpanExporter to query trace data from.

  • kv: KvStore

    The KvStore to persist log records to. This should typically be the same KvStore instance that was passed to the FedifySpanExporter so that logs and traces are co-located and accessible from all processes (e.g., both web and worker nodes).

  • path: string

    The path prefix for the debug dashboard. Defaults to "/__debug__".

I
FederationDebuggerSimpleOptions

Options for createFederationDebugger without an explicit exporter.

  • auth: FederationDebuggerAuth

    Authentication configuration for the debug dashboard. When omitted, the dashboard is accessible without authentication.

  • path: string

    The path prefix for the debug dashboard. Defaults to "/__debug__".

I
SerializedLogRecord

A serialized log record for the debug dashboard.

  • category: readonly string[]

    The logger category.

  • level: string

    The log level.

  • message: string

    The rendered log message.

  • properties: Record<string, unknown>

    The extra properties of the log record (excluding traceId and spanId).

  • timestamp: number

    The timestamp in milliseconds since the Unix epoch.

Type Aliases

T
FederationDebuggerAuth =
{ readonly type: "password"; authenticate(password: string): boolean | Promise<boolean>; }
| { readonly type: "password"; readonly password: string; }
| { readonly type: "usernamePassword"; authenticate(
username: string,
password: string
): boolean | Promise<boolean>; }
| { readonly type: "usernamePassword"; readonly username: string; readonly password: string; }
| { readonly type: "request"; authenticate(request: Request): boolean | Promise<boolean>; }

Authentication configuration for the debug dashboard.

Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@fedify/debugger

Import symbol

import * as Embedded_ActivityPub_debug_dashboard_for_Fedify___This_module_provides_a___link_createFederationDebugger__function_that_wraps_an_existing___link_Federation__object__adding_a_real_time_debug_dashboard_accessible_via_a_configurable_path_prefix_ from "@fedify/debugger";
or

Import directly with a jsr specifier

import * as Embedded_ActivityPub_debug_dashboard_for_Fedify___This_module_provides_a___link_createFederationDebugger__function_that_wraps_an_existing___link_Federation__object__adding_a_real_time_debug_dashboard_accessible_via_a_configurable_path_prefix_ from "jsr:@fedify/debugger";