Skip to content

Commit 23a24c0

Browse files
ymotongpooymotongpoo
authored
[ja] translate platform/android and platform/faas (open-telemetry#6535)
1 parent 823370e commit 23a24c0

File tree

6 files changed

+332
-0
lines changed

6 files changed

+332
-0
lines changed

‎content/ja/docs/platforms/_index.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: プラットフォームと環境
3+
linkTitle: プラットフォーム
4+
description: OpenTelemetryをサポートするハードウェアとソフトウェアのプラットフォームや環境
5+
weight: 260
6+
default_lang_commit: 9ba98f4fded66ec78bfafa189ab2d15d66df2309
7+
---
8+
9+
OpenTelemetry はさまざまなプラットフォームと環境で利用可能で、ハイブリッドシステムでのシームレスなオブザーバビリティを保証します。
10+
この節では、サポートされているプラットフォームで OpenTelemetry を有効にして使用する方法について説明します。

‎content/ja/docs/platforms/android/_index.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Android
3+
# description:
4+
default_lang_commit: 9ba98f4fded66ec78bfafa189ab2d15d66df2309
5+
---
6+
7+
コンテンツは近日公開！

‎content/ja/docs/platforms/faas/_index.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: Functions as a Service
3+
linkTitle: FaaS
4+
description: >-
5+
OpenTelemetryは、さまざまなクラウドベンダーが提供するFaaSを監視するさまざまな方法をサポートしています。
6+
redirects: [{ from: /docs/faas/*, to: ':splat' }] # cSpell:disable-line
7+
default_lang_commit: 9ba98f4fded66ec78bfafa189ab2d15d66df2309
8+
---
9+
10+
Functions as a Service（FaaS）は、[クラウドネイティブアプリ][cloud native apps]にとって重要なサーバーレスコンピュートプラットフォームです。
11+
しかし、プラットフォームの癖によって、これらのアプリケーションはKubernetesやVirtual Machines上で実行されるアプリケーションとは若干異なる監視ガイダンスや要件を持つことになります。
12+
13+
FaaSドキュメントの最初のベンダー範囲は、Microsoft Azure、Google Cloud Platform（GCP）、Amazon Web Services（AWS）です。
14+
AWSのファンクション（関数）はLambdaとしても知られています。
15+
16+
### コミュニティアセット {#community-assets}
17+
18+
現在、OpenTelemetry コミュニティは、アプリケーションを自動計装することができるビルド済みの Lambda レイヤーと、アプリケーションを手動または自動で計装する際に使用できるスタンドアロンの Collector Lambda レイヤーを提供しています。
19+
20+
リリース状況は[OpenTelemetry-Lambdaリポジトリ](https://github.com/open-telemetry/opentelemetry-lambda)で追跡できます。
21+
22+
[cloud native apps]: https://glossary.cncf.io/cloud-native-apps/

‎content/ja/docs/platforms/faas/lambda-auto-instrument.md

+114
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
---
2+
title: Lambda 自動計装
3+
weight: 11
4+
description: あなたのLambdaをOpenTelemetryで自動的に計装する
5+
default_lang_commit: 9ba98f4fded66ec78bfafa189ab2d15d66df2309
6+
cSpell:ignore: Corretto
7+
---
8+
9+
OpenTelemetryコミュニティは、以下の言語用のスタンドアロン計装Lambdaレイヤーを提供しています。
10+
11+
- Java
12+
- JavaScript
13+
- Python
14+
- Ruby
15+
16+
これらのレイヤーは、AWSポータルを使用してLambdaに追加し、アプリケーションを自動的に計装できます。
17+
これらのレイヤーにはコレクターは含まれておらず、外部コレクターインスタンスを構成してデータを送信しない限り、追加する必要があります。
18+
19+
### OTel Collector LambdaレイヤーのARNを追加する {#add-the-arn-of-the-otel-collector-lambda-layer}
20+
21+
[Collector Lambdaレイヤーのガイダンス](../lambda-collector/)を参照して、アプリケーションにレイヤーを追加し、Collectorを設定してください。
22+
これを最初に追加することをおすすめします。
23+
24+
### 言語要件 {#language-requirements}
25+
26+
{{< tabpane text=true >}} {{% tab Java %}}
27+
28+
Lambdaレイヤーは、Java 8, 11, 17 (Corretto) Lambdaランタイムをサポートしています。
29+
サポートされているJavaのバージョンについては、[OpenTelemetry Java ドキュメント](/docs/languages/java/) を参照してください。
30+
31+
**注意:** Javaの自動計装エージェントがLambdaレイヤー内にあります - 自動計装エージェントはAWS Lambdaの起動時間に顕著な影響を与えるので、初期化中に最初のリクエストでタイムアウトを起こさずに本番のリクエストに対応するためには、一般的にプロビジョニングされた同時実行とウォームアップリクエストと共にこれを使用する必要があります。
32+
33+
デフォルトでは、レイヤーのOTel Javaエージェントは、アプリケーション内のすべてのコードを自動計装しようとします。
34+
これはLambdaのコールドスタートの起動時間に悪影響を及ぼす可能性があります。
35+
36+
アプリケーションで使用するライブラリ／フレームワークの自動計装のみを有効にすることをおすすめします。
37+
38+
特定の計装だけを有効にするには、以下の環境変数を使用します。
39+
40+
- `OTEL_INSTRUMENTATION_COMMON_DEFAULT_ENABLED`: falseに設定すると、レイヤーの自動計装を無効にし、各計装を個別に有効にする必要があります。
41+
- `OTEL_INSTRUMENTATION_<NAME>_ENABLED`: 特定のライブラリやフレームワークの自動計装を有効にするには true を設定します。`<NAME>`の部分を有効にしたい計装で置き換えます。利用可能な計装のリストについては、[特定のエージェントの計装を抑制する][1] を参照してください。
42+
43+
[1]: /docs/zero-code/java/agent/disable/#suppressing-specific-agent-instrumentation
44+
45+
たとえば、LambdaとAWS SDKの自動計装だけを有効にするには、以下の環境変数を設定します。
46+
47+
```sh
48+
OTEL_INSTRUMENTATION_COMMON_DEFAULT_ENABLED=false
49+
OTEL_INSTRUMENTATION_AWS_LAMBDA_ENABLED=true
50+
OTEL_INSTRUMENTATION_AWS_SDK_ENABLED=true
51+
```
52+
53+
{{% /tab %}} {{% tab JavaScript %}}
54+
55+
Lambdaレイヤーは、Node.js v14+のLambdaランタイムをサポートしています。
56+
サポートされるJavaScriptとNode.jsのバージョンの詳細については、[OpenTelemetry JavaScriptドキュメント](https://github.com/open-telemetry/opentelemetry-js)を参照してください。
57+
58+
{{% /tab %}} {{% tab Python %}}
59+
60+
LambdaレイヤーはPython 3.8とPython 3.9のLambdaランタイムをサポートしています。
61+
サポートされているPythonのバージョンについては、[OpenTelemetry Pythonドキュメント](https://github.com/open-telemetry/opentelemetry-python/blob/main/README.md#supported-runtimes) と [PyPi](https://pypi.org/project/opentelemetry-api/) のパッケージを参照してください。
62+
63+
{{% /tab %}} {{% tab Ruby %}}
64+
65+
Lambda レイヤーは、Ruby 3.2 と 3.3 の Lambda ランタイムをサポートしています。
66+
サポートされる OpenTelemetry Ruby SDK と API バージョンの詳細については、[OpenTelemetry Rubyドキュメント](https://github.com/open-telemetry/opentelemetry-ruby/blob/main/README.md#compatibility) と [RubyGem](https://rubygems.org/search?query=opentelemetry) のパッケージを参照してください。
67+
68+
{{% /tab %}} {{< /tabpane >}}
69+
70+
### `AWS_LAMBDA_EXEC_WRAPPER` を設定する {#configure-aws_lambda_exec_wrapper}
71+
72+
Node.js、Java、Rubyの場合は `AWS_LAMBDA_EXEC_WRAPPER=/opt/otel-handler` 、Pythonの場合は`AWS_LAMBDA_EXEC_WRAPPER=/opt/otel-instrument` を設定して、アプリケーションのエントリーポイントを変更します。
73+
これらのラッパースクリプトは、自動計装を適用したLambdaアプリケーションを起動します。
74+
75+
### 計装LambdaレイヤーのARNを追加する {#add-the-arn-of-instrumentation-lambda-layer}
76+
77+
Lambda関数でOTelの自動計装を有効にするには、計装レイヤーとコレクターレイヤーを追加して設定し、トレースを有効にする必要があります。
78+
79+
1. AWSコンソールで、計装するLambda関数を開く。
80+
2. 「レイヤー」セクションで、「レイヤーの追加」を選択します。
81+
3. 「ARNを指定」でレイヤーのARNを貼り付け、「追加」を選択します。
82+
83+
あなたの言語の[最新の計装レイヤーリリース](https://github.com/open-telemetry/opentelemetry-lambda/releases)を見つけ、そのARNを使用します。
84+
`<region>`タグをあなたのラムダがあるリージョンに変更します。
85+
86+
注意: ラムダレイヤーはリージョンで分かれたリソースで、公開されているリージョンでのみ使用できます。Lambda関数と同じリージョンでレイヤーを使用するようにしてください。コミュニティは、利用可能なすべてのリージョンでレイヤーを公開しています。
87+
88+
### SDKのエクスポーターの設定 {#configure-your-sdk-exporters}
89+
90+
gRPC/HTTPレシーバーを持つコレクターが組み込まれている場合、Lambdaレイヤーで使用されるデフォルトのエクスポーターは変更なしで動作します。
91+
環境変数を更新する必要はありません。
92+
ただし、プロトコルのサポートレベルやデフォルト値は言語によって異なります。
93+
94+
{{< tabpane text=true >}} {{% tab Java %}}
95+
96+
`OTEL_EXPORTER_OTLP_PROTOCOL=grpc` は `grpc`、`http/protobuf` および `http/json`、`OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317` をサポートします。
97+
98+
{{% /tab %}} {{% tab JavaScript %}}
99+
100+
環境変数 `OTEL_EXPORTER_OTLP_PROTOCOL` はサポートされていません。ハードコードされたエクスポーターはプロトコル `http/protobuf` を使用します。`OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318`
101+
102+
{{% /tab %}} {{% tab Python %}}
103+
104+
`OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf` は `http/protobuf` と `http/json` 、`OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318` をサポートします。
105+
106+
{{% /tab %}} {{% tab Ruby %}}
107+
108+
`OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf` は `http/protobuf` `OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318` をサポートします。
109+
110+
{{% /tab %}} {{< /tabpane >}}
111+
112+
### Lambdaを公開する {#publish-your-lambda}
113+
114+
Lambdaの新しいバージョンを公開して、新しい変更と計装をデプロイします。

‎content/ja/docs/platforms/faas/lambda-collector.md

+156
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
---
2+
title: Lambdaコレクター設定
3+
linkTitle: Lambdaコレクター設定
4+
weight: 11
5+
description: コレクターLambdaレイヤーをあなたのLambdaに追加して設定する
6+
default_lang_commit: 9ba98f4fded66ec78bfafa189ab2d15d66df2309
7+
cSpell:ignore: ADOT awsxray configmap confmap
8+
---
9+
10+
OpenTelemetry コミュニティは、ユーザーに最大限の柔軟性を与えるために、コレクターを計装レイヤーとは別のLambdaレイヤーで提供しています。
11+
これは、計装とコレクターをバンドルしている現在の AWS Distribution of OpenTelemetry (ADOT) の実装とは異なります。
12+
13+
### OTelコレクターLambdaレイヤーのARNを追加する {#add-the-arn-of-the-otel-collector-lambda-layer}
14+
15+
アプリケーションの計装が完了したら、コレクターLambdaレイヤーを追加してデータを収集し、選択したバックエンドに送信します。
16+
17+
[最新のコレクターレイヤーリリース](https://github.com/open-telemetry/opentelemetry-lambda/releases)を見つけ、そのARNを使用します。
18+
`<region>`タグをラムダがいるリージョンに変更します。
19+
20+
注意: ラムダレイヤーはリージョンで分かれたリソースであり、公開されているリージョンでのみ使用できます。Lambda関数と同じリージョンでレイヤーを使用するようにしてください。コミュニティは、利用可能なすべてのリージョンでレイヤーを公開しています。
21+
22+
### OTelコレクターの設定 {#configure-the-otel-collector}
23+
24+
OTelコレクターLambdaレイヤーの設定は、OpenTelemetry標準にしたがっています。
25+
26+
デフォルトでは、OTelコレクターLambdaレイヤーはconfig.yamlを使用します。
27+
28+
#### 希望するバックエンドの環境変数を設定する {#set-the-environment-variable-for-your-preferred-backend}
29+
30+
Lambda環境変数の設定で、認証トークンを格納する新しい変数を作成します。
31+
32+
#### デフォルトエクスポーターを更新する {#update-the-default-exporters}
33+
34+
もしまだ存在していなければ、`config.yaml` ファイルに好みのエクスポーターを追加します。
35+
前のステップでアクセストークンのために設定した環境変数を使用して、エクスポーターを設定します。
36+
37+
**エクスポーターに環境変数が設定されていない場合、デフォルトの設定は、デバッグエクスポーターを使用したデータ送信のみをサポートします**
38+
以下はデフォルトの設定です。
39+
40+
```yaml
41+
receivers:
42+
otlp:
43+
protocols:
44+
grpc:
45+
endpoint: '0.0.0.0:4317'
46+
http:
47+
endpoint: '0.0.0.0:4318'
48+
49+
exporters:
50+
# 注意: v0.86.0 より前のバージョンでは、`debug` のかわりに `logging` を使用すること
51+
debug:
52+
verbosity: detailed
53+
54+
service:
55+
pipelines:
56+
traces:
57+
receivers: [otlp]
58+
exporters: [debug]
59+
metrics:
60+
receivers: [otlp]
61+
exporters: [debug]
62+
telemetry:
63+
metrics:
64+
address: localhost:8888
65+
```
66+
67+
### Lambdaを公開する {#publish-your-lambda}
68+
69+
Lambdaの新しいバージョンをパブリッシュして、行った変更を有効にします。
70+
71+
### 高度な OTel コレクターの設定 {#advanced-otel-collector-configuration}
72+
73+
カスタム構成でサポートされる利用可能なコンポーネントのリストは、こちらをご覧ください。
74+
デバッグを有効にするには、設定ファイルを使ってログレベルをデバッグに設定します。
75+
以下の例を参照してください。
76+
77+
#### 希望のConfmapプロバイダーを選択する {#choose-your-preferred-confmap-provider}
78+
79+
OTel Lambdaレイヤーは `file`、`env`、`yaml`、`http`、`https`、`s3` といった種類の Confmap プロバイダーをサポートしています。
80+
異なる Confmap プロバイダーを使用して OTel コレクターの設定をカスタマイズするには、[Amazon Distribution of OpenTelemetry Confmap providers document](https://aws-otel.github.io/docs/components/confmap-providers#confmap-providers-supported-by-the-adot-collector) を参照してください。
81+
82+
#### カスタム設定ファイルの作成 {#create-a-custom-configuration-file}
83+
84+
以下はルートディレクトリにある `collector.yaml` の設定ファイルのサンプルです。
85+
86+
```yaml
87+
# ルート・ディレクトリの collector.yaml
88+
# 環境変数 'OPENTELEMETRY_COLLECTOR_CONFIG_URI' を '/var/task/collector.yaml' に設定する
89+
90+
receivers:
91+
otlp:
92+
protocols:
93+
grpc:
94+
endpoint: 'localhost:4317'
95+
http:
96+
endpoint: 'localhost:4318'
97+
98+
exporters:
99+
# 注意: v0.86.0 より前のバージョンでは `debug` のかわりに `logging` を使用すること
100+
debug:
101+
awsxray:
102+
103+
service:
104+
pipelines:
105+
traces:
106+
receivers: [otlp]
107+
exporters: [awsxray]
108+
metrics:
109+
receivers: [otlp]
110+
exporters: [debug]
111+
telemetry:
112+
metrics:
113+
address: localhost:8888
114+
```
115+
116+
#### 環境変数を使ってカスタム設定ファイルをマップする {#map-your-custom-configuration-file-using-environment-variables}
117+
118+
confmapプロバイダーを通してコレクターを設定したら、Lambda関数に環境変数 `OPENTELEMETRY_COLLECTOR_CONFIG_URI` を作成し、その値としてconfmapプロバイダーの設定のパスを設定します。
119+
たとえば、ファイルconfigmapプロバイダーを使用している場合は、その値を `/var/task/<path>/<to>/<filename>` に設定します。
120+
これにより、拡張モジュールにコレクターの設定がどこにあるかを伝えます。
121+
122+
##### CLIを使用したカスタムコレクター設定 {#custom-collector-configuration-using-the-cli}
123+
124+
Lambdaコンソール、またはAWS CLIから設定できます。
125+
126+
```bash
127+
aws lambda update-function-configuration --function-name Function --environment Variables={OPENTELEMETRY_COLLECTOR_CONFIG_URI=/var/task/collector.yaml}
128+
```
129+
130+
##### CloudFormationから設定用の環境変数を設定する {#set-configuration-environment-variables-from-cloudformation}
131+
132+
環境変数は**CloudFormation**テンプレートでも設定できます。
133+
134+
```yaml
135+
Function:
136+
Type: AWS::Serverless::Function
137+
Properties:
138+
...
139+
Environment:
140+
Variables:
141+
OPENTELEMETRY_COLLECTOR_CONFIG_URI: /var/task/collector.yaml
142+
```
143+
144+
##### S3オブジェクトから設定を読み込む {#load-configuration-from-an-s3-object}
145+
146+
S3から設定を読み込むには、関数にアタッチされたIAMロールに、関連するバケットへの読み取りアクセスが含まれている必要があります。
147+
148+
```yaml
149+
Function:
150+
Type: AWS::Serverless::Function
151+
Properties:
152+
...
153+
Environment:
154+
Variables:
155+
OPENTELEMETRY_COLLECTOR_CONFIG_URI: s3://<bucket_name>.s3.<region>.amazonaws.com/collector_config.yaml
156+
```

‎content/ja/docs/platforms/faas/lambda-manual-instrument.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: Lambdaの手動計装
3+
weight: 11
4+
description: OpenTelemetryであなたのLambdaを手動計装する
5+
default_lang_commit: 9ba98f4fded66ec78bfafa189ab2d15d66df2309
6+
---
7+
8+
Lambdaの自動計装ドキュメントでカバーされていない言語については、コミュニティはスタンドアロンの計装レイヤーを持っていません。
9+
10+
ユーザーは、選択した言語の汎用計装ガイダンスにしたがい、コレクターLambdaレイヤーを追加してデータを送信する必要があります。
11+
12+
### OTelコレクターLambdaレイヤーのARNを追加する {#add-the-arn-of-the-otel-collector-lambda-layer}
13+
14+
[コレクターLambdaレイヤーのガイダンス](../lambda-collector/)を参照して、アプリケーションにレイヤーを追加し、コレクターを設定してください。
15+
これを最初に追加することをおすすめします。
16+
17+
### LambdaをOTelで計装する {#instrument-the-lambda-with-otel}
18+
19+
アプリケーションを手動で計装する方法については、[各言語向け計装ガイド](/docs/languages/) を確認してください。
20+
21+
### Lambdaを公開する {#publish-your-lambda}
22+
23+
Lambdaの新しいバージョンを公開して、新しい変更と計装をデプロイします。

0 commit comments

Comments
 (0)