Fixed OS type value for DragonFly BSD (#2092)

* Added explicit mapping between GOOS and semconv OS type attribute value

* Added tests for OS type mappings

* Added changelog entry

Co-authored-by: Tyler Yahn <[email protected]>

CHANGELOG.md

@@ -30,6 +30,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 - When using WithNewRoot, don't use the parent context for making sampling decisions. (#2032)
 - `oteltest.Tracer` now creates a valid `SpanContext` when using `WithNewRoot`. (#2073)
+- OS type detector now sets the correct `dragonflybsd` value for DragonFly BSD. (#2092)
 
 ### Security
 

sdk/resource/export_test.go

@@ -31,3 +31,7 @@ var (
 	RuntimeOS   = runtimeOS
 	RuntimeArch = runtimeArch
 )
+
+var (
+	MapRuntimeOSToSemconvOSType = mapRuntimeOSToSemconvOSType
+)

sdk/resource/os.go

@@ -18,6 +18,7 @@ import (
 	"context"
 	"strings"
 
+	"go.opentelemetry.io/otel/attribute"
 	semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
 )
 
@@ -43,9 +44,11 @@ type osDescriptionDetector struct{}
 func (osTypeDetector) Detect(ctx context.Context) (*Resource, error) {
 	osType := runtimeOS()
 
+	osTypeAttribute := mapRuntimeOSToSemconvOSType(osType)
+
 	return NewWithAttributes(
 		semconv.SchemaURL,
-		semconv.OSTypeKey.String(strings.ToLower(osType)),
+		osTypeAttribute,
 	), nil
 }
 
@@ -84,3 +87,32 @@ func WithOS() Option {
 		osDescriptionDetector{},
 	)
 }
+
+// mapRuntimeOSToSemconvOSType translates the OS name as provided by the Go runtime
+// into an OS type attribute with the corresponding value defined by the semantic
+// conventions. In case the provided OS name isn't mapped, it's transformed to lowercase
+// and used as the value for the returned OS type attribute.
+func mapRuntimeOSToSemconvOSType(osType string) attribute.KeyValue {
+	// the elements in this map are the intersection between
+	// available GOOS values and defined semconv OS types
+	osTypeAttributeMap := map[string]attribute.KeyValue{
+		"darwin":    semconv.OSTypeDarwin,
+		"dragonfly": semconv.OSTypeDragonflyBSD,
+		"freebsd":   semconv.OSTypeFreeBSD,
+		"linux":     semconv.OSTypeLinux,
+		"netbsd":    semconv.OSTypeNetBSD,
+		"openbsd":   semconv.OSTypeOpenBSD,
+		"solaris":   semconv.OSTypeSolaris,
+		"windows":   semconv.OSTypeWindows,
+	}
+
+	var osTypeAttribute attribute.KeyValue
+
+	if attr, ok := osTypeAttributeMap[osType]; ok {
+		osTypeAttribute = attr
+	} else {
+		osTypeAttribute = semconv.OSTypeKey.String(strings.ToLower(osType))
+	}
+
+	return osTypeAttribute
+}

sdk/resource/os_test.go

@@ -20,7 +20,9 @@ import (
 
 	"github.com/stretchr/testify/require"
 
+	"go.opentelemetry.io/otel/attribute"
 	"go.opentelemetry.io/otel/sdk/resource"
+	semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
 )
 
 func mockRuntimeProviders() {
@@ -84,3 +86,31 @@ func TestWithOS(t *testing.T) {
 		"os.description": "Test",
 	}, toMap(res))
 }
+
+func TestMapRuntimeOSToSemconvOSType(t *testing.T) {
+	tt := []struct {
+		Name   string
+		Goos   string
+		OSType attribute.KeyValue
+	}{
+		{"Apple Darwin", "darwin", semconv.OSTypeDarwin},
+		{"DragonFly BSD", "dragonfly", semconv.OSTypeDragonflyBSD},
+		{"FreeBSD", "freebsd", semconv.OSTypeFreeBSD},
+		{"Linux", "linux", semconv.OSTypeLinux},
+		{"NetBSD", "netbsd", semconv.OSTypeNetBSD},
+		{"OpenBSD", "openbsd", semconv.OSTypeOpenBSD},
+		{"Oracle Solaris", "solaris", semconv.OSTypeSolaris},
+		{"Microsoft Windows", "windows", semconv.OSTypeWindows},
+		{"Unknown", "unknown", semconv.OSTypeKey.String("unknown")},
+		{"UNKNOWN", "UNKNOWN", semconv.OSTypeKey.String("unknown")},
+	}
+
+	for _, tc := range tt {
+		tc := tc
+
+		t.Run(tc.Name, func(t *testing.T) {
+			osTypeAttribute := resource.MapRuntimeOSToSemconvOSType(tc.Goos)
+			require.EqualValues(t, osTypeAttribute, tc.OSType)
+		})
+	}
+}