Non-blocking logging

Open
#76 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
go

Research direction

Start by locating the default zap file backend and tracing how it writes log messages. Implement bounded buffering that drops messages when full without blocking execution, then verify the backend's write and overflow behavior with the relevant tests or a focused reproduction.

Written by the indexing model from the issue text.

Description

kind/enhancement

The default zap file backend logging backend is really dumb and doesn't have any internal buffering. We need to:

  1. Buffer writes.
  2. Drop log messages when the buffer is full instead of blocking.

We should never block execution on logging.

Dominant language
Go
Stars
63
Forks
55
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ipfs/go-log

All issues in ipfs/go-log

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.