reduce logging output

changelog/unreleased/reduce-log-output.md

@@ -0,0 +1,6 @@
+Change: Reduce log output
+
+Reduced log output. Some errors or warnings were logged multiple times or even unnecesarily. 
+
+
+https://github.com/cs3org/reva/pull/2353

internal/grpc/interceptors/auth/auth.go

@@ -242,7 +242,7 @@ func dismantleToken(ctx context.Context, tkn string, req interface{}, mgr token.
 func getUserGroups(ctx context.Context, u *userpb.User, client gatewayv1beta1.GatewayAPIClient) ([]string, error) {
 	if groupsIf, err := userGroupsCache.Get(u.Id.OpaqueId); err == nil {
 		log := appctx.GetLogger(ctx)
-		log.Info().Msgf("user groups found in cache %s", u.Id.OpaqueId)
+		log.Info().Str("userid", u.Id.OpaqueId).Msg("user groups found in cache")
 		return groupsIf.([]string), nil
 	}
 

internal/grpc/interceptors/auth/scope.go

@@ -63,7 +63,7 @@ func expandAndVerifyScope(ctx context.Context, req interface{}, tokenScope map[s
 		// trying to impersonate the owner, since the share manager doesn't know the
 		// share path.
 		if ref.GetPath() != "" {
-			log.Info().Msgf("resolving path reference to ID to check token scope %+v", ref.GetPath())
+			log.Info().Str("path", ref.GetPath()).Msg("resolving path reference to ID to check token scope")
 			for k := range tokenScope {
 				switch {
 				case strings.HasPrefix(k, "publicshare"):
@@ -138,7 +138,7 @@ func expandAndVerifyScope(ctx context.Context, req interface{}, tokenScope map[s
 		// It's a share ref
 		// The request might be coming from a share created for a lightweight account
 		// after the token was minted.
-		log.Info().Msgf("resolving share reference against received shares to verify token scope %+v", ref)
+		log.Info().Interface("reference", ref).Msg("resolving share reference against received shares to verify token scope")
 		client, err := pool.GetGatewayServiceClient(gatewayAddr)
 		if err != nil {
 			return err

internal/grpc/services/applicationauth/applicationauth.go

@@ -106,7 +106,7 @@ func (s *service) GenerateAppPassword(ctx context.Context, req *appauthpb.Genera
 	pwd, err := s.am.GenerateAppPassword(ctx, req.TokenScope, req.Label, req.Expiration)
 	if err != nil {
 		return &appauthpb.GenerateAppPasswordResponse{
-			Status: status.NewInternal(ctx, err, "error generating app password"),
+			Status: status.NewInternal(ctx, "error generating app password"),
 		}, nil
 	}
 
@@ -120,7 +120,7 @@ func (s *service) ListAppPasswords(ctx context.Context, req *appauthpb.ListAppPa
 	pwds, err := s.am.ListAppPasswords(ctx)
 	if err != nil {
 		return &appauthpb.ListAppPasswordsResponse{
-			Status: status.NewInternal(ctx, err, "error listing app passwords"),
+			Status: status.NewInternal(ctx, "error listing app passwords"),
 		}, nil
 	}
 
@@ -134,7 +134,7 @@ func (s *service) InvalidateAppPassword(ctx context.Context, req *appauthpb.Inva
 	err := s.am.InvalidateAppPassword(ctx, req.Password)
 	if err != nil {
 		return &appauthpb.InvalidateAppPasswordResponse{
-			Status: status.NewInternal(ctx, err, "error invalidating app password"),
+			Status: status.NewInternal(ctx, "error invalidating app password"),
 		}, nil
 	}
 
@@ -147,7 +147,7 @@ func (s *service) GetAppPassword(ctx context.Context, req *appauthpb.GetAppPassw
 	pwd, err := s.am.GetAppPassword(ctx, req.User, req.Password)
 	if err != nil {
 		return &appauthpb.GetAppPasswordResponse{
-			Status: status.NewInternal(ctx, err, "error getting app password via username/password"),
+			Status: status.NewInternal(ctx, "error getting app password via username/password"),
 		}, nil
 	}
 

internal/grpc/services/appprovider/appprovider.go

@@ -20,7 +20,6 @@ package appprovider
 
 import (
 	"context"
-	"errors"
 	"os"
 	"strconv"
 	"time"
@@ -106,7 +105,7 @@ func (s *service) registerProvider() {
 	log := logger.New().With().Int("pid", os.Getpid()).Logger()
 	pInfo, err := s.provider.GetAppProviderInfo(ctx)
 	if err != nil {
-		log.Error().Err(err).Msgf("error registering app provider: could not get provider info")
+		log.Error().Err(err).Msg("error registering app provider: could not get provider info")
 		return
 	}
 	pInfo.Address = s.conf.AppProviderURL
@@ -122,7 +121,7 @@ func (s *service) registerProvider() {
 
 	client, err := pool.GetGatewayServiceClient(s.conf.GatewaySvc)
 	if err != nil {
-		log.Error().Err(err).Msgf("error registering app provider: could not get gateway client")
+		log.Error().Err(err).Msg("error registering app provider: could not get gateway client")
 		return
 	}
 	req := &registrypb.AddAppProviderRequest{Provider: pInfo}
@@ -140,12 +139,12 @@ func (s *service) registerProvider() {
 
 	res, err := client.AddAppProvider(ctx, req)
 	if err != nil {
-		log.Error().Err(err).Msgf("error registering app provider: error calling add app provider")
+		log.Error().Err(err).Msg("error registering app provider: error calling add app provider")
 		return
 	}
 	if res.Status.Code != rpc.Code_CODE_OK {
 		err = status.NewErrorFromCode(res.Status.Code, "appprovider")
-		log.Error().Err(err).Msgf("error registering app provider: add app provider returned error")
+		log.Error().Err(err).Msg("error registering app provider: add app provider returned error")
 		return
 	}
 }
@@ -173,7 +172,7 @@ func (s *service) OpenInApp(ctx context.Context, req *providerpb.OpenInAppReques
 	appURL, err := s.provider.GetAppURL(ctx, req.ResourceInfo, req.ViewMode, req.AccessToken)
 	if err != nil {
 		res := &providerpb.OpenInAppResponse{
-			Status: status.NewInternal(ctx, errors.New("appprovider: error calling GetAppURL"), err.Error()),
+			Status: status.NewInternal(ctx, err.Error()),
 		}
 		return res, nil
 	}

internal/grpc/services/appregistry/appregistry.go

@@ -103,7 +103,7 @@ func (s *svc) GetAppProviders(ctx context.Context, req *registrypb.GetAppProvide
 	p, err := s.reg.FindProviders(ctx, req.ResourceInfo.MimeType)
 	if err != nil {
 		return &registrypb.GetAppProvidersResponse{
-			Status: status.NewInternal(ctx, err, "error looking for the app provider"),
+			Status: status.NewInternal(ctx, "error looking for the app provider"),
 		}, nil
 	}
 
@@ -118,7 +118,7 @@ func (s *svc) AddAppProvider(ctx context.Context, req *registrypb.AddAppProvider
 	err := s.reg.AddProvider(ctx, req.Provider)
 	if err != nil {
 		return &registrypb.AddAppProviderResponse{
-			Status: status.NewInternal(ctx, err, "error adding the app provider"),
+			Status: status.NewInternal(ctx, "error adding the app provider"),
 		}, nil
 	}
 
@@ -132,7 +132,7 @@ func (s *svc) ListAppProviders(ctx context.Context, req *registrypb.ListAppProvi
 	providers, err := s.reg.ListProviders(ctx)
 	if err != nil {
 		return &registrypb.ListAppProvidersResponse{
-			Status: status.NewInternal(ctx, err, "error listing the app providers"),
+			Status: status.NewInternal(ctx, "error listing the app providers"),
 		}, nil
 	}
 
@@ -147,7 +147,7 @@ func (s *svc) ListSupportedMimeTypes(ctx context.Context, req *registrypb.ListSu
 	mimeTypes, err := s.reg.ListSupportedMimeTypes(ctx)
 	if err != nil {
 		return &registrypb.ListSupportedMimeTypesResponse{
-			Status: status.NewInternal(ctx, err, "error listing the supported mime types"),
+			Status: status.NewInternal(ctx, "error listing the supported mime types"),
 		}, nil
 	}
 
@@ -169,7 +169,7 @@ func (s *svc) GetDefaultAppProviderForMimeType(ctx context.Context, req *registr
 	provider, err := s.reg.GetDefaultProviderForMimeType(ctx, req.MimeType)
 	if err != nil {
 		return &registrypb.GetDefaultAppProviderForMimeTypeResponse{
-			Status: status.NewInternal(ctx, err, "error getting the default app provider for the mimetype"),
+			Status: status.NewInternal(ctx, "error getting the default app provider for the mimetype"),
 		}, nil
 	}
 
@@ -184,7 +184,7 @@ func (s *svc) SetDefaultAppProviderForMimeType(ctx context.Context, req *registr
 	err := s.reg.SetDefaultProviderForMimeType(ctx, req.MimeType, req.Provider)
 	if err != nil {
 		return &registrypb.SetDefaultAppProviderForMimeTypeResponse{
-			Status: status.NewInternal(ctx, err, "error setting the default app provider for the mimetype"),
+			Status: status.NewInternal(ctx, "error setting the default app provider for the mimetype"),
 		}, nil
 	}
 

internal/grpc/services/authprovider/authprovider.go

@@ -138,7 +138,7 @@ func (s *service) Authenticate(ctx context.Context, req *provider.AuthenticateRe
 	u, scope, err := s.authmgr.Authenticate(ctx, username, password)
 	switch v := err.(type) {
 	case nil:
-		log.Info().Msgf("user %s authenticated", u.String())
+		log.Info().Str("user", u.String()).Msg("user authenticated")
 		return &provider.AuthenticateResponse{
 			Status:     status.NewOK(ctx),
 			User:       u,
@@ -149,6 +149,7 @@ func (s *service) Authenticate(ctx context.Context, req *provider.AuthenticateRe
 			Status: status.NewPermissionDenied(ctx, v, "wrong password"),
 		}, nil
 	case errtypes.NotFound:
+		log.Debug().Str("client_id", username).Msg("unknown client id")
 		return &provider.AuthenticateResponse{
 			Status: status.NewNotFound(ctx, "unknown client id"),
 		}, nil

internal/grpc/services/authregistry/authregistry.go

@@ -105,7 +105,7 @@ func (s *service) ListAuthProviders(ctx context.Context, req *registrypb.ListAut
 	pinfos, err := s.reg.ListProviders(ctx)
 	if err != nil {
 		return &registrypb.ListAuthProvidersResponse{
-			Status: status.NewInternal(ctx, err, "error getting list of auth providers"),
+			Status: status.NewInternal(ctx, "error getting list of auth providers"),
 		}, nil
 	}
 
@@ -120,7 +120,7 @@ func (s *service) GetAuthProvider(ctx context.Context, req *registrypb.GetAuthPr
 	pinfo, err := s.reg.GetProvider(ctx, req.Type)
 	if err != nil {
 		return &registrypb.GetAuthProviderResponse{
-			Status: status.NewInternal(ctx, err, "error getting auth provider for type: "+req.Type),
+			Status: status.NewInternal(ctx, "error getting auth provider for type: "+req.Type),
 		}, nil
 	}
 

internal/grpc/services/gateway/applicationauth.go

@@ -30,9 +30,8 @@ import (
 func (s *svc) GenerateAppPassword(ctx context.Context, req *appauthpb.GenerateAppPasswordRequest) (*appauthpb.GenerateAppPasswordResponse, error) {
 	c, err := pool.GetAppAuthProviderServiceClient(s.c.ApplicationAuthEndpoint)
 	if err != nil {
-		err = errors.Wrap(err, "gateway: error calling GetAppAuthProviderServiceClient")
 		return &appauthpb.GenerateAppPasswordResponse{
-			Status: status.NewInternal(ctx, err, "error getting app auth provider client"),
+			Status: status.NewInternal(ctx, "error getting app auth provider client"),
 		}, nil
 	}
 
@@ -47,9 +46,8 @@ func (s *svc) GenerateAppPassword(ctx context.Context, req *appauthpb.GenerateAp
 func (s *svc) ListAppPasswords(ctx context.Context, req *appauthpb.ListAppPasswordsRequest) (*appauthpb.ListAppPasswordsResponse, error) {
 	c, err := pool.GetAppAuthProviderServiceClient(s.c.ApplicationAuthEndpoint)
 	if err != nil {
-		err = errors.Wrap(err, "gateway: error calling GetAppAuthProviderServiceClient")
 		return &appauthpb.ListAppPasswordsResponse{
-			Status: status.NewInternal(ctx, err, "error getting app auth provider client"),
+			Status: status.NewInternal(ctx, "error getting app auth provider client"),
 		}, nil
 	}
 
@@ -64,9 +62,8 @@ func (s *svc) ListAppPasswords(ctx context.Context, req *appauthpb.ListAppPasswo
 func (s *svc) InvalidateAppPassword(ctx context.Context, req *appauthpb.InvalidateAppPasswordRequest) (*appauthpb.InvalidateAppPasswordResponse, error) {
 	c, err := pool.GetAppAuthProviderServiceClient(s.c.ApplicationAuthEndpoint)
 	if err != nil {
-		err = errors.Wrap(err, "gateway: error calling GetAppAuthProviderServiceClient")
 		return &appauthpb.InvalidateAppPasswordResponse{
-			Status: status.NewInternal(ctx, err, "error getting app auth provider client"),
+			Status: status.NewInternal(ctx, "error getting app auth provider client"),
 		}, nil
 	}
 
@@ -81,9 +78,8 @@ func (s *svc) InvalidateAppPassword(ctx context.Context, req *appauthpb.Invalida
 func (s *svc) GetAppPassword(ctx context.Context, req *appauthpb.GetAppPasswordRequest) (*appauthpb.GetAppPasswordResponse, error) {
 	c, err := pool.GetAppAuthProviderServiceClient(s.c.ApplicationAuthEndpoint)
 	if err != nil {
-		err = errors.Wrap(err, "gateway: error calling GetAppAuthProviderServiceClient")
 		return &appauthpb.GetAppPasswordResponse{
-			Status: status.NewInternal(ctx, err, "error getting app auth provider client"),
+			Status: status.NewInternal(ctx, "error getting app auth provider client"),
 		}, nil
 	}
 

internal/grpc/services/gateway/appprovider.go

@@ -51,7 +51,7 @@ func (s *svc) OpenInApp(ctx context.Context, req *gateway.OpenInAppRequest) (*pr
 	})
 	if err != nil {
 		return &providerpb.OpenInAppResponse{
-			Status: status.NewInternal(ctx, err, "gateway: error calling Stat on the resource path for the app provider: "+req.Ref.GetPath()),
+			Status: status.NewInternal(ctx, "gateway: error calling Stat on the resource path for the app provider: "+req.Ref.GetPath()),
 		}, nil
 	}
 	if statRes.Status.Code != rpc.Code_CODE_OK {
@@ -67,7 +67,7 @@ func (s *svc) OpenInApp(ctx context.Context, req *gateway.OpenInAppRequest) (*pr
 		uri, err := url.Parse(fileInfo.Target)
 		if err != nil {
 			return &providerpb.OpenInAppResponse{
-				Status: status.NewInternal(ctx, err, "gateway: error parsing target uri: "+fileInfo.Target),
+				Status: status.NewInternal(ctx, "gateway: error parsing target uri: "+fileInfo.Target),
 			}, nil
 		}
 		if uri.Scheme == "webdav" {
@@ -80,13 +80,12 @@ func (s *svc) OpenInApp(ctx context.Context, req *gateway.OpenInAppRequest) (*pr
 		})
 		if err != nil {
 			return &providerpb.OpenInAppResponse{
-				Status: status.NewInternal(ctx, err, "gateway: error calling Stat on the resource path for the app provider: "+req.Ref.GetPath()),
+				Status: status.NewInternal(ctx, "gateway: error calling Stat on the resource path for the app provider: "+req.Ref.GetPath()),
 			}, nil
 		}
 		if res.Status.Code != rpc.Code_CODE_OK {
-			err := status.NewErrorFromCode(res.Status.GetCode(), "gateway")
 			return &providerpb.OpenInAppResponse{
-				Status: status.NewInternal(ctx, err, "Stat failed on the resource path for the app provider: "+req.Ref.GetPath()),
+				Status: status.NewInternal(ctx, "Stat failed on the resource path for the app provider: "+req.Ref.GetPath()),
 			}, nil
 		}
 		fileInfo = res.Info

internal/grpc/services/gateway/appregistry.go

@@ -30,9 +30,8 @@ import (
 func (s *svc) GetAppProviders(ctx context.Context, req *registry.GetAppProvidersRequest) (*registry.GetAppProvidersResponse, error) {
 	c, err := pool.GetAppRegistryClient(s.c.AppRegistryEndpoint)
 	if err != nil {
-		err = errors.Wrap(err, "gateway: error calling GetAppRegistryClient")
 		return &registry.GetAppProvidersResponse{
-			Status: status.NewInternal(ctx, err, "error getting app registry client"),
+			Status: status.NewInternal(ctx, "error getting app registry client"),
 		}, nil
 	}
 
@@ -47,9 +46,8 @@ func (s *svc) GetAppProviders(ctx context.Context, req *registry.GetAppProviders
 func (s *svc) AddAppProvider(ctx context.Context, req *registry.AddAppProviderRequest) (*registry.AddAppProviderResponse, error) {
 	c, err := pool.GetAppRegistryClient(s.c.AppRegistryEndpoint)
 	if err != nil {
-		err = errors.Wrap(err, "gateway: error calling GetAppRegistryClient")
 		return &registry.AddAppProviderResponse{
-			Status: status.NewInternal(ctx, err, "error getting app registry client"),
+			Status: status.NewInternal(ctx, "error getting app registry client"),
 		}, nil
 	}
 
@@ -64,9 +62,8 @@ func (s *svc) AddAppProvider(ctx context.Context, req *registry.AddAppProviderRe
 func (s *svc) ListAppProviders(ctx context.Context, req *registry.ListAppProvidersRequest) (*registry.ListAppProvidersResponse, error) {
 	c, err := pool.GetAppRegistryClient(s.c.AppRegistryEndpoint)
 	if err != nil {
-		err = errors.Wrap(err, "gateway: error calling GetAppRegistryClient")
 		return &registry.ListAppProvidersResponse{
-			Status: status.NewInternal(ctx, err, "error getting app registry client"),
+			Status: status.NewInternal(ctx, "error getting app registry client"),
 		}, nil
 	}
 
@@ -81,9 +78,8 @@ func (s *svc) ListAppProviders(ctx context.Context, req *registry.ListAppProvide
 func (s *svc) ListSupportedMimeTypes(ctx context.Context, req *registry.ListSupportedMimeTypesRequest) (*registry.ListSupportedMimeTypesResponse, error) {
 	c, err := pool.GetAppRegistryClient(s.c.AppRegistryEndpoint)
 	if err != nil {
-		err = errors.Wrap(err, "gateway: error calling GetAppRegistryClient")
 		return &registry.ListSupportedMimeTypesResponse{
-			Status: status.NewInternal(ctx, err, "error getting app registry client"),
+			Status: status.NewInternal(ctx, "error getting app registry client"),
 		}, nil
 	}
 
@@ -98,9 +94,8 @@ func (s *svc) ListSupportedMimeTypes(ctx context.Context, req *registry.ListSupp
 func (s *svc) GetDefaultAppProviderForMimeType(ctx context.Context, req *registry.GetDefaultAppProviderForMimeTypeRequest) (*registry.GetDefaultAppProviderForMimeTypeResponse, error) {
 	c, err := pool.GetAppRegistryClient(s.c.AppRegistryEndpoint)
 	if err != nil {
-		err = errors.Wrap(err, "gateway: error calling GetAppRegistryClient")
 		return &registry.GetDefaultAppProviderForMimeTypeResponse{
-			Status: status.NewInternal(ctx, err, "error getting app registry client"),
+			Status: status.NewInternal(ctx, "error getting app registry client"),
 		}, nil
 	}
 
@@ -115,9 +110,8 @@ func (s *svc) GetDefaultAppProviderForMimeType(ctx context.Context, req *registr
 func (s *svc) SetDefaultAppProviderForMimeType(ctx context.Context, req *registry.SetDefaultAppProviderForMimeTypeRequest) (*registry.SetDefaultAppProviderForMimeTypeResponse, error) {
 	c, err := pool.GetAppRegistryClient(s.c.AppRegistryEndpoint)
 	if err != nil {
-		err = errors.Wrap(err, "gateway: error calling GetAppRegistryClient")
 		return &registry.SetDefaultAppProviderForMimeTypeResponse{
-			Status: status.NewInternal(ctx, err, "error getting app registry client"),
+			Status: status.NewInternal(ctx, "error getting app registry client"),
 		}, nil
 	}