Tracecheck

Description

Tracecheck is a Go linter that checks for a traceId in a logger definition and adds it if missing.

Here's a summary of functionalities of Tracecheck:

• Check for odd number of key and value pairs for common logger libraries
• Check for the use of a traceId with the logger in functions that take a context as argument
• Add a traceId and spanId when absent using the -fix flag

It's recommended to use Tracecheck with golangci-lint.

Based on Loggercheck

Badges

Install

go install github.com/george-maroun/tracecheck/cmd/tracecheck

Usage

Usage: tracecheck [-flag] [package]


Flags:
  -V    print version and exit
  -all
        no effect (deprecated)
  -c int
        display offending line with this many lines of context (default -1)
  -cpuprofile string
        write CPU profile to this file
  -debug string
        debug flags, any subset of "fpstv"
  -disable value
        comma-separated list of disabled logger checker (kitlog,klog,logr,zap) (default kitlog)
  -fix
        apply all suggested fixes
  -flags
        print analyzer flags in JSON
  -json
        emit JSON output
  -memprofile string
        write memory profile to this file
  -noprintflike
        require printf-like format specifier not present in args
  -requirestringkey
        require all logging keys to be inlined constant strings
  -rulefile string
        path to a file contains a list of rules
  -source
        no effect (deprecated)
  -tags string
        no effect (deprecated)
  -test
        indicates whether test files should be analyzed, too (default true)
  -trace string
        write trace log to this file
  -v    no effect (deprecated)

Example

Run: tracecheck -fix ./...

If the logger does not specify a traceId: -> Tracecheck adds a span declaration, and traceId and spanId key-value arguments to the logger.

package fix_import

import (
	"github.com/go-logr/zapr"
	"go.uber.org/zap"
	"context"
)

func SomeFunc(ctx context.Context, eventType, deliveryID string, payload []byte) error {
	log := zapr.NewLogger(zap.L()).WithValues("eventType", eventType, "deliverID", deliveryID)
	return nil
}

package fix_import

import (
	"context"
	"github.com/go-logr/zapr"
	"go.opentelemetry.io/otel/trace"
	"go.uber.org/zap"
)

func SomeFunc(ctx context.Context, eventType, deliveryID string, payload []byte) error {
	span := trace.SpanFromContext(ctx)
	log := zapr.NewLogger(zap.L()).WithValues("traceId", span.SpanContext().TraceID().String(), "spanId", span.SpanContext().SpanID().String(), "eventType", eventType, "deliverID", deliveryID)
	return nil
}

a.go:10:23: missing traceId in logging keys