Skip to content

Commit

Permalink
docs(builder): remove 'otelcol_version' configuration parameter (#6132)
Browse files Browse the repository at this point in the history
  • Loading branch information
ezeqme authored Jan 31, 2025
1 parent a0fab08 commit e201d36
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 12 deletions.
1 change: 0 additions & 1 deletion content/en/docs/collector/building/connector/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -497,7 +497,6 @@ your own OpenTelemetry Collector binary. You can add or remove components
name: otelcol-dev-bin
description: Basic OpenTelemetry collector distribution for Developers
output_path: ./otelcol-dev
otelcol_version: 0.86.0
exporters:
Expand Down
19 changes: 8 additions & 11 deletions content/en/docs/collector/custom-collector.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,15 +98,14 @@ configure the code generation and compile process. In fact, all the tags for

Here are the tags for the `dist` map:

| Tag | Description | Optional | Default Value |
| ---------------- | -------------------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------- |
| module: | The module name for the new distribution, following Go mod conventions. Optional, but recommended. | Yes | `go.opentelemetry.io/collector/cmd/builder` |
| name: | The binary name for your distribution | Yes | `otelcol-custom` |
| description: | A long name for the application. | Yes | `Custom OpenTelemetry Collector distribution` |
| otelcol_version: | The OpenTelemetry Collector version to use as base for the distribution. | Yes | `{{% version-from-registry collector-builder noPrefix %}}` |
| output_path: | The path to write the output (sources and binary). | Yes | `/var/folders/86/s7l1czb16g124tng0d7wyrtw0000gn/T/otelcol-distribution3618633831` |
| version: | The version for your custom OpenTelemetry Collector. | Yes | `1.0.0` |
| go: | Which Go binary to use to compile the generated sources. | Yes | go from the PATH |
| Tag | Description | Optional | Default Value |
| ------------ | -------------------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------- |
| module: | The module name for the new distribution, following Go mod conventions. Optional, but recommended. | Yes | `go.opentelemetry.io/collector/cmd/builder` |
| name: | The binary name for your distribution | Yes | `otelcol-custom` |
| description: | A long name for the application. | Yes | `Custom OpenTelemetry Collector distribution` |
| output_path: | The path to write the output (sources and binary). | Yes | `/var/folders/86/s7l1czb16g124tng0d7wyrtw0000gn/T/otelcol-distribution3618633831` |
| version: | The version for your custom OpenTelemetry Collector. | Yes | `1.0.0` |
| go: | Which Go binary to use to compile the generated sources. | Yes | go from the PATH |

As you can see on the table above, all the `dist` tags are optional, so you will
be adding custom values for them depending if your intentions to make your
Expand All @@ -125,7 +124,6 @@ dist:
name: otelcol-dev
description: Basic OTel Collector distribution for Developers
output_path: ./otelcol-dev
otelcol_version: 0.114.0
```
Now you need to add the modules representing the components you want to be
Expand All @@ -149,7 +147,6 @@ dist:
name: otelcol-dev
description: Basic OTel Collector distribution for Developers
output_path: ./otelcol-dev
otelcol_version: {{% version-from-registry collector-builder noPrefix %}}
exporters:
- gomod:
Expand Down

0 comments on commit e201d36

Please sign in to comment.