Skip to content
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

Builder tool name is inconsistent #5581

Closed
jpeach opened this issue Jun 23, 2022 · 6 comments · Fixed by #5651
Closed

Builder tool name is inconsistent #5581

jpeach opened this issue Jun 23, 2022 · 6 comments · Fixed by #5651
Labels
bug Something isn't working

Comments

@jpeach
Copy link
Contributor

jpeach commented Jun 23, 2022

Describe the bug
The builder tool is alternately named ocb, builder or opentelemetry-collector-builder, depending on where you look.

Steps to reproduce
Download a release binary, e.g. ocb_0.54.0_darwin_amd64

$ ./ocb_0.54.0_darwin_arm64 --help
OpenTelemetry Collector distribution builder (0.54.0)

Usage:
  builder [flags]
  builder [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  version     Version of opentelemetry-collector-builder

Flags:
      --config string            config file (default is $HOME/.otelcol-builder.yaml)
      --description string       A descriptive name for the OpenTelemetry Collector distribution (default "Custom OpenTelemetry Collector distribution")
      --go string                The Go binary to use during the compilation phase. Default: go from the PATH
  -h, --help                     help for builder
      --module string            The Go module for the new distribution (default "go.opentelemetry.io/collector/cmd/builder")
      --name string              The executable name for the OpenTelemetry Collector distribution (default "otelcol-custom")
      --otelcol-version string   Which version of OpenTelemetry Collector to use as base (default "0.54.0")
      --output-path string       Where to write the resulting files (default "/var/folders/hf/8frlwk6s40j0wj3jpgbq94z00000gp/T/otelcol-distribution2878501842")
      --skip-compilation         Whether builder should only generate go code with no compile of the collector (default false)
      --version string           The version for the OpenTelemetry Collector distribution (default "1.0.0")

Use "builder [command] --help" for more information about a command.

What did you expect to see?
A consistent name for the builder tool.

What did you see instead?
The release process names the tool ocb, the subcommand name is builder and the version help calls it opentelemetry-collector-builder. And I guess the config file implies the tool would be otelcol-builder.

What version did you use?
Version: 0.54.0

What config did you use?
Config: N/A

Environment
OS: Darwin
Compiler(if manually compiled): N/A

@jpeach jpeach added the bug Something isn't working label Jun 23, 2022
@jpkrohling
Copy link
Member

ocb stands for opentelemetry-collector-builder, so, both versions would work. The others were names we used previously in different contexts, so, it would be OK to replace them by either ocb or opentelemetry-collector-builder.

@jpeach
Copy link
Contributor Author

jpeach commented Jul 6, 2022

@jpkrohling WDYT if I standardize all the names to otel-builder?

@jpkrohling
Copy link
Member

It has to be otelcol-builder then. Sounds good to me, although I still prefer ocb. What do other @open-telemetry/collector-approvers think?

@jpeach
Copy link
Contributor Author

jpeach commented Jul 7, 2022

It has to be otelcol-builder then.

Hmm, I was suggesting otel-builder to be symmetric with otel-collector, which I thought was the standard binary name, but it looks like the default name is otelcol-custom, so maybe this is less standardized than I had thought.

@jpkrohling
Copy link
Member

I was suggesting otel-builder to be symmetric with otel-collector

Right, but the builder isn't at the same level as "otel-collector", as it's a tool that builds "otelcol" binaries.

@jpeach
Copy link
Contributor Author

jpeach commented Jul 7, 2022

OK, I'll knock up a PR to standardize on ocb then 👍

jpeach added a commit to jpeach/opentelemetry-collector that referenced this issue Jul 8, 2022
Update the builder to consistently use "ocb" in the name of the command,
version and configuration file.

This fixes open-telemetry#5581.

Signed-off-by: James Peach <[email protected]>
jpeach added a commit to jpeach/opentelemetry-collector that referenced this issue Jul 9, 2022
Update the builder to consistently use "ocb" in the name of the command,
version and configuration file.

This fixes open-telemetry#5581.

Signed-off-by: James Peach <[email protected]>
jpeach added a commit to jpeach/opentelemetry-collector that referenced this issue Jul 19, 2022
Update the builder to consistently use "ocb" in the name of the command,
version. To avoid needing to be forward compatible with configuration
file names, move the configuration file name from a flag to a command
argument, while deprecating and preserving the original behavior.

This fixes open-telemetry#5581.

Signed-off-by: James Peach <[email protected]>
jpeach added a commit to jpeach/opentelemetry-collector that referenced this issue Jul 20, 2022
Update the builder to consistently use "ocb" in the name of the command,
version. To avoid needing to be forward compatible with configuration
file names, move the configuration file name from a flag to a command
argument, while deprecating and preserving the original behavior.

This fixes open-telemetry#5581.

Signed-off-by: James Peach <[email protected]>
jpeach added a commit to jpeach/opentelemetry-collector that referenced this issue Jul 22, 2022
Update the builder to consistently use "ocb" in the name of the command,
version. Since the builder does not expand environment variables in the
config file pathname, the default value for `--config` does not work,
so we can make this flag required so that users don't silently build an
inoperative collector.

This fixes open-telemetry#5581.

Signed-off-by: James Peach <[email protected]>
bogdandrutu pushed a commit that referenced this issue Jul 22, 2022
Update the builder to consistently use "ocb" in the name of the command,
version. Since the builder does not expand environment variables in the
config file pathname, the default value for `--config` does not work,
so we can make this flag required so that users don't silently build an
inoperative collector.

This fixes #5581.

Signed-off-by: James Peach <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants