matrix-org/dendrite

Move to zerolog

Open

#1,468 opened on Oct 2, 2020

View on GitHubContributor guide
 (12 comments) (4 reactions) (0 assignees)Go (658 forks)auto 404
T-TaskX-Performancegood first issue

Repository metrics

Stars
 (5,632 stars)
PR merge metrics
 (PR metrics pending)

Description

We should move to use https://github.com/uber-go/zap or https://github.com/rs/zerolog instead of logrus because logrus does a loooooot of allocations, far more than the rest of Dendrite. I'd propose we use the sugared one since we're not looking for any specific improvement other than "why is logging consuming so much time/allocs". In terms of numbers:

  • logrus 29501 ns/op
  • zap 1250 ns/op (~24x speedup)

Allocations:

  • logrus 125 allocs/op
  • zap 11 allocs/op

Contributor guide

Research direction
Replace logrus with zerolog or zap, ensuring all logging calls are updated and performance benefits are realized.
Tech stack
go
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70