[Resources.Process] implement latest semantic convention spec #3347

thompson-tomo · 2025-10-28T10:10:58Z

Fixes #2892
Design discussion issue #

Changes

This adds in additional recommend attributes to describe process. Implementation has been based on latest spec https://github.com/open-telemetry/semantic-conventions/blob/main/docs/resource/process.md

Merge requirement checklist

CONTRIBUTING guidelines followed (license requirements, nullable enabled, static analysis, etc.)
Unit tests added/updated
Appropriate CHANGELOG.md files updated for non-trivial changes
Changes in public API reviewed (if applicable)

Co-authored-by: Martin Costello <[email protected]>

codecov · 2025-10-28T10:21:24Z

Codecov Report

❌ Patch coverage is 86.36364% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 71.30%. Comparing base (0809a6a) to head (e885a7e).
⚠️ Report is 13 commits behind head on main.
✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
...OpenTelemetry.Resources.Process/ProcessDetector.cs	86.36%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3347      +/-   ##
==========================================
+ Coverage   71.16%   71.30%   +0.14%     
==========================================
  Files         452      442      -10     
  Lines       17567    17530      -37     
==========================================
- Hits        12501    12500       -1     
+ Misses       5066     5030      -36

Flag	Coverage Δ
unittests-Instrumentation.Cassandra	`?`
unittests-Resources.Process	`89.28% <86.36%> (-10.72%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
...OpenTelemetry.Resources.Process/ProcessDetector.cs	`88.46% <86.36%> (-11.54%)`	⬇️

... and 10 files with indirect coverage changes

🚀 New features to boost your workflow:

📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

src/OpenTelemetry.Resources.Process/ProcessDetector.cs

Kielek · 2025-11-04T06:13:41Z

src/OpenTelemetry.Resources.Process/ProcessDetector.cs

+            attributes.Add(new(ProcessSemanticConventions.AttributeProcessStartTime, currentProcess.StartTime.ToString("O") ?? DateTime.Now.ToString("O")));
        }
-#endif
+        catch (Win32Exception)
+        {
+            attributes.Add(new(ProcessSemanticConventions.AttributeProcessStartTime, DateTime.Now.ToString("O")));
+        }


Fallbacks here are not true IMO. If you are not detect attributes, just omit it.

I thought about that but in the case here creation time is an identifying attribute and all identifying should actually be required hence open-telemetry/weaver#986 to address it.

Also Using The current time enables the functionality of distinguishing between telemetry from process starts, leaving it out you lose that.

Lack of the data is better than the wrong data.

Are you saying that all the process entity attributes should be omitted if the creation time can not be set given it is an identifying attribute?

For me the exact value of the atrribute is not as meaningful as having a value there which can then be used to achieve the use case.

I am not against keeping part of the attributes. Part of data seems to be fine. I am against putting obviously wrong data in the attributes/any other signal.

In this case, add this attribute conditionally if it is available. You can document it properly in the README. Small deviations from the semantics should be allowed if we have technical blockers for implementation.

Kielek · 2025-11-04T07:14:08Z

src/OpenTelemetry.Resources.Process/ProcessDetector.cs

+            attributes.Add(new(ProcessSemanticConventions.AttributeProcessStartTime, currentProcess.StartTime.ToString("O") ?? DateTime.Now.ToString("O")));
        }
-#endif
+        catch (Win32Exception)
+        {
+            attributes.Add(new(ProcessSemanticConventions.AttributeProcessStartTime, DateTime.Now.ToString("O")));
+        }


Lack of the data is better than the wrong data.

github-actions · 2025-11-12T03:31:50Z

This PR was marked stale due to lack of activity. It will be closed in 7 days.

github-actions · 2025-11-21T03:30:58Z

This PR was marked stale due to lack of activity. It will be closed in 7 days.

Kielek · 2025-11-28T13:03:55Z

src/OpenTelemetry.Resources.Process/ProcessDetector.cs

+            new(ProcessSemanticConventions.AttributeProcessExecName, currentProcess.ProcessName),
+            new(ProcessSemanticConventions.AttributeProcessInteractive, Environment.UserInteractive),
 #if NET
            new(ProcessSemanticConventions.AttributeProcessPid, Environment.ProcessId),


You already have currentProcess.Id here. Is there any reason to go through Environment and potentially fetching process data from the scratch?

What is more, there will be common scenario both for .NET/non .NET

src/OpenTelemetry.Resources.Process/CHANGELOG.md

Kielek · 2025-11-28T13:15:12Z

src/OpenTelemetry.Resources.Process/ProcessDetector.cs

        {
            new(ProcessSemanticConventions.AttributeProcessOwner, Environment.UserName),
+            new(ProcessSemanticConventions.AttributeProcessArgsCount, Environment.GetCommandLineArgs().Length),
+            new(ProcessSemanticConventions.AttributeProcessTitle, currentProcess.MainWindowTitle),


I am not sure if it should be used here. Main windows title is not the process title. Check https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.process.mainwindowtitle?view=net-10.0

It is recommended attribute, so it can be omitted in this PR.

Good spot have corrected how this is sourced.

Kielek · 2025-11-28T13:16:50Z

src/OpenTelemetry.Resources.Process/ProcessDetector.cs

            new(ProcessSemanticConventions.AttributeProcessOwner, Environment.UserName),
+            new(ProcessSemanticConventions.AttributeProcessArgsCount, Environment.GetCommandLineArgs().Length),
+            new(ProcessSemanticConventions.AttributeProcessTitle, currentProcess.MainWindowTitle),
+            new(ProcessSemanticConventions.AttributeProcessWorkingDir, Environment.CurrentDirectory),


Based what on I see is not reliable and might change in time.
alternative approach currentProcess.StartInfo.WorkingDirectory is not working while I was testing.

As it is conditionally required and we have AttributeProcessArgsCount, I would drop this attribute.

It works for me in my testing. Resource attributes are allowed to change, they just need to be a descriptive attribute which this is. The description of the property mentions that this is the working directory.

Kielek · 2025-11-28T13:20:34Z

src/OpenTelemetry.Resources.Process/ProcessDetector.cs

+            new(ProcessSemanticConventions.AttributeProcessTitle, currentProcess.MainWindowTitle),
+            new(ProcessSemanticConventions.AttributeProcessWorkingDir, Environment.CurrentDirectory),
+
+            new(ProcessSemanticConventions.AttributeProcessExecName, currentProcess.ProcessName),


Are you sure that it met SHOULD criteria from OTel sem. conv?
The name of the process executable. On Linux based systems, this SHOULD be set to the base name of the target of /proc/[pid]/exe. On Windows, this SHOULD be set to the base name of GetProcessImageFileNameW.

If not, it is conditionally required, and we have non-controversial in place AttributeProcessArgsCount. Potentially, it can be removed from this PR.

Have updated it to use the main module name.

Kielek · 2025-11-28T13:24:57Z

src/OpenTelemetry.Resources.Process/ProcessDetector.cs

+            new(ProcessSemanticConventions.AttributeProcessWorkingDir, Environment.CurrentDirectory),
+
+            new(ProcessSemanticConventions.AttributeProcessExecName, currentProcess.ProcessName),
+            new(ProcessSemanticConventions.AttributeProcessInteractive, Environment.UserInteractive),


Are you sure that
https://learn.microsoft.com/en-us/dotnet/api/system.environment.userinteractive?view=net-10.0
is compliant with sem conf description: Whether the process is connected to an interactive shell.?

It can be omitted, as it is recommended attribute.

Yes but to further increase the checks, I now check if stdio is connected.

src/OpenTelemetry.Resources.Process/README.md

…//github.com/thompson-tomo/opentelemetry-dotnet-contrib into feature/#2892_ImplementRecomendedProcessAttr

thompson-tomo and others added 12 commits July 10, 2025 17:48

Add in alot more process attributes open-telemetry#2892

5bfc0cf

Implementation of feedback

6316cca

Further review feedback

ae97c1c

Co-authored-by: Martin Costello <[email protected]>

Add in an action method

44d0dd8

Fix changelog

4fede6b

split out runtime changes

36b62f4

review feedback

6d77f69

Improve docs

415c7dc

Remove opt-in params

c714d56

Update docs

74eabc0

Typo fix in attribute name

ae2e468

Merge branch 'main' into feature/#2892_ImplementRecomendedProcessAttr

7fb1252

github-actions bot added the comp:resources.process Things related to OpenTelemetry.Resources.Process label Oct 28, 2025

Merge branch 'main' into feature/#2892_ImplementRecomendedProcessAttr

c8d5ee1

thompson-tomo changed the title ~~Feature/#2892 implement recomended process attr~~ implement latest semconv spec for process resource #2892 Oct 28, 2025

thompson-tomo marked this pull request as ready for review October 28, 2025 10:23

thompson-tomo requested a review from a team as a code owner October 28, 2025 10:23

matt-hensley reviewed Oct 28, 2025

View reviewed changes

src/OpenTelemetry.Resources.Process/ProcessDetector.cs Outdated Show resolved Hide resolved

Tweak error handling

5bef668

github-actions bot assigned Kielek and lachmatt Nov 4, 2025

github-actions bot requested review from Kielek and lachmatt November 4, 2025 04:03

Kielek reviewed Nov 4, 2025

View reviewed changes

Kielek requested changes Nov 4, 2025

View reviewed changes

github-actions bot added the Stale label Nov 12, 2025

Merge branch 'main' into feature/#2892_ImplementRecomendedProcessAttr

247870d

github-actions bot removed the Stale label Nov 13, 2025

github-actions bot added Stale and removed Stale labels Nov 21, 2025

thompson-tomo added 2 commits November 26, 2025 20:56

Remove fallback for process start time attribute

f42b41e

Merge branch 'main' into feature/#2892_ImplementRecomendedProcessAttr

bf8cbcf

Kielek changed the title ~~implement latest semconv spec for process resource #2892~~ [Resources.Process] implement latest semantic convention spec Nov 28, 2025

Kielek reviewed Nov 28, 2025

View reviewed changes

thompson-tomo added 2 commits December 4, 2025 13:03

Review feedback implementation

e72dae1

Merge branch 'feature/#2892_ImplementRecomendedProcessAttr' of https:…

e885a7e

…//github.com/thompson-tomo/opentelemetry-dotnet-contrib into feature/#2892_ImplementRecomendedProcessAttr

[Resources.Process] implement latest semantic convention spec #3347

Are you sure you want to change the base?

[Resources.Process] implement latest semantic convention spec #3347

Uh oh!

Conversation

thompson-tomo commented Oct 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Merge requirement checklist

Uh oh!

codecov bot commented Oct 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

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!

thompson-tomo Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

github-actions bot commented Nov 12, 2025

Uh oh!

github-actions bot commented Nov 21, 2025

Uh oh!

Choose a reason for hiding this comment

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!

thompson-tomo Dec 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thompson-tomo Dec 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

thompson-tomo commented Oct 28, 2025 •

edited

Loading

codecov bot commented Oct 28, 2025 •

edited

Loading

thompson-tomo Nov 4, 2025 •

edited

Loading

thompson-tomo Dec 4, 2025 •

edited

Loading

thompson-tomo Dec 4, 2025 •

edited

Loading