Skip to content

Commit b5379de

Browse files
cartermpcartermp
authored
Merge branch 'main' into michael2893-update-collector-docs-gateway
2 parents f7162ba + 3684c03 commit b5379de

8 files changed

+340
-4
lines changed

‎.github/workflows/survey-on-merged-pr.yml

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Survey on Merged PR by Non-Member
2+
3+
on:
4+
pull_request:
5+
types: [closed]
6+
7+
jobs:
8+
comment-on-pr:
9+
runs-on: ubuntu-latest
10+
if: github.event.pull_request.merged == true
11+
steps:
12+
- name: Check if user is a member of the org
13+
id: check-membership
14+
run: |
15+
USERNAME=$(jq -r '.pull_request.user.login' "$GITHUB_EVENT_PATH")
16+
ORG="${{ github.repository_owner }}"
17+
STATUS=$(gh api "orgs/$ORG/members/$USERNAME" --silent && echo "true" || echo "false")
18+
if [[ "$STATUS" == "true" ]]; then
19+
echo "MEMBER_FOUND=true" >> $GITHUB_ENV
20+
else
21+
echo "MEMBER_FOUND=false" >> $GITHUB_ENV
22+
fi
23+
env:
24+
GH_TOKEN: ${{ secrets.OPENTELEMETRYBOT_GITHUB_TOKEN }}
25+
26+
- name: Add comment to PR if author is not a member
27+
if: env.MEMBER_FOUND == 'false'
28+
run: |
29+
PR_NUMBER=${{ github.event.pull_request.number }}
30+
gh pr comment $PR_NUMBER --body "Thank you for your contribution! 🎉 We would like to hear from you about your experience contributing to OpenTelemetry by filling out this survey: https://forms.gle/WV58koUBGSG9HBY66"

‎content/ja/docs/collector/installation.md

+296
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,296 @@
1+
---
2+
title: コレクターのインストール
3+
# prettier-ignore
4+
cSpell:ignore: darwin dpkg GOARCH journalctl kubectl otelcorecol pprof tlsv zpages
5+
weight: 2
6+
default_lang_commit: a570a00
7+
---
8+
9+
OpenTelemetryコレクターはさまざまなオペレーティングシステムやアーキテクチャにデプロイできます。
10+
以下の手順は、コレクターの最新の安定版をダウンロードしてインストールする方法を示しています。
11+
12+
OpenTelemetryコレクターに適用可能なデプロイメントモデル、コンポーネント、リポジトリについてよく知らない場合は、まず[データ収集][Data Collection]と[デプロイ方法][Deployment Methods]のページを確認してください。
13+
14+
## Docker
15+
16+
以下のコマンドはDockerイメージをプルし、コレクターをコンテナ内で実行します。
17+
`{{% param vers %}}` を実行したいコレクターのバージョンに置き換えてください。
18+
19+
{{< tabpane text=true >}} {{% tab DockerHub %}}
20+
21+
```sh
22+
docker pull otel/opentelemetry-collector-contrib:{{% param vers %}}
23+
docker run otel/opentelemetry-collector-contrib:{{% param vers %}}
24+
```
25+
26+
{{% /tab %}} {{% tab ghcr.io %}}
27+
28+
```sh
29+
docker pull ghcr.io/open-telemetry/opentelemetry-collector-releases/opentelemetry-collector-contrib:{{% param vers %}}
30+
docker run ghcr.io/open-telemetry/opentelemetry-collector-releases/opentelemetry-collector-contrib:{{% param vers %}}
31+
```
32+
33+
{{% /tab %}} {{< /tabpane >}}
34+
35+
作業ディレクトリからカスタム設定ファイルを読み込むには、そのファイルをボリュームとしてマウントします。
36+
37+
{{< tabpane text=true >}} {{% tab DockerHub %}}
38+
39+
```sh
40+
docker run -v $(pwd)/config.yaml:/etc/otelcol-contrib/config.yaml otel/opentelemetry-collector-contrib:{{% param vers %}}
41+
```
42+
43+
{{% /tab %}} {{% tab ghcr.io %}}
44+
45+
```sh
46+
docker run -v $(pwd)/config.yaml:/etc/otelcol-contrib/config.yaml ghcr.io/open-telemetry/opentelemetry-collector-releases/opentelemetry-collector-contrib:{{% param vers %}}
47+
```
48+
49+
{{% /tab %}} {{< /tabpane >}}
50+
51+
## Docker Compose
52+
53+
以下の例のように、既存の `docker-compose.yaml` ファイルにOpenTelemetryコレクターを追加できます。
54+
55+
```yaml
56+
otel-collector:
57+
image: otel/opentelemetry-collector-contrib
58+
volumes:
59+
- ./otel-collector-config.yaml:/etc/otelcol-contrib/config.yaml
60+
ports:
61+
- 1888:1888 # pprof extension
62+
- 8888:8888 # Prometheus metrics exposed by the Collector
63+
- 8889:8889 # Prometheus exporter metrics
64+
- 13133:13133 # health_check extension
65+
- 4317:4317 # OTLP gRPC receiver
66+
- 4318:4318 # OTLP http receiver
67+
- 55679:55679 # zpages extension
68+
```
69+
70+
## Kubernetes
71+
72+
次のコマンドは、エージェントをデーモンセットと単一のゲートウェイインスタンスとしてデプロイします。
73+
74+
```sh
75+
kubectl apply -f https://raw.githubusercontent.com/open-telemetry/opentelemetry-collector/v{{% param vers %}}/examples/k8s/otel-config.yaml
76+
```
77+
78+
先ほどの例は、本番環境で使う前に拡張したりカスタマイズしたりするための、出発点としてのものです。
79+
本番環境でのカスタマイズとインストールについては、[OpenTelemetry Helm Charts][] を参照してください。
80+
81+
また、[OpenTelemetry Operator][] を使って、OpenTelemetryコレクターインスタンスのプロビジョニングとメンテナンスを行えます。
82+
この機能には、自動アップグレード処理、OpenTelemetry コンフィギュレーションに基づいた `Service` コンフィギュレーション、デプロイメントへの自動サイドカーインジェクションなどがあります。
83+
84+
Kubernetesでコレクターを使用する方法については、[Kubernetesで始める](/docs/kubernetes/getting-started/)を参照してください。
85+
86+
## Nomad
87+
88+
[HashiCorp NomadでOpenTelemetryを始める][Getting Started with OpenTelemetry on HashiCorp Nomad]に、エージェント、ゲートウェイとして、あるいは完全なデモの形でコレクターをデプロイするための参照ジョブファイルがあります。
89+
90+
## Linux
91+
92+
すべてのコレクターのリリースには、Linux amd64/arm64/i386システム用のAPK、DEB、RPMパッケージが含まれています。
93+
インストール後のデフォルト設定は `/etc/otelcol/config.yaml` にあります。
94+
95+
> Note: サービスの自動設定には `systemd` が必要です。
96+
97+
### APKのインストール
98+
99+
Alpine系のシステムを使い始めるには、以下のコマンドを実行します。
100+
101+
{{< tabpane text=true >}} {{% tab AMD64 %}}
102+
103+
```sh
104+
apk update
105+
apk add wget shadow
106+
wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_amd64.apk
107+
apk add --allow-untrusted otelcol_{{% param vers %}}_linux_amd64.apk
108+
```
109+
110+
{{% /tab %}} {{% tab ARM64 %}}
111+
112+
```sh
113+
apk update
114+
apk add wget shadow
115+
wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_arm64.apk
116+
apk add --allow-untrusted otelcol_{{% param vers %}}_linux_arm64.apk
117+
```
118+
119+
{{% /tab %}} {{% tab i386 %}}
120+
121+
```sh
122+
apk update
123+
apk add wget shadow
124+
wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_386.apk
125+
apk add --allow-untrusted otelcol_{{% param vers %}}_linux_386.apk
126+
```
127+
128+
{{% /tab %}} {{< /tabpane >}}
129+
130+
### DEBのインストール
131+
132+
Debian系のシステムで使い始めるには、以下のコマンドを実行します。
133+
134+
{{< tabpane text=true >}} {{% tab AMD64 %}}
135+
136+
```sh
137+
sudo apt-get update
138+
sudo apt-get -y install wget systemctl
139+
wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_amd64.deb
140+
sudo dpkg -i otelcol_{{% param vers %}}_linux_amd64.deb
141+
```
142+
143+
{{% /tab %}} {{% tab ARM64 %}}
144+
145+
```sh
146+
sudo apt-get update
147+
sudo apt-get -y install wget systemctl
148+
wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_arm64.deb
149+
sudo dpkg -i otelcol_{{% param vers %}}_linux_arm64.deb
150+
```
151+
152+
{{% /tab %}} {{% tab i386 %}}
153+
154+
```sh
155+
sudo apt-get update
156+
sudo apt-get -y install wget systemctl
157+
wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_386.deb
158+
sudo dpkg -i otelcol_{{% param vers %}}_linux_386.deb
159+
```
160+
161+
{{% /tab %}} {{< /tabpane >}}
162+
163+
### RPMのインストール
164+
165+
Red Hat系のシステムで使い始めるには、以下のコマンドを実行します。
166+
167+
{{< tabpane text=true >}} {{% tab AMD64 %}}
168+
169+
```sh
170+
sudo yum update
171+
sudo yum -y install wget systemctl
172+
wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_amd64.rpm
173+
sudo rpm -ivh otelcol_{{% param vers %}}_linux_amd64.rpm
174+
```
175+
176+
{{% /tab %}} {{% tab ARM64 %}}
177+
178+
```sh
179+
sudo yum update
180+
sudo yum -y install wget systemctl
181+
wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_arm64.rpm
182+
sudo rpm -ivh otelcol_{{% param vers %}}_linux_arm64.rpm
183+
```
184+
185+
{{% /tab %}} {{% tab i386 %}}
186+
187+
```sh
188+
sudo yum update
189+
sudo yum -y install wget systemctl
190+
wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_386.rpm
191+
sudo rpm -ivh otelcol_{{% param vers %}}_linux_386.rpm
192+
```
193+
194+
{{% /tab %}} {{< /tabpane >}}
195+
196+
### 手動でのLinuxへのインストール
197+
198+
Linux向けの[リリース][releases]は、さまざまなアーキテクチャに対応しています。
199+
バイナリを含むファイルをダウンロードし、あなたのマシンに手動でインストールしてください。
200+
201+
{{< tabpane text=true >}} {{% tab AMD64 %}}
202+
203+
```sh
204+
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
205+
tar -xvf otelcol_{{% param vers %}}_linux_amd64.tar.gz
206+
```
207+
208+
{{% /tab %}} {{% tab ARM64 %}}
209+
210+
```sh
211+
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
212+
tar -xvf otelcol_{{% param vers %}}_linux_arm64.tar.gz
213+
```
214+
215+
{{% /tab %}} {{% tab i386 %}}
216+
217+
```sh
218+
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
219+
tar -xvf otelcol_{{% param vers %}}_linux_386.tar.gz
220+
```
221+
222+
{{% /tab %}} {{% tab ppc64le %}}
223+
224+
```sh
225+
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
226+
tar -xvf otelcol_{{% param vers %}}_linux_ppc64le.tar.gz
227+
```
228+
229+
{{% /tab %}} {{< /tabpane >}}
230+
231+
### 自動サービスコンフィギュレーション
232+
233+
デフォルトでは、`otelcol` systemd サービスはインストール後に `--config=/etc/otelcol/config.yaml` オプションをつけて起動します。
234+
235+
別の設定を使うには、`/etc/otelcol/otelcol.conf` systemd 環境ファイルにある `OTELCOL_OPTIONS` 変数を適切なコマンドラインオプションに設定します。
236+
`/usr/bin/otelcol --help` を実行すると、利用可能なすべてのオプションを確認できます。
237+
このファイルに追加の環境変数を追加して `otelcol` サービスに渡せます。
238+
239+
コレクターの設定ファイルまたは `/etc/otelcol/otelcol.conf` を変更した場合は、`otelcol` サービスを再起動して変更を適用します。
240+
241+
```sh
242+
sudo systemctl restart otelcol
243+
```
244+
245+
`otelcol` サービスからの出力をチェックするには、以下を実行します。
246+
247+
```sh
248+
sudo journalctl -u otelcol
249+
```
250+
251+
## macOS
252+
253+
macOS向けの [リリース][releases] は Intel および ARM システムで利用可能です。
254+
リリースはgzip圧縮されたtarball (`.tar.gz`) としてパッケージ化されています。
255+
解凍するには、以下のコマンドを実行してください。
256+
257+
{{< tabpane text=true >}} {{% tab Intel %}}
258+
259+
```sh
260+
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
261+
tar -xvf otelcol_{{% param vers %}}_darwin_amd64.tar.gz
262+
```
263+
264+
{{% /tab %}} {{% tab ARM %}}
265+
266+
```sh
267+
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
268+
tar -xvf otelcol_{{% param vers %}}_darwin_arm64.tar.gz
269+
```
270+
271+
{{% /tab %}} {{< /tabpane >}}
272+
273+
すべてのコレクターのリリースには、解凍後に実行できる `otelcol` 実行ファイルが含まれています。
274+
275+
## Windows
276+
277+
Windows向けの [リリース][releases] は gzip された tarball (`.tar.gz`) としてパッケージ化されています。
278+
すべてのコレクターのリリースには、解凍後に実行できる `otelcol.exe` 実行ファイルが含まれています。
279+
280+
## ソースからビルドする
281+
282+
以下のコマンドを使用して、ローカルのオペレーティングシステムに基づいてコレクターの最新バージョンをビルドできます。
283+
284+
```sh
285+
git clone https://github.com/open-telemetry/opentelemetry-collector.git
286+
cd opentelemetry-collector
287+
make install-tools
288+
make otelcorecol
289+
```
290+
291+
[data collection]: /docs/concepts/components/#collector
292+
[deployment methods]: ../deployment/
293+
[opentelemetry helm charts]: /docs/kubernetes/helm/
294+
[opentelemetry operator]: /docs/kubernetes/operator/
295+
[getting started with opentelemetry on hashicorp nomad]: https://github.com/hashicorp/nomad-open-telemetry-getting-started
296+
[releases]: https://github.com/open-telemetry/opentelemetry-collector-releases/releases

‎data/ecosystem/vendors.yaml

+6
Original file line numberDiff line numberDiff line change
@@ -438,6 +438,12 @@
438438
contact: [email protected]
439439
oss: false
440440
commercial: true
441+
- name: BMC Helix
442+
nativeOTLP: true
443+
url: https://docs.bmc.com/docs/helixaiops/244/enabling-bmc-helix-applications-to-collect-service-traces-from-opentelemetry-1391498839.html
444+
contact: [email protected]
445+
oss: false
446+
commercial: true
441447
- name: Seq
442448
nativeOTLP: true
443449
url: https://docs.datalust.co/docs/opentelemetry-net-sdk-1

‎data/registry/instrumentation-dotnet-aws.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ isFirstParty: false
2020
package:
2121
registry: nuget
2222
name: OpenTelemetry.Instrumentation.AWS
23-
version: 1.10.0-beta.3
23+
version: 1.10.0-rc.1

‎data/registry/instrumentation-dotnet-awslambda.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ isFirstParty: false
1919
package:
2020
registry: nuget
2121
name: OpenTelemetry.Instrumentation.AWSLambda
22-
version: 1.10.0-beta.3
22+
version: 1.10.0-rc.1

‎data/registry/instrumentation-dotnet-instrumentation-aws.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ isFirstParty: false
1616
package:
1717
registry: nuget
1818
name: OpenTelemetry.Instrumentation.AWS
19-
version: 1.10.0-beta.3
19+
version: 1.10.0-rc.1

‎data/registry/instrumentation-java-http4k.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ isFirstParty: true
1919
package:
2020
registry: maven
2121
name: org.http4k/http4k-opentelemetry
22-
version: 5.44.2.0
22+
version: 5.44.3.0

‎static/refcache.json

+4
Original file line numberDiff line numberDiff line change
@@ -2475,6 +2475,10 @@
24752475
"StatusCode": 206,
24762476
"LastSeen": "2024-08-09T10:44:31.007449-04:00"
24772477
},
2478+
"https://docs.bmc.com/docs/helixaiops/244/enabling-bmc-helix-applications-to-collect-service-traces-from-opentelemetry-1391498839.html": {
2479+
"StatusCode": 200,
2480+
"LastSeen": "2024-12-05T17:11:24.457484-08:00"
2481+
},
24782482
"https://docs.bugsnag.com/performance/distributed-tracing": {
24792483
"StatusCode": 206,
24802484
"LastSeen": "2024-09-24T06:18:58.718106443Z"

0 commit comments

Comments
 (0)