fix: support --remote-config startup option with Windows services #1443
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
* add changelog entry
|
|
||
| // This is a copy of https://github.com/open-telemetry/opentelemetry-collector/blob/20710ff2aeaed3fe1c3e46423291522674db44d6/otelcol/collector_windows.go. | ||
| // This is required to maintain our command line flags when running the collector as a Windows service, until either | ||
| // the necessary names become public, or there's a better way of customizing config providers. |
There was a problem hiding this comment.
it looks like NewSvcHandler is public already, which seems to be the only thing we use in the patch, do we need other names/functions to be public? If so, maybe we could identify those and create an upstream issue for it.
There was a problem hiding this comment.
Good catch! If windowsService was public in upstream we could simply redefine NewSvcHandler to use our flags function. None of the rest would need to be copied and things would be much cleaner indeed. Will create an upstream issue for it.
rnishtala-sumo
approved these changes
Feb 12, 2024
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.
With the introduction of remote management the application command line parameters were modified to include the
--remote-configstartup parameter. However this was unintentionally done only for interactive mode. Since the Windows service initialization code uses a different path the new parameter does not work correctly and the application exits.The Windows service launch code path from the upstream repository uses the flags function defined in the upstream code, which doesn't support the
--remote-configcommand line parameter. For interactive mode that function was redefined in our implementation of OtelCol to include the--remote-configcommand line parameter.This PRs copies the upstream Windows service launch routine and modifies it slightly to use our version of the
argsfunction instead of the upstream version, making it possible to launch the OtelCol as a Windows server.Testing has been performed by installing a MSI that includes this modified code. The Windows service now launches correctly as illustrated by the Sumo Logic console and Windows Service console.