opencontainers / opencontainers/runc

libcontainer logging

Open
#3,434 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area/logging
Dominant language
Go
Stars
13.5k
Forks
2.3k
Avg merge
2d 8h
Merged PRs (30d)
30

Description

As pointed out by @mrunalp in https://github.com/opencontainers/runc/pull/3433#issuecomment-1079806993, libcontainer packages should not do any logging, since this is a library used by other users.

Unfortunately, libcontainer is also a part of runc which is a CLI tool and we expect it to do some logging.

This can be solved by having a logger in libcontainer, which defaults to a shallow implementation that does nothing, and then runc can redefine it to use logrus. Something like libcontainer.SetLogger() perhaps (where the argument is logrus compatible logger).

WDYT @opencontainers/runc-maintainers?

Contributor guide

Open the contributing guide

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.

Research direction

Start by reviewing the libcontainer packages and runc's CLI logging setup described in the issue. Resolve the logger interface and integration design so libcontainer defaults to no logging while runc can provide a logrus-compatible implementation, then verify the affected logging behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.