RSDK-5352: Rename golog -> rdk/logging (viamrobotics#3061)

stevebriskin · Oct 25, 2023 · 90e1f3a · 90e1f3a
1 parent a077153
commit 90e1f3a
Show file tree

Hide file tree

Showing 446 changed files with 2,280 additions and 1,802 deletions.
diff --git a/cli/auth.go b/cli/auth.go
@@ -14,7 +14,6 @@ import (
 	"strings"
 	"time"
 
-	"github.com/edaniels/golog"
 	"github.com/golang-jwt/jwt/v4"
 	"github.com/pkg/errors"
 	"github.com/urfave/cli/v2"
@@ -25,6 +24,8 @@ import (
 	apppb "go.viam.com/api/app/v1"
 	"go.viam.com/utils"
 	"go.viam.com/utils/rpc"
+
+	"go.viam.com/rdk/logging"
 )
 
 type authFlow struct {
@@ -38,7 +39,7 @@ type authFlow struct {
 	disableBrowserOpen bool
 
 	httpClient *http.Client
-	logger     golog.Logger
+	logger     logging.Logger
 	console    io.Writer
 }
 
@@ -605,7 +606,7 @@ func newCLIAuthFlowWithAuthDomain(authDomain, audience, clientID string, console
 
 		disableBrowserOpen: disableBrowserOpen,
 		httpClient:         &http.Client{Timeout: time.Second * 30},
-		logger:             golog.Global(),
+		logger:             logging.Global(),
 		console:            console,
 	}
 }

diff --git a/cli/boards_test.go b/cli/boards_test.go
@@ -30,4 +30,4 @@ func TestAppendAuthHeadersAPIKeyAuth(t *testing.T) {
 	test.That(t, len(testReq.Header), test.ShouldEqual, 2)
 	test.That(t, testReq.Header.Get("key_id"), test.ShouldEqual, testKeyID)
 	test.That(t, testReq.Header.Get("key"), test.ShouldEqual, testKeyCrypto)
-}
+}
diff --git a/cli/client.go b/cli/client.go
@@ -13,7 +13,6 @@ import (
 	"strings"
 	"time"
 
-	"github.com/edaniels/golog"
 	"github.com/fullstorydev/grpcurl"
 	"github.com/google/uuid"
 	"github.com/jhump/protoreflect/grpcreflect"
@@ -33,6 +32,7 @@ import (
 
 	rconfig "go.viam.com/rdk/config"
 	"go.viam.com/rdk/grpc"
+	"go.viam.com/rdk/logging"
 	"go.viam.com/rdk/resource"
 	"go.viam.com/rdk/robot/client"
 	"go.viam.com/rdk/services/shell"
@@ -334,9 +334,9 @@ func RobotsPartRunAction(c *cli.Context) error {
 	}
 
 	// Create logger based on presence of debugFlag.
-	logger := zap.NewNop().Sugar()
+	logger := logging.FromZapCompatible(zap.NewNop().Sugar())
 	if c.Bool(debugFlag) {
-		logger = golog.NewDebugLogger("cli")
+		logger = logging.NewDebugLogger("cli")
 	}
 
 	return client.runRobotPartCommand(
@@ -362,9 +362,9 @@ func RobotsPartShellAction(c *cli.Context) error {
 	}
 
 	// Create logger based on presence of debugFlag.
-	logger := zap.NewNop().Sugar()
+	logger := logging.FromZapCompatible(zap.NewNop().Sugar())
 	if c.Bool(debugFlag) {
-		logger = golog.NewDebugLogger("cli")
+		logger = logging.NewDebugLogger("cli")
 	}
 
 	return client.startRobotPartShell(
@@ -851,7 +851,7 @@ func (c *viamClient) runRobotPartCommand(
 	svcMethod, data string,
 	streamDur time.Duration,
 	debug bool,
-	logger golog.Logger,
+	logger logging.Logger,
 ) error {
 	dialCtx, fqdn, rpcOpts, err := c.prepareDial(orgStr, locStr, robotStr, partStr, debug)
 	if err != nil {
@@ -946,7 +946,7 @@ func (c *viamClient) runRobotPartCommand(
 func (c *viamClient) startRobotPartShell(
 	orgStr, locStr, robotStr, partStr string,
 	debug bool,
-	logger golog.Logger,
+	logger logging.Logger,
 ) error {
 	dialCtx, fqdn, rpcOpts, err := c.prepareDial(orgStr, locStr, robotStr, partStr, debug)
 	if err != nil {

diff --git a/cli/module_registry.go b/cli/module_registry.go
@@ -14,7 +14,6 @@ import (
 	"path/filepath"
 	"strings"
 
-	"github.com/edaniels/golog"
 	"github.com/google/uuid"
 	"github.com/pkg/errors"
 	"github.com/urfave/cli/v2"
@@ -23,6 +22,7 @@ import (
 	vutils "go.viam.com/utils"
 
 	modconfig "go.viam.com/rdk/config"
+	"go.viam.com/rdk/logging"
 	"go.viam.com/rdk/module/modmanager"
 	modmanageroptions "go.viam.com/rdk/module/modmanager/options"
 	"go.viam.com/rdk/utils"
@@ -685,7 +685,7 @@ func createTarballForUpload(moduleUploadPath string, stdout io.Writer) (string,
 	return tmpFile.Name(), nil
 }
 
-func readModels(path string, logger golog.Logger) ([]ModuleComponent, error) {
+func readModels(path string, logger logging.Logger) ([]ModuleComponent, error) {
 	parentAddr, err := os.MkdirTemp("", "viam-cli-test-*")
 	if err != nil {
 		return nil, err
@@ -743,7 +743,7 @@ func sameModels(a, b []ModuleComponent) bool {
 
 // UpdateModelsAction figures out the models that a module supports and updates it's metadata file.
 func UpdateModelsAction(c *cli.Context) error {
-	logger := golog.NewDevelopmentLogger("x")
+	logger := logging.NewDevelopmentLogger("x")
 	newModels, err := readModels(c.String("binary"), logger)
 	if err != nil {
 		return err

diff --git a/components/arm/arm.go b/components/arm/arm.go
@@ -9,12 +9,12 @@ import (
 	"fmt"
 	"strings"
 
-	"github.com/edaniels/golog"
 	v1 "go.viam.com/api/common/v1"
 	pb "go.viam.com/api/component/arm/v1"
 	motionpb "go.viam.com/api/service/motion/v1"
 
 	"go.viam.com/rdk/data"
+	"go.viam.com/rdk/logging"
 	"go.viam.com/rdk/motionplan"
 	"go.viam.com/rdk/referenceframe"
 	"go.viam.com/rdk/resource"
@@ -124,7 +124,7 @@ func CreateStatus(ctx context.Context, a Arm) (*pb.Status, error) {
 }
 
 // Move is a helper function to abstract away movement for general arms.
-func Move(ctx context.Context, logger golog.Logger, a Arm, dst spatialmath.Pose) error {
+func Move(ctx context.Context, logger logging.Logger, a Arm, dst spatialmath.Pose) error {
 	joints, err := a.JointPositions(ctx, nil)
 	if err != nil {
 		return err
@@ -147,7 +147,7 @@ func Move(ctx context.Context, logger golog.Logger, a Arm, dst spatialmath.Pose)
 
 // Plan is a helper function to be called by arm implementations to abstract away the default procedure for using the
 // motion planning library with arms.
-func Plan(ctx context.Context, logger golog.Logger, a Arm, dst spatialmath.Pose) ([][]referenceframe.Input, error) {
+func Plan(ctx context.Context, logger logging.Logger, a Arm, dst spatialmath.Pose) ([][]referenceframe.Input, error) {
 	model := a.ModelFrame()
 	jp, err := a.JointPositions(ctx, nil)
 	if err != nil {

diff --git a/components/arm/arm_test.go b/components/arm/arm_test.go
@@ -6,7 +6,6 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/edaniels/golog"
 	"github.com/golang/geo/r3"
 	"github.com/mitchellh/mapstructure"
 	pb "go.viam.com/api/component/arm/v1"
@@ -16,6 +15,7 @@ import (
 	"go.viam.com/rdk/components/arm"
 	"go.viam.com/rdk/components/arm/fake"
 	ur "go.viam.com/rdk/components/arm/universalrobots"
+	"go.viam.com/rdk/logging"
 	"go.viam.com/rdk/motionplan"
 	"go.viam.com/rdk/referenceframe"
 	"go.viam.com/rdk/resource"
@@ -214,7 +214,7 @@ func TestCreateStatus(t *testing.T) {
 }
 
 func TestOOBArm(t *testing.T) {
-	logger := golog.NewTestLogger(t)
+	logger := logging.NewTestLogger(t)
 	cfg := resource.Config{
 		Name:  arm.API.String(),
 		Model: resource.DefaultModelFamily.WithModel("ur5e"),
@@ -318,7 +318,7 @@ func TestOOBArm(t *testing.T) {
 
 func TestXArm6Locations(t *testing.T) {
 	// check the exact values/locations of arm geometries at a couple different poses
-	logger := golog.NewTestLogger(t)
+	logger := logging.NewTestLogger(t)
 	cfg := resource.Config{
 		Name:  arm.API.String(),
 		Model: resource.DefaultModelFamily.WithModel("fake"),
@@ -441,7 +441,7 @@ func TestXArm6Locations(t *testing.T) {
 
 func TestUR5ELocations(t *testing.T) {
 	// check the exact values/locations of arm geometries at a couple different poses
-	logger := golog.NewTestLogger(t)
+	logger := logging.NewTestLogger(t)
 	cfg := resource.Config{
 		Name:  arm.API.String(),
 		Model: resource.DefaultModelFamily.WithModel("fake"),

diff --git a/components/arm/client.go b/components/arm/client.go
@@ -8,12 +8,12 @@ import (
 	"errors"
 	"fmt"
 
-	"github.com/edaniels/golog"
 	commonpb "go.viam.com/api/common/v1"
 	pb "go.viam.com/api/component/arm/v1"
 	"go.viam.com/utils/protoutils"
 	"go.viam.com/utils/rpc"
 
+	"go.viam.com/rdk/logging"
 	rprotoutils "go.viam.com/rdk/protoutils"
 	"go.viam.com/rdk/referenceframe"
 	"go.viam.com/rdk/resource"
@@ -30,7 +30,7 @@ type client struct {
 	name   string
 	client pb.ArmServiceClient
 	model  referenceframe.Model
-	logger golog.Logger
+	logger logging.Logger
 }
 
 // NewClientFromConn constructs a new Client from connection passed in.
@@ -39,7 +39,7 @@ func NewClientFromConn(
 	conn rpc.ClientConn,
 	remoteName string,
 	name resource.Name,
-	logger golog.Logger,
+	logger logging.Logger,
 ) (Arm, error) {
 	pbClient := pb.NewArmServiceClient(conn)
 	c := &client{

diff --git a/components/arm/client_test.go b/components/arm/client_test.go
@@ -5,7 +5,6 @@ import (
 	"net"
 	"testing"
 
-	"github.com/edaniels/golog"
 	"github.com/golang/geo/r3"
 	componentpb "go.viam.com/api/component/arm/v1"
 	robotpb "go.viam.com/api/robot/v1"
@@ -14,6 +13,7 @@ import (
 
 	"go.viam.com/rdk/components/arm"
 	viamgrpc "go.viam.com/rdk/grpc"
+	"go.viam.com/rdk/logging"
 	"go.viam.com/rdk/referenceframe"
 	"go.viam.com/rdk/resource"
 	"go.viam.com/rdk/robot/framesystem"
@@ -24,10 +24,10 @@ import (
 )
 
 func TestClient(t *testing.T) {
-	logger := golog.NewTestLogger(t)
+	logger := logging.NewTestLogger(t)
 	listener1, err := net.Listen("tcp", "localhost:0")
 	test.That(t, err, test.ShouldBeNil)
-	rpcServer, err := rpc.NewServer(logger, rpc.WithUnauthenticated())
+	rpcServer, err := rpc.NewServer(logger.AsZap(), rpc.WithUnauthenticated())
 	test.That(t, err, test.ShouldBeNil)
 
 	var (

diff --git a/components/arm/eva/eva.go b/components/arm/eva/eva.go
@@ -16,13 +16,13 @@ import (
 	"sync"
 	"time"
 
-	"github.com/edaniels/golog"
 	"github.com/pkg/errors"
 	"go.uber.org/multierr"
 	pb "go.viam.com/api/component/arm/v1"
 	"go.viam.com/utils"
 
 	"go.viam.com/rdk/components/arm"
+	"go.viam.com/rdk/logging"
 	"go.viam.com/rdk/motionplan"
 	"go.viam.com/rdk/operation"
 	"go.viam.com/rdk/referenceframe"
@@ -45,7 +45,9 @@ var evamodeljson []byte
 
 func init() {
 	resource.RegisterComponent(arm.API, Model, resource.Registration[arm.Arm, *Config]{
-		Constructor: func(ctx context.Context, _ resource.Dependencies, conf resource.Config, logger golog.Logger) (arm.Arm, error) {
+		Constructor: func(
+			ctx context.Context, _ resource.Dependencies, conf resource.Config, logger logging.Logger,
+		) (arm.Arm, error) {
 			return NewEva(ctx, conf, logger)
 		},
 	})
@@ -86,7 +88,7 @@ type eva struct {
 	sessionToken string
 
 	moveLock sync.Mutex
-	logger   golog.Logger
+	logger   logging.Logger
 	model    referenceframe.Model
 
 	frameJSON []byte
@@ -95,7 +97,7 @@ type eva struct {
 }
 
 // NewEva TODO.
-func NewEva(ctx context.Context, conf resource.Config, logger golog.Logger) (arm.Arm, error) {
+func NewEva(ctx context.Context, conf resource.Config, logger logging.Logger) (arm.Arm, error) {
 	model, err := MakeModelFrame(conf.Name)
 	if err != nil {
 		return nil, err

diff --git a/components/arm/fake/fake.go b/components/arm/fake/fake.go
@@ -5,14 +5,14 @@ import (
 	"context"
 	"sync"
 
-	"github.com/edaniels/golog"
 	"github.com/pkg/errors"
 	pb "go.viam.com/api/component/arm/v1"
 
 	"go.viam.com/rdk/components/arm"
 	"go.viam.com/rdk/components/arm/eva"
 	ur "go.viam.com/rdk/components/arm/universalrobots"
 	"go.viam.com/rdk/components/arm/xarm"
+	"go.viam.com/rdk/logging"
 	"go.viam.com/rdk/motionplan"
 	"go.viam.com/rdk/referenceframe"
 	"go.viam.com/rdk/resource"
@@ -65,7 +65,7 @@ func init() {
 }
 
 // NewArm returns a new fake arm.
-func NewArm(ctx context.Context, deps resource.Dependencies, conf resource.Config, logger golog.Logger) (arm.Arm, error) {
+func NewArm(ctx context.Context, deps resource.Dependencies, conf resource.Config, logger logging.Logger) (arm.Arm, error) {
 	a := &Arm{
 		Named:  conf.ResourceName().AsNamed(),
 		logger: logger,
@@ -103,7 +103,7 @@ func buildModel(cfg resource.Config, newConf *Config) (referenceframe.Model, err
 type Arm struct {
 	resource.Named
 	CloseCount int
-	logger     golog.Logger
+	logger     logging.Logger
 
 	mu     sync.RWMutex
 	joints *pb.JointPositions

diff --git a/components/arm/fake/fake_test.go b/components/arm/fake/fake_test.go
@@ -4,16 +4,16 @@ import (
 	"context"
 	"testing"
 
-	"github.com/edaniels/golog"
 	pb "go.viam.com/api/component/arm/v1"
 	"go.viam.com/test"
 
+	"go.viam.com/rdk/logging"
 	"go.viam.com/rdk/referenceframe"
 	"go.viam.com/rdk/resource"
 )
 
 func TestReconfigure(t *testing.T) {
-	logger := golog.NewTestLogger(t)
+	logger := logging.NewTestLogger(t)
 
 	cfg := resource.Config{
 		Name: "testArm",