Skip to content

Commit 139939b

Browse files
committed
docs: standarize on contrib
- quick start, installation Signed-off-by: jaehanbyun <[email protected]>
1 parent 8ff20bd commit 139939b

File tree

3 files changed

+77
-48
lines changed

3 files changed

+77
-48
lines changed

content/en/docs/collector/installation.md

Lines changed: 60 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Install the Collector
33
weight: 2
4-
cSpell:ignore: darwin dpkg journalctl kubectl otelcorecol pprof tlsv zpages
4+
cSpell:ignore: contrib darwin dpkg journalctl kubectl pprof tlsv zpages
55
---
66

77
You can deploy the OpenTelemetry Collector on a wide variety of operating
@@ -12,6 +12,20 @@ If you aren't familiar with the deployment models, components, and repositories
1212
applicable to the OpenTelemetry Collector, first review the [Data Collection][]
1313
and [Deployment Methods][] page.
1414

15+
> Note: Collector distributions
16+
>
17+
> OpenTelemetry provides two official Collector distributions:
18+
>
19+
> - Core ("otelcol"): Minimal set of core components maintained in the core
20+
> repository.
21+
> - Contrib ("otelcol-contrib"): Superset with many additional receivers,
22+
> processors, exporters, and extensions.
23+
>
24+
> This page uses the Contrib distribution (`opentelemetry-collector-contrib`) in
25+
> examples. If you prefer the Core distribution, replace the image/binary and
26+
> config paths accordingly (for example, `/etc/otelcol-contrib/`
27+
> `/etc/otelcol/`).
28+
1529
## Docker
1630

1731
The following commands pull a Docker image and run the Collector in a container.
@@ -100,7 +114,7 @@ and as full demo in [Getting Started with OpenTelemetry on HashiCorp Nomad][].
100114

101115
Every Collector release includes APK, DEB and RPM packaging for Linux
102116
amd64/arm64/i386 systems. You can find the default configuration in
103-
`/etc/otelcol/config.yaml` after installation.
117+
`/etc/otelcol-contrib/config.yaml` after installation.
104118

105119
> Note: `systemd` is required for automatic service configuration.
106120
@@ -113,26 +127,26 @@ To get started on Debian systems run the following commands:
113127
```sh
114128
sudo apt-get update
115129
sudo apt-get -y install wget
116-
wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_amd64.deb
117-
sudo dpkg -i otelcol_{{% param vers %}}_linux_amd64.deb
130+
wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol-contrib_{{% param vers %}}_linux_amd64.deb
131+
sudo dpkg -i otelcol-contrib_{{% param vers %}}_linux_amd64.deb
118132
```
119133

120134
{{% /tab %}} {{% tab ARM64 %}}
121135

122136
```sh
123137
sudo apt-get update
124138
sudo apt-get -y install wget
125-
wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_arm64.deb
126-
sudo dpkg -i otelcol_{{% param vers %}}_linux_arm64.deb
139+
wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol-contrib_{{% param vers %}}_linux_arm64.deb
140+
sudo dpkg -i otelcol-contrib_{{% param vers %}}_linux_arm64.deb
127141
```
128142

129143
{{% /tab %}} {{% tab i386 %}}
130144

131145
```sh
132146
sudo apt-get update
133147
sudo apt-get -y install wget
134-
wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_386.deb
135-
sudo dpkg -i otelcol_{{% param vers %}}_linux_386.deb
148+
wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol-contrib_{{% param vers %}}_linux_386.deb
149+
sudo dpkg -i otelcol-contrib_{{% param vers %}}_linux_386.deb
136150
```
137151

138152
{{% /tab %}} {{< /tabpane >}}
@@ -146,26 +160,26 @@ To get started on Red Hat systems run the following commands:
146160
```sh
147161
sudo yum update
148162
sudo yum -y install wget systemctl
149-
wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_amd64.rpm
150-
sudo rpm -ivh otelcol_{{% param vers %}}_linux_amd64.rpm
163+
wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol-contrib_{{% param vers %}}_linux_amd64.rpm
164+
sudo rpm -ivh otelcol-contrib_{{% param vers %}}_linux_amd64.rpm
151165
```
152166

153167
{{% /tab %}} {{% tab ARM64 %}}
154168

155169
```sh
156170
sudo yum update
157171
sudo yum -y install wget systemctl
158-
wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_arm64.rpm
159-
sudo rpm -ivh otelcol_{{% param vers %}}_linux_arm64.rpm
172+
wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol-contrib_{{% param vers %}}_linux_arm64.rpm
173+
sudo rpm -ivh otelcol-contrib_{{% param vers %}}_linux_arm64.rpm
160174
```
161175

162176
{{% /tab %}} {{% tab i386 %}}
163177

164178
```sh
165179
sudo yum update
166180
sudo yum -y install wget systemctl
167-
wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_386.rpm
168-
sudo rpm -ivh otelcol_{{% param vers %}}_linux_386.rpm
181+
wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol-contrib_{{% param vers %}}_linux_386.rpm
182+
sudo rpm -ivh otelcol-contrib_{{% param vers %}}_linux_386.rpm
169183
```
170184

171185
{{% /tab %}} {{< /tabpane >}}
@@ -178,55 +192,56 @@ file containing the binary and install it on your machine manually:
178192
{{< tabpane text=true >}} {{% tab AMD64 %}}
179193

180194
```sh
181-
curl --proto '=https' --tlsv1.2 -fOL https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_amd64.tar.gz
182-
tar -xvf otelcol_{{% param vers %}}_linux_amd64.tar.gz
195+
curl --proto '=https' --tlsv1.2 -fOL https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol-contrib_{{% param vers %}}_linux_amd64.tar.gz
196+
tar -xvf otelcol-contrib_{{% param vers %}}_linux_amd64.tar.gz
183197
```
184198

185199
{{% /tab %}} {{% tab ARM64 %}}
186200

187201
```sh
188-
curl --proto '=https' --tlsv1.2 -fOL https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_arm64.tar.gz
189-
tar -xvf otelcol_{{% param vers %}}_linux_arm64.tar.gz
202+
curl --proto '=https' --tlsv1.2 -fOL https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol-contrib_{{% param vers %}}_linux_arm64.tar.gz
203+
tar -xvf otelcol-contrib_{{% param vers %}}_linux_arm64.tar.gz
190204
```
191205

192206
{{% /tab %}} {{% tab i386 %}}
193207

194208
```sh
195-
curl --proto '=https' --tlsv1.2 -fOL https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_386.tar.gz
196-
tar -xvf otelcol_{{% param vers %}}_linux_386.tar.gz
209+
curl --proto '=https' --tlsv1.2 -fOL https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol-contrib_{{% param vers %}}_linux_386.tar.gz
210+
tar -xvf otelcol-contrib_{{% param vers %}}_linux_386.tar.gz
197211
```
198212

199213
{{% /tab %}} {{% tab ppc64le %}}
200214

201215
```sh
202-
curl --proto '=https' --tlsv1.2 -fOL https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_ppc64le.tar.gz
203-
tar -xvf otelcol_{{% param vers %}}_linux_ppc64le.tar.gz
216+
curl --proto '=https' --tlsv1.2 -fOL https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol-contrib_{{% param vers %}}_linux_ppc64le.tar.gz
217+
tar -xvf otelcol-contrib_{{% param vers %}}_linux_ppc64le.tar.gz
204218
```
205219

206220
{{% /tab %}} {{< /tabpane >}}
207221

208222
### Automatic service configuration
209223

210-
By default, the `otelcol` systemd service starts with the
211-
`--config=/etc/otelcol/config.yaml` option after installation.
224+
By default, the `otelcol-contrib` systemd service starts with the
225+
`--config=/etc/otelcol-contrib/config.yaml` option after installation.
212226

213227
To use a different settings, set the `OTELCOL_OPTIONS` variable in the
214-
`/etc/otelcol/otelcol.conf` systemd environment file to the appropriate
215-
command-line options. You can run `/usr/bin/otelcol --help` to see all available
216-
options. You can pass additional environment variables to the `otelcol` service
217-
by adding them to this file.
228+
`/etc/otelcol-contrib/otelcol-contrib.conf` systemd environment file to the
229+
appropriate command-line options. You can run `/usr/bin/otelcol-contrib --help`
230+
to see all available options. You can pass additional environment variables to
231+
the `otelcol-contrib` service by adding them to this file.
218232

219-
If you modify the Collector configuration file or `/etc/otelcol/otelcol.conf`,
220-
restart the `otelcol` service to apply the changes by running:
233+
If you modify the Collector configuration file or
234+
`/etc/otelcol-contrib/otelcol-contrib.conf`, restart the `otelcol-contrib`
235+
service to apply the changes by running:
221236

222237
```sh
223-
sudo systemctl restart otelcol
238+
sudo systemctl restart otelcol-contrib
224239
```
225240

226-
To check the output from the `otelcol` service, run:
241+
To check the output from the `otelcol-contrib` service, run:
227242

228243
```sh
229-
sudo journalctl -u otelcol
244+
sudo journalctl -u otelcol-contrib
230245
```
231246

232247
## macOS
@@ -238,21 +253,21 @@ commands:
238253
{{< tabpane text=true >}} {{% tab Intel %}}
239254

240255
```sh
241-
curl --proto '=https' --tlsv1.2 -fOL https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_darwin_amd64.tar.gz
242-
tar -xvf otelcol_{{% param vers %}}_darwin_amd64.tar.gz
256+
curl --proto '=https' --tlsv1.2 -fOL https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol-contrib_{{% param vers %}}_darwin_amd64.tar.gz
257+
tar -xvf otelcol-contrib_{{% param vers %}}_darwin_amd64.tar.gz
243258
```
244259

245260
{{% /tab %}} {{% tab ARM %}}
246261

247262
```sh
248-
curl --proto '=https' --tlsv1.2 -fOL https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_darwin_arm64.tar.gz
249-
tar -xvf otelcol_{{% param vers %}}_darwin_arm64.tar.gz
263+
curl --proto '=https' --tlsv1.2 -fOL https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol-contrib_{{% param vers %}}_darwin_arm64.tar.gz
264+
tar -xvf otelcol-contrib_{{% param vers %}}_darwin_arm64.tar.gz
250265
```
251266

252267
{{% /tab %}} {{< /tabpane >}}
253268

254-
Every Collector release includes an `otelcol` executable that you can run after
255-
unpacking.
269+
Every Collector release includes an `otelcol-contrib` executable that you can
270+
run after unpacking.
256271

257272
## Windows
258273

@@ -264,14 +279,14 @@ Application Event Log source with the distribution name.
264279
### MSI installation
265280

266281
```powershell
267-
msiexec /i "https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_windows_x64.msi"
282+
msiexec /i "https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol-contrib_{{% param vers %}}_windows_x64.msi"
268283
```
269284

270285
### Manual installation
271286

272287
```powershell
273-
Invoke-WebRequest -Uri "https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_windows_amd64.tar.gz" -OutFile "otelcol_{{% param vers %}}_windows_amd64.tar.gz"
274-
tar -xvzf otelcol_{{% param vers %}}_windows_amd64.tar.gz
288+
Invoke-WebRequest -Uri "https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol-contrib_{{% param vers %}}_windows_amd64.tar.gz" -OutFile "otelcol-contrib_{{% param vers %}}_windows_amd64.tar.gz"
289+
tar -xvzf otelcol-contrib_{{% param vers %}}_windows_amd64.tar.gz
275290
```
276291

277292
Every release includes the Collector executable that you can run after
@@ -283,10 +298,10 @@ You can build the latest version of the Collector based on the local operating
283298
system using the following commands:
284299

285300
```sh
286-
git clone https://github.com/open-telemetry/opentelemetry-collector.git
287-
cd opentelemetry-collector
301+
git clone https://github.com/open-telemetry/opentelemetry-collector-contrib.git
302+
cd opentelemetry-collector-contrib
288303
make install-tools
289-
make otelcorecol
304+
make otelcontribcol
290305
```
291306

292307
[data collection]: /docs/concepts/components/#collector

content/en/docs/collector/quick-start.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,20 @@ You are going to learn to do the following in less than five minutes:
1919
- Set up and run the OpenTelemetry Collector.
2020
- Send telemetry and see it processed by the Collector.
2121

22+
> Note: Collector distributions
23+
>
24+
> OpenTelemetry provides two official Collector distributions:
25+
>
26+
> - Core ("otelcol"): Minimal set of core components maintained in the core
27+
> repository.
28+
> - Contrib ("otelcol-contrib"): Superset with many additional receivers,
29+
> processors, exporters, and extensions.
30+
>
31+
> This quick start uses the Contrib distribution
32+
> (`opentelemetry-collector-contrib`). If you prefer the Core distribution,
33+
> replace the image/binary and config paths accordingly (for example,
34+
> `/etc/otelcol-contrib/``/etc/otelcol/`).
35+
2236
## Prerequisites
2337

2438
Make sure that your developer environment has the following. This page assumes

content/ja/docs/zero-code/java/spring-boot-starter/getting-started.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ Spring Bootアプリケーションを計装するために、[Javaエージェ
1313

1414
{{% /alert %}}
1515

16-
### 互換性 {#compatibility}
16+
## 互換性 {#compatibility}
1717

1818
OpenTelemetry Spring Bootスターターは、Spring Boot 2.6+および3.1+、そしてSpring Bootネイティブイメージアプリケーションで動作します。
1919
[opentelemetry-java-examples/spring-native](https://github.com/open-telemetry/opentelemetry-java-examples/tree/main/spring-native)リポジトリには、OpenTelemetry Spring Bootスターターを使用して計装されたSpring Bootネイティブイメージアプリケーションの例が含まれています。
2020

21-
### 依存関係の管理 {#dependency-management}
21+
## 依存関係の管理 {#dependency-management}
2222

2323
Bill of Material([BOM](https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#bill-of-materials-bom-poms))は、依存関係(推移的なものを含む)のバージョンが整合していることを保証します。
2424

@@ -90,7 +90,7 @@ Gradleで異なる設定方法を混在させないよう注意してくださ
9090

9191
{{% /alert %}}
9292

93-
#### OpenTelemetryスターターの依存関係 {#opentelemetry-starter-dependency}
93+
### OpenTelemetryスターターの依存関係 {#opentelemetry-starter-dependency}
9494

9595
OpenTelemetryスターターを有効にするには、以下の依存関係を追加します。
9696

0 commit comments

Comments
 (0)