Fix detection if the collector is running as service on Windows #9042
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #9042 +/- ##
=======================================
Coverage 91.49% 91.49%
=======================================
Files 316 316
Lines 17184 17184
=======================================
Hits 15723 15723
Misses 1165 1165
Partials 296 296 ☔ View full report in Codecov by Sentry. |
atoulme
approved these changes
Dec 5, 2023
dmitryax
reviewed
Dec 5, 2023
|
Unrelated test failure https://github.com/open-telemetry/opentelemetry-collector/actions/runs/7103768222/job/19337227044?pr=9042#step:7:159:~:text=%2D%2D%2D%20FAIL%3A%20TestZeroSizeWithConsumers%20(0.00s,FAIL |
bogdandrutu
reviewed
Dec 6, 2023
…-detection' of github.com:pjanotti/opentelemetry-service into fix-run-as-service-detection
|
Hit again the same test failure as above: https://github.com/open-telemetry/opentelemetry-collector/actions/runs/7111073648/job/19358552303?pr=9042#step:7:159 |
|
Change (code wise) looks good, but I am not sure about the behavior. Do we have someone with windows experience to confirm this? Maybe @reyang can find someone? |
|
Please rebase to fix the build. |
|
I can vouch for Paulo's expertise regarding Windows. He is also maintainer of the .net SDK. |
dmitryax
approved these changes
Dec 8, 2023
sokoide
pushed a commit
to sokoide/opentelemetry-collector
that referenced
this pull request
Dec 18, 2023
…-telemetry#9042) **Description:** Fix run as a service detection on Windows. Instead of trying to detect if it is a service or not, for which both `svc.IsAnInteractiveSession()` and `svc.IsWindowsService()` are somehow broken, try to run as a Windows service, if that fails fallback to run as an interactive process. This follows a recommendation of the Windows [service API documentation](https://learn.microsoft.com/en-us/windows/win32/api/winsvc/nf-winsvc-startservicectrldispatchera#return-value). The new code calls `svc.Run` and in case of error checks for `windows.ERROR_FAILED_SERVICE_CONTROLLER_CONNECT`. If this is the error the application can safely assume that it is not running as a service. The duration of a call to `svc.Run` failing with this error was below 3 microseconds in the current GH runner and below 5 microseconds on my box. While this value seems fine for startup I'm keeping the `NO_WINDOWS_SERVICE` option instead of deprecating it (it doesn't seem worth the trouble of deprecating it). **Link to tracking Issue:** Fix open-telemetry#7350 **Testing:** Fix tested on the Splunk fork that deploys the collector as a service and as an interactive process on Windows containers. **Documentation:** Added changelog.
codeboten
pushed a commit
that referenced
this pull request
Aug 1, 2024
I'm volunteering myself to own the tier 2 support for windows/amd64. This will put the windows/amd64 on par with the other tier 2 platforms by having a specific person owning it. Some of Windows related things that I contribute(d): * Codeowner of various Windows related components in contrib (pkg/winperfcounters, activedirectorydsreceiver, iisreceiver, windowseventlogreceiver, and windowsperfcountersreceiver) * Fixing Windows related issues (e.g.: #9042, #9689, #9726, open-telemetry/opentelemetry-collector-contrib#30743) * MSI on the collector releases repo (open-telemetry/opentelemetry-collector-releases#560)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
Fix run as a service detection on Windows. Instead of trying to detect if it is a service or not, for which both
svc.IsAnInteractiveSession()andsvc.IsWindowsService()are somehow broken, try to run as a Windows service, if that fails fallback to run as an interactive process. This follows a recommendation of the Windows service API documentation. The new code callssvc.Runand in case of error checks forwindows.ERROR_FAILED_SERVICE_CONTROLLER_CONNECT. If this is the error the application can safely assume that it is not running as a service.The duration of a call to
svc.Runfailing with this error was below 3 microseconds in the current GH runner and below 5 microseconds on my box. While this value seems fine for startup I'm keeping theNO_WINDOWS_SERVICEoption instead of deprecating it (it doesn't seem worth the trouble of deprecating it).Link to tracking Issue:
Fix #7350
Testing:
Fix tested on the Splunk fork that deploys the collector as a service and as an interactive process on Windows containers.
Documentation:
Added changelog.