open-telemetry
/
opentelemetry-collector
mirror of https://github.com/open-telemetry/opentelemetry-collector.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[cmd/builder] Specify limitations of `go install` on the README (#8712) 

Document `go install` limitations on `cmd/builder` README.

Fixes #8691
This commit is contained in:
Pablo Baeyens 2023-10-20 17:28:33 +02:00 committed by GitHub
parent 7c33b71f36
commit 3d3fffafea
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
cmd/builder/README.md
View File

@ -51,8 +51,21 @@ $ /tmp/dist/otelcol-custom --config=/tmp/otelcol.yaml
## Installation
Download the binary for your respective platform under the ["Releases"](https://github.com/open-telemetry/opentelemetry-collector/releases/latest) page.
If install an official release build, the binary is named `ocb`, but if you installed by using `go install`, it will be called `builder`.
There are two supported ways to install the builder: via the official releases (recommended) and through `go install`.
### Official releases
This is the recommended installation method. Download the binary for your respective platform under the ["Releases"](https://github.com/open-telemetry/opentelemetry-collector/releases/latest) page.
### `go install`
You need to have a `go` compiler in your PATH. Run the following command to install the latest version:
```
go install go.opentelemetry.io/collector/cmd/builder@latest
```
If installing through this method the binary will be called `builder`. Binaries installed through this method [will incorrectly show `dev` as their version](https://github.com/open-telemetry/opentelemetry-collector/issues/8691).
## Running