feat: add service version in service context for error reporting

.gitignore

@@ -1 +1,2 @@
 vendor/
+.idea

core.go

@@ -15,6 +15,9 @@ type driverConfig struct {
 
 	// ServiceName is added as `ServiceContext()` to all logs when set
 	ServiceName string
+
+	// ServiceVersion is added as `ServiceVersionContext()` to all logs when set
+	ServiceVersion string
 }
 
 // Core is a zapdriver specific core wrapped around the default zap core. It
@@ -58,6 +61,14 @@ func ServiceName(name string) func(*core) {
 	}
 }
 
+// zapdriver core option to add `ServiceVersion()` to all logs with `version` as
+// service version
+func ServiceVersion(version string) func(*core) {
+	return func(c *core) {
+		c.config.ServiceVersion = version
+	}
+}
+
 // WrapCore returns a `zap.Option` that wraps the default core with the
 // zapdriver one.
 func WrapCore(options ...func(*core)) zap.Option {
@@ -124,14 +135,14 @@ func (c *core) Write(ent zapcore.Entry, fields []zapcore.Field) error {
 	fields = append(fields, labelsField(c.allLabels()))
 	fields = c.withSourceLocation(ent, fields)
 	if c.config.ServiceName != "" {
-		fields = c.withServiceContext(c.config.ServiceName, fields)
+		fields = c.withServiceContext(c.config.ServiceName, c.config.ServiceVersion, fields)
 	}
 	if c.config.ReportAllErrors && zapcore.ErrorLevel.Enabled(ent.Level) {
 		fields = c.withErrorReport(ent, fields)
 		if c.config.ServiceName == "" {
 			// A service name was not set but error report needs it
 			// So attempt to add a generic service name
-			fields = c.withServiceContext("unknown", fields)
+			fields = c.withServiceContext("unknown", c.config.ServiceVersion, fields)
 		}
 	}
 
@@ -216,15 +227,15 @@ func (c *core) withSourceLocation(ent zapcore.Entry, fields []zapcore.Field) []z
 	return append(fields, SourceLocation(ent.Caller.PC, ent.Caller.File, ent.Caller.Line, true))
 }
 
-func (c *core) withServiceContext(name string, fields []zapcore.Field) []zapcore.Field {
+func (c *core) withServiceContext(name, version string, fields []zapcore.Field) []zapcore.Field {
 	// If the service context was manually set, don't overwrite it
 	for i := range fields {
 		if fields[i].Key == serviceContextKey {
 			return fields
 		}
 	}
 
-	return append(fields, ServiceContext(name))
+	return append(fields, ServiceContext(name, version))
 }
 
 func (c *core) withErrorReport(ent zapcore.Entry, fields []zapcore.Field) []zapcore.Field {

core_test.go

@@ -141,10 +141,10 @@ func TestWithServiceContext(t *testing.T) {
 
 	want := []zap.Field{
 		zap.String("hello", "world"),
-		zap.Object(serviceContextKey, newServiceContext("test service")),
+		zap.Object(serviceContextKey, newServiceContext("test service", "test version")),
 	}
 
-	assert.Equal(t, want, (&core{}).withServiceContext("test service", fields))
+	assert.Equal(t, want, (&core{}).withServiceContext("test service", "test version", fields))
 }
 
 func TestWithServiceContext_DoesNotOverwrite(t *testing.T) {
@@ -154,7 +154,7 @@ func TestWithServiceContext_DoesNotOverwrite(t *testing.T) {
 		zap.String(serviceContextKey, "world"),
 	}
 
-	assert.Equal(t, want, (&core{}).withServiceContext("test service", fields))
+	assert.Equal(t, want, (&core{}).withServiceContext("test service", "test version", fields))
 }
 
 func TestWrite(t *testing.T) {
@@ -299,7 +299,8 @@ func TestWriteServiceContext(t *testing.T) {
 		permLabels: newLabels(),
 		tempLabels: newLabels(),
 		config: driverConfig{
-			ServiceName: "test service",
+			ServiceName:    "test service",
+			ServiceVersion: "v0.0.1",
 		},
 	})
 
@@ -309,6 +310,7 @@ func TestWriteServiceContext(t *testing.T) {
 	// Assert that a service context was attached even though service name was not set
 	serviceContext := logs.All()[0].ContextMap()[serviceContextKey].(map[string]interface{})
 	assert.Equal(t, "test service", serviceContext["service"])
+	assert.Equal(t, "v0.0.1", serviceContext["version"])
 }
 
 func TestWriteReportAllErrors_WithServiceContext(t *testing.T) {
@@ -320,6 +322,7 @@ func TestWriteReportAllErrors_WithServiceContext(t *testing.T) {
 		config: driverConfig{
 			ReportAllErrors: true,
 			ServiceName:     "test service",
+			ServiceVersion:  "v0.0.1",
 		},
 	})
 
@@ -335,6 +338,7 @@ func TestWriteReportAllErrors_WithServiceContext(t *testing.T) {
 	// Assert that a service context was attached even though service name was not set
 	serviceContext := logs.All()[0].ContextMap()[serviceContextKey].(map[string]interface{})
 	assert.Equal(t, "test service", serviceContext["service"])
+	assert.Equal(t, "v0.0.1", serviceContext["version"])
 }
 
 func TestWriteReportAllErrors_InfoLog(t *testing.T) {

service.go

@@ -12,25 +12,27 @@ const serviceContextKey = "serviceContext"
 //
 // see: https://cloud.google.com/error-reporting/reference/rest/v1beta1/ServiceContext
 // see: https://cloud.google.com/error-reporting/docs/formatting-error-messages
-func ServiceContext(name string) zap.Field {
-	return zap.Object(serviceContextKey, newServiceContext(name))
+func ServiceContext(name, version string) zap.Field {
+	return zap.Object(serviceContextKey, newServiceContext(name, version))
 }
 
 // serviceContext describes a running service that sends errors.
 // Currently it only describes a service name.
 type serviceContext struct {
-	Name string `json:"service"`
+	Name    string `json:"service"`
+	Version string `json:"version"`
 }
 
 // MarshalLogObject implements zapcore.ObjectMarshaller interface.
 func (service_context serviceContext) MarshalLogObject(enc zapcore.ObjectEncoder) error {
 	enc.AddString("service", service_context.Name)
-
+	enc.AddString("version", service_context.Version)
 	return nil
 }
 
-func newServiceContext(name string) *serviceContext {
+func newServiceContext(name, version string) *serviceContext {
 	return &serviceContext{
-		Name: name,
+		Name:    name,
+		Version: version,
 	}
 }

service_test.go

@@ -9,15 +9,17 @@ import (
 func TestServiceContext(t *testing.T) {
 	t.Parallel()
 
-	got := ServiceContext("test service name").Interface.(*serviceContext)
+	got := ServiceContext("test service name", "v1").Interface.(*serviceContext)
 
 	assert.Equal(t, "test service name", got.Name)
+	assert.Equal(t, "v1", got.Version)
 }
 
 func TestNewServiceContext(t *testing.T) {
 	t.Parallel()
 
-	got := newServiceContext("test service name")
+	got := newServiceContext("test service name", "v1")
 
 	assert.Equal(t, "test service name", got.Name)
+	assert.Equal(t, "v1", got.Version)
 }