Add required and recommended attributes - #4437
Conversation
dbarker
left a comment
dbarker
left a comment
There was a problem hiding this comment.
Thanks for the PR! Please see feedback below.
…o with other minor changes
|
@dbarker Thanks for the review and feedback! I've made the changes
|
There was a problem hiding this comment.
Pull request overview
Adds missing required/recommended Process Entity and Process Executable Entity semantic convention attributes to the Process Resource Detector, with supporting utilities, tests, and documentation updates.
Changes:
- Extends process detection to populate
process.creation.time,process.owner,process.executable.build_id.htlhash, andprocess.executable.name(when available). - Refactors executable discovery utility to return both path + basename, and adds utilities for creation time / owner / deterministic build ID.
- Adds unit + integration-style tests and updates the resource detector README and header docstrings accordingly.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| resource_detectors/test/process_detector_test.cc | Adds new utility tests and an integration test asserting expected resource attributes are present. |
| resource_detectors/src/process_detector.cc | Populates the new process attributes in Detect() using the new utility APIs. |
| resource_detectors/src/process_detector_utils.cc | Implements executable info, creation time, owner lookup, and htlhash build ID computation. |
| resource_detectors/README.md | Documents added attributes and platform limitations (notably macOS executable info). |
| resource_detectors/include/opentelemetry/resource_detectors/process_detector.h | Updates public detector documentation to describe newly populated attributes. |
| resource_detectors/include/opentelemetry/resource_detectors/detail/process_detector_utils.h | Declares new utility APIs (ExecutableInfo, creation time, owner, htlhash, SHA-256 helper). |
Suppressed comments (1)
resource_detectors/include/opentelemetry/resource_detectors/detail/process_detector_utils.h:81
- GetProcessOwner() has no pid parameter, but the doc comment includes an
@parampid entry. This is confusing for users of this header (even under detail/).
*
* @param pid Process ID.
*/
std::string GetProcessOwner();
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| #include <fstream> | ||
| #include <string> | ||
| #include <vector> | ||
|
|
||
| #ifdef _MSC_VER | ||
| // clang-format off | ||
| # include <windows.h> | ||
| # include <psapi.h> | ||
| # include <shellapi.h> | ||
| # pragma comment(lib, "shell32.lib") | ||
| // clang-format on | ||
| #else | ||
| # include <sys/types.h> | ||
| # include <unistd.h> | ||
| # include <cstdio> | ||
| #endif |
| * Retrieves the absolute file system path and the base name of the process executable. | ||
| * Platform-specific behavior: | ||
| * - Windows: Uses OpenProcess() + GetProcessImageFileNameW(). | ||
| * - Linux/Unix: Reads the /proc/<pid>/exe symbolic link. |
| std::ifstream f(exe_path, std::ios::binary | std::ios::ate); | ||
| if (!f.is_open()) | ||
| { | ||
| return std::string(); | ||
| } | ||
|
|
||
| auto file_size = static_cast<std::uint64_t>(f.tellg()); | ||
|
|
| std::string expected_path = opentelemetry::resource_detector::detail::GetExecutableInfo(pid).path; | ||
| EXPECT_EQ(path, expected_path); |
|
Thanks for the review! I'm back to this now. |
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #4437 +/- ##
==========================================
+ Coverage 82.67% 82.80% +0.14%
==========================================
Files 516 516
Lines 20197 20406 +209
==========================================
+ Hits 16696 16896 +200
- Misses 3501 3510 +9
🚀 New features to boost your workflow:
|
dbarker
left a comment
dbarker
left a comment
There was a problem hiding this comment.
Thanks for fixing the CI issues. Please see some feedback below on the process.executable.build_id.htlhash attribute value calculation.
| EXPECT_NE(attrs.find(opentelemetry::semconv::process::kProcessPid), attrs.end()) | ||
| << "process.pid must be present"; | ||
|
|
||
| #if defined(_MSC_VER) || defined(__linux__) |
There was a problem hiding this comment.
Can macOS be included in this check now that the executable path is populated?
There was a problem hiding this comment.
Yes it can be, I've updated the tests, Readme and comments accordingly. The only limitation is that it can't be used for an arbitrary process id, i've documented that in the Readme. If you'd prefer, that note can be removed.
Fixes #4436
Changes
process.creation.time,process.owner,process.executable.build_id.htlhashandprocess.executable.namewith declaration inresource_detectors/include/opentelemetry/resource_detectors/detail/process_detector_utils.hand implementation inresource_detectors/src/process_detector_utils.cc.resource_detectors/src/process_detector.cc.resource_detectors/test/process_detector_test.cc.Please provide a brief description of the changes here.
For significant contributions please make sure you have completed the following items:
CHANGELOG.mdupdated for non-trivial changes