我找不到适用于我的库的日志库,所以自己制作了一个。
I couldn't find a logging library that worked for my library, so I made one

原始链接: https://hackers.pub/@hongminhee/2025/logtape-fedify-case-study

## Fedify 与面向库的日志记录的需求 作者在构建 Fedify(一个 ActivityPub 服务器框架)时遇到一个挑战:现有的日志库是为应用程序设计的,而不是为不引人注目的库设计的。像 Winston、Pino 或 `debug` 这样的传统选择要么对用户施加配置选择,要么缺乏复杂、联邦系统所需的结构化、基于级别的日志记录。 为了解决这个问题,作者创建了 **LogTape**,一个专门为库作者设计的日志库。LogTape 利用 **分层类别**,允许开发者进行广泛的日志记录,*而无需*默认输出——用户明确启用特定子系统(例如“fedify”、“federation”、“http”)的日志记录。这提供了精细的控制,并避免了控制台的混乱。 LogTape 还通过 `AsyncLocalStorage` 提供 **隐式上下文**,自动使用 `requestId` 标记日志,以便轻松关联异步操作,这对于调试联邦活动流程至关重要。 用户可以选择不记录日志、仅记录错误级别的日志,或针对特定区域进行详细调试,所有这些都可以配置而无需更改代码。LogTape 支持各种运行时(Node.js、Deno、Bun),并与现有的可观察性工具集成。作者强调尽早设计类别、使用结构化日志记录,并信任用户控制日志可见性。 LogTape 旨在填补日志记录领域的空白,为需要仅在请求时才提供详细调试信息的库提供解决方案。

一场 Hacker News 讨论始于一位用户宣布创建新的日志库(`hackers.pub`),因为现有选项无法满足他们的需求。核心问题在于库内部进行日志记录的困难,允许最终用户控制日志详细程度,而无需强制使用。 评论者指出,这在 Java 和 Python 等语言中是一种成熟的模式,成熟的记录器允许可配置的嵌入式日志记录。 提到了几种现有的 JavaScript 解决方案,包括 `logtape` 和 `log4js`,而另一些人则建议 `OpenTelemetry` 作为一种潜在的解决方案。 对话还涉及了像 `Log4j` 这样成熟库的可靠性(引用了 Log4Shell 漏洞),以及构建内部解决方案与利用现有解决方案之间的权衡。 一些用户表达了希望在语言运行时本身内置日志记录功能,以简化配置。
相关文章

原文

When I started building Fedify, an ActivityPub server framework, I ran into a problem that surprised me: I couldn't figure out how to add logging.

Not because logging is hard—there are dozens of mature logging libraries for JavaScript. The problem was that they're primarily designed for applications, not for libraries that want to stay unobtrusive.

I wrote about this a few months ago, and the response was modest—some interest, some skepticism, and quite a bit of debate about whether the post was AI-generated. I'll be honest: English isn't my first language, so I use LLMs to polish my writing. But the ideas and technical content are mine.

Several readers wanted to see a real-world example rather than theory.

The problem: existing loggers assume you're building an app

Fedify helps developers build federated social applications using the ActivityPub protocol. If you've ever worked with federation, you know debugging can be painful. When an activity fails to deliver, you need to answer questions like:

  • Did the HTTP request actually go out?
  • Was the signature generated correctly?
  • Did the remote server reject it? Why?
  • Was there a problem parsing the response?

These questions span multiple subsystems: HTTP handling, cryptographic signatures, JSON-LD processing, queue management, and more. Without good logging, debugging turns into guesswork.

But here's the dilemma I faced as a library author: if I add verbose logging to help with debugging, I risk annoying users who don't want their console cluttered with Fedify's internal chatter. If I stay silent, users struggle to diagnose issues.

I looked at the existing options. With winston or Pino, I would have to either:

  • Configure a logger inside Fedify (imposing my choices on users), or
  • Ask users to pass a logger instance to Fedify (adding boilerplate)

There's also debug, which is designed for this use case. But it doesn't give you structured, level-based logs that ops teams expect—and it relies on environment variables, which some runtimes like Deno restrict by default for security reasons.

None of these felt right. So I built LogTape—a logging library designed from the ground up for library authors. And Fedify became its first real user.

The solution: hierarchical categories with zero default output

The key insight was simple: a library should be able to log without producing any output unless the application developer explicitly enables it.

Fedify uses LogTape's hierarchical category system to give users fine-grained control over what they see. Here's how the categories are organized:

Category What it logs
["fedify"] Everything from the library
["fedify", "federation", "inbox"] Incoming activities
["fedify", "federation", "outbox"] Outgoing activities
["fedify", "federation", "http"] HTTP requests and responses
["fedify", "sig", "http"] HTTP Signature operations
["fedify", "sig", "ld"] Linked Data Signature operations
["fedify", "sig", "key"] Key generation and retrieval
["fedify", "runtime", "docloader"] JSON-LD document loading
["fedify", "webfinger", "lookup"] WebFinger resource lookups

…and about a dozen more. Each category corresponds to a distinct subsystem.

This means a user can configure logging like this:

await configure({
  sinks: { console: getConsoleSink() },
  loggers: [
    // Show errors from all of Fedify
    { category: "fedify", sinks: ["console"], lowestLevel: "error" },
    // But show debug info for inbox processing specifically
    { category: ["fedify", "federation", "inbox"], sinks: ["console"], lowestLevel: "debug" },
  ],
});

When something goes wrong with incoming activities, they get detailed logs for that subsystem while keeping everything else quiet. No code changes required—just configuration.

Request tracing with implicit contexts

The hierarchical categories solved the filtering problem, but there was another challenge: correlating logs across async boundaries.

In a federated system, a single user action might trigger a cascade of operations: fetch a remote actor, verify their signature, process the activity, fan out to followers, and so on. When something fails, you need to correlate all the log entries for that specific request.

Fedify uses LogTape's implicit context feature to automatically tag every log entry with a requestId:

await configure({
  sinks: {
    file: getFileSink("fedify.jsonl", { formatter: jsonLinesFormatter })
  },
  loggers: [
    { category: "fedify", sinks: ["file"], lowestLevel: "info" },
  ],
  contextLocalStorage: new AsyncLocalStorage(),  // Enables implicit contexts
});

With this configuration, every log entry automatically includes a requestId property. When you need to debug a specific request, you can filter your logs:

jq 'select(.properties.requestId == "abc-123")' fedify.jsonl

And you'll see every log entry from that request—across all subsystems, all in order. No manual correlation needed.

The requestId is derived from standard headers when available (X-Request-Id, Traceparent, etc.), so it integrates naturally with existing observability infrastructure.

What users actually see

So what does all this configuration actually mean for someone using Fedify?

If a Fedify user doesn't configure LogTape at all, they see nothing. No warnings about missing configuration, no default output, and minimal performance overhead—the logging calls are essentially no-ops.

For basic visibility, they can enable error-level logging for all of Fedify with three lines of configuration. When debugging a specific issue, they can enable debug-level logging for just the relevant subsystem.

And if they're running in production with serious observability requirements, they can pipe structured JSON logs to their monitoring system with request correlation built in.

The same library code supports all these scenarios—whether the user is running on Node.js, Deno, Bun, or edge functions, without extra polyfills or shims. The user decides what they need.

Lessons learned

Building Fedify with LogTape taught me a few things:

Design your categories early. The hierarchical structure should reflect how users will actually want to filter logs. I organized Fedify's categories around subsystems that users might need to debug independently.

Use structured logging. Properties like requestId, activityId, and actorId are far more useful than string interpolation when you need to analyze logs programmatically.

Implicit contexts turned out to be more useful than I expected. Being able to correlate logs across async boundaries without passing context manually made debugging distributed operations much easier. When a user reports that activity delivery failed, I can give them a single jq command to extract everything relevant.

Trust your users. Some library authors worry about exposing too much internal detail through logs. I've found the opposite—users appreciate being able to see what's happening when they need to. The key is making it opt-in.

Try it yourself

If you're building a library and struggling with the logging question—how much to log, how to give users control, how to avoid being noisy—I'd encourage you to look at how Fedify does it.

The Fedify logging documentation explains everything in detail. And if you want to understand the philosophy behind LogTape's design, my earlier post covers that.

LogTape isn't trying to replace winston or Pino for application developers who are happy with those tools. It fills a different gap: logging for libraries that want to stay out of the way until users need them. If that's what you're looking for, it might be a better fit than the usual app-centric loggers.

联系我们 contact @ memedata.com