mirror of
https://github.com/mjl-/mox.git
synced 2025-07-13 06:54:38 +03:00
switch to slog.Logger for logging, for easier reuse of packages by external software
we don't want external software to include internal details like mlog. slog.Logger is/will be the standard. we still have mlog for its helper functions, and its handler that logs in concise logfmt used by mox. packages that are not meant for reuse still pass around mlog.Log for convenience. we use golang.org/x/exp/slog because we also support the previous Go toolchain version. with the next Go release, we'll switch to the builtin slog.
This commit is contained in:
Mechiel Lukkien
@ -16,6 +16,8 @@ import (
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"golang.org/x/exp/slog"
|
||||
|
||||
"github.com/prometheus/client_golang/prometheus"
|
||||
"github.com/prometheus/client_golang/prometheus/promauto"
|
||||
|
||||
@ -28,8 +30,6 @@ import (
|
||||
"github.com/mjl-/mox/tlsrpt"
|
||||
)
|
||||
|
||||
var xlog = mlog.New("mtastsdb")
|
||||
|
||||
var (
|
||||
metricGet = promauto.NewCounterVec(
|
||||
prometheus.CounterOpts{
|
||||
@ -108,7 +108,7 @@ func Close() {
|
||||
defer mutex.Unlock()
|
||||
if DB != nil {
|
||||
err := DB.Close()
|
||||
xlog.Check(err, "closing database")
|
||||
mlog.New("mtastsdb", nil).Check(err, "closing database")
|
||||
DB = nil
|
||||
}
|
||||
}
|
||||
@ -119,8 +119,7 @@ func Close() {
|
||||
//
|
||||
// Returns ErrNotFound if record is not present.
|
||||
// Returns ErrBackoff if a recent attempt to fetch a record failed.
|
||||
func lookup(ctx context.Context, domain dns.Domain) (*PolicyRecord, error) {
|
||||
log := xlog.WithContext(ctx)
|
||||
func lookup(ctx context.Context, log mlog.Log, domain dns.Domain) (*PolicyRecord, error) {
|
||||
db, err := database(ctx)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
@ -222,8 +221,8 @@ func PolicyRecords(ctx context.Context) ([]PolicyRecord, error) {
|
||||
// Get returns an "sts" or "no-policy-found" in reportResult in most cases (when
|
||||
// not a local/internal error). It may add an "sts" result without policy contents
|
||||
// ("policy-string") in case of errors while fetching the policy.
|
||||
func Get(ctx context.Context, resolver dns.Resolver, domain dns.Domain) (policy *mtasts.Policy, reportResult tlsrpt.Result, fresh bool, err error) {
|
||||
log := xlog.WithContext(ctx)
|
||||
func Get(ctx context.Context, elog *slog.Logger, resolver dns.Resolver, domain dns.Domain) (policy *mtasts.Policy, reportResult tlsrpt.Result, fresh bool, err error) {
|
||||
log := mlog.New("mtastsdb", elog)
|
||||
defer func() {
|
||||
result := "ok"
|
||||
if err != nil && errors.Is(err, ErrBackoff) {
|
||||
@ -234,16 +233,16 @@ func Get(ctx context.Context, resolver dns.Resolver, domain dns.Domain) (policy
|
||||
result = "error"
|
||||
}
|
||||
metricGet.WithLabelValues(result).Inc()
|
||||
log.Debugx("mtastsdb get result", err, mlog.Field("domain", domain), mlog.Field("fresh", fresh))
|
||||
log.Debugx("mtastsdb get result", err, slog.Any("domain", domain), slog.Bool("fresh", fresh))
|
||||
}()
|
||||
|
||||
cachedPolicy, err := lookup(ctx, domain)
|
||||
cachedPolicy, err := lookup(ctx, log, domain)
|
||||
if err != nil && errors.Is(err, ErrNotFound) {
|
||||
// We don't have a policy for this domain, not even a record that we tried recently
|
||||
// and should backoff. So attempt to fetch policy.
|
||||
nctx, cancel := context.WithTimeout(ctx, time.Minute)
|
||||
defer cancel()
|
||||
record, p, ptext, err := mtasts.Get(nctx, resolver, domain)
|
||||
record, p, ptext, err := mtasts.Get(nctx, log.Logger, resolver, domain)
|
||||
if err != nil {
|
||||
switch {
|
||||
case errors.Is(err, mtasts.ErrNoRecord) || errors.Is(err, mtasts.ErrMultipleRecords) || errors.Is(err, mtasts.ErrRecordSyntax) || errors.Is(err, mtasts.ErrNoPolicy) || errors.Is(err, mtasts.ErrPolicyFetch) || errors.Is(err, mtasts.ErrPolicySyntax):
|
||||
@ -303,7 +302,7 @@ func Get(ctx context.Context, resolver dns.Resolver, domain dns.Domain) (policy
|
||||
policy = &cachedPolicy.Policy
|
||||
nctx, cancel := context.WithTimeout(ctx, 30*time.Second)
|
||||
defer cancel()
|
||||
record, _, err := mtasts.LookupRecord(nctx, resolver, domain)
|
||||
record, _, err := mtasts.LookupRecord(nctx, log.Logger, resolver, domain)
|
||||
if err != nil {
|
||||
if errors.Is(err, mtasts.ErrNoRecord) {
|
||||
if policy.Mode != mtasts.ModeNone {
|
||||
@ -336,7 +335,7 @@ func Get(ctx context.Context, resolver dns.Resolver, domain dns.Domain) (policy
|
||||
// didn't store the raw policy lines in the past.
|
||||
nctx, cancel = context.WithTimeout(ctx, 30*time.Second)
|
||||
defer cancel()
|
||||
p, ptext, err := mtasts.FetchPolicy(nctx, domain)
|
||||
p, ptext, err := mtasts.FetchPolicy(nctx, log.Logger, domain)
|
||||
if err != nil {
|
||||
log.Errorx("fetching updated policy for domain, continuing with previously cached policy", err)
|
||||
|
||||
|
||||
@ -12,6 +12,7 @@ import (
|
||||
"time"
|
||||
|
||||
"github.com/mjl-/mox/dns"
|
||||
"github.com/mjl-/mox/mlog"
|
||||
"github.com/mjl-/mox/mox-"
|
||||
"github.com/mjl-/mox/mtasts"
|
||||
)
|
||||
@ -32,6 +33,8 @@ func TestDB(t *testing.T) {
|
||||
os.Remove(dbpath)
|
||||
defer os.Remove(dbpath)
|
||||
|
||||
log := mlog.New("mtastsdb", nil)
|
||||
|
||||
if err := Init(false); err != nil {
|
||||
t.Fatalf("init database: %s", err)
|
||||
}
|
||||
@ -42,7 +45,7 @@ func TestDB(t *testing.T) {
|
||||
timeNow = func() time.Time { return now }
|
||||
defer func() { timeNow = time.Now }()
|
||||
|
||||
if p, err := lookup(ctxbg, dns.Domain{ASCII: "example.com"}); err != ErrNotFound {
|
||||
if p, err := lookup(ctxbg, log, dns.Domain{ASCII: "example.com"}); err != ErrNotFound {
|
||||
t.Fatalf("expected not found, got %v, %#v", err, p)
|
||||
}
|
||||
|
||||
@ -59,7 +62,7 @@ func TestDB(t *testing.T) {
|
||||
if err := Upsert(ctxbg, dns.Domain{ASCII: "example.com"}, "123", &policy1, policy1.String()); err != nil {
|
||||
t.Fatalf("upsert record: %s", err)
|
||||
}
|
||||
if got, err := lookup(ctxbg, dns.Domain{ASCII: "example.com"}); err != nil {
|
||||
if got, err := lookup(ctxbg, log, dns.Domain{ASCII: "example.com"}); err != nil {
|
||||
t.Fatalf("lookup after insert: %s", err)
|
||||
} else if !reflect.DeepEqual(got.Policy, policy1) {
|
||||
t.Fatalf("mismatch between inserted and retrieved: got %#v, want %#v", got, policy1)
|
||||
@ -76,7 +79,7 @@ func TestDB(t *testing.T) {
|
||||
if err := Upsert(ctxbg, dns.Domain{ASCII: "example.com"}, "124", &policy2, policy2.String()); err != nil {
|
||||
t.Fatalf("upsert record: %s", err)
|
||||
}
|
||||
if got, err := lookup(ctxbg, dns.Domain{ASCII: "example.com"}); err != nil {
|
||||
if got, err := lookup(ctxbg, log, dns.Domain{ASCII: "example.com"}); err != nil {
|
||||
t.Fatalf("lookup after insert: %s", err)
|
||||
} else if !reflect.DeepEqual(got.Policy, policy2) {
|
||||
t.Fatalf("mismatch between inserted and retrieved: got %v, want %v", got, policy2)
|
||||
@ -108,7 +111,7 @@ func TestDB(t *testing.T) {
|
||||
t.Fatalf("records mismatch, got %#v, expected %#v", records, expRecords)
|
||||
}
|
||||
|
||||
if _, err := lookup(ctxbg, dns.Domain{ASCII: "other.example.com"}); err != ErrBackoff {
|
||||
if _, err := lookup(ctxbg, log, dns.Domain{ASCII: "other.example.com"}); err != ErrBackoff {
|
||||
t.Fatalf("got %#v, expected ErrBackoff", err)
|
||||
}
|
||||
|
||||
@ -125,7 +128,7 @@ func TestDB(t *testing.T) {
|
||||
|
||||
testGet := func(domain string, expPolicy *mtasts.Policy, expFresh bool, expErr error) {
|
||||
t.Helper()
|
||||
p, _, fresh, err := Get(ctxbg, resolver, dns.Domain{ASCII: domain})
|
||||
p, _, fresh, err := Get(ctxbg, log.Logger, resolver, dns.Domain{ASCII: domain})
|
||||
if (err == nil) != (expErr == nil) || err != nil && !errors.Is(err, expErr) {
|
||||
t.Fatalf("got err %v, expected %v", err, expErr)
|
||||
}
|
||||
|
||||
@ -8,6 +8,8 @@ import (
|
||||
"runtime/debug"
|
||||
"time"
|
||||
|
||||
"golang.org/x/exp/slog"
|
||||
|
||||
"github.com/mjl-/bstore"
|
||||
|
||||
"github.com/mjl-/mox/dns"
|
||||
@ -28,11 +30,9 @@ func refresh() int {
|
||||
for {
|
||||
ticker.Reset(interval)
|
||||
|
||||
ctx := context.WithValue(mox.Context, mlog.CidKey, mox.Cid())
|
||||
n, err := refresh1(ctx, dns.StrictResolver{Pkg: "mtastsdb"}, time.Sleep)
|
||||
if err != nil {
|
||||
xlog.WithContext(ctx).Errorx("periodic refresh of cached mtasts policies", err)
|
||||
}
|
||||
log := mlog.New("mtastsdb", nil).WithCid(mox.Cid())
|
||||
n, err := refresh1(mox.Context, log, dns.StrictResolver{Pkg: "mtastsdb"}, time.Sleep)
|
||||
log.Check(err, "periodic refresh of cached mtasts policies")
|
||||
if n > 0 {
|
||||
refreshed += n
|
||||
}
|
||||
@ -51,7 +51,7 @@ func refresh() int {
|
||||
// refreshes evenly over the next 3 hours, randomizing the domains, and we add some
|
||||
// jitter to the timing. Each refresh is done in a new goroutine, so a single slow
|
||||
// refresh doesn't mess up the timing.
|
||||
func refresh1(ctx context.Context, resolver dns.Resolver, sleep func(d time.Duration)) (int, error) {
|
||||
func refresh1(ctx context.Context, log mlog.Log, resolver dns.Resolver, sleep func(d time.Duration)) (int, error) {
|
||||
db, err := database(ctx)
|
||||
if err != nil {
|
||||
return 0, err
|
||||
@ -87,10 +87,10 @@ func refresh1(ctx context.Context, resolver dns.Resolver, sleep func(d time.Dura
|
||||
}
|
||||
|
||||
// Launch goroutine with the refresh.
|
||||
xlog.WithContext(ctx).Debug("will refresh mta-sts policies over next 3 hours", mlog.Field("count", len(prs)))
|
||||
log.Debug("will refresh mta-sts policies over next 3 hours", slog.Int("count", len(prs)))
|
||||
start := timeNow()
|
||||
for i, pr := range prs {
|
||||
go refreshDomain(ctx, db, resolver, pr)
|
||||
go refreshDomain(ctx, log, db, resolver, pr)
|
||||
if i < len(prs)-1 {
|
||||
interval := 3 * int64(time.Hour) / int64(len(prs)-1)
|
||||
extra := time.Duration(rand.Int63n(interval) - interval/2)
|
||||
@ -104,13 +104,12 @@ func refresh1(ctx context.Context, resolver dns.Resolver, sleep func(d time.Dura
|
||||
return len(prs), nil
|
||||
}
|
||||
|
||||
func refreshDomain(ctx context.Context, db *bstore.DB, resolver dns.Resolver, pr PolicyRecord) {
|
||||
log := xlog.WithContext(ctx)
|
||||
func refreshDomain(ctx context.Context, log mlog.Log, db *bstore.DB, resolver dns.Resolver, pr PolicyRecord) {
|
||||
defer func() {
|
||||
x := recover()
|
||||
if x != nil {
|
||||
// Should not happen, but make sure errors don't take down the application.
|
||||
log.Error("refresh1", mlog.Field("panic", x))
|
||||
log.Error("refresh1", slog.Any("panic", x))
|
||||
debug.PrintStack()
|
||||
metrics.PanicInc(metrics.Mtastsdb)
|
||||
}
|
||||
@ -121,11 +120,11 @@ func refreshDomain(ctx context.Context, db *bstore.DB, resolver dns.Resolver, pr
|
||||
|
||||
d, err := dns.ParseDomain(pr.Domain)
|
||||
if err != nil {
|
||||
log.Errorx("refreshing mta-sts policy: parsing policy domain", err, mlog.Field("domain", d))
|
||||
log.Errorx("refreshing mta-sts policy: parsing policy domain", err, slog.Any("domain", d))
|
||||
return
|
||||
}
|
||||
log.Debug("refreshing mta-sts policy for domain", mlog.Field("domain", d))
|
||||
record, _, err := mtasts.LookupRecord(ctx, resolver, d)
|
||||
log.Debug("refreshing mta-sts policy for domain", slog.Any("domain", d))
|
||||
record, _, err := mtasts.LookupRecord(ctx, log.Logger, resolver, d)
|
||||
if err == nil && record.ID == pr.RecordID {
|
||||
qup := bstore.QueryDB[PolicyRecord](ctx, db)
|
||||
qup.FilterNonzero(PolicyRecord{Domain: pr.Domain, LastUpdate: pr.LastUpdate})
|
||||
@ -137,7 +136,7 @@ func refreshDomain(ctx context.Context, db *bstore.DB, resolver dns.Resolver, pr
|
||||
if n, err := qup.UpdateNonzero(update); err != nil {
|
||||
log.Errorx("updating refreshed, unmodified policy in database", err)
|
||||
} else if n != 1 {
|
||||
log.Info("expected to update 1 policy after refresh", mlog.Field("count", n))
|
||||
log.Info("expected to update 1 policy after refresh", slog.Int("count", n))
|
||||
}
|
||||
return
|
||||
}
|
||||
@ -152,14 +151,14 @@ func refreshDomain(ctx context.Context, db *bstore.DB, resolver dns.Resolver, pr
|
||||
// ../rfc/8461:587
|
||||
return
|
||||
} else if err != nil {
|
||||
log.Errorx("looking up mta-sts record for domain", err, mlog.Field("domain", d))
|
||||
log.Errorx("looking up mta-sts record for domain", err, slog.Any("domain", d))
|
||||
// Try to fetch new policy. It could be just DNS that is down. We don't want to let our policy expire.
|
||||
}
|
||||
|
||||
p, _, err := mtasts.FetchPolicy(ctx, d)
|
||||
p, _, err := mtasts.FetchPolicy(ctx, log.Logger, d)
|
||||
if err != nil {
|
||||
if !errors.Is(err, mtasts.ErrNoPolicy) || pr.Mode != mtasts.ModeNone {
|
||||
log.Errorx("refreshing mtasts policy for domain", err, mlog.Field("domain", d))
|
||||
log.Errorx("refreshing mtasts policy for domain", err, slog.Any("domain", d))
|
||||
}
|
||||
return
|
||||
}
|
||||
@ -178,6 +177,6 @@ func refreshDomain(ctx context.Context, db *bstore.DB, resolver dns.Resolver, pr
|
||||
if n, err := qup.UpdateFields(update); err != nil {
|
||||
log.Errorx("updating refreshed, modified policy in database", err)
|
||||
} else if n != 1 {
|
||||
log.Info("updating refreshed, did not update 1 policy", mlog.Field("count", n))
|
||||
log.Info("updating refreshed, did not update 1 policy", slog.Int("count", n))
|
||||
}
|
||||
}
|
||||
|
||||
@ -22,6 +22,7 @@ import (
|
||||
"github.com/mjl-/bstore"
|
||||
|
||||
"github.com/mjl-/mox/dns"
|
||||
"github.com/mjl-/mox/mlog"
|
||||
"github.com/mjl-/mox/mox-"
|
||||
"github.com/mjl-/mox/mtasts"
|
||||
)
|
||||
@ -135,7 +136,8 @@ func TestRefresh(t *testing.T) {
|
||||
t.Fatalf("bad sleep duration %v", d)
|
||||
}
|
||||
}
|
||||
if n, err := refresh1(ctxbg, resolver, sleep); err != nil || n != 3 {
|
||||
log := mlog.New("mtastsdb", nil)
|
||||
if n, err := refresh1(ctxbg, log, resolver, sleep); err != nil || n != 3 {
|
||||
t.Fatalf("refresh1: err %s, n %d, expected no error, 3", err, n)
|
||||
}
|
||||
if slept != 2 {
|
||||
|
||||
Reference in New Issue
Block a user