[pdata] Update return value of pcommon.ValueType.String for ValueTypeStr

Recently we updated all names related to pdata String value. It makes sense to update string returned by Value.String accordingly to avoid discrepancy with other value types
open-telemetry · Oct 6, 2022 · 964d308 · 964d308
1 parent e0eea95
commit 964d308
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,6 +18,7 @@
 - Delete deprecated `StringVal` and `SetStringVal` methods. (#6178)
 - Delete deprecated `ValueTypeString` method. (#6178)
 - Change AggregationTemporality.String to simpler, easier to read. (#6117)
+- Update pcommon.ValueType.String to return "STR" for ValueTypeStr. (#6247)
 
 ### 🚩 Deprecations 🚩
 

diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
@@ -177,7 +177,7 @@ With the modified configuration if you re-run the test above the log output shou
 ```
 2020-11-11T04:08:17.344Z	DEBUG	loggingexporter/logging_exporter.go:353	ResourceSpans #0
 Resource labels:
-     -> service.name: STRING(api)
+     -> service.name: STR(api)
 ScopeSpans #0
 Span #0
     Trace ID       : 5982fe77008310cc80f1da5e10147519
@@ -188,7 +188,7 @@ Span #0
     Start time     : 2018-01-24 08:16:15.726 +0000 UTC
     End time       : 2018-01-24 08:16:15.752 +0000 UTC
 Attributes:
-     -> data.http_response_code: STRING(201)
+     -> data.http_response_code: STR(201)
 ```
 
 ### Health Check

diff --git a/exporter/loggingexporter/internal/otlptext/databuffer_test.go b/exporter/loggingexporter/internal/otlptext/databuffer_test.go
@@ -46,7 +46,7 @@ func TestNestedMapSerializesCorrectly(t *testing.T) {
 	av.PutEmptyMap("zoo").PutInt("bar", 13)
 
 	expected := `{
-     -> foo: STRING(test)
+     -> foo: STR(test)
      -> zoo: MAP({"bar":13})
 }`
 

diff --git a/pdata/pcommon/common.go b/pdata/pcommon/common.go
@@ -50,7 +50,7 @@ func (avt ValueType) String() string {
 	case ValueTypeEmpty:
 		return "EMPTY"
 	case ValueTypeStr:
-		return "STRING"
+		return "STR"
 	case ValueTypeBool:
 		return "BOOL"
 	case ValueTypeInt:

diff --git a/pdata/pcommon/common_test.go b/pdata/pcommon/common_test.go
@@ -58,7 +58,7 @@ func TestValue(t *testing.T) {
 
 func TestValueType(t *testing.T) {
 	assert.EqualValues(t, "EMPTY", ValueTypeEmpty.String())
-	assert.EqualValues(t, "STRING", ValueTypeStr.String())
+	assert.EqualValues(t, "STR", ValueTypeStr.String())
 	assert.EqualValues(t, "BOOL", ValueTypeBool.String())
 	assert.EqualValues(t, "INT", ValueTypeInt.String())
 	assert.EqualValues(t, "DOUBLE", ValueTypeDouble.String())