From 879eb18143635538993262d9f3a74c17a92eab89 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Fri, 8 Mar 2024 13:42:23 -0500 Subject: [PATCH 1/2] DOCS-1827: Update Go module logging examples --- docs/registry/create/_index.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/registry/create/_index.md b/docs/registry/create/_index.md index 653e5076f3..603400a44c 100644 --- a/docs/registry/create/_index.md +++ b/docs/registry/create/_index.md @@ -437,7 +437,7 @@ func (b *myBase) Reconfigure(ctx context.Context, deps resource.Dependencies, co geometries, err := kinematicbase.CollisionGeometry(conf.Frame) if err != nil { - b.logger.Warnf("base %v %s", b.Name(), err.Error()) + b.logger.CWarnw(ctx, "base %v %s", b.Name(), err.Error()) } b.geometries = geometries @@ -497,7 +497,7 @@ func (b *myBase) SetVelocity(ctx context.Context, linear, angular r3.Vector, ext // SetPower computes relative power between the wheels and sets power for both motors. func (b *myBase) SetPower(ctx context.Context, linear, angular r3.Vector, extra map[string]interface{}) error { - b.logger.Debugf("SetPower Linear: %.2f Angular: %.2f", linear.Y, angular.Z) + b.logger.CDebugw(ctx, "SetPower Linear: %.2f Angular: %.2f", linear.Y, angular.Z) if math.Abs(linear.Y) < 0.01 && math.Abs(angular.Z) < 0.01 { return b.Stop(ctx, extra) } @@ -509,7 +509,7 @@ func (b *myBase) SetPower(ctx context.Context, linear, angular r3.Vector, extra // Stop halts motion. func (b *myBase) Stop(ctx context.Context, extra map[string]interface{}) error { - b.logger.Debug("Stop") + b.logger.CDebugw(ctx, "Stop") err1 := b.left.Stop(ctx, extra) err2 := b.right.Stop(ctx, extra) return multierr.Combine(err1, err2) @@ -1060,13 +1060,15 @@ func init() { resource.RegisterComponent(...) } // Finally, when you need to log, use the functions on your component's logger: -fn (c *component) someFunction(a int) { +fn (c *component) someFunction(ctx context.Context, a int) { // Log with severity info: - c.logger.Infof("performing some function with a=%v",a) + c.logger.CInfow(ctx, "performing some function with a=%v", a) // Log with severity debug (using value wrapping): - c.logger.Debugw("performing some function","a",a) + c.logger.CDebugw(ctx, "performing some function", "a" ,a) + // Log with severity warn: + c.logger.CWarnw(ctx, "encountered warning for component: %v ", c.Name()) // Log with severity error without a parameter: - c.logger.Errorln("performing some function") + c.logger.CErrorw(ctx, "encountered an error") } ``` From 85e4ec2457b6116db66caaa779a166dd3ee1a4ed Mon Sep 17 00:00:00 2001 From: andf-viam <132301587+andf-viam@users.noreply.github.com> Date: Fri, 8 Mar 2024 14:27:47 -0500 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Benjamin Rewis <32186188+benjirewis@users.noreply.github.com> --- docs/registry/create/_index.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/registry/create/_index.md b/docs/registry/create/_index.md index 603400a44c..dcd8124312 100644 --- a/docs/registry/create/_index.md +++ b/docs/registry/create/_index.md @@ -437,7 +437,7 @@ func (b *myBase) Reconfigure(ctx context.Context, deps resource.Dependencies, co geometries, err := kinematicbase.CollisionGeometry(conf.Frame) if err != nil { - b.logger.CWarnw(ctx, "base %v %s", b.Name(), err.Error()) + b.logger.CWarnf(ctx, "base %v %s", b.Name(), err.Error()) } b.geometries = geometries @@ -497,7 +497,7 @@ func (b *myBase) SetVelocity(ctx context.Context, linear, angular r3.Vector, ext // SetPower computes relative power between the wheels and sets power for both motors. func (b *myBase) SetPower(ctx context.Context, linear, angular r3.Vector, extra map[string]interface{}) error { - b.logger.CDebugw(ctx, "SetPower Linear: %.2f Angular: %.2f", linear.Y, angular.Z) + b.logger.CDebugf(ctx, "SetPower Linear: %.2f Angular: %.2f", linear.Y, angular.Z) if math.Abs(linear.Y) < 0.01 && math.Abs(angular.Z) < 0.01 { return b.Stop(ctx, extra) } @@ -509,7 +509,7 @@ func (b *myBase) SetPower(ctx context.Context, linear, angular r3.Vector, extra // Stop halts motion. func (b *myBase) Stop(ctx context.Context, extra map[string]interface{}) error { - b.logger.CDebugw(ctx, "Stop") + b.logger.CDebug(ctx, "Stop") err1 := b.left.Stop(ctx, extra) err2 := b.right.Stop(ctx, extra) return multierr.Combine(err1, err2) @@ -1062,13 +1062,13 @@ func init() { // Finally, when you need to log, use the functions on your component's logger: fn (c *component) someFunction(ctx context.Context, a int) { // Log with severity info: - c.logger.CInfow(ctx, "performing some function with a=%v", a) + c.logger.CInfof(ctx, "performing some function with a=%v", a) // Log with severity debug (using value wrapping): c.logger.CDebugw(ctx, "performing some function", "a" ,a) // Log with severity warn: - c.logger.CWarnw(ctx, "encountered warning for component: %v ", c.Name()) + c.logger.CWarnw(ctx, "encountered warning for component", "name", c.Name()) // Log with severity error without a parameter: - c.logger.CErrorw(ctx, "encountered an error") + c.logger.CError(ctx, "encountered an error") } ```