Added Readme file for otel #3992
Conversation
michalpristas
added
Team:Elastic-Agent-Control-Plane
|
Pinging @elastic/elastic-agent-control-plane (Team:Elastic-Agent-Control-Plane) |
|
Pinging @elastic/elastic-agent (Team:Elastic-Agent) |
magefile.go
Outdated
| return tmpl.Execute(out, data) | ||
| } | ||
|
|
||
| func getDependencies() (receivers, exporters, processors []dependency, err error) { |
There was a problem hiding this comment.
This function is OTel specific so maybe rename it to reflect that?
There was a problem hiding this comment.
Consider parsing out extensions as well, e.g. github.com/open-telemetry/opentelemetry-collector-contrib/extension/basicauthextension
magefile.go
Outdated
| } | ||
| } | ||
|
|
||
| readFile.Close() |
There was a problem hiding this comment.
Maybe move this to a defer statement right after the the file is opened? That way, we close the file handle even if we return early from this function because of an error.
magefile.go
Outdated
| } | ||
| } | ||
|
|
||
| func OtelReadme() error { |
There was a problem hiding this comment.
Can't say as of now if we'll end up with more OTel-specific mage targets, but if I had to guess I would say we would. So it might be a good idea to namespace all OTel-specific targets with otel:? So this target would then become otel:readme.
Co-authored-by: Shaunak Kashyap <[email protected]>
Co-authored-by: Shaunak Kashyap <[email protected]>
Co-authored-by: Shaunak Kashyap <[email protected]>
Co-authored-by: Shaunak Kashyap <[email protected]>
Co-authored-by: Shaunak Kashyap <[email protected]>
Co-authored-by: Shaunak Kashyap <[email protected]>
|
|
I would link to this from a new section in https://github.com/elastic/elastic-agent/blob/main/README.md |
Added README file for otel. README is dynamically re-generated when dependencies are changed. mage otelReadme will parse dependencies and regenerate output file. command is also part of mage update or mage check
Added README file for otel.
README is dynamically re-generated when dependencies are changed.
mage otelReadmewill parse dependencies and regenerate output file.
command is also part of
mage updateormage checkFixes: #3851