feat: Add opentelemetry-resource-detector-os by yhara · Pull Request #2443 · open-telemetry/opentelemetry-ruby-contrib

yhara · 2026-07-09T09:04:02Z

Hello. I understood that #2303 is a task to create an opentelemetry-resource-detector-os gem under resources/os/, so I've started working on it. Please let me know if there are any issues. @thompson-tomo

TODOs

implement get_* (at least for linux; maybe split PRs for other OS)
os.build_id is not in OpenTelemetry::SemanticConventions::Resource::*. Should I skip this or add the constant to SemanticConventions?
- → Use OpenTelemetry::SemConv for new codes

linux-foundation-easycla · 2026-07-09T09:04:10Z

The committers listed above are authorized under a signed CLA.

✅ login: thompson-tomo / name: James Thompson (b5264dd)
✅ login: yhara / name: Yutaka HARA (b5264dd)
✅ login: yhara / name: Yutaka Hara (22d78eb)

Co-authored-by: James Thompson <thompson.tomo@outlook.com>

thompson-tomo · 2026-07-10T13:25:24Z

+    let(:detected_resource_attributes) { detected_resource.attribute_enumerator.to_h }
+
+    it 'returns a resource with os_type string' do
+      _(detected_resource_attributes['os.type']).must_be_instance_of(String)


We need to be checking the value.

Co-authored-by: James Thompson <thompson.tomo@outlook.com>

yhara · 2026-07-16T08:05:06Z

+            name = lookup_plist(plist, 'ProductName')
+            attrs[SEMCONV::OS_NAME] = name if name
+
+            attrs[SEMCONV::OS_DESCRIPTION] = "#{name} #{ver} (#{buildver})" if name && ver && buildver


The same way as opentelemetry-go.

yhara · 2026-07-21T08:17:04Z

Examples of actual values:

Windows (x64-mingw-ucrt)

#<OpenTelemetry::SDK::Resources::Resource:0x0000018423bccf48 @attributes={
  "os.type"=>"windows", 
  "os.name"=>"Windows", 
  "os.version"=>"10.0.26200.8037", 
  "os.description"=>"Microsoft Windows [Version 10.0.26200.8037]", 
  "os.build_id"=>"26200"}>

Mac

#<OpenTelemetry::SDK::Resources::Resource:0x0000000100da7388 @attributes={
  "os.type" => "darwin", 
  "os.version" => "15.7.7", 
  "os.build_id" => "24G720", 
  "os.name" => "macOS", 
  "os.description" => "macOS 15.7.7 (24G720)"}>

Linux (Ubuntu on Amazon EC2)

#<OpenTelemetry::SDK::Resources::Resource:0x000079025886e830 @attributes={
  "os.type" => "linux", 
  "os.name" => "Ubuntu", 
  "os.version" => "26.04", 
  "os.description" => "Ubuntu 26.04 LTS", 
  "os.build_id" => "7.0.0-1008-aws"}>

Linux (Ubuntu on WSL2)

#<OpenTelemetry::SDK::Resources::Resource:0x00007f1792715038 @attributes={
  "os.type" => "linux", 
  "os.name" => "Ubuntu", 
  "os.version" => "22.04", 
  "os.description" => "Ubuntu 22.04.5 LTS", 
  "os.build_id" => "5.15.146.1-microsoft-standard-WSL2+"}>

thompson-tomo · 2026-07-22T12:54:45Z

+begin
+  # (Windows only)
+  require 'win32/registry'
+rescue LoadError
+end


This doesn't work on jruby. Can u find a solution which also satisfies rubocop

Co-authored-by: James Thompson <thompson.tomo@outlook.com>

This should fix the CI error with jruby on Ubuntu. Also fixes a rubocop warning

thompson-tomo · 2026-07-23T09:00:15Z

+    it 'returns an os resource (e2e test; no mocking)' do
+      case RUBY_PLATFORM
+      when /linux/
+        _(detected_resource_attributes['os.type']).must_equal('linux')
+      when /mswin|msys|mingw|cygwin/
+        _(detected_resource_attributes['os.type']).must_equal('windows')
+      when /darwin/
+        _(detected_resource_attributes['os.type']).must_equal('darwin')
+      else
+        _(detected_resource_attributes).must_equal([])
+      end
+    end


Can we verify the presence of an attribute sourced from the system so we are confirming that the source provides the info.

0c06f6d There aren't many attributes that can always be retrieved, but I made sure that if one is obtained, it is returned as a string.

RUBY_PLATFORM is "java" on JRuby

This is needed on Windows + Ruby4

yhara · 2026-08-03T09:06:51Z

@thompson-tomo Hi, what do we need to get this merged? Is there anything you are concerned about? (testing side or the implementation side)

Remove conditional check for JRuby tests on Ubuntu.

kaylareopelle

Thanks your this contribution, @yhara! I have a few questions/comments.

In addition, would you be willing to help maintain this resource detector going forward? If so, please add your GitHub username to the .github/.component_owners.yml file. Here's an example for the container resource detector:

opentelemetry-ruby-contrib/.github/component_owners.yml

Lines 42 to 43 in 293ef1f

    
           resources/container: 
        
             - scbjans

kaylareopelle · 2026-08-12T03:07:42Z

          yard: true
          build: true
      - name: "Test JRuby"
-        if: startsWith(matrix.os, 'ubuntu')


What was the motivation for removing this line? Just curious because I think it may impact the way we test things outside of the resource-detector-os.

We need to remove so that we can test the os resource detector on windows & jruby.

kaylareopelle · 2026-08-12T20:11:28Z

+  spec.required_ruby_version = '>= 3.3'
+
+  spec.add_dependency 'fiddle', '~> 1.1.8'
+  spec.add_dependency 'opentelemetry-sdk', '~> 1.10'


The sdk has a very loose dependency on opentelemetry-semantic-conventions, with no version restrictions. Did you do any testing to see if you try to install a version of the semconv before the Incubating module was established what happened?

kaylareopelle · 2026-08-12T20:11:45Z

+        extend self
+
+        RESOURCE = OpenTelemetry::SDK::Resources::Resource
+        SEMCONV = OpenTelemetry::SemConv::Incubating::OS


kaylareopelle · 2026-08-12T20:15:04Z

+            # eg. "Ubuntu"
+            name = lookup_os_release(os_release, 'NAME')


These examples are helpful! Thanks!

kaylareopelle · 2026-08-12T20:19:07Z

+
+## How does this gem fit in?
+
+The `opentelemetry-resource-detector-os` gem provides a means of retrieving a resource for supported environments following the resource semantic conventions. This detector automatically identifies and populates resource attributes with relevant metadata from the environment.


A suggestion for easier access to context. You can disregard or reword if you prefer it another way.

Suggested change

The `opentelemetry-resource-detector-os` gem provides a means of retrieving a resource for supported environments following the resource semantic conventions. This detector automatically identifies and populates resource attributes with relevant metadata from the environment.

The `opentelemetry-resource-detector-os` gem provides a means of retrieving a resource for supported environments following [the operating system resource semantic conventions](https://opentelemetry.io/docs/specs/semconv/resource/os/). This detector automatically identifies and populates resource attributes with relevant metadata from the environment.

kaylareopelle · 2026-08-12T20:19:56Z

+
+## v0.1.0 / 2026-xx-xx
+
+- Initial release.


For our release automation, it's best to have just the top line for the first release. It'll add the version, date, and "Initial release." text.

Suggested change

## v0.1.0 / 2026-xx-xx

- Initial release.

feat: Add opentelemetry-resource-detector-os

22d78eb

thompson-tomo reviewed Jul 9, 2026

View reviewed changes

Comment thread resources/os/lib/opentelemetry/resource/detector/os.rb Outdated

yhara and others added 3 commits July 10, 2026 15:19

Use OpenTelemetry::SemConv

b5264dd

Co-authored-by: James Thompson <thompson.tomo@outlook.com>

Merge branch 'main' into os-resource-detector

12b77f4

feat: implement os.type detection

b557c71

thompson-tomo reviewed Jul 10, 2026

View reviewed changes

Add resource-detector-os to CI workflow

0f44746

github-actions Bot added the ci label Jul 11, 2026

yhara and others added 4 commits July 13, 2026 18:51

chore: VERSION should be zero until the first release

b3e8a6a

Co-authored-by: James Thompson <thompson.tomo@outlook.com>

feat: implement more os attributes

fd74899

tests: Add test for linux

e0d06cd

refactor: fixes for rubocop

4824487

thompson-tomo reviewed Jul 15, 2026

View reviewed changes

Comment thread resources/os/Gemfile Outdated

thompson-tomo reviewed Jul 15, 2026

View reviewed changes

yhara added 4 commits July 16, 2026 14:24

chore: Pin rubocop gem versions

2da6e8c

tests: merge some test cases

be9520e

tests: Extract test data to file

63160f1

feat: get macOS information from plist

5aaff9e

yhara commented Jul 16, 2026

View reviewed changes

yhara added 3 commits July 21, 2026 16:50

tests: fix typo

8360085

feat: set os.build_id on windows

4f0a407

tests: Add e2e test

298099a

Merge branch 'main' into os-resource-detector

ff67fe5

yhara marked this pull request as ready for review July 21, 2026 08:17

yhara requested review from dazuma, kaylareopelle, robbkidd and simi as code owners July 21, 2026 08:17

yhara requested review from a team, hannahramadan and xuan-cao-swi as code owners July 21, 2026 08:17

thompson-tomo reviewed Jul 22, 2026

View reviewed changes

Comment thread resources/os/Gemfile Outdated

thompson-tomo reviewed Jul 22, 2026

View reviewed changes

yhara and others added 2 commits July 23, 2026 13:36

chore: Upgrade simpleconv to 1.0

7e39286

Co-authored-by: James Thompson <thompson.tomo@outlook.com>

fix: do not try loading win32/registy on other OS

df75f08

This should fix the CI error with jruby on Ubuntu. Also fixes a rubocop warning

thompson-tomo reviewed Jul 23, 2026

View reviewed changes

yhara added 4 commits July 24, 2026 16:29

fix: Stop using RUBY_PLATFORM

7942005

RUBY_PLATFORM is "java" on JRuby

fix: Add fiddle as dependency

b35511e

This is needed on Windows + Ruby4

tests: Add more assertion

0c06f6d

Merge branch 'main' into os-resource-detector

9d2c1c6

thompson-tomo added 2 commits August 5, 2026 22:24

Add OS resource detector to labeler configuration

20120d5

Update JRuby test action condition

406d1a7

Remove conditional check for JRuby tests on Ubuntu.

kaylareopelle reviewed Aug 12, 2026

View reviewed changes


		## How does this gem fit in?

		The `opentelemetry-resource-detector-os` gem provides a means of retrieving a resource for supported environments following the resource semantic conventions. This detector automatically identifies and populates resource attributes with relevant metadata from the environment.

Uh oh!

Conversation

yhara commented Jul 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

linux-foundation-easycla Bot commented Jul 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yhara commented Jul 21, 2026

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yhara commented Aug 3, 2026

Uh oh!

kaylareopelle left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

yhara commented Jul 9, 2026 •

edited

Loading

linux-foundation-easycla Bot commented Jul 9, 2026 •

edited

Loading