tinkerbell / tinkerbell/hook

Add a log shipper

Open
#277 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Shell
Stars
131
Forks
65
PR merge metrics
No merged PRs in 30d

Description

Currently, we send Workflow container logs to a single syslog server. This is the only option. It would be great to be able to send logs to a different collector or to multiple collectors. Some proposed constraints:

  • very lightweight
  • configurable on start up or on the fly
  • be able to send to multiple collectors
  • logs must always be available locally from HookOS via the docker logs command
  • must support Docker and Containerd (Containerd will hopefully be the default runtime in the future)
  • must support the existing syslog setup
  • nice to have if it can collect and ship Linux system logs like kernel messages, onboot, and service containers, etc.

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 existing syslog setup and how HookOS keeps container output available through docker logs. Define the design and implementation entry points for a lightweight shipper that supports Docker, Containerd, multiple collectors, runtime configuration, local logs, and the existing syslog path; include tests or validation for each stated constraint.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, linux, shell
Domain
devops, infrastructure, observability
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.