[processor/resourcedetection] Add os.version resource attribute (#38087)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description
Adding the `os.version` resource attribute to system `resourcedetection`
processor

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes: #38059

<!--Describe what testing was performed and which tests were added.-->
#### Testing
Updated unit tests.

<!--Describe the documentation added.-->
#### Documentation
N/A

<!--Please delete paragraphs that you did not use before submitting.-->

---------

Co-authored-by: Antoine Toulme <[email protected]>

Author: avilevy18

.chloggen/resourceprocessory_system_os_version.yaml

@@ -0,0 +1,27 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: 'enhancement'
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: resourcedetection
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: 'Adding the os.version resource attribute to system resourcedetection processor'
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [38087]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:
+
+# If your change doesn't affect end users or the exported elements of any package,
+# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: [user]

internal/metadataproviders/system/metadata.go

@@ -13,6 +13,7 @@ import (
 
 	"github.com/Showmax/go-fqdn"
 	"github.com/shirou/gopsutil/v4/cpu"
+	"github.com/shirou/gopsutil/v4/host"
 	conventions "go.opentelemetry.io/collector/semconv/v1.27.0"
 	"go.opentelemetry.io/otel/attribute"
 	"go.opentelemetry.io/otel/sdk/resource"
@@ -53,6 +54,9 @@ type Provider interface {
 	// OSType returns the host operating system
 	OSType() (string, error)
 
+	// OSVersion returns the version of the operating system
+	OSVersion() (string, error)
+
 	// LookupCNAME returns the canonical name for the current host
 	LookupCNAME() (string, error)
 
@@ -88,6 +92,14 @@ func (systemMetadataProvider) OSType() (string, error) {
 	return internal.GOOSToOSType(runtime.GOOS), nil
 }
 
+func (systemMetadataProvider) OSVersion() (string, error) {
+	info, err := host.Info()
+	if err != nil {
+		return "", fmt.Errorf("OSVersion failed to get os version: %w", err)
+	}
+	return info.PlatformVersion, nil
+}
+
 func (systemMetadataProvider) FQDN() (string, error) {
 	return fqdn.FqdnHostname()
 }

processor/resourcedetectionprocessor/internal/system/documentation.md

@@ -21,3 +21,4 @@
 | host.name | The host.name | Any Str | true |
 | os.description | Human readable OS version information. | Any Str | false |
 | os.type | The os.type | Any Str | true |
+| os.version | The os.version | Any Str | false |

processor/resourcedetectionprocessor/internal/system/internal/metadata/generated_config.go

@@ -27,6 +27,8 @@ all_set:
       enabled: true
     os.type:
       enabled: true
+    os.version:
+      enabled: true
 none_set:
   resource_attributes:
     host.arch:
@@ -55,3 +57,5 @@ none_set:
       enabled: false
     os.type:
       enabled: false
+    os.version:
+      enabled: false

processor/resourcedetectionprocessor/internal/system/internal/metadata/generated_config_test.go

@@ -19,6 +19,10 @@ resource_attributes:
     description: The os.type
     type: string
     enabled: true
+  os.version:
+    description: The os.version
+    type: string
+    enabled: false
   host.arch:
     description: The host.arch
     type: string

processor/resourcedetectionprocessor/internal/system/internal/metadata/generated_resource.go

@@ -88,6 +88,11 @@ func (d *Detector) Detect(ctx context.Context) (resource pcommon.Resource, schem
 		return pcommon.NewResource(), "", fmt.Errorf("failed getting OS type: %w", err)
 	}
 
+	osVersion, err := d.provider.OSVersion()
+	if err != nil {
+		return pcommon.NewResource(), "", fmt.Errorf("failed getting OS version: %w", err)
+	}
+
 	hostArch, err := d.provider.HostArch()
 	if err != nil {
 		return pcommon.NewResource(), "", fmt.Errorf("failed getting host architecture: %w", err)
@@ -136,6 +141,7 @@ func (d *Detector) Detect(ctx context.Context) (resource pcommon.Resource, schem
 		if err == nil {
 			d.rb.SetHostName(hostname)
 			d.rb.SetOsType(osType)
+			d.rb.SetOsVersion(osVersion)
 			if d.cfg.ResourceAttributes.HostID.Enabled {
 				if hostID, hostIDErr := d.provider.HostID(ctx); hostIDErr == nil {
 					d.rb.SetHostID(hostID)

processor/resourcedetectionprocessor/internal/system/internal/metadata/generated_resource_test.go

@@ -48,6 +48,11 @@ func (m *mockMetadata) OSType() (string, error) {
 	return args.String(0), args.Error(1)
 }
 
+func (m *mockMetadata) OSVersion() (string, error) {
+	args := m.MethodCalled("OSVersion")
+	return args.String(0), args.Error(1)
+}
+
 func (m *mockMetadata) HostID(_ context.Context) (string, error) {
 	args := m.MethodCalled("HostID")
 	return args.String(0), args.Error(1)
@@ -147,6 +152,7 @@ func allEnabledConfig() metadata.ResourceAttributesConfig {
 	cfg.HostIP.Enabled = true
 	cfg.HostMac.Enabled = true
 	cfg.OsDescription.Enabled = true
+	cfg.OsVersion.Enabled = true
 	return cfg
 }
 
@@ -155,6 +161,7 @@ func TestDetectFQDNAvailable(t *testing.T) {
 	md.On("FQDN").Return("fqdn", nil)
 	md.On("OSDescription").Return("Ubuntu 22.04.2 LTS (Jammy Jellyfish)", nil)
 	md.On("OSType").Return("darwin", nil)
+	md.On("OSVersion").Return("22.04.2 LTS (Jammy Jellyfish)", nil)
 	md.On("HostID").Return("2", nil)
 	md.On("HostArch").Return("amd64", nil)
 	md.On("HostIPs").Return(testIPsAddresses, nil)
@@ -171,6 +178,7 @@ func TestDetectFQDNAvailable(t *testing.T) {
 		conventions.AttributeHostName:      "fqdn",
 		conventions.AttributeOSDescription: "Ubuntu 22.04.2 LTS (Jammy Jellyfish)",
 		conventions.AttributeOSType:        "darwin",
+		conventions.AttributeOSVersion:     "22.04.2 LTS (Jammy Jellyfish)",
 		conventions.AttributeHostID:        "2",
 		conventions.AttributeHostArch:      conventions.AttributeHostArchAMD64,
 		"host.ip":                          testIPsAttribute,
@@ -186,6 +194,7 @@ func TestFallbackHostname(t *testing.T) {
 	mdHostname.On("FQDN").Return("", errors.New("err"))
 	mdHostname.On("OSDescription").Return("Ubuntu 22.04.2 LTS (Jammy Jellyfish)", nil)
 	mdHostname.On("OSType").Return("darwin", nil)
+	mdHostname.On("OSVersion").Return("22.04.2 LTS (Jammy Jellyfish)", nil)
 	mdHostname.On("HostArch").Return("amd64", nil)
 
 	detector := newTestDetector(mdHostname, []string{"dns", "os"}, metadata.DefaultResourceAttributesConfig())
@@ -210,6 +219,7 @@ func TestEnableHostID(t *testing.T) {
 	mdHostname.On("FQDN").Return("", errors.New("err"))
 	mdHostname.On("OSDescription").Return("Ubuntu 22.04.2 LTS (Jammy Jellyfish)", nil)
 	mdHostname.On("OSType").Return("darwin", nil)
+	mdHostname.On("OSVersion").Return("22.04.2 LTS (Jammy Jellyfish)", nil)
 	mdHostname.On("HostID").Return("3", nil)
 	mdHostname.On("HostArch").Return("amd64", nil)
 	mdHostname.On("HostIPs").Return(testIPsAddresses, nil)
@@ -225,6 +235,7 @@ func TestEnableHostID(t *testing.T) {
 		conventions.AttributeHostName:      "hostname",
 		conventions.AttributeOSDescription: "Ubuntu 22.04.2 LTS (Jammy Jellyfish)",
 		conventions.AttributeOSType:        "darwin",
+		conventions.AttributeOSVersion:     "22.04.2 LTS (Jammy Jellyfish)",
 		conventions.AttributeHostID:        "3",
 		conventions.AttributeHostArch:      conventions.AttributeHostArchAMD64,
 		"host.ip":                          testIPsAttribute,
@@ -239,6 +250,7 @@ func TestUseHostname(t *testing.T) {
 	mdHostname.On("Hostname").Return("hostname", nil)
 	mdHostname.On("OSDescription").Return("Ubuntu 22.04.2 LTS (Jammy Jellyfish)", nil)
 	mdHostname.On("OSType").Return("darwin", nil)
+	mdHostname.On("OSVersion").Return("22.04.2 LTS (Jammy Jellyfish)", nil)
 	mdHostname.On("HostID").Return("1", nil)
 	mdHostname.On("HostArch").Return("amd64", nil)
 	mdHostname.On("HostIPs").Return(testIPsAddresses, nil)
@@ -254,6 +266,7 @@ func TestUseHostname(t *testing.T) {
 		conventions.AttributeHostName:      "hostname",
 		conventions.AttributeOSDescription: "Ubuntu 22.04.2 LTS (Jammy Jellyfish)",
 		conventions.AttributeOSType:        "darwin",
+		conventions.AttributeOSVersion:     "22.04.2 LTS (Jammy Jellyfish)",
 		conventions.AttributeHostID:        "1",
 		conventions.AttributeHostArch:      conventions.AttributeHostArchAMD64,
 		"host.ip":                          testIPsAttribute,
@@ -268,6 +281,7 @@ func TestDetectError(t *testing.T) {
 	mdFQDN := &mockMetadata{}
 	mdFQDN.On("OSDescription").Return("Ubuntu 22.04.2 LTS (Jammy Jellyfish)", nil)
 	mdFQDN.On("OSType").Return("windows", nil)
+	mdFQDN.On("OSVersion").Return("22.04.2 LTS (Jammy Jellyfish)", nil)
 	mdFQDN.On("FQDN").Return("", errors.New("err"))
 	mdFQDN.On("Hostname").Return("", errors.New("err"))
 	mdFQDN.On("HostID").Return("", errors.New("err"))
@@ -285,6 +299,7 @@ func TestDetectError(t *testing.T) {
 	mdHostname := &mockMetadata{}
 	mdHostname.On("OSDescription").Return("Ubuntu 22.04.2 LTS (Jammy Jellyfish)", nil)
 	mdHostname.On("OSType").Return("windows", nil)
+	mdHostname.On("OSVersion").Return("22.04.2 LTS (Jammy Jellyfish)", nil)
 	mdHostname.On("Hostname").Return("", errors.New("err"))
 	mdHostname.On("HostID").Return("", errors.New("err"))
 	mdHostname.On("HostArch").Return("amd64", nil)
@@ -302,6 +317,7 @@ func TestDetectError(t *testing.T) {
 	mdOSType.On("FQDN").Return("fqdn", nil)
 	mdOSType.On("OSDescription").Return("Ubuntu 22.04.2 LTS (Jammy Jellyfish)", nil)
 	mdOSType.On("OSType").Return("", errors.New("err"))
+	mdOSType.On("OSVersion").Return("", "22.04.2 LTS (Jammy Jellyfish)")
 	mdOSType.On("HostID").Return("1", nil)
 	mdOSType.On("HostArch").Return("amd64", nil)
 	mdOSType.On("HostIPs").Return(testIPsAddresses, nil)
@@ -312,11 +328,28 @@ func TestDetectError(t *testing.T) {
 	assert.Equal(t, "", schemaURL)
 	assert.True(t, internal.IsEmptyResource(res))
 
+	// OS version fails
+	mdOSVersion := &mockMetadata{}
+	mdOSVersion.On("FQDN").Return("fqdn", nil)
+	mdOSVersion.On("OSDescription").Return("Ubuntu 22.04.2 LTS (Jammy Jellyfish)", nil)
+	mdOSVersion.On("OSType").Return("windows", nil)
+	mdOSVersion.On("OSVersion").Return("", errors.New("err"))
+	mdOSVersion.On("HostID").Return("1", nil)
+	mdOSVersion.On("HostArch").Return("amd64", nil)
+	mdOSVersion.On("HostIPs").Return(testIPsAddresses, nil)
+
+	detector = newTestDetector(mdOSVersion, []string{"os"}, allEnabledConfig())
+	res, schemaURL, err = detector.Detect(context.Background())
+	assert.Error(t, err)
+	assert.Equal(t, "", schemaURL)
+	assert.True(t, internal.IsEmptyResource(res))
+
 	// Host ID fails. All other attributes should be set.
 	mdHostID := &mockMetadata{}
 	mdHostID.On("Hostname").Return("hostname", nil)
 	mdHostID.On("OSDescription").Return("Ubuntu 22.04.2 LTS (Jammy Jellyfish)", nil)
 	mdHostID.On("OSType").Return("linux", nil)
+	mdHostID.On("OSVersion").Return("22.04.2 LTS (Jammy Jellyfish)", nil)
 	mdHostID.On("HostID").Return("", errors.New("err"))
 	mdHostID.On("HostArch").Return("arm64", nil)
 	mdHostID.On("HostIPs").Return(testIPsAddresses, nil)
@@ -330,6 +363,7 @@ func TestDetectError(t *testing.T) {
 		conventions.AttributeHostName:      "hostname",
 		conventions.AttributeOSDescription: "Ubuntu 22.04.2 LTS (Jammy Jellyfish)",
 		conventions.AttributeOSType:        "linux",
+		conventions.AttributeOSVersion:     "22.04.2 LTS (Jammy Jellyfish)",
 		conventions.AttributeHostArch:      conventions.AttributeHostArchARM64,
 		"host.ip":                          testIPsAttribute,
 		"host.mac":                         testMACsAttribute,
@@ -341,6 +375,7 @@ func TestDetectCPUInfo(t *testing.T) {
 	md.On("FQDN").Return("fqdn", nil)
 	md.On("OSDescription").Return("Ubuntu 22.04.2 LTS (Jammy Jellyfish)", nil)
 	md.On("OSType").Return("darwin", nil)
+	md.On("OSVersion").Return("22.04.2 LTS (Jammy Jellyfish)", nil)
 	md.On("HostID").Return("2", nil)
 	md.On("HostArch").Return("amd64", nil)
 	md.On("HostIPs").Return(testIPsAddresses, nil)
@@ -359,6 +394,7 @@ func TestDetectCPUInfo(t *testing.T) {
 		conventions.AttributeHostName:      "fqdn",
 		conventions.AttributeOSDescription: "Ubuntu 22.04.2 LTS (Jammy Jellyfish)",
 		conventions.AttributeOSType:        "darwin",
+		conventions.AttributeOSVersion:     "22.04.2 LTS (Jammy Jellyfish)",
 		conventions.AttributeHostID:        "2",
 		conventions.AttributeHostArch:      conventions.AttributeHostArchAMD64,
 		"host.ip":                          testIPsAttribute,