-
Notifications
You must be signed in to change notification settings - Fork 121
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[OTel mode] Provide otelcol
executable as a shortcut to elastic-agent otel
#4661
Comments
Pinging @elastic/elastic-agent-control-plane (Team:Elastic-Agent-Control-Plane) |
@belimawr Starting to look on how to implement that, I think one way to do it will to create a simlink |
Because it needs to run the elastic-agent command with arguments, I believe a simlink will not works and we also need to support this on Windows. Because we use cobra for the CLI commands and arguments, it's easy to just create a new binary with the |
We need to measure how much we increase the on disk footprint of the agent with this addition. One quirk of the current Windows packaging is that symlinks in the zip are replaced with copies of the binary and then converted back to symlinks at install time (zip doesn't/didn't have support for symlinks when this was done). |
I completely forgot about it 🤦♂️. I was thinking only about the implementation side of things. Another option would be to use a shell script + windows equivalent that that just calls |
I just don't know if there is any Windows specific quirk about doing it. |
@cmacknz @belimawr just get a discussion with @ycombinator and one possible solution here maybe more portable will be to create a new golang binary that call |
A separate binary is more portable than a shell script, but shell scripts don't need to be compiled for every architecture, don't need to be signed on Windows+Mac, should take up less space on disk, and more importantly won't show up as another source of CVEs in security scans. I think the best path is actually just a shell script that invokes |
Two fun notes on this:
|
Perhaps we just do otelcol? @ycombinator @nimarezainia can we get this included in a sprint asap? |
It is already in a sprint. |
Chatting with @strawgate off-issue, we were debating the name of the new shortcut executable. We think |
Should we not differentiate between our distribution and that of the upstream - mainly because the Elastic distribution will be a superset, for example it will include features/bugfixes that haven't yet been up-streamed (or features that may never be up-streamed). Only valid for cases where the user would have multiple collectors downloaded and only could differentiate when they are extracted. Not sure if this is common. |
Users can still tell ours apart because there is elastic-agent sitting next to it and otelcol is just a shortcut :) |
elastic-otel
executable as a shortcut to elastic-agent otel
otelcol
executable as a shortcut to elastic-agent otel
Updated issue title and description to use |
Describe the enhancement:
Currently, to run Elastic Agent in OTel mode, users must run
./elastic-agent otel ...
(or the Windows equivalent). It would be convenient if users could simply run something like./otelcol ...
instead.Describe a specific use case for the enhancement or feature:
For users who are familiar with OpenTelemetry but not with Elastic Agent, the less we expose Elastic Agent concepts to such users the better.
What is the definition of done?
./otelcol ...
in addition to./elastic-agent otel ...
.The text was updated successfully, but these errors were encountered: