Update internal/shared/logutil/convert.go.tmpl

Co-authored-by: Robert Pająk <[email protected]>
open-telemetry · Oct 14, 2024 · 27601bc · 27601bc
1 parent 9bca788
commit 27601bc
Show file tree

Hide file tree

Showing 11 changed files with 35 additions and 35 deletions.
diff --git a/bridges/otellogr/convert.go b/bridges/otellogr/convert.go
@@ -16,8 +16,8 @@ import (
 	"go.opentelemetry.io/otel/log"
 )
 
-// Convert various types to log.Value.
-func ConvertValue(v any) log.Value {
+// convertValue converts various types to log.Value.
+func convertValue(v any) log.Value {
 	// Handling the most common types without reflect is a small perf win.
 	switch val := v.(type) {
 	case bool:
@@ -79,7 +79,7 @@ func ConvertValue(v any) log.Value {
 	case reflect.Slice, reflect.Array:
 		items := make([]log.Value, 0, val.Len())
 		for i := 0; i < val.Len(); i++ {
-			items = append(items, ConvertValue(val.Index(i).Interface()))
+			items = append(items, convertValue(val.Index(i).Interface()))
 		}
 		return log.SliceValue(items...)
 	case reflect.Map:
@@ -94,15 +94,15 @@ func ConvertValue(v any) log.Value {
 			}
 			kvs = append(kvs, log.KeyValue{
 				Key:   key,
-				Value: ConvertValue(val.MapIndex(k).Interface()),
+				Value: convertValue(val.MapIndex(k).Interface()),
 			})
 		}
 		return log.MapValue(kvs...)
 	case reflect.Ptr, reflect.Interface:
 		if val.IsNil() {
 			return log.Value{}
 		}
-		return ConvertValue(val.Elem().Interface())
+		return convertValue(val.Elem().Interface())
 	}
 
 	// Try to handle this as gracefully as possible.
@@ -113,7 +113,7 @@ func ConvertValue(v any) log.Value {
 	return log.StringValue(fmt.Sprintf("unhandled: (%s) %+v", t, v))
 }
 
-// ConvertUintValue converts a uint64 to a log.Value.
+// convertUintValue converts a uint64 to a log.Value.
 // If the value is too large to fit in an int64, it is converted to a string.
 func convertUintValue(v uint64) log.Value {
 	if v > math.MaxInt64 {

diff --git a/bridges/otellogr/convert_test.go b/bridges/otellogr/convert_test.go
@@ -252,13 +252,13 @@ func TestConvertValue(t *testing.T) {
 		},
 	} {
 		t.Run(tt.name, func(t *testing.T) {
-			assert.Equal(t, tt.wantValue, ConvertValue(tt.value))
+			assert.Equal(t, tt.wantValue, convertValue(tt.value))
 		})
 	}
 }
 
 func TestConvertValueFloat32(t *testing.T) {
-	value := ConvertValue(float32(3.14))
+	value := convertValue(float32(3.14))
 	want := log.Float64Value(3.14)
 
 	assert.InDelta(t, value.AsFloat64(), want.AsFloat64(), 0.0001)

diff --git a/bridges/otellogr/logsink.go b/bridges/otellogr/logsink.go
@@ -229,7 +229,7 @@ func convertKVs(ctx context.Context, keysAndValues ...any) (context.Context, []l
 
 		kvs = append(kvs, log.KeyValue{
 			Key:   k,
-			Value: ConvertValue(v),
+			Value: convertValue(v),
 		})
 	}
 

diff --git a/bridges/otellogrus/convert.go b/bridges/otellogrus/convert.go
@@ -16,8 +16,8 @@ import (
 	"go.opentelemetry.io/otel/log"
 )
 
-// Convert various types to log.Value.
-func ConvertValue(v any) log.Value {
+// convertValue converts various types to log.Value.
+func convertValue(v any) log.Value {
 	// Handling the most common types without reflect is a small perf win.
 	switch val := v.(type) {
 	case bool:
@@ -79,7 +79,7 @@ func ConvertValue(v any) log.Value {
 	case reflect.Slice, reflect.Array:
 		items := make([]log.Value, 0, val.Len())
 		for i := 0; i < val.Len(); i++ {
-			items = append(items, ConvertValue(val.Index(i).Interface()))
+			items = append(items, convertValue(val.Index(i).Interface()))
 		}
 		return log.SliceValue(items...)
 	case reflect.Map:
@@ -94,15 +94,15 @@ func ConvertValue(v any) log.Value {
 			}
 			kvs = append(kvs, log.KeyValue{
 				Key:   key,
-				Value: ConvertValue(val.MapIndex(k).Interface()),
+				Value: convertValue(val.MapIndex(k).Interface()),
 			})
 		}
 		return log.MapValue(kvs...)
 	case reflect.Ptr, reflect.Interface:
 		if val.IsNil() {
 			return log.Value{}
 		}
-		return ConvertValue(val.Elem().Interface())
+		return convertValue(val.Elem().Interface())
 	}
 
 	// Try to handle this as gracefully as possible.
@@ -113,7 +113,7 @@ func ConvertValue(v any) log.Value {
 	return log.StringValue(fmt.Sprintf("unhandled: (%s) %+v", t, v))
 }
 
-// ConvertUintValue converts a uint64 to a log.Value.
+// convertUintValue converts a uint64 to a log.Value.
 // If the value is too large to fit in an int64, it is converted to a string.
 func convertUintValue(v uint64) log.Value {
 	if v > math.MaxInt64 {

diff --git a/bridges/otellogrus/convert_test.go b/bridges/otellogrus/convert_test.go
@@ -252,13 +252,13 @@ func TestConvertValue(t *testing.T) {
 		},
 	} {
 		t.Run(tt.name, func(t *testing.T) {
-			assert.Equal(t, tt.wantValue, ConvertValue(tt.value))
+			assert.Equal(t, tt.wantValue, convertValue(tt.value))
 		})
 	}
 }
 
 func TestConvertValueFloat32(t *testing.T) {
-	value := ConvertValue(float32(3.14))
+	value := convertValue(float32(3.14))
 	want := log.Float64Value(3.14)
 
 	assert.InDelta(t, value.AsFloat64(), want.AsFloat64(), 0.0001)

diff --git a/bridges/otellogrus/hook.go b/bridges/otellogrus/hook.go
@@ -174,7 +174,7 @@ func convertFields(fields logrus.Fields) []log.KeyValue {
 	for k, v := range fields {
 		kvs = append(kvs, log.KeyValue{
 			Key:   k,
-			Value: ConvertValue(v),
+			Value: convertValue(v),
 		})
 	}
 	return kvs

diff --git a/bridges/otelzap/convert.go b/bridges/otelzap/convert.go
@@ -16,8 +16,8 @@ import (
 	"go.opentelemetry.io/otel/log"
 )
 
-// Convert various types to log.Value.
-func ConvertValue(v any) log.Value {
+// convertValue converts various types to log.Value.
+func convertValue(v any) log.Value {
 	// Handling the most common types without reflect is a small perf win.
 	switch val := v.(type) {
 	case bool:
@@ -79,7 +79,7 @@ func ConvertValue(v any) log.Value {
 	case reflect.Slice, reflect.Array:
 		items := make([]log.Value, 0, val.Len())
 		for i := 0; i < val.Len(); i++ {
-			items = append(items, ConvertValue(val.Index(i).Interface()))
+			items = append(items, convertValue(val.Index(i).Interface()))
 		}
 		return log.SliceValue(items...)
 	case reflect.Map:
@@ -94,15 +94,15 @@ func ConvertValue(v any) log.Value {
 			}
 			kvs = append(kvs, log.KeyValue{
 				Key:   key,
-				Value: ConvertValue(val.MapIndex(k).Interface()),
+				Value: convertValue(val.MapIndex(k).Interface()),
 			})
 		}
 		return log.MapValue(kvs...)
 	case reflect.Ptr, reflect.Interface:
 		if val.IsNil() {
 			return log.Value{}
 		}
-		return ConvertValue(val.Elem().Interface())
+		return convertValue(val.Elem().Interface())
 	}
 
 	// Try to handle this as gracefully as possible.
@@ -113,7 +113,7 @@ func ConvertValue(v any) log.Value {
 	return log.StringValue(fmt.Sprintf("unhandled: (%s) %+v", t, v))
 }
 
-// ConvertUintValue converts a uint64 to a log.Value.
+// convertUintValue converts a uint64 to a log.Value.
 // If the value is too large to fit in an int64, it is converted to a string.
 func convertUintValue(v uint64) log.Value {
 	if v > math.MaxInt64 {

diff --git a/bridges/otelzap/convert_test.go b/bridges/otelzap/convert_test.go
@@ -252,13 +252,13 @@ func TestConvertValue(t *testing.T) {
 		},
 	} {
 		t.Run(tt.name, func(t *testing.T) {
-			assert.Equal(t, tt.wantValue, ConvertValue(tt.value))
+			assert.Equal(t, tt.wantValue, convertValue(tt.value))
 		})
 	}
 }
 
 func TestConvertValueFloat32(t *testing.T) {
-	value := ConvertValue(float32(3.14))
+	value := convertValue(float32(3.14))
 	want := log.Float64Value(3.14)
 
 	assert.InDelta(t, value.AsFloat64(), want.AsFloat64(), 0.0001)

diff --git a/bridges/otelzap/encoder.go b/bridges/otelzap/encoder.go
@@ -119,7 +119,7 @@ func (m *objectEncoder) AddReflected(k string, v interface{}) error {
 	m.cur.attrs = append(m.cur.attrs,
 		log.KeyValue{
 			Key:   k,
-			Value: ConvertValue(v),
+			Value: convertValue(v),
 		})
 	return nil
 }
@@ -219,7 +219,7 @@ func (a *arrayEncoder) AppendObject(v zapcore.ObjectMarshaler) error {
 }
 
 func (a *arrayEncoder) AppendReflected(v interface{}) error {
-	a.elems = append(a.elems, ConvertValue(v))
+	a.elems = append(a.elems, convertValue(v))
 	return nil
 }
 

diff --git a/internal/shared/logutil/convert.go.tmpl b/internal/shared/logutil/convert.go.tmpl
@@ -16,8 +16,8 @@ import (
 	"go.opentelemetry.io/otel/log"
 )
 
-// Convert various types to log.Value.
-func ConvertValue(v any) log.Value {
+// convertValue converts various types to log.Value.
+func convertValue(v any) log.Value {
 	// Handling the most common types without reflect is a small perf win.
 	switch val := v.(type) {
 	case bool:
@@ -79,7 +79,7 @@ func ConvertValue(v any) log.Value {
 	case reflect.Slice, reflect.Array:
 		items := make([]log.Value, 0, val.Len())
 		for i := 0; i < val.Len(); i++ {
-			items = append(items, ConvertValue(val.Index(i).Interface()))
+			items = append(items, convertValue(val.Index(i).Interface()))
 		}
 		return log.SliceValue(items...)
 	case reflect.Map:
@@ -94,15 +94,15 @@ func ConvertValue(v any) log.Value {
 			}
 			kvs = append(kvs, log.KeyValue{
 				Key:   key,
-				Value: ConvertValue(val.MapIndex(k).Interface()),
+				Value: convertValue(val.MapIndex(k).Interface()),
 			})
 		}
 		return log.MapValue(kvs...)
 	case reflect.Ptr, reflect.Interface:
 		if val.IsNil() {
 			return log.Value{}
 		}
-		return ConvertValue(val.Elem().Interface())
+		return convertValue(val.Elem().Interface())
 	}
 
 	// Try to handle this as gracefully as possible.

diff --git a/internal/shared/logutil/convert_test.go.tmpl b/internal/shared/logutil/convert_test.go.tmpl
@@ -252,13 +252,13 @@ func TestConvertValue(t *testing.T) {
 		},
 	} {
 		t.Run(tt.name, func(t *testing.T) {
-			assert.Equal(t, tt.wantValue, ConvertValue(tt.value))
+			assert.Equal(t, tt.wantValue, convertValue(tt.value))
 		})
 	}
 }
 
 func TestConvertValueFloat32(t *testing.T) {
-	value := ConvertValue(float32(3.14))
+	value := convertValue(float32(3.14))
 	want := log.Float64Value(3.14)
 
 	assert.InDelta(t, value.AsFloat64(), want.AsFloat64(), 0.0001)
-Original file line number
+Diff line change
@@ Expand Up @@
     		kvs = append(kvs, log.KeyValue{
     			Key:   k,
-    			Value: ConvertValue(v),
+    			Value: convertValue(v),
     		})
     	}
@@ Expand Down @@